ServiceStack.Client

Annotate Request DTOs with IGet, IPost, etc HTTP Verb markers to specify which HTTP Method is used: https://docs.servicestack.net/csharp-client.html#http-verb-interface-markers

Convert AutoLogin RegisterResponse into AuthenticateResponse to avoid additional trip

Need to provide async request options http://msdn.microsoft.com/en-us/library/86wf6409(VS.71).aspx

The request filter is called before any request. This request filter is executed globally.

The response action is called once the server response is available. It will allow you to access raw response information. This response action is executed globally. Note that you should NOT consume the response stream as this is handled by ServiceStack

Called before request resend, when the initial request required authentication

The request filter is called before any request. This request filter only works with the instance where it was set (not global).

The response action is called once the server response is available. It will allow you to access raw response information. Note that you should NOT consume the response stream as this is handled by ServiceStack

The ResultsFilter is called before the Request is sent allowing you to return a cached response.

The ResultsFilterResponse is called before returning the response allowing responses to be cached.

Called with requestUri, ResponseType when server returns 304 NotModified

Capture a CRUD Event

AutoCrudOperation, e.g. Create, Update, Patch, Delete, Save

DB Model

Primary Key of DB Model

Date of Event (UTC)

Rows Updated if available

Request DTO Type

Serialized Request Body

UserAuthId if Authenticated

UserName or unique User Identifier

URN format: urn:{requesttype}:{ModelId}

Custom Reference Data with integer Primary Key

Custom Reference Data with non-integer Primary Key

Custom Metadata to attach to this event

DTO to capture file uploaded using [UploadTo]

Upload a file to the specified managed location

Download file from the specified managed location

Overwrite file at the specified managed location

Delete file at the specified managed location

Is AutoQuery or Crud Request API

Is AutoQuery Request DTO

Is Crud Request DTO

Is AutoQuery or Crud Request DTO

Is AutoQuery Request DTO

Is AutoQuery QueryDb`1 Request DTO

Is AutoQuery Into QueryDb`2 Request DTO

Is Any AutoQuery Request DTO

Is AutoQuery QueryData`1 Request DTO

Is AutoQuery QueryData`2 Request DTO

Is AutoQuery Request DTO

Is Crud Request DTO

Is AutoQuery or Crud Request DTO for Data Model

Is Crud Request DTO for Data Model

Is AutoQuery Request DTO for Data Model

Is ICreateDb or ISaveDb Crud Request DTO

Is ICreateDb or ISaveDb Crud Request DTO for Data Model

Is IPatchDb, IUpdateDb or ISaveDb Crud Request DTO

Is IPatchDb, IUpdateDb or ISaveDb Crud Request DTO for Data Model

Is ICreateDb, IPatchDb, IUpdateDb or ISaveDb Crud Request DTO

Is ICreateDb, IPatchDb, IUpdateDb or ISaveDb Crud Request DTO for Data Model

Is IDeleteDb Crud Request DTO

Is IDeleteDb Crud Request DTO for Data Model

Retrieve AutoQuery Data Model from AutoQuery CRUD APIs

Useful .NET Encryption Utils from: https://andrewlocatelliwoodcock.wordpress.com/2011/08/01/implementing-rsa-asymmetric-public-private-key-encryption-in-c-encrypting-under-the-public-key/

Convert from Grid Matrix of Inputs into a flat List of Inputs with configured grid classes

Returns the minimum visible size when the target should be visible. Returns next Size if no rule was defined for the target. Returns ExtraSmall (xs) if there were no 'Show' Media Rules.

Property Name

Size | Bootstrap | Tailwind xs | -576px | sm | 576px | -640px md | 768px | 768px lg | 992px | 1024px xl | 1200px | 1280px xxl | 1400px | 1536px

https://www.iana.org/assignments/jwt/jwt.xhtml#claims

Full name

Given name(s) or first name(s)

Surname(s) or last name(s)

Returns the next message from queueName or null if no message

Only show if authAttributes.contains(Show) E.g. limit to role:TheRole

Do not show if authAttributes.contains(Hide) E.g. hide from role:TheRole

If not specified uses browser's navigator.languages

Assume Dates are returned as UTC

Generic template for adding metadata info about custom plugins

Which User Roles have access to this Plugins Services. See RoleNames for built-in Roles.

What Services Types (and their user-defined routes) are enabled in this plugin

List of enabled features in this plugin

Additional custom metadata about this plugin

App Info and

The App's BaseUrl

The ServiceStack Version

Name of the ServiceStack Instance

The Config.ApiVersion

Textual description of the ServiceStack App (shown in Home Services list)

Icon for this ServiceStack App (shown in Home Services list)

Link to your website users can click to find out more about you

A custom logo or image that users can click on to visit your site

The default color of text

The default color of links

The default background color of each screen

The default background image of each screen anchored to the bottom left

The default icon for each of your App's Services

The configured JsConfig.TextCase

Use System.Text.Json for APIs by default

Info on Endpoint Routing

Custom User-Defined Attributes

App Info and

The brand icon to use with App brand name

Hide APIs with tags

The module paths that are loaded

Always hide APIs with tags (inc DebugMode)

Admin UI Links

Default Themes for all UIs

The default styles to use for rendering AutoQuery UI Forms

The default styles to use for rendering API Explorer Forms

The default styles to use for rendering Admin UI

The default formats for displaying info

Custom User-Defined Attributes

Customize Admin Users FormLayout

Reorder where the DB Column appears in Type (changes API & UI ordering)

Apply custom lambda to each matching property

Omit properties that match filter from inclusion in code-gen type

Omit property from inclusion in code-gen type

Best effort to create RefInfo from Reflection alone

Creates the error response from the values provided. If the errorCode is empty it will use the first validation error code, if there is none it will throw an error.

The error code. The error message. The validation errors.

Default MaxStringContentLength is 8k, and throws an exception when reached

Serializer cache of delegates required to create a type from a string map (e.g. for REST urls)

Gets the namespace from an attribute marked on the type's definition

Namespace of type

Apply Request Filter to all ServerEventClient Requests

Removes all registered Handlers, Named Receivers and Listeners

Need to provide async request options http://msdn.microsoft.com/en-us/library/86wf6409(VS.71).aspx

The request filter is called before any request. This request filter is executed globally.

Gets the collection of headers to be added to outgoing requests.

Sets all baseUri properties, using the Format property for the SyncReplyBaseUri and AsyncOneWayBaseUri

Base URI of the service

Relative BasePath to use for predefined routes. Set with `UseBasePath` or `WithBasePath()` Always contains '/' prefix + '/' suffix, e.g. /api/

Replace the Base reply/oneway paths to use a different prefix

Whether to Accept Gzip,Deflate Content-Encoding and to auto decompress responses

The user name for basic authentication

The password for basic authentication

Sets the username and the password for basic authentication.

The Authorization Bearer Token to send with this request

Gets or sets authentication information for the request. Warning: It's recommend to use and for basic auth. This property is only used for IIS level authentication.

Determines if the basic auth header should be sent with every request. By default, the basic auth header is only sent when "401 Unauthorized" is returned.

Specifies if cookies should be stored

Called before request resend, when the initial request required authentication

If a request fails with a 401 Unauthorized and a BearerToken is present the client will automatically fetch a new AccessToken using this RefreshToken and retry the request

Send the Request to get the AccessToken with the RefreshToken at a non-default location

Whether to enable auto refreshing token of JWT Tokens from Refresh Tokens

The request filter is called before any request. This request filter only works with the instance where it was set (not global).

The ResultsFilter is called before the Request is sent allowing you to return a cached response.

The ResultsFilterResponse is called before returning the response allowing responses to be cached.

Called with requestUri, ResponseType when server returns 304 NotModified

Called by Send method if an exception occurs, for instance a System.Net.WebException because the server returned an HTTP error code. Override if you want to handle specific exceptions or always want to parse the response to a custom ErrorResponse DTO type instead of ServiceStack's ErrorResponse class. In case ex is a System.Net.WebException, do not use createWebRequest/getResponse/HandleResponse<TResponse> to parse the response because that will result in the same exception again. Use ThrowWebServiceException<YourErrorResponseType> to parse the response and to throw a WebServiceException containing the parsed DTO. Then override Send to handle that exception.

APIs returning HttpWebResponse must be explicitly Disposed, e.g using (var res = client.Get(url)) { ... }

APIs returning HttpWebResponse must be explicitly Disposed, e.g using (var res = client.Delete(url)) { ... }

APIs returning HttpWebResponse must be explicitly Disposed, e.g using (var res = client.Post(url)) { ... }

APIs returning HttpWebResponse must be explicitly Disposed, e.g using (var res = client.Put(url)) { ... }

APIs returning HttpWebResponse must be explicitly Disposed, e.g using (var res = client.CustomMethod(method,dto)) { ... }

APIs returning HttpWebResponse must be explicitly Disposed, e.g using (var res = client.Head(request)) { ... }

HTTP Methods supported my Service Clients

Get the preferred HTTP method to use with this API, if it either: - Implements IVerb marker interface - Inherits AutoQuery/CRUD DTO - Using a single distinct user defined [Route]

preferred HTTP Method or null if cannot be inferred

Is there a compressor registered with this encoding?

return the registered IStreamCompressor implementation for for this

Assert there exists a IStreamCompressor for this encoding

Remove compression support for this encoding

Compresses the specified text using the default compression method: Deflate

The text. Type of the compression.

Compresses the specified text using the default compression method: Deflate

Decompresses the specified gz buffer using the default compression method: Inflate

The gz buffer. Type of the compression.

Decompresses the specified gz buffer using inflate or gzip method

Compressed stream Type of the compression. Can be "gzip" or "deflate" Decompressed stream

Decompresses the specified gz buffer using the default compression method: Inflate

Donated by Ivan Korneliuk from his post: http://korneliuk.blogspot.com/2012/08/servicestack-reusing-dtos.html Modified to only allow using routes matching the supplied HTTP Verb

Generate a url from a Request DTO. Pretty URL generation require Routes to be defined using `[Route]` on the Request DTO

The exception which is thrown when a validation error occurred. This validation is serialized in a extra clean and human-readable way by ServiceStack.

Returns the first error code

The error code.

Used if we need to serialize this exception to XML

Encapsulates a validation result.

Gets or sets the success code.

The success code.

Gets or sets the error code.

The error code.

Gets or sets the success message.

The success message.

Gets or sets the error message.

The error message.

The errors generated by the validation.

Returns True if the validation was successful (errors list is empty).

Constructs a new ValidationResult

A list of validation results

Initializes a new instance of the class.

The errors. The success code. The error code.

Merge errors from another

Naming convention for the request's Response DTO

Shortcut to get the ResponseStatus whether it's bare or inside a IHttpResult