RestSharp

# Assembly: RestSharp

# Namespace: RestSharp

# Class DeserializationException

# Inheritance

↳ object
  ↳ System.Exception

# Syntax

public class DeserializationException : Exception, ISerializable

# Constructor DeserializationException(IRestResponse, Exception)

# Syntax
public DeserializationException(IRestResponse response, Exception innerException)
# Parameters
Name Type Description
response RestSharp.IRestResponse
innerException System.Exception

# Property Response

# Syntax
public IRestResponse Response { get; }

# Enum ParameterType

Types of parameters that can be added to requests

# Syntax

public enum ParameterType

# Fields

Name Description
Cookie Cookie parameter
GetOrPost
UrlSegment
HttpHeader
RequestBody
QueryString
QueryStringWithoutEncode

# Enum DataFormat

Data formats

# Syntax

public enum DataFormat

# Fields

Name Description
Json
Xml
None

# Enum Method

HTTP method to use when making requests

# Syntax

public enum Method

# Fields

Name Description
GET
POST
PUT
DELETE
HEAD
OPTIONS
PATCH
MERGE
COPY

# Struct DateFormat

Format strings for commonly-used date formats

# Syntax

public struct DateFormat

# Field ISO_8601

.NET format string for ISO 8601 date format

# Syntax
public static string ISO_8601 = "s"

# Field ROUND_TRIP

.NET format string for roundtrip date format

# Syntax
public static string ROUND_TRIP = "u"

# Enum ResponseStatus

Status for responses (surprised?)

# Syntax

public enum ResponseStatus

# Fields

Name Description
None
Completed
Error
TimedOut
Aborted

# Class FileParameter

Container for files to be uploaded with requests

# Inheritance

↳ object

# Syntax

public class FileParameter

# Property ContentLength

The length of data to be sent

# Syntax
public long ContentLength { get; set; }

# Property Writer

Provides raw data for file

# Syntax
public Action<Stream> Writer { get; set; }

# Property FileName

Name of the file to use when uploading

# Syntax
public string FileName { get; set; }

# Property ContentType

MIME content type of file

# Syntax
public string ContentType { get; set; }

# Property Name

Name of the parameter

# Syntax
public string Name { get; set; }

# Method Create(String, Byte[], String, String)

# Syntax
public static FileParameter Create(string name, byte[] data, string filename, string contentType)
# Parameters
Name Type Description
name string
data byte[]
filename string
contentType string
# Returns
Type Description
RestSharp.FileParameter

# Method Create(String, Byte[], String)

# Syntax
public static FileParameter Create(string name, byte[] data, string filename)
# Parameters
Name Type Description
name string
data byte[]
filename string
# Returns
Type Description
RestSharp.FileParameter

# Method Create(String, Action<Stream>, Int64, String, String)

# Syntax
public static FileParameter Create(string name, Action<Stream> writer, long contentLength, string fileName, string contentType = null)
# Parameters
Name Type Description
name string
writer System.Action<System.IO.Stream>
contentLength long
fileName string
contentType string
# Returns
Type Description
RestSharp.FileParameter

# Class Http

HttpWebRequest wrapper (async methods)

# Inheritance

↳ object

# Syntax

public class Http : IHttp

# Method AsPostAsync(Action<HttpResponse>, String)

# Syntax
public HttpWebRequest AsPostAsync(Action<HttpResponse> action, string httpMethod)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
httpMethod string
# Returns
Type Description
HttpWebRequest

# Method AsGetAsync(Action<HttpResponse>, String)

# Syntax
public HttpWebRequest AsGetAsync(Action<HttpResponse> action, string httpMethod)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
httpMethod string
# Returns
Type Description
HttpWebRequest

# Constructor Http()

# Syntax
public Http()

# Property HasParameters

True if this HTTP request has any HTTP parameters

# Syntax
protected bool HasParameters { get; }

# Property HasCookies

True if this HTTP request has any HTTP cookies

# Syntax
protected bool HasCookies { get; }

# Property HasBody

True if a request body has been specified

# Syntax
protected bool HasBody { get; }

# Property HasFiles

True if files have been set to be uploaded

# Syntax
protected bool HasFiles { get; }

# Property AutomaticDecompression

# Syntax
public bool AutomaticDecompression { get; set; }

# Property AlwaysMultipartFormData

Always send a multipart/form-data request - even when no Files are present.

# Syntax
public bool AlwaysMultipartFormData { get; set; }

# Property UserAgent

# Syntax
public string UserAgent { get; set; }

# Property Timeout

# Syntax
public int Timeout { get; set; }

# Property ReadWriteTimeout

# Syntax
public int ReadWriteTimeout { get; set; }

# Property Credentials

# Syntax
public ICredentials Credentials { get; set; }

# Property CookieContainer

# Syntax
public CookieContainer CookieContainer { get; set; }

# Property AdvancedResponseWriter

# Syntax
public Action<Stream, IHttpResponse> AdvancedResponseWriter { get; set; }

# Property ResponseWriter

# Syntax
public Action<Stream> ResponseWriter { get; set; }

# Property Files

# Syntax
public IList<HttpFile> Files { get; }

# Property FollowRedirects

# Syntax
public bool FollowRedirects { get; set; }

# Property Pipelined

# Syntax
public bool Pipelined { get; set; }

# Property ClientCertificates

# Syntax
public X509CertificateCollection ClientCertificates { get; set; }

# Property MaxRedirects

# Syntax
public int? MaxRedirects { get; set; }

# Property UseDefaultCredentials

# Syntax
public bool UseDefaultCredentials { get; set; }

# Property ConnectionGroupName

# Syntax
public string ConnectionGroupName { get; set; }

# Property Encoding

# Syntax
public Encoding Encoding { get; set; }

# Property Headers

# Syntax
public IList<HttpHeader> Headers { get; }

# Property Parameters

# Syntax
public IList<HttpParameter> Parameters { get; }

# Property Cookies

# Syntax
public IList<HttpCookie> Cookies { get; }

# Property RequestBody

# Syntax
public string RequestBody { get; set; }

# Property RequestContentType

# Syntax
public string RequestContentType { get; set; }

# Property RequestBodyBytes

# Syntax
public byte[] RequestBodyBytes { get; set; }

# Property Url

# Syntax
public Uri Url { get; set; }

# Property Host

# Syntax
public string Host { get; set; }

# Property AllowedDecompressionMethods

# Syntax
public IList<DecompressionMethods> AllowedDecompressionMethods { get; set; }

# Property PreAuthenticate

# Syntax
public bool PreAuthenticate { get; set; }

# Property UnsafeAuthenticatedConnectionSharing

# Syntax
public bool UnsafeAuthenticatedConnectionSharing { get; set; }

# Property Proxy

# Syntax
public IWebProxy Proxy { get; set; }

# Property CachePolicy

# Syntax
public RequestCachePolicy CachePolicy { get; set; }

# Property RemoteCertificateValidationCallback

Callback function for handling the validation of remote certificates.

# Syntax
public RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; }

# Property WebRequestConfigurator

# Syntax
public Action<HttpWebRequest> WebRequestConfigurator { get; set; }

# Method Create()

# Syntax
[Obsolete]
public static IHttp Create()
# Returns
Type Description
RestSharp.IHttp

# Method CreateWebRequest(Uri)

# Syntax
[Obsolete("Overriding this method won't be possible in future version")]
protected virtual HttpWebRequest CreateWebRequest(Uri url)
# Parameters
Name Type Description
url Uri
# Returns
Type Description
HttpWebRequest

# Method Post()

Execute a POST request

# Syntax
public HttpResponse Post()
# Returns
Type Description
RestSharp.HttpResponse

# Method Put()

Execute a PUT request

# Syntax
public HttpResponse Put()
# Returns
Type Description
RestSharp.HttpResponse

# Method Get()

Execute a GET request

# Syntax
public HttpResponse Get()
# Returns
Type Description
RestSharp.HttpResponse

# Method Head()

Execute a HEAD request

# Syntax
public HttpResponse Head()
# Returns
Type Description
RestSharp.HttpResponse

# Method Options()

Execute an OPTIONS request

# Syntax
public HttpResponse Options()
# Returns
Type Description
RestSharp.HttpResponse

# Method Delete()

Execute a DELETE request

# Syntax
public HttpResponse Delete()
# Returns
Type Description
RestSharp.HttpResponse

# Method Patch()

Execute a PATCH request

# Syntax
public HttpResponse Patch()
# Returns
Type Description
RestSharp.HttpResponse

# Method Merge()

Execute a MERGE request

# Syntax
public HttpResponse Merge()
# Returns
Type Description
RestSharp.HttpResponse

# Method AsGet(String)

Execute a GET-style request with the specified HTTP Method.

# Syntax
public HttpResponse AsGet(string httpMethod)
# Parameters
Name Type Description
httpMethod string The HTTP method to execute.
# Returns
Type Description
RestSharp.HttpResponse

# Method AsPost(String)

Execute a POST-style request with the specified HTTP Method.

# Syntax
public HttpResponse AsPost(string httpMethod)
# Parameters
Name Type Description
httpMethod string The HTTP method to execute.
# Returns
Type Description
RestSharp.HttpResponse

# Method ConfigureWebRequest(String, Uri)

# Syntax
[Obsolete("Use the WebRequestConfigurator delegate instead of overriding this method")]
protected virtual HttpWebRequest ConfigureWebRequest(string method, Uri url)
# Parameters
Name Type Description
method string
url Uri
# Returns
Type Description
HttpWebRequest

# Method DeleteAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest DeleteAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method GetAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest GetAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method HeadAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest HeadAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method OptionsAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest OptionsAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method PostAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest PostAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method PutAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest PutAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method PatchAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest PatchAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method MergeAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
public HttpWebRequest MergeAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method ConfigureAsyncWebRequest(String, Uri)

# Syntax
[Obsolete("Use the WebRequestConfigurator delegate instead of overriding this method")]
protected virtual HttpWebRequest ConfigureAsyncWebRequest(string method, Uri url)
# Parameters
Name Type Description
method string
url Uri
# Returns
Type Description
HttpWebRequest

# Class HttpCookie

Representation of an HTTP cookie

# Inheritance

↳ object

# Syntax

public class HttpCookie

# Property Comment

Comment of the cookie

# Syntax
public string Comment { get; set; }

# Property CommentUri

Comment of the cookie

# Syntax
public Uri CommentUri { get; set; }

# Property Discard

Indicates whether the cookie should be discarded at the end of the session

# Syntax
public bool Discard { get; set; }

# Property Domain

Domain of the cookie

# Syntax
public string Domain { get; set; }

# Property Expired

Indicates whether the cookie is expired

# Syntax
public bool Expired { get; set; }

# Property Expires

Date and time that the cookie expires

# Syntax
public DateTime Expires { get; set; }

# Property HttpOnly

Indicates that this cookie should only be accessed by the server

# Syntax
public bool HttpOnly { get; set; }

# Property Name

Name of the cookie

# Syntax
public string Name { get; set; }

# Property Path

Path of the cookie

# Syntax
public string Path { get; set; }

# Property Port

Port of the cookie

# Syntax
public string Port { get; set; }

# Property Secure

Indicates that the cookie should only be sent over secure channels

# Syntax
public bool Secure { get; set; }

# Property TimeStamp

Date and time the cookie was created

# Syntax
public DateTime TimeStamp { get; set; }

# Property Value

Value of the cookie

# Syntax
public string Value { get; set; }

# Property Version

Version of the cookie

# Syntax
public int Version { get; set; }

# Class HttpFile

Container for HTTP file

# Inheritance

↳ object

# Syntax

public class HttpFile

# Property ContentLength

The length of data to be sent

# Syntax
public long ContentLength { get; set; }

# Property Writer

Provides raw data for file

# Syntax
public Action<Stream> Writer { get; set; }

# Property FileName

Name of the file to use when uploading

# Syntax
public string FileName { get; set; }

# Property ContentType

MIME content type of file

# Syntax
public string ContentType { get; set; }

# Property Name

Name of the parameter

# Syntax
public string Name { get; set; }

# Class HttpHeader

Representation of an HTTP header

# Inheritance

↳ object

# Syntax

public class HttpHeader

# Constructor HttpHeader(String, String)

Creates a new instance of HttpHeader

# Syntax
public HttpHeader(string name, string value)
# Parameters
Name Type Description
name string Header name
value string Header value

# Constructor HttpHeader()

Creates a new instance of HttpHeader. Remember to assign properties!

# Syntax
public HttpHeader()

# Property Name

Name of the header

# Syntax
public string Name { get; set; }

# Property Value

Value of the header

# Syntax
public string Value { get; set; }

# Class HttpParameter

Representation of an HTTP parameter (QueryString or Form value)

# Inheritance

↳ object

# Syntax

public class HttpParameter

# Property Name

Name of the parameter

# Syntax
public string Name { get; set; }

# Property Value

Value of the parameter

# Syntax
public string Value { get; set; }

# Property ContentType

Content-Type of the parameter

# Syntax
public string ContentType { get; set; }

# Class HttpResponse

# Inheritance

↳ object

# Syntax

public class HttpResponse : IHttpResponse

# Constructor HttpResponse()

# Syntax
public HttpResponse()

# Property ContentType

# Syntax
public string ContentType { get; set; }

# Property ContentLength

# Syntax
public long ContentLength { get; set; }

# Property ContentEncoding

# Syntax
public string ContentEncoding { get; set; }

# Property Content

# Syntax
public string Content { get; }

# Property StatusCode

# Syntax
public HttpStatusCode StatusCode { get; set; }

# Property StatusDescription

# Syntax
public string StatusDescription { get; set; }

# Property RawBytes

# Syntax
public byte[] RawBytes { get; set; }

# Property ResponseUri

# Syntax
public Uri ResponseUri { get; set; }

# Property Server

# Syntax
public string Server { get; set; }

# Property Headers

# Syntax
public IList<HttpHeader> Headers { get; }

# Property Cookies

# Syntax
public IList<HttpCookie> Cookies { get; }

# Property ResponseStatus

# Syntax
public ResponseStatus ResponseStatus { get; set; }

# Property ErrorMessage

# Syntax
public string ErrorMessage { get; set; }

# Property ErrorException

# Syntax
public Exception ErrorException { get; set; }

# Property ProtocolVersion

# Syntax
public Version ProtocolVersion { get; set; }

# Interface IHttp

# Syntax

public interface IHttp

# Property ResponseWriter

The delegate to use to write the response instead of reading into RawBytes

# Syntax
Action<Stream> ResponseWriter { get; set; }

# Property AdvancedResponseWriter

The delegate to use to write the response instead of reading into RawBytes Here you can also check the request details

# Syntax
Action<Stream, IHttpResponse> AdvancedResponseWriter { get; set; }

# Property CookieContainer

The to be used for the request

# Syntax
CookieContainer CookieContainer { get; set; }

# Property Credentials

to be sent with request

# Syntax
ICredentials Credentials { get; set; }

# Property AutomaticDecompression

Enable or disable automatic gzip/deflate decompression

# Syntax
bool AutomaticDecompression { get; set; }

# Property AlwaysMultipartFormData

Always send a multipart/form-data request - even when no Files are present.

# Syntax
bool AlwaysMultipartFormData { get; set; }

# Property UserAgent

# Syntax
string UserAgent { get; set; }

# Property Timeout

Timeout in milliseconds to be used for the request

# Syntax
int Timeout { get; set; }

# Property ReadWriteTimeout

The number of milliseconds before the writing or reading times out.

# Syntax
int ReadWriteTimeout { get; set; }

# Property FollowRedirects

Whether or not HTTP 3xx response redirects should be automatically followed

# Syntax
bool FollowRedirects { get; set; }

# Property Pipelined

Whether or not to use pipelined connections

# Syntax
bool Pipelined { get; set; }

# Property ClientCertificates

X509CertificateCollection to be sent with request

# Syntax
X509CertificateCollection ClientCertificates { get; set; }

# Property MaxRedirects

Maximum number of automatic redirects to follow if FollowRedirects is true

# Syntax
int? MaxRedirects { get; set; }

# Property UseDefaultCredentials

Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) will be sent along to the server.

# Syntax
bool UseDefaultCredentials { get; set; }

# Property Encoding

Encoding for the request, UTF8 is the default

# Syntax
Encoding Encoding { get; set; }

# Property Headers

HTTP headers to be sent with request

# Syntax
IList<HttpHeader> Headers { get; }

# Property Parameters

HTTP parameters (QueryString or Form values) to be sent with request

# Syntax
IList<HttpParameter> Parameters { get; }

# Property Files

Collection of files to be sent with request

# Syntax
IList<HttpFile> Files { get; }

# Property Cookies

HTTP cookies to be sent with request

# Syntax
IList<HttpCookie> Cookies { get; }

# Property RequestBody

Request body to be sent with request

# Syntax
string RequestBody { get; set; }

# Property RequestContentType

Content type of the request body.

# Syntax
string RequestContentType { get; set; }

# Property PreAuthenticate

Flag to send authorisation header with the HttpWebRequest

# Syntax
bool PreAuthenticate { get; set; }

# Property UnsafeAuthenticatedConnectionSharing

Flag to reuse same connection in the HttpWebRequest

# Syntax
bool UnsafeAuthenticatedConnectionSharing { get; set; }

# Property CachePolicy

Caching policy for requests created with this wrapper.

# Syntax
RequestCachePolicy CachePolicy { get; set; }

# Property ConnectionGroupName

The ConnectionGroupName property enables you to associate a request with a connection group.

# Syntax
string ConnectionGroupName { get; set; }

# Property RequestBodyBytes

An alternative to RequestBody, for when the caller already has the byte array.

# Syntax
byte[] RequestBodyBytes { get; set; }

# Property Url

URL to call for this request

# Syntax
Uri Url { get; set; }

# Property Host

Explicit Host header value to use in requests independent from the request URI. If null, default host value extracted from URI is used.

# Syntax
string Host { get; set; }

# Property AllowedDecompressionMethods

List of allowed decompression methods

# Syntax
IList<DecompressionMethods> AllowedDecompressionMethods { get; set; }

# Property Proxy

Proxy info to be sent with request

# Syntax
IWebProxy Proxy { get; set; }

# Property RemoteCertificateValidationCallback

# Syntax
RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; }

# Property WebRequestConfigurator

# Syntax
Action<HttpWebRequest> WebRequestConfigurator { get; set; }

# Method DeleteAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest DeleteAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method GetAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest GetAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method HeadAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest HeadAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method OptionsAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest OptionsAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method PostAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest PostAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method PutAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest PutAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method PatchAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest PatchAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method MergeAsync(Action<HttpResponse>)

# Syntax
[Obsolete]
HttpWebRequest MergeAsync(Action<HttpResponse> action)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
# Returns
Type Description
HttpWebRequest

# Method AsPostAsync(Action<HttpResponse>, String)

Execute an async POST-style request with the specified HTTP Method.

# Syntax
HttpWebRequest AsPostAsync(Action<HttpResponse> action, string httpMethod)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
httpMethod string The HTTP method to execute.
# Returns
Type Description
HttpWebRequest

# Method AsGetAsync(Action<HttpResponse>, String)

Execute an async GET-style request with the specified HTTP Method.

# Syntax
HttpWebRequest AsGetAsync(Action<HttpResponse> action, string httpMethod)
# Parameters
Name Type Description
action System.Action<RestSharp.HttpResponse>
httpMethod string The HTTP method to execute.
# Returns
Type Description
HttpWebRequest

# Method Delete()

# Syntax
HttpResponse Delete()
# Returns
Type Description
RestSharp.HttpResponse

# Method Get()

# Syntax
HttpResponse Get()
# Returns
Type Description
RestSharp.HttpResponse

# Method Head()

# Syntax
HttpResponse Head()
# Returns
Type Description
RestSharp.HttpResponse

# Method Options()

# Syntax
HttpResponse Options()
# Returns
Type Description
RestSharp.HttpResponse

# Method Post()

# Syntax
HttpResponse Post()
# Returns
Type Description
RestSharp.HttpResponse

# Method Put()

# Syntax
HttpResponse Put()
# Returns
Type Description
RestSharp.HttpResponse

# Method Patch()

# Syntax
HttpResponse Patch()
# Returns
Type Description
RestSharp.HttpResponse

# Method Merge()

# Syntax
HttpResponse Merge()
# Returns
Type Description
RestSharp.HttpResponse

# Method AsPost(String)

# Syntax
HttpResponse AsPost(string httpMethod)
# Parameters
Name Type Description
httpMethod string
# Returns
Type Description
RestSharp.HttpResponse

# Method AsGet(String)

# Syntax
HttpResponse AsGet(string httpMethod)
# Parameters
Name Type Description
httpMethod string
# Returns
Type Description
RestSharp.HttpResponse

# Interface IHttpResponse

HTTP response data

# Syntax

public interface IHttpResponse

# Property ContentType

MIME content type of response

# Syntax
string ContentType { get; set; }

# Property ContentLength

Length in bytes of the response content

# Syntax
long ContentLength { get; set; }

# Property ContentEncoding

Encoding of the response content

# Syntax
string ContentEncoding { get; set; }

# Property Content

String representation of response content

# Syntax
string Content { get; }

# Property StatusCode

HTTP response status code

# Syntax
HttpStatusCode StatusCode { get; set; }

# Property StatusDescription

Description of HTTP status returned

# Syntax
string StatusDescription { get; set; }

# Property RawBytes

Response content

# Syntax
byte[] RawBytes { get; set; }

# Property ResponseUri

The URL that actually responded to the content (different from request if redirected)

# Syntax
Uri ResponseUri { get; set; }

# Property Server

HttpWebResponse.Server

# Syntax
string Server { get; set; }

# Property Headers

Headers returned by server with the response

# Syntax
IList<HttpHeader> Headers { get; }

# Property Cookies

Cookies returned by server with the response

# Syntax
IList<HttpCookie> Cookies { get; }

# Property ResponseStatus

Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead

# Syntax
ResponseStatus ResponseStatus { get; set; }

# Property ErrorMessage

Transport or other non-HTTP error generated while attempting request

# Syntax
string ErrorMessage { get; set; }

# Property ErrorException

Exception thrown when error is encountered.

# Syntax
Exception ErrorException { get; set; }

# Property ProtocolVersion

The HTTP protocol version (1.0, 1.1, etc)

# Remarks

Only set when underlying framework supports it.

# Syntax
Version ProtocolVersion { get; set; }

# Interface IRestClient

# Syntax

public interface IRestClient

# Extension methods

  • RestSharp.RestClientExtensions.ExecuteAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse>)
  • RestSharp.RestClientExtensions.ExecuteAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>>)
  • RestSharp.RestClientExtensions.GetAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PostAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PutAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.HeadAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.OptionsAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PatchAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.DeleteAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.GetAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PostAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PutAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.HeadAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.OptionsAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PatchAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.DeleteAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.GetTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.PostTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.PutTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.HeadTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.OptionsTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.PatchTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.DeleteTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.ExecuteDynamic(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.GetAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.PostAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.PutAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.HeadAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.OptionsAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.PatchAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.DeleteAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.Get<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Post<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Put<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Head<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Options<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Patch<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Delete<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Get(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Post(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Put(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Head(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Options(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Patch(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Delete(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient, RestSharp.Parameter)
  • RestSharp.RestClientExtensions.AddOrUpdateDefaultParameter(RestSharp.IRestClient, RestSharp.Parameter)
  • RestSharp.RestClientExtensions.RemoveDefaultParameter(RestSharp.IRestClient, string)
  • RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient, string, object)
  • RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient, string, object, RestSharp.ParameterType)
  • RestSharp.RestClientExtensions.AddDefaultHeader(RestSharp.IRestClient, string, string)
  • RestSharp.RestClientExtensions.AddDefaultHeaders(RestSharp.IRestClient, System.Collections.Generic.Dictionary<string, string>)
  • RestSharp.RestClientExtensions.AddDefaultUrlSegment(RestSharp.IRestClient, string, string)
  • RestSharp.RestClientExtensions.AddDefaultQueryParameter(RestSharp.IRestClient, string, string)
  • RestSharp.RestClientJsonRequest.Get<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Post<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Put<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Head<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Options<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Patch<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Delete<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.Serialization.Xml.DotNetXmlSerializerClientExtensions.UseDotNetXmlSerializer(RestSharp.IRestClient, string, System.Text.Encoding)

# Method UseSerializer(Func<IRestSerializer>)

The UseSerializer method.

# Syntax
IRestClient UseSerializer(Func<IRestSerializer> serializerFactory)
# Parameters
Name Type Description
serializerFactory System.Func<RestSharp.Serialization.IRestSerializer> The serializer factory
# Returns
Type Description
RestSharp.IRestClient

# Method UseSerializer<T>()

Replace the default serializer with a custom one

# Syntax
IRestClient UseSerializer<T>()
    where T : IRestSerializer, new()
# Generic parameters
Name Description
T The type that implements IRestSerializer
# Returns
Type Description
RestSharp.IRestClient

# Property CookieContainer

# Syntax
CookieContainer CookieContainer { get; set; }

# Property AutomaticDecompression

# Syntax
bool AutomaticDecompression { get; set; }

# Property MaxRedirects

# Syntax
int? MaxRedirects { get; set; }

# Property UserAgent

# Syntax
string UserAgent { get; set; }

# Property Timeout

# Syntax
int Timeout { get; set; }

# Property ReadWriteTimeout

# Syntax
int ReadWriteTimeout { get; set; }

# Property UseSynchronizationContext

# Syntax
bool UseSynchronizationContext { get; set; }

# Property Authenticator

# Syntax
IAuthenticator Authenticator { get; set; }

# Property BaseUrl

# Syntax
Uri BaseUrl { get; set; }

# Property Encoding

# Syntax
Encoding Encoding { get; set; }

# Property ThrowOnDeserializationError

# Syntax
bool ThrowOnDeserializationError { get; set; }

# Property FailOnDeserializationError

Modifies the default behavior of RestSharp to swallow exceptions. When set to 

true
, RestSharp will consider the request as unsuccessful in case it fails to deserialize the response.

# Syntax
bool FailOnDeserializationError { get; set; }

# Property ThrowOnAnyError

Modifies the default behavior of RestSharp to swallow exceptions. When set to 

true
, exceptions will be re-thrown.

# Syntax
bool ThrowOnAnyError { get; set; }

# Property ConnectionGroupName

# Syntax
string ConnectionGroupName { get; set; }

# Property PreAuthenticate

Flag to send authorisation header with the HttpWebRequest

# Syntax
bool PreAuthenticate { get; set; }

# Property UnsafeAuthenticatedConnectionSharing

Flag to reuse same connection in the HttpWebRequest

# Syntax
bool UnsafeAuthenticatedConnectionSharing { get; set; }

# Property DefaultParameters

A list of parameters that will be set for all requests made by the RestClient instance.

# Syntax
IList<Parameter> DefaultParameters { get; }

# Property BaseHost

Explicit Host header value to use in requests independent from the request URI. If null, default host value extracted from URI is used.

# Syntax
string BaseHost { get; set; }

# Property AllowMultipleDefaultParametersWithSameName

By default, RestSharp doesn't allow multiple parameters to have the same name. This properly allows to override the default behavior.

# Syntax
bool AllowMultipleDefaultParametersWithSameName { get; set; }

# Property ClientCertificates

X509CertificateCollection to be sent with request

# Syntax
X509CertificateCollection ClientCertificates { get; set; }

# Property Proxy

# Syntax
IWebProxy Proxy { get; set; }

# Property CachePolicy

# Syntax
RequestCachePolicy CachePolicy { get; set; }

# Property Pipelined

# Syntax
bool Pipelined { get; set; }

# Property FollowRedirects

# Syntax
bool FollowRedirects { get; set; }

# Property RemoteCertificateValidationCallback

Callback function for handling the validation of remote certificates. Useful for certificate pinning and overriding certificate errors in the scope of a request.

# Syntax
RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; }

# Method Deserialize<T>(IRestResponse)

# Syntax
IRestResponse<T> Deserialize<T>(IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method UseUrlEncoder(Func<String, String>)

Allows to use a custom way to encode URL parameters

# Examples
client.UseUrlEncoder(s => HttpUtility.UrlEncode(s));
# Syntax
IRestClient UseUrlEncoder(Func<string, string> encoder)
# Parameters
Name Type Description
encoder System.Func<string, string> A delegate to encode URL parameters
# Returns
Type Description
RestSharp.IRestClient

# Method UseQueryEncoder(Func<String, Encoding, String>)

Allows to use a custom way to encode query parameters

# Examples
client.UseUrlEncoder((s, encoding) => HttpUtility.UrlEncode(s, encoding));
# Syntax
IRestClient UseQueryEncoder(Func<string, Encoding, string> queryEncoder)
# Parameters
Name Type Description
queryEncoder System.Func<string, System.Text.Encoding, string> A delegate to encode query parameters
# Returns
Type Description
RestSharp.IRestClient

# Method Execute(IRestRequest)

Executes the given request and returns an untyped response.

# Syntax
IRestResponse Execute(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Pre-configured request instance.
# Returns
Type Description
RestSharp.IRestResponse Untyped response.

# Method Execute(IRestRequest, Method)

Executes the given request and returns an untyped response. Allows to specify the HTTP method (GET, POST, etc) so you won't need to set it on the request.

# Syntax
IRestResponse Execute(IRestRequest request, Method httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Pre-configured request instance.
httpMethod RestSharp.Method The HTTP method (GET, POST, etc) to be used when making the request.
# Returns
Type Description
RestSharp.IRestResponse Untyped response.

# Method Execute<T>(IRestRequest)

Executes the given request and returns a typed response. RestSharp will deserialize the response and it will be available in the 

Data
property of the response instance.

# Syntax
IRestResponse<T> Execute<T>(IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest Pre-configured request instance.
# Returns
Type Description
RestSharp.IRestResponse<T> Typed response.

# Method Execute<T>(IRestRequest, Method)

Executes the given request and returns a typed response. RestSharp will deserialize the response and it will be available in the 

Data
property of the response instance. Allows to specify the HTTP method (GET, POST, etc) so you won't need to set it on the request.

# Syntax
IRestResponse<T> Execute<T>(IRestRequest request, Method httpMethod)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest Pre-configured request instance.
httpMethod RestSharp.Method The HTTP method (GET, POST, etc) to be used when making the request.
# Returns
Type Description
RestSharp.IRestResponse<T> Typed response.

# Method DownloadData(IRestRequest)

A specialized method to download files.

# Syntax
byte[] DownloadData(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Pre-configured request instance.
# Returns
Type Description
byte[] The downloaded file.

# Method DownloadData(IRestRequest, Boolean)

Executes the specified request and downloads the response data

# Syntax
[Obsolete("Use ThrowOnAnyError property to instruct RestSharp to rethrow exceptions")]
byte[] DownloadData(IRestRequest request, bool throwOnError)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to execute
throwOnError bool Throw an exception if download fails.
# Returns
Type Description
byte[] Response data

# Method BuildUri(IRestRequest)

# Syntax
Uri BuildUri(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest
# Returns
Type Description
Uri

# Method BuildUriWithoutQueryParameters(IRestRequest)

# Syntax
string BuildUriWithoutQueryParameters(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest
# Returns
Type Description
string

# Method ConfigureWebRequest(Action<HttpWebRequest>)

Add a delegate to apply custom configuration to HttpWebRequest before making a call

# Syntax
void ConfigureWebRequest(Action<HttpWebRequest> configurator)
# Parameters
Name Type Description
configurator System.Action<HttpWebRequest> Configuration delegate for HttpWebRequest

# Method AddHandler(String, Func<IDeserializer>)

Adds or replaces a deserializer for the specified content type

# Syntax
void AddHandler(string contentType, Func<IDeserializer> deserializerFactory)
# Parameters
Name Type Description
contentType string Content type for which the deserializer will be replaced
deserializerFactory System.Func<RestSharp.Deserializers.IDeserializer> Custom deserializer factory

# Method RemoveHandler(String)

Removes custom deserialzier for the specified content type

# Syntax
void RemoveHandler(string contentType)
# Parameters
Name Type Description
contentType string Content type for which deserializer needs to be removed

# Method ClearHandlers()

Remove deserializers for all content types

# Syntax
void ClearHandlers()

# Method ExecuteAsGet(IRestRequest, String)

# Syntax
IRestResponse ExecuteAsGet(IRestRequest request, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse

# Method ExecuteAsPost(IRestRequest, String)

# Syntax
IRestResponse ExecuteAsPost(IRestRequest request, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse

# Method ExecuteAsGet<T>(IRestRequest, String)

# Syntax
IRestResponse<T> ExecuteAsGet<T>(IRestRequest request, string httpMethod)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method ExecuteAsPost<T>(IRestRequest, String)

# Syntax
IRestResponse<T> ExecuteAsPost<T>(IRestRequest request, string httpMethod)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method ExecuteAsync<T>(IRestRequest, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
Task<IRestResponse<T>> ExecuteAsync<T>(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteAsync<T>(IRestRequest, Method, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
Task<IRestResponse<T>> ExecuteAsync<T>(IRestRequest request, Method httpMethod, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
httpMethod RestSharp.Method Override the request method
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteAsync(IRestRequest, Method, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
Task<IRestResponse> ExecuteAsync(IRestRequest request, Method httpMethod, CancellationToken cancellationToken = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
httpMethod RestSharp.Method Override the request method
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteAsync(IRestRequest, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
Task<IRestResponse> ExecuteAsync(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteGetAsync<T>(IRestRequest, CancellationToken)

Executes a GET-style request asynchronously, authenticating if needed

# Syntax
Task<IRestResponse<T>> ExecuteGetAsync<T>(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecutePostAsync<T>(IRestRequest, CancellationToken)

Executes a POST-style request asynchronously, authenticating if needed

# Syntax
Task<IRestResponse<T>> ExecutePostAsync<T>(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteGetAsync(IRestRequest, CancellationToken)

Executes a GET-style asynchronously, authenticating if needed

# Syntax
Task<IRestResponse> ExecuteGetAsync(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecutePostAsync(IRestRequest, CancellationToken)

Executes a POST-style asynchronously, authenticating if needed

# Syntax
Task<IRestResponse> ExecutePostAsync(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method UseSerializer(IRestSerializer)

# Syntax
[Obsolete("Use the overload that accepts the delegate factory")]
IRestClient UseSerializer(IRestSerializer serializer)
# Parameters
Name Type Description
serializer RestSharp.Serialization.IRestSerializer
# Returns
Type Description
RestSharp.IRestClient

# Method ExecuteAsync(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsync(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsync<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsync<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsync(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>, Method)

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsync(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback, Method httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
httpMethod RestSharp.Method
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsync<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>, Method)

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsync<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback, Method httpMethod)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
httpMethod RestSharp.Method
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncGet(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>, String)

Executes a GET-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsyncGet(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion providing access to the async handle.
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncPost(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>, String)

Executes a POST-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsyncPost(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion providing access to the async handle.
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncGet<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>, String)

Executes a GET-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsyncGet<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback, string httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncPost<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>, String)

Executes a GET-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
RestRequestAsyncHandle ExecuteAsyncPost<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback, string httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteTaskAsync<T>(IRestRequest)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be renamed to ExecuteAsync soon")]
Task<IRestResponse<T>> ExecuteTaskAsync<T>(IRestRequest request)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteTaskAsync<T>(IRestRequest, CancellationToken)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("UseExecuteAsync instead")]
Task<IRestResponse<T>> ExecuteTaskAsync<T>(IRestRequest request, CancellationToken token)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteTaskAsync<T>(IRestRequest, Method)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
Task<IRestResponse<T>> ExecuteTaskAsync<T>(IRestRequest request, Method httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
httpMethod RestSharp.Method Override the request method
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteGetTaskAsync<T>(IRestRequest)

Executes a GET-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteGetAsync instead")]
Task<IRestResponse<T>> ExecuteGetTaskAsync<T>(IRestRequest request)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteGetTaskAsync<T>(IRestRequest, CancellationToken)

Executes a GET-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteGetAsync instead")]
Task<IRestResponse<T>> ExecuteGetTaskAsync<T>(IRestRequest request, CancellationToken token)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecutePostTaskAsync<T>(IRestRequest)

Executes a POST-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecutePostAsync instead")]
Task<IRestResponse<T>> ExecutePostTaskAsync<T>(IRestRequest request)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecutePostTaskAsync<T>(IRestRequest, CancellationToken)

Executes a POST-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecutePostAsync instead")]
Task<IRestResponse<T>> ExecutePostTaskAsync<T>(IRestRequest request, CancellationToken token)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteTaskAsync(IRestRequest, CancellationToken)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
Task<IRestResponse> ExecuteTaskAsync(IRestRequest request, CancellationToken token)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteTaskAsync(IRestRequest, CancellationToken, Method)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
Task<IRestResponse> ExecuteTaskAsync(IRestRequest request, CancellationToken token, Method httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
httpMethod RestSharp.Method Override the request method
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteTaskAsync(IRestRequest)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
Task<IRestResponse> ExecuteTaskAsync(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteGetTaskAsync(IRestRequest)

Executes a GET-style asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteGetAsync instead")]
Task<IRestResponse> ExecuteGetTaskAsync(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteGetTaskAsync(IRestRequest, CancellationToken)

Executes a GET-style asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteGetAsync instead")]
Task<IRestResponse> ExecuteGetTaskAsync(IRestRequest request, CancellationToken token)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecutePostTaskAsync(IRestRequest)

Executes a POST-style asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecutePostAsync instead")]
Task<IRestResponse> ExecutePostTaskAsync(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecutePostTaskAsync(IRestRequest, CancellationToken)

Executes a POST-style asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecutePostAsync instead")]
Task<IRestResponse> ExecutePostTaskAsync(IRestRequest request, CancellationToken token)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method AddHandler(String, IDeserializer)

Adds or replaces a deserializer for the specified content type

# Syntax
[Obsolete("Use the overload that accepts a factory delegate")]
void AddHandler(string contentType, IDeserializer deserializer)
# Parameters
Name Type Description
contentType string Content type for which the deserializer will be replaced
deserializer RestSharp.Deserializers.IDeserializer Custom deserializer

# Interface IRestRequest

# Syntax

public interface IRestRequest

# Property AlwaysMultipartFormData

Always send a multipart/form-data request - even when no Files are present.

# Syntax
bool AlwaysMultipartFormData { get; set; }

# Property JsonSerializer

Serializer to use when writing JSON request bodies. Used if RequestFormat is Json. By default the included JsonSerializer is used (currently using SimpleJson default serialization).

# Syntax
ISerializer JsonSerializer { get; set; }

# Property XmlSerializer

Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. By default the included XmlSerializer is used.

# Syntax
IXmlSerializer XmlSerializer { get; set; }

# Property AdvancedResponseWriter

Set this to handle the response stream yourself, based on the response details

# Syntax
Action<Stream, IHttpResponse> AdvancedResponseWriter { get; set; }

# Property ResponseWriter

Set this to write response to Stream rather than reading into memory.

# Syntax
Action<Stream> ResponseWriter { get; set; }

# Property Parameters

Container of all HTTP parameters to be passed with the request. See AddParameter() for explanation of the types of parameters that can be passed

# Syntax
List<Parameter> Parameters { get; }

# Property Files

Container of all the files to be uploaded with the request.

# Syntax
List<FileParameter> Files { get; }

# Property Method

Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS Default is GET

# Syntax
Method Method { get; set; }

# Property Resource

The Resource URL to make the request against. Tokens are substituted with UrlSegment parameters and match by name. Should not include the scheme or domain. Do not include leading slash. Combined with RestClient.BaseUrl to assemble final URL: {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com)

# Examples

// example for url token replacement
request.Resource = &quot;Products/{ProductId}&quot;;
request.AddParameter(&quot;ProductId&quot;, 123, ParameterType.UrlSegment);
# Syntax
string Resource { get; set; }

# Property RequestFormat

Serializer to use when writing request bodies.

# Syntax
[Obsolete("Use AddJsonBody or AddXmlBody to tell RestSharp how to serialize the request body")]
DataFormat RequestFormat { get; set; }

# Property RootElement

Used by the default deserializers to determine where to start deserializing from. Can be used to skip container or root elements that do not have corresponding deserialzation targets.

# Syntax
string RootElement { get; set; }

# Property DateFormat

Used by the default deserializers to explicitly set which date format string to use when parsing dates.

# Syntax
string DateFormat { get; set; }

# Property XmlNamespace

Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names.

# Syntax
string XmlNamespace { get; set; }

# Property Credentials

In general you would not need to set this directly. Used by the NtlmAuthenticator.

# Syntax
[Obsolete("Use one of authenticators provided")]
ICredentials Credentials { get; set; }

# Property Timeout

Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient.

# Syntax
int Timeout { get; set; }

# Property ReadWriteTimeout

The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient.

# Syntax
int ReadWriteTimeout { get; set; }

# Property Attempts

How many attempts were made to send this Request?

# Remarks

This number is incremented each time the RestClient sends the request.

# Syntax
int Attempts { get; }

# Property UseDefaultCredentials

Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) will be sent along to the server. The default is false.

# Syntax
bool UseDefaultCredentials { get; set; }

# Property AllowedDecompressionMethods

List of allowed decompression methods

# Syntax
IList<DecompressionMethods> AllowedDecompressionMethods { get; }

# Property OnBeforeDeserialization

When supplied, the function will be called before calling the deserializer

# Syntax
Action<IRestResponse> OnBeforeDeserialization { get; set; }

# Property OnBeforeRequest

When supplied, the function will be called before making a request

# Syntax
Action<IHttp> OnBeforeRequest { get; set; }

# Property Body

Serialized request body to be accessed in authenticators

# Syntax
RequestBody Body { get; set; }

# Method AddFile(String, String, String)

Adds a file to the Files collection to be included with a POST or PUT request (other methods do not support file uploads).

# Syntax
IRestRequest AddFile(string name, string path, string contentType = null)
# Parameters
Name Type Description
name string The parameter name to use in the request
path string Full path to file to upload
contentType string The MIME type of the file to upload
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddFile(String, Byte[], String, String)

Adds the bytes to the Files collection with the specified file name and content type

# Syntax
IRestRequest AddFile(string name, byte[] bytes, string fileName, string contentType = null)
# Parameters
Name Type Description
name string The parameter name to use in the request
bytes byte[] The file data
fileName string The file name to use for the uploaded file
contentType string The MIME type of the file to upload
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddFile(String, Action<Stream>, String, Int64, String)

Adds the bytes to the Files collection with the specified file name and content type

# Syntax
IRestRequest AddFile(string name, Action<Stream> writer, string fileName, long contentLength, string contentType = null)
# Parameters
Name Type Description
name string The parameter name to use in the request
writer System.Action<System.IO.Stream> A function that writes directly to the stream. Should NOT close the stream.
fileName string The file name to use for the uploaded file
contentLength long The length (in bytes) of the file content.
contentType string The MIME type of the file to upload
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddFileBytes(String, Byte[], String, String)

Add bytes to the Files collection as if it was a file of specific type

# Syntax
IRestRequest AddFileBytes(string name, byte[] bytes, string filename, string contentType = "application/x-gzip")
# Parameters
Name Type Description
name string A form parameter name
bytes byte[] The file data
filename string The file name to use for the uploaded file
contentType string Specific content type. Es: application/x-gzip
# Returns
Type Description
RestSharp.IRestRequest

# Method AddBody(Object, String)

Serializes obj to format specified by RequestFormat, but passes XmlNamespace if using the default XmlSerializer The default format is XML. Change RequestFormat if you wish to use a different serialization format.

# Syntax
[Obsolete("Use AddJsonBody or AddXmlBody instead")]
IRestRequest AddBody(object obj, string xmlNamespace)
# Parameters
Name Type Description
obj object The object to serialize
xmlNamespace string The XML namespace to use when serializing
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddBody(Object)

Serializes obj to data format specified by RequestFormat and adds it to the request body. The default format is XML. Change RequestFormat if you wish to use a different serialization format.

# Syntax
[Obsolete("Use AddJsonBody or AddXmlBody instead")]
IRestRequest AddBody(object obj)
# Parameters
Name Type Description
obj object The object to serialize
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddJsonBody(Object)

Instructs RestSharp to send a given object in the request body, serialized as JSON.

# Syntax
IRestRequest AddJsonBody(object obj)
# Parameters
Name Type Description
obj object The object to serialize
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddJsonBody(Object, String)

Instructs RestSharp to send a given object in the request body, serialized as JSON. Allows specifying a custom content type. Usually, this method is used to support PATCH requests that require application/json-patch+json content type.

# Syntax
IRestRequest AddJsonBody(object obj, string contentType)
# Parameters
Name Type Description
obj object The object to serialize
contentType string Custom content type to override the default application/json
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddXmlBody(Object)

Instructs RestSharp to send a given object in the request body, serialized as XML.

# Syntax
IRestRequest AddXmlBody(object obj)
# Parameters
Name Type Description
obj object The object to serialize
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddXmlBody(Object, String)

Instructs RestSharp to send a given object in the request body, serialized as XML but passes XmlNamespace if using the default XmlSerializer.

# Syntax
IRestRequest AddXmlBody(object obj, string xmlNamespace)
# Parameters
Name Type Description
obj object The object to serialize
xmlNamespace string The XML namespace to use when serializing
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddObject(Object, String[])

Calls AddParameter() for all public, readable properties specified in the includedProperties list

# Examples

request.AddObject(product, &quot;ProductId&quot;, &quot;Price&quot;, ...);
# Syntax
IRestRequest AddObject(object obj, params string[] includedProperties)
# Parameters
Name Type Description
obj object The object with properties to add as parameters
includedProperties string[] The names of the properties to include
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddObject(Object)

Calls AddParameter() for all public, readable properties of obj

# Syntax
IRestRequest AddObject(object obj)
# Parameters
Name Type Description
obj object The object with properties to add as parameters
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddParameter(Parameter)

Add the parameter to the request

# Syntax
IRestRequest AddParameter(Parameter p)
# Parameters
Name Type Description
p RestSharp.Parameter Parameter to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddParameter(String, Object)

Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)

# Syntax
IRestRequest AddParameter(string name, object value)
# Parameters
Name Type Description
name string Name of the parameter
value object Value of the parameter
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddParameter(String, Object, ParameterType)

Adds a parameter to the request. There are five types of parameters:

  • GetOrPost: Either a QueryString value or encoded form value based on method
  • HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  • UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  • Cookie: Adds the name/value pair to the HTTP request's Cookies collection
  • RequestBody: Used by AddBody() (not recommended to use directly)
# Syntax
IRestRequest AddParameter(string name, object value, ParameterType type)
# Parameters
Name Type Description
name string Name of the parameter
value object Value of the parameter
type RestSharp.ParameterType The type of parameter to add
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddParameter(String, Object, String, ParameterType)

Adds a parameter to the request. There are five types of parameters:

  • GetOrPost: Either a QueryString value or encoded form value based on method
  • HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  • UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  • Cookie: Adds the name/value pair to the HTTP request's Cookies collection
  • RequestBody: Used by AddBody() (not recommended to use directly)
# Syntax
IRestRequest AddParameter(string name, object value, string contentType, ParameterType type)
# Parameters
Name Type Description
name string Name of the parameter
value object Value of the parameter
contentType string Content-Type of the parameter
type RestSharp.ParameterType The type of parameter to add
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddOrUpdateParameter(Parameter)

Adds a parameter to the request or updates it with the given argument, if the parameter already exists in the request.

# Syntax
IRestRequest AddOrUpdateParameter(Parameter parameter)
# Parameters
Name Type Description
parameter RestSharp.Parameter Parameter to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddOrUpdateParameters(IEnumerable<Parameter>)

Add or update parameters to the request

# Syntax
IRestRequest AddOrUpdateParameters(IEnumerable<Parameter> parameters)
# Parameters
Name Type Description
parameters System.Collections.Generic.IEnumerable<RestSharp.Parameter> Collection of parameters to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddOrUpdateParameter(String, Object)

Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)

# Syntax
IRestRequest AddOrUpdateParameter(string name, object value)
# Parameters
Name Type Description
name string Name of the parameter
value object Value of the parameter
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddOrUpdateParameter(String, Object, ParameterType)

Adds a parameter to the request. There are five types of parameters:

  • GetOrPost: Either a QueryString value or encoded form value based on method
  • HttpHeader: Adds the name/value pair to the HTTP request Headers collection
  • UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  • Cookie: Adds the name/value pair to the HTTP request Cookies collection
  • RequestBody: Used by AddBody() (not recommended to use directly)
# Syntax
IRestRequest AddOrUpdateParameter(string name, object value, ParameterType type)
# Parameters
Name Type Description
name string Name of the parameter
value object Value of the parameter
type RestSharp.ParameterType The type of parameter to add
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddOrUpdateParameter(String, Object, String, ParameterType)

Adds a parameter to the request. There are five types of parameters:

  • GetOrPost: Either a QueryString value or encoded form value based on method
  • HttpHeader: Adds the name/value pair to the HTTP request Headers collection
  • UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  • Cookie: Adds the name/value pair to the HTTP request Cookies collection
  • RequestBody: Used by AddBody() (not recommended to use directly)
# Syntax
IRestRequest AddOrUpdateParameter(string name, object value, string contentType, ParameterType type)
# Parameters
Name Type Description
name string Name of the parameter
value object Value of the parameter
contentType string Content-Type of the parameter
type RestSharp.ParameterType The type of parameter to add
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddHeader(String, String)

Shortcut to AddParameter(name, value, HttpHeader) overload

# Syntax
IRestRequest AddHeader(string name, string value)
# Parameters
Name Type Description
name string Name of the header to add
value string Value of the header to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddHeaders(ICollection<KeyValuePair<String, String>>)

Uses AddHeader(name, value) in a convenient way to pass in multiple headers at once.

# Syntax
IRestRequest AddHeaders(ICollection<KeyValuePair<string, string>> headers)
# Parameters
Name Type Description
headers System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string, string>> Key/Value pairs containing the name: value of the headers
# Returns
Type Description
RestSharp.IRestRequest This request

# Method AddCookie(String, String)

Shortcut to AddParameter(name, value, Cookie) overload

# Syntax
IRestRequest AddCookie(string name, string value)
# Parameters
Name Type Description
name string Name of the cookie to add
value string Value of the cookie to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddUrlSegment(String, String)

Shortcut to AddParameter(name, value, UrlSegment) overload

# Syntax
IRestRequest AddUrlSegment(string name, string value)
# Parameters
Name Type Description
name string Name of the segment to add
value string Value of the segment to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddUrlSegment(String, Object)

Shortcut to AddParameter(name, value, UrlSegment) overload

# Syntax
IRestRequest AddUrlSegment(string name, object value)
# Parameters
Name Type Description
name string Name of the segment to add
value object Value of the segment to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddQueryParameter(String, String)

Shortcut to AddParameter(name, value, QueryString) overload

# Syntax
IRestRequest AddQueryParameter(string name, string value)
# Parameters
Name Type Description
name string Name of the parameter to add
value string Value of the parameter to add
# Returns
Type Description
RestSharp.IRestRequest

# Method AddQueryParameter(String, String, Boolean)

Shortcut to AddParameter(name, value, QueryString) overload

# Syntax
IRestRequest AddQueryParameter(string name, string value, bool encode)
# Parameters
Name Type Description
name string Name of the parameter to add
value string Value of the parameter to add
encode bool Whether parameter should be encoded or not
# Returns
Type Description
RestSharp.IRestRequest

# Method AddDecompressionMethod(DecompressionMethods)

# Syntax
IRestRequest AddDecompressionMethod(DecompressionMethods decompressionMethod)
# Parameters
Name Type Description
decompressionMethod DecompressionMethods
# Returns
Type Description
RestSharp.IRestRequest

# Method IncreaseNumAttempts()

# Syntax
void IncreaseNumAttempts()

# Interface IRestResponse

Container for data sent back from API

# Syntax

public interface IRestResponse

# Extension methods

  • RestSharp.Extensions.ResponseExtensions.ToAsyncResponse<T>(RestSharp.IRestResponse)

# Property Request

The RestRequest that was made to get this RestResponse

# Remarks

Mainly for debugging if ResponseStatus is not OK

# Syntax
IRestRequest Request { get; set; }

# Property ContentType

MIME content type of response

# Syntax
string ContentType { get; set; }

# Property ContentLength

Length in bytes of the response content

# Syntax
long ContentLength { get; set; }

# Property ContentEncoding

Encoding of the response content

# Syntax
string ContentEncoding { get; set; }

# Property Content

String representation of response content

# Syntax
string Content { get; set; }

# Property StatusCode

HTTP response status code

# Syntax
HttpStatusCode StatusCode { get; set; }

# Property IsSuccessful

Whether or not the response status code indicates success

# Syntax
bool IsSuccessful { get; }

# Property StatusDescription

Description of HTTP status returned

# Syntax
string StatusDescription { get; set; }

# Property RawBytes

Response content

# Syntax
byte[] RawBytes { get; set; }

# Property ResponseUri

The URL that actually responded to the content (different from request if redirected)

# Syntax
Uri ResponseUri { get; set; }

# Property Server

HttpWebResponse.Server

# Syntax
string Server { get; set; }

# Property Cookies

Cookies returned by server with the response

# Syntax
IList<RestResponseCookie> Cookies { get; }

# Property Headers

Headers returned by server with the response

# Syntax
IList<Parameter> Headers { get; }

# Property ResponseStatus

Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead

# Syntax
ResponseStatus ResponseStatus { get; set; }

# Property ErrorMessage

Transport or other non-HTTP error generated while attempting request

# Syntax
string ErrorMessage { get; set; }

# Property ErrorException

Exceptions thrown during the request, if any.

# Remarks

Will contain only network transport or framework exceptions thrown during the request. HTTP protocol errors are handled by RestSharp and will not appear here.

# Syntax
Exception ErrorException { get; set; }

# Property ProtocolVersion

The HTTP protocol version (1.0, 1.1, etc)

# Remarks

Only set when underlying framework supports it.

# Syntax
Version ProtocolVersion { get; set; }

# Interface IRestResponse<T>

Container for data sent back from API including deserialized data

# Syntax

public interface IRestResponse<T> : IRestResponse

# Generic parameters

Name Description
T Type of data to deserialize to

# Extension methods

  • RestSharp.Extensions.ResponseExtensions.ToAsyncResponse<T>(RestSharp.IRestResponse)

# Property Data

Deserialized entity data

# Syntax
T Data { get; set; }

# Class JsonRequest<TRequest, TResponse>

# Inheritance

↳ object
  ↳ RestSharp.RestRequest

# Syntax

public class JsonRequest<TRequest, TResponse> : RestRequest, IRestRequest

# Generic parameters

Name Description
TRequest
TResponse

# Constructor JsonRequest(String, TRequest)

# Syntax
public JsonRequest(string resource, TRequest request)
# Parameters
Name Type Description
resource string
request TRequest

# Method ResponseForStatusCode(HttpStatusCode, TResponse)

# Syntax
public JsonRequest<TRequest, TResponse> ResponseForStatusCode(HttpStatusCode statusCode, TResponse response)
# Parameters
Name Type Description
statusCode HttpStatusCode
response TResponse
# Returns
Type Description
RestSharp.JsonRequest<TRequest, TResponse>

# Method ResponseForStatusCode(HttpStatusCode, Func<TResponse>)

# Syntax
public JsonRequest<TRequest, TResponse> ResponseForStatusCode(HttpStatusCode statusCode, Func<TResponse> getResponse)
# Parameters
Name Type Description
statusCode HttpStatusCode
getResponse System.Func<TResponse>
# Returns
Type Description
RestSharp.JsonRequest<TRequest, TResponse>

# Method ChangeResponse(Action<IRestResponse<TResponse>>)

# Syntax
public JsonRequest<TRequest, TResponse> ChangeResponse(Action<IRestResponse<TResponse>> change)
# Parameters
Name Type Description
change System.Action<RestSharp.IRestResponse<TResponse>>
# Returns
Type Description
RestSharp.JsonRequest<TRequest, TResponse>

# Class RestClient

Client to translate RestRequests into Http requests and process response result

# Inheritance

↳ object

# Syntax

public class RestClient : IRestClient

# Extension methods

  • RestSharp.RestClientExtensions.ExecuteAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse>)
  • RestSharp.RestClientExtensions.ExecuteAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>>)
  • RestSharp.RestClientExtensions.GetAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PostAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PutAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.HeadAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.OptionsAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PatchAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.DeleteAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.GetAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PostAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PutAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.HeadAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.OptionsAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.PatchAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.DeleteAsync(RestSharp.IRestClient, RestSharp.IRestRequest, System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>)
  • RestSharp.RestClientExtensions.GetTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.PostTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.PutTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.HeadTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.OptionsTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.PatchTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.DeleteTaskAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.ExecuteDynamic(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.GetAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.PostAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.PutAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.HeadAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.OptionsAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.PatchAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.DeleteAsync<T>(RestSharp.IRestClient, RestSharp.IRestRequest, System.Threading.CancellationToken)
  • RestSharp.RestClientExtensions.Get<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Post<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Put<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Head<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Options<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Patch<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Delete<T>(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Get(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Post(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Put(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Head(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Options(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Patch(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.Delete(RestSharp.IRestClient, RestSharp.IRestRequest)
  • RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient, RestSharp.Parameter)
  • RestSharp.RestClientExtensions.AddOrUpdateDefaultParameter(RestSharp.IRestClient, RestSharp.Parameter)
  • RestSharp.RestClientExtensions.RemoveDefaultParameter(RestSharp.IRestClient, string)
  • RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient, string, object)
  • RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient, string, object, RestSharp.ParameterType)
  • RestSharp.RestClientExtensions.AddDefaultHeader(RestSharp.IRestClient, string, string)
  • RestSharp.RestClientExtensions.AddDefaultHeaders(RestSharp.IRestClient, System.Collections.Generic.Dictionary<string, string>)
  • RestSharp.RestClientExtensions.AddDefaultUrlSegment(RestSharp.IRestClient, string, string)
  • RestSharp.RestClientExtensions.AddDefaultQueryParameter(RestSharp.IRestClient, string, string)
  • RestSharp.RestClientExtensions.UseJson(RestSharp.RestClient)
  • RestSharp.RestClientExtensions.UseXml(RestSharp.RestClient)
  • RestSharp.RestClientJsonRequest.Get<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Post<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Put<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Head<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Options<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Patch<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.RestClientJsonRequest.Delete<TRequest, TResponse>(RestSharp.IRestClient, RestSharp.JsonRequest<TRequest, TResponse>)
  • RestSharp.Serialization.Xml.DotNetXmlSerializerClientExtensions.UseDotNetXmlSerializer(RestSharp.IRestClient, string, System.Text.Encoding)

# Method ExecuteTaskAsync(IRestRequest, CancellationToken, Method)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
public virtual Task<IRestResponse> ExecuteTaskAsync(IRestRequest request, CancellationToken token, Method httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
httpMethod RestSharp.Method Override the request method
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteAsync(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>, Method)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsync(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback, Method httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion providing access to the async handle.
httpMethod RestSharp.Method HTTP call method (GET, PUT, etc)
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsync(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsync(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion providing access to the async handle.
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncGet(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>, String)

Executes a GET-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsyncGet(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion providing access to the async handle.
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncPost(IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>, String)

Executes a POST-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsyncPost(IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion providing access to the async handle.
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsync<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>, Method)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsync<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback, Method httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion
httpMethod RestSharp.Method Override the request http method
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsync<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsync<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncGet<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>, String)

Executes a GET-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsyncGet<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback, string httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsyncPost<T>(IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>, String)

Executes a POST-style request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be removed soon in favour of the proper async call")]
public virtual RestRequestAsyncHandle ExecuteAsyncPost<T>(IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback, string httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle> Callback function to be executed upon completion
httpMethod string The HTTP method to execute
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteGetTaskAsync<T>(IRestRequest)

Executes a GET-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be renamed to ExecuteGetAsync soon")]
public virtual Task<IRestResponse<T>> ExecuteGetTaskAsync<T>(IRestRequest request)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteTaskAsync(IRestRequest, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
public virtual Task<IRestResponse> ExecuteTaskAsync(IRestRequest request, CancellationToken token)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteTaskAsync<T>(IRestRequest, CancellationToken, Method)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
public virtual Task<IRestResponse<T>> ExecuteTaskAsync<T>(IRestRequest request, CancellationToken token, Method httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
httpMethod RestSharp.Method Override the request method
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteGetTaskAsync<T>(IRestRequest, CancellationToken)

Executes a GET-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteGetAsync instead")]
public virtual Task<IRestResponse<T>> ExecuteGetTaskAsync<T>(IRestRequest request, CancellationToken token)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecutePostTaskAsync<T>(IRestRequest, CancellationToken)

Executes a POST-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecutePostAsync instead")]
public virtual Task<IRestResponse<T>> ExecutePostTaskAsync<T>(IRestRequest request, CancellationToken token)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecutePostTaskAsync<T>(IRestRequest)

Executes a POST-style request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecutePostAsync instead")]
public virtual Task<IRestResponse<T>> ExecutePostTaskAsync<T>(IRestRequest request)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteTaskAsync<T>(IRestRequest, Method)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Please use ExecuteAsync instead")]
public virtual Task<IRestResponse<T>> ExecuteTaskAsync<T>(IRestRequest request, Method httpMethod)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
httpMethod RestSharp.Method Override the request method
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteTaskAsync<T>(IRestRequest)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Please use ExecuteAsync instead")]
public virtual Task<IRestResponse<T>> ExecuteTaskAsync<T>(IRestRequest request)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteTaskAsync<T>(IRestRequest, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Please use ExecuteAsync instead")]
public virtual Task<IRestResponse<T>> ExecuteTaskAsync<T>(IRestRequest request, CancellationToken token)
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecutePostTaskAsync(IRestRequest, CancellationToken)

Executes a POST-style asynchronously, authenticating if needed

# Syntax
[Obsolete("This method will be renamed to ExecutePostAsync soon")]
public virtual Task<IRestResponse> ExecutePostTaskAsync(IRestRequest request, CancellationToken token)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecutePostTaskAsync(IRestRequest)

Executes a POST-style asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecutePostAsync instead")]
public virtual Task<IRestResponse> ExecutePostTaskAsync(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteTaskAsync(IRestRequest)

Executes the request asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync instead")]
public virtual Task<IRestResponse> ExecuteTaskAsync(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteGetTaskAsync(IRestRequest)

Executes a GET-style asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteGetAsync instead")]
public virtual Task<IRestResponse> ExecuteGetTaskAsync(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteGetTaskAsync(IRestRequest, CancellationToken)

Executes a GET-style asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteGetAsync instead")]
public virtual Task<IRestResponse> ExecuteGetTaskAsync(IRestRequest request, CancellationToken token)
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
token System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteGetAsync<T>(IRestRequest, CancellationToken)

Executes a GET-style request asynchronously, authenticating if needed

# Syntax
public Task<IRestResponse<T>> ExecuteGetAsync<T>(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecutePostAsync<T>(IRestRequest, CancellationToken)

Executes a POST-style request asynchronously, authenticating if needed

# Syntax
public Task<IRestResponse<T>> ExecutePostAsync<T>(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken The cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteGetAsync(IRestRequest, CancellationToken)

Executes a GET-style asynchronously, authenticating if needed

# Syntax
public Task<IRestResponse> ExecuteGetAsync(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecutePostAsync(IRestRequest, CancellationToken)

Executes a POST-style asynchronously, authenticating if needed

# Syntax
public Task<IRestResponse> ExecutePostAsync(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteAsync<T>(IRestRequest, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
public Task<IRestResponse<T>> ExecuteAsync<T>(IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteAsync(IRestRequest, Method, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
public Task<IRestResponse> ExecuteAsync(IRestRequest request, Method httpMethod, CancellationToken cancellationToken = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
httpMethod RestSharp.Method Override the request method
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Method ExecuteAsync<T>(IRestRequest, Method, CancellationToken)

Executes the request asynchronously, authenticating if needed

# Syntax
public Task<IRestResponse<T>> ExecuteAsync<T>(IRestRequest request, Method httpMethod, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
request RestSharp.IRestRequest Request to be executed
httpMethod RestSharp.Method Override the request method
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse<T>>

# Method ExecuteAsync(IRestRequest, CancellationToken)

# Syntax
public Task<IRestResponse> ExecuteAsync(IRestRequest request, CancellationToken token = default(CancellationToken))
# Parameters
Name Type Description
request RestSharp.IRestRequest
token System.Threading.CancellationToken
# Returns
Type Description
System.Threading.Tasks.Task<RestSharp.IRestResponse>

# Constructor RestClient()

Default constructor that registers default content handlers

# Syntax
public RestClient()

# Constructor RestClient(Uri)

Sets the BaseUrl property for requests made by this client instance

# Syntax
public RestClient(Uri baseUrl)
# Parameters
Name Type Description
baseUrl Uri

# Constructor RestClient(String)

Sets the BaseUrl property for requests made by this client instance

# Syntax
public RestClient(string baseUrl)
# Parameters
Name Type Description
baseUrl string

# Method UseSerializer(IRestSerializer)

# Syntax
[Obsolete("Use the overload that accepts the delegate factory")]
public IRestClient UseSerializer(IRestSerializer serializer)
# Parameters
Name Type Description
serializer RestSharp.Serialization.IRestSerializer
# Returns
Type Description
RestSharp.IRestClient

# Method UseUrlEncoder(Func<String, String>)

# Syntax
public IRestClient UseUrlEncoder(Func<string, string> encoder)
# Parameters
Name Type Description
encoder System.Func<string, string>
# Returns
Type Description
RestSharp.IRestClient

# Method UseQueryEncoder(Func<String, Encoding, String>)

# Syntax
public IRestClient UseQueryEncoder(Func<string, Encoding, string> queryEncoder)
# Parameters
Name Type Description
queryEncoder System.Func<string, System.Text.Encoding, string>
# Returns
Type Description
RestSharp.IRestClient

# Property AutomaticDecompression

# Syntax
public bool AutomaticDecompression { get; set; }

# Property MaxRedirects

# Syntax
public int? MaxRedirects { get; set; }

# Property ClientCertificates

# Syntax
public X509CertificateCollection ClientCertificates { get; set; }

# Property Proxy

# Syntax
public IWebProxy Proxy { get; set; }

# Property CachePolicy

# Syntax
public RequestCachePolicy CachePolicy { get; set; }

# Property Pipelined

# Syntax
public bool Pipelined { get; set; }

# Property FollowRedirects

# Syntax
public bool FollowRedirects { get; set; }

# Property CookieContainer

# Syntax
public CookieContainer CookieContainer { get; set; }

# Property UserAgent

# Syntax
public string UserAgent { get; set; }

# Property Timeout

# Syntax
public int Timeout { get; set; }

# Property ReadWriteTimeout

# Syntax
public int ReadWriteTimeout { get; set; }

# Property UseSynchronizationContext

# Syntax
public bool UseSynchronizationContext { get; set; }

# Property Authenticator

# Syntax
public IAuthenticator Authenticator { get; set; }

# Property BaseUrl

# Syntax
public virtual Uri BaseUrl { get; set; }

# Property Encoding

# Syntax
public Encoding Encoding { get; set; }

# Property PreAuthenticate

# Syntax
public bool PreAuthenticate { get; set; }

# Property ThrowOnDeserializationError

# Syntax
public bool ThrowOnDeserializationError { get; set; }

# Property FailOnDeserializationError

# Syntax
public bool FailOnDeserializationError { get; set; }

# Property ThrowOnAnyError

# Syntax
public bool ThrowOnAnyError { get; set; }

# Property UnsafeAuthenticatedConnectionSharing

# Syntax
public bool UnsafeAuthenticatedConnectionSharing { get; set; }

# Property ConnectionGroupName

# Syntax
public string ConnectionGroupName { get; set; }

# Property RemoteCertificateValidationCallback

# Syntax
public RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; }

# Property DefaultParameters

# Syntax
public IList<Parameter> DefaultParameters { get; }

# Property BaseHost

# Syntax
public string BaseHost { get; set; }

# Property AllowMultipleDefaultParametersWithSameName

# Syntax
public bool AllowMultipleDefaultParametersWithSameName { get; set; }

# Method AddHandler(String, Func<IDeserializer>)

# Syntax
public void AddHandler(string contentType, Func<IDeserializer> deserializerFactory)
# Parameters
Name Type Description
contentType string
deserializerFactory System.Func<RestSharp.Deserializers.IDeserializer>

# Method AddHandler(String, IDeserializer)

# Syntax
[Obsolete("Use the overload that accepts a factory delegate")]
public void AddHandler(string contentType, IDeserializer deserializer)
# Parameters
Name Type Description
contentType string
deserializer RestSharp.Deserializers.IDeserializer

# Method RemoveHandler(String)

# Syntax
public void RemoveHandler(string contentType)
# Parameters
Name Type Description
contentType string

# Method ClearHandlers()

# Syntax
public void ClearHandlers()

# Method Deserialize<T>(IRestResponse)

# Syntax
public IRestResponse<T> Deserialize<T>(IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method ConfigureWebRequest(Action<HttpWebRequest>)

# Syntax
public void ConfigureWebRequest(Action<HttpWebRequest> configurator)
# Parameters
Name Type Description
configurator System.Action<HttpWebRequest>

# Method BuildUri(IRestRequest)

# Syntax
public Uri BuildUri(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest
# Returns
Type Description
Uri

# Method IRestClient.BuildUriWithoutQueryParameters(IRestRequest)

# Syntax
string IRestClient.BuildUriWithoutQueryParameters(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest
# Returns
Type Description
string

# Method UseSerializer(Func<IRestSerializer>)

# Syntax
public IRestClient UseSerializer(Func<IRestSerializer> serializerFactory)
# Parameters
Name Type Description
serializerFactory System.Func<RestSharp.Serialization.IRestSerializer>
# Returns
Type Description
RestSharp.IRestClient

# Method UseSerializer<T>()

# Syntax
public IRestClient UseSerializer<T>()
    where T : IRestSerializer, new()
# Generic parameters
Name Description
T
# Returns
Type Description
RestSharp.IRestClient

# Method DownloadData(IRestRequest)

# Syntax
public byte[] DownloadData(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest
# Returns
Type Description
byte[]

# Method DownloadData(IRestRequest, Boolean)

# Syntax
public byte[] DownloadData(IRestRequest request, bool throwOnError)
# Parameters
Name Type Description
request RestSharp.IRestRequest
throwOnError bool
# Returns
Type Description
byte[]

# Method Execute(IRestRequest, Method)

# Syntax
public virtual IRestResponse Execute(IRestRequest request, Method httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod RestSharp.Method
# Returns
Type Description
RestSharp.IRestResponse

# Method Execute(IRestRequest)

# Syntax
public virtual IRestResponse Execute(IRestRequest request)
# Parameters
Name Type Description
request RestSharp.IRestRequest
# Returns
Type Description
RestSharp.IRestResponse

# Method ExecuteAsGet(IRestRequest, String)

# Syntax
public IRestResponse ExecuteAsGet(IRestRequest request, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse

# Method ExecuteAsPost(IRestRequest, String)

# Syntax
public IRestResponse ExecuteAsPost(IRestRequest request, string httpMethod)
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse

# Method Execute<T>(IRestRequest, Method)

# Syntax
public virtual IRestResponse<T> Execute<T>(IRestRequest request, Method httpMethod)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod RestSharp.Method
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Execute<T>(IRestRequest)

# Syntax
public virtual IRestResponse<T> Execute<T>(IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method ExecuteAsGet<T>(IRestRequest, String)

# Syntax
public IRestResponse<T> ExecuteAsGet<T>(IRestRequest request, string httpMethod)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method ExecuteAsPost<T>(IRestRequest, String)

# Syntax
public IRestResponse<T> ExecuteAsPost<T>(IRestRequest request, string httpMethod)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
request RestSharp.IRestRequest
httpMethod string
# Returns
Type Description
RestSharp.IRestResponse<T>

# Class RestClientExtensions

# Inheritance

↳ object

# Syntax

public static class RestClientExtensions

# Method ExecuteAsync(IRestClient, IRestRequest, Action<IRestResponse>)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync that returns Task")]
public static RestRequestAsyncHandle ExecuteAsync(this IRestClient client, IRestRequest request, Action<IRestResponse> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient The IRestClient this method extends
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse> Callback function to be executed upon completion
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method ExecuteAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>>)

Executes the request and callback asynchronously, authenticating if needed

# Syntax
[Obsolete("Use ExecuteAsync that returns Task")]
public static RestRequestAsyncHandle ExecuteAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>> callback)
    where T : new()
# Generic parameters
Name Description
T Target deserialization type
# Parameters
Name Type Description
client RestSharp.IRestClient The IRestClient this method extends
request RestSharp.IRestRequest Request to be executed
callback System.Action<RestSharp.IRestResponse<T>> Callback function to be executed upon completion providing access to the async handle
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method GetAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use GetAsync that returns Task")]
public static RestRequestAsyncHandle GetAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
    where T : new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method PostAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use PostAsync that returns Task")]
public static RestRequestAsyncHandle PostAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
    where T : new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method PutAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use PutAsync that returns Task")]
public static RestRequestAsyncHandle PutAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
    where T : new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method HeadAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use HeadAsync that returns Task")]
public static RestRequestAsyncHandle HeadAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
    where T : new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method OptionsAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use OptionsAsync that returns Task")]
public static RestRequestAsyncHandle OptionsAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
    where T : new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method PatchAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use PatchAsync that returns Task")]
public static RestRequestAsyncHandle PatchAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
    where T : new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method DeleteAsync<T>(IRestClient, IRestRequest, Action<IRestResponse<T>, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use DeleteAsync that returns Task")]
public static RestRequestAsyncHandle DeleteAsync<T>(this IRestClient client, IRestRequest request, Action<IRestResponse<T>, RestRequestAsyncHandle> callback)
    where T : new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse<T>, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method GetAsync(IRestClient, IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use GetAsync that returns Task")]
public static RestRequestAsyncHandle GetAsync(this IRestClient client, IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method PostAsync(IRestClient, IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use PostAsync that returns Task")]
public static RestRequestAsyncHandle PostAsync(this IRestClient client, IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method PutAsync(IRestClient, IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use PutAsync that returns Task")]
public static RestRequestAsyncHandle PutAsync(this IRestClient client, IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method HeadAsync(IRestClient, IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use HeadAsync that returns Task")]
public static RestRequestAsyncHandle HeadAsync(this IRestClient client, IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method OptionsAsync(IRestClient, IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use OptionsAsync that returns Task")]
public static RestRequestAsyncHandle OptionsAsync(this IRestClient client, IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method PatchAsync(IRestClient, IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use PatchAsync that returns Task")]
public static RestRequestAsyncHandle PatchAsync(this IRestClient client, IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method DeleteAsync(IRestClient, IRestRequest, Action<IRestResponse, RestRequestAsyncHandle>)

# Syntax
[Obsolete("Use DeleteAsync that returns Task")]
public static RestRequestAsyncHandle DeleteAsync(this IRestClient client, IRestRequest request, Action<IRestResponse, RestRequestAsyncHandle> callback)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
callback System.Action<RestSharp.IRestResponse, RestSharp.RestRequestAsyncHandle>
# Returns
Type Description
RestSharp.RestRequestAsyncHandle

# Method GetTaskAsync<T>(IRestClient, IRestRequest)

# Syntax
[Obsolete("Use GetAsync")]
public static Task<T> GetTaskAsync<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method PostTaskAsync<T>(IRestClient, IRestRequest)

# Syntax
[Obsolete("Use PostAsync")]
public static Task<T> PostTaskAsync<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method PutTaskAsync<T>(IRestClient, IRestRequest)

# Syntax
[Obsolete("Use PutAsync")]
public static Task<T> PutTaskAsync<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method HeadTaskAsync<T>(IRestClient, IRestRequest)

# Syntax
[Obsolete("Use HeadAsync")]
public static Task<T> HeadTaskAsync<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method OptionsTaskAsync<T>(IRestClient, IRestRequest)

# Syntax
[Obsolete("Use OptionsAsync")]
public static Task<T> OptionsTaskAsync<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method PatchTaskAsync<T>(IRestClient, IRestRequest)

# Syntax
[Obsolete("Use PatchAsync")]
public static Task<T> PatchTaskAsync<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method DeleteTaskAsync<T>(IRestClient, IRestRequest)

# Syntax
[Obsolete("Use DeleteAsync")]
public static Task<T> DeleteTaskAsync<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method ExecuteDynamic(IRestClient, IRestRequest)

Execute the request and returns a response with the dynamic object as Data

# Syntax
public static IRestResponse<dynamic> ExecuteDynamic(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<dynamic>

# Method GetAsync<T>(IRestClient, IRestRequest, CancellationToken)

Execute the request using GET HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static Task<T> GetAsync<T>(this IRestClient client, IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method PostAsync<T>(IRestClient, IRestRequest, CancellationToken)

Execute the request using POST HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static Task<T> PostAsync<T>(this IRestClient client, IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method PutAsync<T>(IRestClient, IRestRequest, CancellationToken)

Execute the request using PUT HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static Task<T> PutAsync<T>(this IRestClient client, IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method HeadAsync<T>(IRestClient, IRestRequest, CancellationToken)

Execute the request using HEAD HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static Task<T> HeadAsync<T>(this IRestClient client, IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method OptionsAsync<T>(IRestClient, IRestRequest, CancellationToken)

Execute the request using OPTIONS HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static Task<T> OptionsAsync<T>(this IRestClient client, IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method PatchAsync<T>(IRestClient, IRestRequest, CancellationToken)

Execute the request using PATCH HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static Task<T> PatchAsync<T>(this IRestClient client, IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method DeleteAsync<T>(IRestClient, IRestRequest, CancellationToken)

Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static Task<T> DeleteAsync<T>(this IRestClient client, IRestRequest request, CancellationToken cancellationToken = default(CancellationToken))
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
cancellationToken System.Threading.CancellationToken Cancellation token
# Returns
Type Description
System.Threading.Tasks.Task<T>

# Method Get<T>(IRestClient, IRestRequest)

Execute the request using GET HTTP method. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static IRestResponse<T> Get<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Post<T>(IRestClient, IRestRequest)

Execute the request using POST HTTP method. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static IRestResponse<T> Post<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Put<T>(IRestClient, IRestRequest)

Execute the request using PUT HTTP method. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static IRestResponse<T> Put<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Head<T>(IRestClient, IRestRequest)

Execute the request using HEAD HTTP method. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static IRestResponse<T> Head<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Options<T>(IRestClient, IRestRequest)

Execute the request using OPTIONS HTTP method. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static IRestResponse<T> Options<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Patch<T>(IRestClient, IRestRequest)

Execute the request using PATCH HTTP method. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static IRestResponse<T> Patch<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Delete<T>(IRestClient, IRestRequest)

Execute the request using DELETE HTTP method. The response data is deserialized to the Data property of the returned response object.

# Syntax
public static IRestResponse<T> Delete<T>(this IRestClient client, IRestRequest request)
# Generic parameters
Name Description
T Expected result type
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse<T>

# Method Get(IRestClient, IRestRequest)

Execute the request using GET HTTP method.

# Syntax
public static IRestResponse Get(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse

# Method Post(IRestClient, IRestRequest)

Execute the request using POST HTTP method.

# Syntax
public static IRestResponse Post(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse

# Method Put(IRestClient, IRestRequest)

Execute the request using PUT HTTP method.

# Syntax
public static IRestResponse Put(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse

# Method Head(IRestClient, IRestRequest)

Execute the request using HEAD HTTP method.

# Syntax
public static IRestResponse Head(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse

# Method Options(IRestClient, IRestRequest)

Execute the request using OPTIONS HTTP method.

# Syntax
public static IRestResponse Options(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse

# Method Patch(IRestClient, IRestRequest)

Execute the request using PATCH HTTP method.

# Syntax
public static IRestResponse Patch(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse

# Method Delete(IRestClient, IRestRequest)

Execute the request using DELETE HTTP method.

# Syntax
public static IRestResponse Delete(this IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient RestClient instance
request RestSharp.IRestRequest The request
# Returns
Type Description
RestSharp.IRestResponse

# Method AddDefaultParameter(IRestClient, Parameter)

Add a parameter to use on every request made with this client instance

# Syntax
public static IRestClient AddDefaultParameter(this IRestClient restClient, Parameter p)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
p RestSharp.Parameter Parameter to add
# Returns
Type Description
RestSharp.IRestClient

# Method AddOrUpdateDefaultParameter(IRestClient, Parameter)

Add a new or update an existing parameter to use on every request made with this client instance

# Syntax
public static IRestClient AddOrUpdateDefaultParameter(this IRestClient restClient, Parameter p)
# Parameters
Name Type Description
restClient RestSharp.IRestClient
p RestSharp.Parameter
# Returns
Type Description
RestSharp.IRestClient

# Method RemoveDefaultParameter(IRestClient, String)

Removes a parameter from the default parameters that are used on every request made with this client instance

# Syntax
public static IRestClient RemoveDefaultParameter(this IRestClient restClient, string name)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
name string The name of the parameter that needs to be removed
# Returns
Type Description
RestSharp.IRestClient

# Method AddDefaultParameter(IRestClient, String, Object)

Adds a default HTTP parameter (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) Used on every request made by this client instance

# Syntax
public static IRestClient AddDefaultParameter(this IRestClient restClient, string name, object value)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
name string Name of the parameter
value object Value of the parameter
# Returns
Type Description
RestSharp.IRestClient This request

# Method AddDefaultParameter(IRestClient, String, Object, ParameterType)

Adds a default parameter to the request. There are four types of parameters:

  • GetOrPost: Either a QueryString value or encoded form value based on method
  • HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  • UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  • RequestBody: Used by AddBody() (not recommended to use directly) Used on every request made by this client instance
# Syntax
public static IRestClient AddDefaultParameter(this IRestClient restClient, string name, object value, ParameterType type)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
name string Name of the parameter
value object Value of the parameter
type RestSharp.ParameterType The type of parameter to add
# Returns
Type Description
RestSharp.IRestClient This request

# Method AddDefaultHeader(IRestClient, String, String)

Adds a default header to the RestClient. Used on every request made by this client instance.

# Syntax
public static IRestClient AddDefaultHeader(this IRestClient restClient, string name, string value)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
name string Name of the header to add
value string Value of the header to add
# Returns
Type Description
RestSharp.IRestClient

# Method AddDefaultHeaders(IRestClient, Dictionary<String, String>)

Adds default headers to the RestClient. Used on every request made by this client instance.

# Syntax
public static IRestClient AddDefaultHeaders(this IRestClient restClient, Dictionary<string, string> headers)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
headers System.Collections.Generic.Dictionary<string, string> Dictionary containing the Names and Values of the headers to add
# Returns
Type Description
RestSharp.IRestClient

# Method AddDefaultUrlSegment(IRestClient, String, String)

Adds a default URL segment parameter to the RestClient. Used on every request made by this client instance.

# Syntax
public static IRestClient AddDefaultUrlSegment(this IRestClient restClient, string name, string value)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
name string Name of the segment to add
value string Value of the segment to add
# Returns
Type Description
RestSharp.IRestClient

# Method AddDefaultQueryParameter(IRestClient, String, String)

Adds a default URL query parameter to the RestClient. Used on every request made by this client instance.

# Syntax
public static IRestClient AddDefaultQueryParameter(this IRestClient restClient, string name, string value)
# Parameters
Name Type Description
restClient RestSharp.IRestClient The IRestClient instance
name string Name of the query parameter to add
value string Value of the query parameter to add
# Returns
Type Description
RestSharp.IRestClient

# Method UseJson(RestClient)

# Syntax
public static RestClient UseJson(this RestClient client)
# Parameters
Name Type Description
client RestSharp.RestClient
# Returns
Type Description
RestSharp.RestClient

# Method UseXml(RestClient)

# Syntax
public static RestClient UseXml(this RestClient client)
# Parameters
Name Type Description
client RestSharp.RestClient
# Returns
Type Description
RestSharp.RestClient

# Class NameValuePair

# Inheritance

↳ object

# Syntax

public class NameValuePair

# Field Empty

# Syntax
public static NameValuePair Empty

# Constructor NameValuePair(String, String)

# Syntax
public NameValuePair(string name, string value)
# Parameters
Name Type Description
name string
value string

# Property Name

# Syntax
public string Name { get; }

# Property Value

# Syntax
public string Value { get; }

# Property IsEmpty

# Syntax
public bool IsEmpty { get; }

# Class Parameter

Parameter container for REST requests

# Inheritance

↳ object

# Syntax

public class Parameter : IEquatable<Parameter>

# Constructor Parameter(String, Object, ParameterType)

# Syntax
public Parameter(string name, object value, ParameterType type)
# Parameters
Name Type Description
name string
value object
type RestSharp.ParameterType

# Constructor Parameter(String, Object, String, ParameterType)

# Syntax
public Parameter(string name, object value, string contentType, ParameterType type)
# Parameters
Name Type Description
name string
value object
contentType string
type RestSharp.ParameterType

# Property Name

Name of the parameter

# Syntax
public string Name { get; set; }

# Property Value

Value of the parameter

# Syntax
public object Value { get; set; }

# Property Type

Type of the parameter

# Syntax
public ParameterType Type { get; set; }

# Property DataFormat

Body parameter data type

# Syntax
public DataFormat DataFormat { get; set; }

# Property ContentType

MIME content type of the parameter

# Syntax
public string ContentType { get; set; }

# Method ToString()

Return a human-readable representation of this parameter

# Syntax
public override string ToString()
# Returns
Type Description
string String

# Method Equals(Parameter)

# Syntax
public bool Equals(Parameter other)
# Parameters
Name Type Description
other RestSharp.Parameter
# Returns
Type Description
bool

# Method Equals(Object)

# Syntax
public override bool Equals(object obj)
# Parameters
Name Type Description
obj object
# Returns
Type Description
bool

# Method GetHashCode()

# Syntax
public override int GetHashCode()
# Returns
Type Description
int

# Class XmlParameter

# Inheritance

↳ object
  ↳ RestSharp.Parameter

# Syntax

public class XmlParameter : Parameter, IEquatable<Parameter>

# Constructor XmlParameter(String, Object, String)

# Syntax
public XmlParameter(string name, object value, string xmlNamespace = null)
# Parameters
Name Type Description
name string
value object
xmlNamespace string

# Property XmlNamespace

# Syntax
public string XmlNamespace { get; }

# Class JsonParameter

# Inheritance

↳ object
  ↳ RestSharp.Parameter

# Inherited members

  • RestSharp.Parameter.Name

# Syntax

public class JsonParameter : Parameter, IEquatable<Parameter>

# Constructor JsonParameter(String, Object)

# Syntax
public JsonParameter(string name, object value)
# Parameters
Name Type Description
name string
value object

# Constructor JsonParameter(String, Object, String)

# Syntax
public JsonParameter(string name, object value, string contentType)
# Parameters
Name Type Description
name string
value object
contentType string

# Class RequestBody

# Inheritance

↳ object

# Syntax

public class RequestBody

# Property ContentType

# Syntax
public string ContentType { get; }

# Property Name

# Syntax
public string Name { get; }

# Property Value

# Syntax
public object Value { get; }

# Constructor RequestBody(String, String, Object)

# Syntax
public RequestBody(string contentType, string name, object value)
# Parameters
Name Type Description
contentType string
name string
value object

# Class RestClientJsonRequest

# Inheritance

↳ object

# Syntax

public static class RestClientJsonRequest

# Method Get<TRequest, TResponse>(IRestClient, JsonRequest<TRequest, TResponse>)

# Syntax
public static IRestResponse<TResponse> Get<TRequest, TResponse>(this IRestClient client, JsonRequest<TRequest, TResponse> request)
    where TResponse : new()
# Generic parameters
Name Description
TRequest
TResponse
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.JsonRequest<TRequest, TResponse>
# Returns
Type Description
RestSharp.IRestResponse<TResponse>

# Method Post<TRequest, TResponse>(IRestClient, JsonRequest<TRequest, TResponse>)

# Syntax
public static IRestResponse<TResponse> Post<TRequest, TResponse>(this IRestClient client, JsonRequest<TRequest, TResponse> request)
    where TResponse : new()
# Generic parameters
Name Description
TRequest
TResponse
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.JsonRequest<TRequest, TResponse>
# Returns
Type Description
RestSharp.IRestResponse<TResponse>

# Method Put<TRequest, TResponse>(IRestClient, JsonRequest<TRequest, TResponse>)

# Syntax
public static IRestResponse<TResponse> Put<TRequest, TResponse>(this IRestClient client, JsonRequest<TRequest, TResponse> request)
    where TResponse : new()
# Generic parameters
Name Description
TRequest
TResponse
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.JsonRequest<TRequest, TResponse>
# Returns
Type Description
RestSharp.IRestResponse<TResponse>

# Method Head<TRequest, TResponse>(IRestClient, JsonRequest<TRequest, TResponse>)

# Syntax
public static IRestResponse<TResponse> Head<TRequest, TResponse>(this IRestClient client, JsonRequest<TRequest, TResponse> request)
    where TResponse : new()
# Generic parameters
Name Description
TRequest
TResponse
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.JsonRequest<TRequest, TResponse>
# Returns
Type Description
RestSharp.IRestResponse<TResponse>

# Method Options<TRequest, TResponse>(IRestClient, JsonRequest<TRequest, TResponse>)

# Syntax
public static IRestResponse<TResponse> Options<TRequest, TResponse>(this IRestClient client, JsonRequest<TRequest, TResponse> request)
    where TResponse : new()
# Generic parameters
Name Description
TRequest
TResponse
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.JsonRequest<TRequest, TResponse>
# Returns
Type Description
RestSharp.IRestResponse<TResponse>

# Method Patch<TRequest, TResponse>(IRestClient, JsonRequest<TRequest, TResponse>)

# Syntax
public static IRestResponse<TResponse> Patch<TRequest, TResponse>(this IRestClient client, JsonRequest<TRequest, TResponse> request)
    where TResponse : new()
# Generic parameters
Name Description
TRequest
TResponse
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.JsonRequest<TRequest, TResponse>
# Returns
Type Description
RestSharp.IRestResponse<TResponse>

# Method Delete<TRequest, TResponse>(IRestClient, JsonRequest<TRequest, TResponse>)

# Syntax
public static IRestResponse<TResponse> Delete<TRequest, TResponse>(this IRestClient client, JsonRequest<TRequest, TResponse> request)
    where TResponse : new()
# Generic parameters
Name Description
TRequest
TResponse
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.JsonRequest<TRequest, TResponse>
# Returns
Type Description
RestSharp.IRestResponse<TResponse>

# Class RestRequest

Container for data used to make requests

# Inheritance

↳ object

# Syntax

public class RestRequest : IRestRequest

# Constructor RestRequest()

Default constructor

# Syntax
public RestRequest()

# Constructor RestRequest(Method)

Sets Method property to value of method

# Syntax
public RestRequest(Method method)
# Parameters
Name Type Description
method RestSharp.Method Method to use for this request

# Constructor RestRequest(String, Method)

# Syntax
public RestRequest(string resource, Method method)
# Parameters
Name Type Description
resource string
method RestSharp.Method

# Constructor RestRequest(String, DataFormat)

# Syntax
public RestRequest(string resource, DataFormat dataFormat)
# Parameters
Name Type Description
resource string
dataFormat RestSharp.DataFormat

# Constructor RestRequest(String)

# Syntax
public RestRequest(string resource)
# Parameters
Name Type Description
resource string

# Constructor RestRequest(String, Method, DataFormat)

# Syntax
public RestRequest(string resource, Method method, DataFormat dataFormat)
# Parameters
Name Type Description
resource string
method RestSharp.Method
dataFormat RestSharp.DataFormat

# Constructor RestRequest(Uri, Method, DataFormat)

# Syntax
public RestRequest(Uri resource, Method method, DataFormat dataFormat)
# Parameters
Name Type Description
resource Uri
method RestSharp.Method
dataFormat RestSharp.DataFormat

# Constructor RestRequest(Uri, Method)

# Syntax
public RestRequest(Uri resource, Method method)
# Parameters
Name Type Description
resource Uri
method RestSharp.Method

# Constructor RestRequest(Uri)

# Syntax
public RestRequest(Uri resource)
# Parameters
Name Type Description
resource Uri

# Property AllowedDecompressionMethods

# Syntax
public IList<DecompressionMethods> AllowedDecompressionMethods { get; }

# Property AlwaysMultipartFormData

# Syntax
public bool AlwaysMultipartFormData { get; set; }

# Property JsonSerializer

# Syntax
public ISerializer JsonSerializer { get; set; }

# Property XmlSerializer

# Syntax
public IXmlSerializer XmlSerializer { get; set; }

# Property Body

# Syntax
public RequestBody Body { get; set; }

# Property ResponseWriter

# Syntax
public Action<Stream> ResponseWriter { get; set; }

# Property AdvancedResponseWriter

# Syntax
public Action<Stream, IHttpResponse> AdvancedResponseWriter { get; set; }

# Property UseDefaultCredentials

# Syntax
public bool UseDefaultCredentials { get; set; }

# Method AddFile(String, String, String)

# Syntax
public IRestRequest AddFile(string name, string path, string contentType = null)
# Parameters
Name Type Description
name string
path string
contentType string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddFile(String, Byte[], String, String)

# Syntax
public IRestRequest AddFile(string name, byte[] bytes, string fileName, string contentType = null)
# Parameters
Name Type Description
name string
bytes byte[]
fileName string
contentType string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddFile(String, Action<Stream>, String, Int64, String)

# Syntax
public IRestRequest AddFile(string name, Action<Stream> writer, string fileName, long contentLength, string contentType = null)
# Parameters
Name Type Description
name string
writer System.Action<System.IO.Stream>
fileName string
contentLength long
contentType string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddFileBytes(String, Byte[], String, String)

# Syntax
public IRestRequest AddFileBytes(string name, byte[] bytes, string filename, string contentType = "application/x-gzip")
# Parameters
Name Type Description
name string
bytes byte[]
filename string
contentType string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddBody(Object, String)

# Syntax
[Obsolete("Use AddXmlBody")]
public IRestRequest AddBody(object obj, string xmlNamespace)
# Parameters
Name Type Description
obj object
xmlNamespace string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddBody(Object)

# Syntax
[Obsolete("Use AddXmlBody or AddJsonBody")]
public IRestRequest AddBody(object obj)
# Parameters
Name Type Description
obj object
# Returns
Type Description
RestSharp.IRestRequest

# Method AddJsonBody(Object)

# Syntax
public IRestRequest AddJsonBody(object obj)
# Parameters
Name Type Description
obj object
# Returns
Type Description
RestSharp.IRestRequest

# Method AddJsonBody(Object, String)

# Syntax
public IRestRequest AddJsonBody(object obj, string contentType)
# Parameters
Name Type Description
obj object
contentType string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddXmlBody(Object)

# Syntax
public IRestRequest AddXmlBody(object obj)
# Parameters
Name Type Description
obj object
# Returns
Type Description
RestSharp.IRestRequest

# Method AddXmlBody(Object, String)

# Syntax
public IRestRequest AddXmlBody(object obj, string xmlNamespace)
# Parameters
Name Type Description
obj object
xmlNamespace string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddObject(Object, String[])

# Syntax
public IRestRequest AddObject(object obj, params string[] includedProperties)
# Parameters
Name Type Description
obj object
includedProperties string[]
# Returns
Type Description
RestSharp.IRestRequest

# Method AddObject(Object)

# Syntax
public IRestRequest AddObject(object obj)
# Parameters
Name Type Description
obj object
# Returns
Type Description
RestSharp.IRestRequest

# Method AddParameter(Parameter)

# Syntax
public IRestRequest AddParameter(Parameter p)
# Parameters
Name Type Description
p RestSharp.Parameter
# Returns
Type Description
RestSharp.IRestRequest

# Method AddParameter(String, Object)

# Syntax
public IRestRequest AddParameter(string name, object value)
# Parameters
Name Type Description
name string
value object
# Returns
Type Description
RestSharp.IRestRequest

# Method AddParameter(String, Object, ParameterType)

# Syntax
public IRestRequest AddParameter(string name, object value, ParameterType type)
# Parameters
Name Type Description
name string
value object
type RestSharp.ParameterType
# Returns
Type Description
RestSharp.IRestRequest

# Method AddParameter(String, Object, String, ParameterType)

# Syntax
public IRestRequest AddParameter(string name, object value, string contentType, ParameterType type)
# Parameters
Name Type Description
name string
value object
contentType string
type RestSharp.ParameterType
# Returns
Type Description
RestSharp.IRestRequest

# Method AddOrUpdateParameter(Parameter)

# Syntax
public IRestRequest AddOrUpdateParameter(Parameter parameter)
# Parameters
Name Type Description
parameter RestSharp.Parameter
# Returns
Type Description
RestSharp.IRestRequest

# Method AddOrUpdateParameters(IEnumerable<Parameter>)

# Syntax
public IRestRequest AddOrUpdateParameters(IEnumerable<Parameter> parameters)
# Parameters
Name Type Description
parameters System.Collections.Generic.IEnumerable<RestSharp.Parameter>
# Returns
Type Description
RestSharp.IRestRequest

# Method AddOrUpdateParameter(String, Object)

# Syntax
public IRestRequest AddOrUpdateParameter(string name, object value)
# Parameters
Name Type Description
name string
value object
# Returns
Type Description
RestSharp.IRestRequest

# Method AddOrUpdateParameter(String, Object, ParameterType)

# Syntax
public IRestRequest AddOrUpdateParameter(string name, object value, ParameterType type)
# Parameters
Name Type Description
name string
value object
type RestSharp.ParameterType
# Returns
Type Description
RestSharp.IRestRequest

# Method AddOrUpdateParameter(String, Object, String, ParameterType)

# Syntax
public IRestRequest AddOrUpdateParameter(string name, object value, string contentType, ParameterType type)
# Parameters
Name Type Description
name string
value object
contentType string
type RestSharp.ParameterType
# Returns
Type Description
RestSharp.IRestRequest

# Method AddHeader(String, String)

# Syntax
public IRestRequest AddHeader(string name, string value)
# Parameters
Name Type Description
name string
value string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddHeaders(ICollection<KeyValuePair<String, String>>)

# Syntax
public IRestRequest AddHeaders(ICollection<KeyValuePair<string, string>> headers)
# Parameters
Name Type Description
headers System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string, string>>
# Returns
Type Description
RestSharp.IRestRequest

# Method AddCookie(String, String)

# Syntax
public IRestRequest AddCookie(string name, string value)
# Parameters
Name Type Description
name string
value string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddUrlSegment(String, String)

# Syntax
public IRestRequest AddUrlSegment(string name, string value)
# Parameters
Name Type Description
name string
value string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddQueryParameter(String, String)

# Syntax
public IRestRequest AddQueryParameter(string name, string value)
# Parameters
Name Type Description
name string
value string
# Returns
Type Description
RestSharp.IRestRequest

# Method AddQueryParameter(String, String, Boolean)

# Syntax
public IRestRequest AddQueryParameter(string name, string value, bool encode)
# Parameters
Name Type Description
name string
value string
encode bool
# Returns
Type Description
RestSharp.IRestRequest

# Method AddDecompressionMethod(DecompressionMethods)

# Syntax
public IRestRequest AddDecompressionMethod(DecompressionMethods decompressionMethod)
# Parameters
Name Type Description
decompressionMethod DecompressionMethods
# Returns
Type Description
RestSharp.IRestRequest

# Property Parameters

# Syntax
public List<Parameter> Parameters { get; }

# Property Files

# Syntax
public List<FileParameter> Files { get; }

# Property Method

# Syntax
public Method Method { get; set; }

# Property Resource

# Syntax
public string Resource { get; set; }

# Property RequestFormat

# Syntax
public DataFormat RequestFormat { get; set; }

# Property RootElement

# Syntax
[Obsolete("Add custom content handler instead. This property will be removed.")]
public string RootElement { get; set; }

# Property OnBeforeDeserialization

# Syntax
public Action<IRestResponse> OnBeforeDeserialization { get; set; }

# Property OnBeforeRequest

# Syntax
public Action<IHttp> OnBeforeRequest { get; set; }

# Property DateFormat

# Syntax
[Obsolete("Add custom content handler instead. This property will be removed.")]
public string DateFormat { get; set; }

# Property XmlNamespace

# Syntax
[Obsolete("Add custom content handler instead. This property will be removed.")]
public string XmlNamespace { get; set; }

# Property Credentials

# Syntax
public ICredentials Credentials { get; set; }

# Property Timeout

# Syntax
public int Timeout { get; set; }

# Property ReadWriteTimeout

# Syntax
public int ReadWriteTimeout { get; set; }

# Method IncreaseNumAttempts()

# Syntax
public void IncreaseNumAttempts()

# Property Attempts

# Syntax
public int Attempts { get; }

# Method AddUrlSegment(String, Object)

# Syntax
public IRestRequest AddUrlSegment(string name, object value)
# Parameters
Name Type Description
name string
value object
# Returns
Type Description
RestSharp.IRestRequest

# Class RestRequestAsyncHandle

# Inheritance

↳ object

# Syntax

public class RestRequestAsyncHandle

# Field WebRequest

# Syntax
public HttpWebRequest WebRequest

# Method Abort()

# Syntax
public void Abort()

# Class RestResponseBase

Base class for common properties shared by RestResponse and RestResponse[[T]]

# Inheritance

↳ object

# Syntax

[DebuggerDisplay("{DebuggerDisplay()}")]
public abstract class RestResponseBase

# Constructor RestResponseBase()

Default constructor

# Syntax
protected RestResponseBase()

# Property Request

The RestRequest that was made to get this RestResponse

# Remarks

Mainly for debugging if ResponseStatus is not OK

# Syntax
public IRestRequest Request { get; set; }

# Property ContentType

MIME content type of response

# Syntax
public string ContentType { get; set; }

# Property ContentLength

Length in bytes of the response content

# Syntax
public long ContentLength { get; set; }

# Property ContentEncoding

Encoding of the response content

# Syntax
public string ContentEncoding { get; set; }

# Property Content

String representation of response content

# Syntax
public string Content { get; set; }

# Property StatusCode

HTTP response status code

# Syntax
public HttpStatusCode StatusCode { get; set; }

# Property IsSuccessful

Whether or not the response status code indicates success

# Syntax
public bool IsSuccessful { get; }

# Property StatusDescription

Description of HTTP status returned

# Syntax
public string StatusDescription { get; set; }

# Property RawBytes

Response content

# Syntax
public byte[] RawBytes { get; set; }

# Property ResponseUri

The URL that actually responded to the content (different from request if redirected)

# Syntax
public Uri ResponseUri { get; set; }

# Property Server

HttpWebResponse.Server

# Syntax
public string Server { get; set; }

# Property Cookies

Cookies returned by server with the response

# Syntax
public IList<RestResponseCookie> Cookies { get; protected set; }

# Property Headers

Headers returned by server with the response

# Syntax
public IList<Parameter> Headers { get; protected set; }

# Property ResponseStatus

Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead

# Syntax
public ResponseStatus ResponseStatus { get; set; }

# Property ErrorMessage

Transport or other non-HTTP error generated while attempting request

# Syntax
public string ErrorMessage { get; set; }

# Property ErrorException

The exception thrown during the request, if any

# Syntax
public Exception ErrorException { get; set; }

# Property ProtocolVersion

The HTTP protocol version (1.0, 1.1, etc)

# Remarks

Only set when underlying framework supports it.

# Syntax
public Version ProtocolVersion { get; set; }

# Method DebuggerDisplay()

Assists with debugging responses by displaying in the debugger output

# Syntax
protected string DebuggerDisplay()
# Returns
Type Description
string

# Class RestResponse<T>

Container for data sent back from API including deserialized data

# Inheritance

↳ object
  ↳ RestSharp.RestResponseBase

# Syntax

[DebuggerDisplay("{DebuggerDisplay()}")]
public class RestResponse<T> : RestResponseBase, IRestResponse<T>, IRestResponse

# Generic parameters

Name Description
T Type of data to deserialize to

# Extension methods

  • RestSharp.Extensions.ResponseExtensions.ToAsyncResponse<T>(RestSharp.IRestResponse)

# Property Data

Deserialized entity data

# Syntax
public T Data { get; set; }

Operator: RestSharp.RestResponse1.op_Explicit(RestSharp.RestResponse)~RestSharp.RestResponse{0}

# Class RestResponse

Container for data sent back from API

# Inheritance

↳ object
  ↳ RestSharp.RestResponseBase

# Inherited members

  • RestSharp.RestResponseBase.Request

# Syntax

[DebuggerDisplay("{DebuggerDisplay()}")]
public class RestResponse : RestResponseBase, IRestResponse

# Extension methods

  • RestSharp.Extensions.ResponseExtensions.ToAsyncResponse<T>(RestSharp.IRestResponse)

# Class RestResponseCookie

# Inheritance

↳ object

# Syntax

[Obsolete("We will use HttpCookie in the response as well in the next major version")]
public class RestResponseCookie

# Property Comment

Comment of the cookie

# Syntax
public string Comment { get; set; }

# Property CommentUri

Comment of the cookie

# Syntax
public Uri CommentUri { get; set; }

# Property Discard

Indicates whether the cookie should be discarded at the end of the session

# Syntax
public bool Discard { get; set; }

# Property Domain

Domain of the cookie

# Syntax
public string Domain { get; set; }

# Property Expired

Indicates whether the cookie is expired

# Syntax
public bool Expired { get; set; }

# Property Expires

Date and time that the cookie expires

# Syntax
public DateTime Expires { get; set; }

# Property HttpOnly

Indicates that this cookie should only be accessed by the server

# Syntax
public bool HttpOnly { get; set; }

# Property Name

Name of the cookie

# Syntax
public string Name { get; set; }

# Property Path

Path of the cookie

# Syntax
public string Path { get; set; }

# Property Port

Port of the cookie

# Syntax
public string Port { get; set; }

# Property Secure

Indicates that the cookie should only be sent over secure channels

# Syntax
public bool Secure { get; set; }

# Property TimeStamp

Date and time the cookie was created

# Syntax
public DateTime TimeStamp { get; set; }

# Property Value

Value of the cookie

# Syntax
public string Value { get; set; }

# Property Version

Version of the cookie

# Syntax
public int Version { get; set; }

# Property HttpCookie

# Syntax
public HttpCookie HttpCookie { get; }

# Namespace: RestSharp.Authenticators

# Class AuthenticatorBase

# Inheritance

↳ object

# Syntax

public abstract class AuthenticatorBase : IAuthenticator

# Constructor AuthenticatorBase(String)

# Syntax
protected AuthenticatorBase(string token)
# Parameters
Name Type Description
token string

# Property Token

# Syntax
protected string Token { get; }

# Method GetAuthenticationParameter(String)

# Syntax
protected abstract Parameter GetAuthenticationParameter(string accessToken)
# Parameters
Name Type Description
accessToken string
# Returns
Type Description
RestSharp.Parameter

# Method Authenticate(IRestClient, IRestRequest)

# Syntax
public void Authenticate(IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest

# Class HttpBasicAuthenticator

Allows "basic access authentication" for HTTP requests.

# Remarks

Encoding can be specified depending on what your server expect (see https://stackoverflow.com/a/7243567). UTF-8 is used by default but some servers might expect ISO-8859-1 encoding.

# Inheritance

↳ object
  ↳ RestSharp.Authenticators.AuthenticatorBase

# Syntax

public class HttpBasicAuthenticator : AuthenticatorBase, IAuthenticator

# Constructor HttpBasicAuthenticator(String, String)

# Syntax
public HttpBasicAuthenticator(string username, string password)
# Parameters
Name Type Description
username string
password string

# Constructor HttpBasicAuthenticator(String, String, Encoding)

# Syntax
public HttpBasicAuthenticator(string username, string password, Encoding encoding)
# Parameters
Name Type Description
username string
password string
encoding System.Text.Encoding

# Method GetAuthenticationParameter(String)

# Syntax
protected override Parameter GetAuthenticationParameter(string accessToken)
# Parameters
Name Type Description
accessToken string
# Returns
Type Description
RestSharp.Parameter

# Interface IAuthenticator

# Syntax

public interface IAuthenticator

# Method Authenticate(IRestClient, IRestRequest)

# Syntax
void Authenticate(IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest

# Class JwtAuthenticator

JSON WEB TOKEN (JWT) Authenticator class. https://tools.ietf.org/html/draft-ietf-oauth-json-web-token

# Inheritance

↳ object

# Syntax

public class JwtAuthenticator : IAuthenticator

# Constructor JwtAuthenticator(String)

# Syntax
public JwtAuthenticator(string accessToken)
# Parameters
Name Type Description
accessToken string

# Method SetBearerToken(String)

Set the new bearer token so the request gets the new header value

# Syntax
public void SetBearerToken(string accessToken)
# Parameters
Name Type Description
accessToken string

# Method Authenticate(IRestClient, IRestRequest)

# Syntax
public void Authenticate(IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest

# Class NtlmAuthenticator

Tries to Authenticate with the credentials of the currently logged in user, or impersonate a user

# Inheritance

↳ object

# Syntax

public class NtlmAuthenticator : IAuthenticator

# Constructor NtlmAuthenticator()

Authenticate with the credentials of the currently logged in user

# Syntax
public NtlmAuthenticator()

# Constructor NtlmAuthenticator(String, String)

Authenticate by impersonation

# Syntax
public NtlmAuthenticator(string username, string password)
# Parameters
Name Type Description
username string
password string

# Constructor NtlmAuthenticator(ICredentials)

Authenticate by impersonation, using an existing ICredentials instance

# Syntax
public NtlmAuthenticator(ICredentials credentials)
# Parameters
Name Type Description
credentials ICredentials

# Method Authenticate(IRestClient, IRestRequest)

# Syntax
public void Authenticate(IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest

# Class OAuth1Authenticator

# See also

RFC: The OAuth 1.0 Protocol (opens new window)

# Inheritance

↳ object

# Syntax

public class OAuth1Authenticator : IAuthenticator

# Property Realm

# Syntax
public virtual string Realm { get; set; }

# Property ParameterHandling

# Syntax
public virtual OAuthParameterHandling ParameterHandling { get; set; }

# Property SignatureMethod

# Syntax
public virtual OAuthSignatureMethod SignatureMethod { get; set; }

# Property SignatureTreatment

# Syntax
public virtual OAuthSignatureTreatment SignatureTreatment { get; set; }

# Method Authenticate(IRestClient, IRestRequest)

# Syntax
public void Authenticate(IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest

# Method ForRequestToken(String, String, OAuthSignatureMethod)

# Syntax
public static OAuth1Authenticator ForRequestToken(string consumerKey, string consumerSecret, OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
signatureMethod RestSharp.Authenticators.OAuth.OAuthSignatureMethod
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Method ForRequestToken(String, String, String)

# Syntax
public static OAuth1Authenticator ForRequestToken(string consumerKey, string consumerSecret, string callbackUrl)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
callbackUrl string
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Method ForAccessToken(String, String, String, String, OAuthSignatureMethod)

# Syntax
public static OAuth1Authenticator ForAccessToken(string consumerKey, string consumerSecret, string token, string tokenSecret, OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
token string
tokenSecret string
signatureMethod RestSharp.Authenticators.OAuth.OAuthSignatureMethod
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Method ForAccessToken(String, String, String, String, String)

# Syntax
public static OAuth1Authenticator ForAccessToken(string consumerKey, string consumerSecret, string token, string tokenSecret, string verifier)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
token string
tokenSecret string
verifier string
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Method ForAccessTokenRefresh(String, String, String, String, String)

# Syntax
public static OAuth1Authenticator ForAccessTokenRefresh(string consumerKey, string consumerSecret, string token, string tokenSecret, string sessionHandle)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
token string
tokenSecret string
sessionHandle string
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Method ForAccessTokenRefresh(String, String, String, String, String, String)

# Syntax
public static OAuth1Authenticator ForAccessTokenRefresh(string consumerKey, string consumerSecret, string token, string tokenSecret, string verifier, string sessionHandle)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
token string
tokenSecret string
verifier string
sessionHandle string
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Method ForClientAuthentication(String, String, String, String, OAuthSignatureMethod)

# Syntax
public static OAuth1Authenticator ForClientAuthentication(string consumerKey, string consumerSecret, string username, string password, OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
username string
password string
signatureMethod RestSharp.Authenticators.OAuth.OAuthSignatureMethod
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Method ForProtectedResource(String, String, String, String, OAuthSignatureMethod)

# Syntax
public static OAuth1Authenticator ForProtectedResource(string consumerKey, string consumerSecret, string accessToken, string accessTokenSecret, OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1)
# Parameters
Name Type Description
consumerKey string
consumerSecret string
accessToken string
accessTokenSecret string
signatureMethod RestSharp.Authenticators.OAuth.OAuthSignatureMethod
# Returns
Type Description
RestSharp.Authenticators.OAuth1Authenticator

# Class OAuth2Authenticator

Base class for OAuth 2 Authenticators.

# Remarks

Since there are many ways to authenticate in OAuth2, this is used as a base class to differentiate between other authenticators. Any other OAuth2 authenticators must derive from this abstract class.

# Inheritance

↳ object

# Syntax

[Obsolete("Check the OAuth2 authenticators implementation on how to use the AuthenticatorBase instead")]
public abstract class OAuth2Authenticator : IAuthenticator

# Constructor OAuth2Authenticator(String)

# Syntax
protected OAuth2Authenticator(string accessToken)
# Parameters
Name Type Description
accessToken string

# Property AccessToken

Gets the access token.

# Syntax
public string AccessToken { get; }

# Method Authenticate(IRestClient, IRestRequest)

# Syntax
public void Authenticate(IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest

# Method GetAuthenticationParameter(String)

# Syntax
protected abstract Parameter GetAuthenticationParameter(string accessToken)
# Parameters
Name Type Description
accessToken string
# Returns
Type Description
RestSharp.Parameter

# Class OAuth2AuthorizationRequestHeaderAuthenticator

The OAuth 2 authenticator using the authorization request header field.

# Remarks

Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.1

# Inheritance

↳ object
  ↳ RestSharp.Authenticators.AuthenticatorBase

# Syntax

public class OAuth2AuthorizationRequestHeaderAuthenticator : AuthenticatorBase, IAuthenticator

# Constructor OAuth2AuthorizationRequestHeaderAuthenticator(String)

# Syntax
public OAuth2AuthorizationRequestHeaderAuthenticator(string accessToken)
# Parameters
Name Type Description
accessToken string

# Constructor OAuth2AuthorizationRequestHeaderAuthenticator(String, String)

# Syntax
public OAuth2AuthorizationRequestHeaderAuthenticator(string accessToken, string tokenType)
# Parameters
Name Type Description
accessToken string
tokenType string

# Method GetAuthenticationParameter(String)

# Syntax
protected override Parameter GetAuthenticationParameter(string accessToken)
# Parameters
Name Type Description
accessToken string
# Returns
Type Description
RestSharp.Parameter

# Class OAuth2UriQueryParameterAuthenticator

The OAuth 2 authenticator using URI query parameter.

# Remarks

Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.2

# Inheritance

↳ object
  ↳ RestSharp.Authenticators.AuthenticatorBase

# Syntax

public class OAuth2UriQueryParameterAuthenticator : AuthenticatorBase, IAuthenticator

# Constructor OAuth2UriQueryParameterAuthenticator(String)

# Syntax
public OAuth2UriQueryParameterAuthenticator(string accessToken)
# Parameters
Name Type Description
accessToken string

# Method GetAuthenticationParameter(String)

# Syntax
protected override Parameter GetAuthenticationParameter(string accessToken)
# Parameters
Name Type Description
accessToken string
# Returns
Type Description
RestSharp.Parameter

# Class SimpleAuthenticator

# Inheritance

↳ object

# Syntax

public class SimpleAuthenticator : IAuthenticator

# Constructor SimpleAuthenticator(String, String, String, String)

# Syntax
public SimpleAuthenticator(string usernameKey, string username, string passwordKey, string password)
# Parameters
Name Type Description
usernameKey string
username string
passwordKey string
password string

# Method Authenticate(IRestClient, IRestRequest)

# Syntax
public void Authenticate(IRestClient client, IRestRequest request)
# Parameters
Name Type Description
client RestSharp.IRestClient
request RestSharp.IRestRequest

# Namespace: RestSharp.Authenticators.OAuth

# Enum OAuthSignatureMethod

# Syntax

public enum OAuthSignatureMethod

# Fields

Name Description
HmacSha1
HmacSha256
PlainText
RsaSha1

# Enum OAuthSignatureTreatment

# Syntax

public enum OAuthSignatureTreatment

# Fields

Name Description
Escaped
Unescaped

# Enum OAuthParameterHandling

# Syntax

public enum OAuthParameterHandling

# Fields

Name Description
HttpAuthorizationHeader
UrlOrPostParameters

# Enum OAuthType

# Syntax

public enum OAuthType

# Fields

Name Description
RequestToken
AccessToken
ProtectedResource
ClientAuthentication

# Namespace: RestSharp.Extensions

# Class MiscExtensions

Extension method overload!

# Inheritance

↳ object

# Syntax

public static class MiscExtensions

# Method SaveAs(Byte[], String)

Save a byte array to a file

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static void SaveAs(this byte[] input, string path)
# Parameters
Name Type Description
input byte[] Bytes to save
path string Full path to save file to

# Method ReadAsBytes(Stream)

Read a stream into a byte array

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static byte[] ReadAsBytes(this Stream input)
# Parameters
Name Type Description
input System.IO.Stream Stream to read
# Returns
Type Description
byte[] byte[]

# Method CopyTo(Stream, Stream)

Copies bytes from one stream to another

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static void CopyTo(this Stream input, Stream output)
# Parameters
Name Type Description
input System.IO.Stream The input stream.
output System.IO.Stream The output stream.

# Method AsString(Byte[], String)

Converts a byte array to a string, using its byte order mark to convert it to the right encoding. http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static string AsString(this byte[] buffer, string encoding)
# Parameters
Name Type Description
buffer byte[] An array of bytes to convert
encoding string Content encoding. Will fallback to UTF8 if not a valid encoding.
# Returns
Type Description
string The byte as a string.

# Method AsString(Byte[])

Converts a byte array to a string, using its byte order mark to convert it to the right encoding. http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static string AsString(this byte[] buffer)
# Parameters
Name Type Description
buffer byte[] An array of bytes to convert
# Returns
Type Description
string The byte as a string using UTF8.

# Class ReflectionExtensions

Reflection extensions

# Inheritance

↳ object

# Syntax

public static class ReflectionExtensions

# Method GetAttribute<T>(MemberInfo)

Retrieve an attribute from a member (property)

# Syntax
public static T GetAttribute<T>(this MemberInfo prop)
    where T : Attribute
# Generic parameters
Name Description
T Type of attribute to retrieve
# Parameters
Name Type Description
prop System.Reflection.MemberInfo Member to retrieve attribute from
# Returns
Type Description
T

# Method GetAttribute<T>(Type)

Retrieve an attribute from a type

# Syntax
public static T GetAttribute<T>(this Type type)
    where T : Attribute
# Generic parameters
Name Description
T Type of attribute to retrieve
# Parameters
Name Type Description
type System.Type Type to retrieve attribute from
# Returns
Type Description
T

# Method IsSubclassOfRawGeneric(Type, Type)

Checks a type to see if it derives from a raw generic (e.g. List[[]])

# Syntax
public static bool IsSubclassOfRawGeneric(this Type toCheck, Type generic)
# Parameters
Name Type Description
toCheck System.Type
generic System.Type
# Returns
Type Description
bool

# Method FindEnumValue(Type, String, CultureInfo)

Find a value from a System.Enum by trying several possible variants of the string value of the enum.

# Syntax
public static object FindEnumValue(this Type type, string value, CultureInfo culture)
# Parameters
Name Type Description
type System.Type Type of enum
value string Value for which to search
culture System.Globalization.CultureInfo The culture used to calculate the name variants
# Returns
Type Description
object

# Class ResponseExtensions

# Inheritance

↳ object

# Syntax

public static class ResponseExtensions

# Method ToAsyncResponse<T>(IRestResponse)

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static IRestResponse<T> ToAsyncResponse<T>(this IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
RestSharp.IRestResponse<T>

# Class ResponseStatusExtensions

# Inheritance

↳ object

# Syntax

public static class ResponseStatusExtensions

# Method ToWebException(ResponseStatus)

# Syntax
public static WebException ToWebException(this ResponseStatus responseStatus)
# Parameters
Name Type Description
responseStatus RestSharp.ResponseStatus
# Returns
Type Description
WebException

# Class RSACryptoServiceProviderExtensions

# Inheritance

↳ object

# Syntax

public static class RSACryptoServiceProviderExtensions

# Method FromXmlString2(RSACryptoServiceProvider, String)

Imports the specified XML String into the crypto service provider

# Remarks

.NET Core 2.0 doesn't provide an implementation of RSACryptoServiceProvider.FromXmlString/ToXmlString, so we have to do it ourselves. Source: https://gist.github.com/Jargon64/5b172c452827e15b21882f1d76a94be4/

# Syntax
public static void FromXmlString2(this RSACryptoServiceProvider rsa, string xmlString)
# Parameters
Name Type Description
rsa RSACryptoServiceProvider
xmlString string

# Class StringExtensions

# Inheritance

↳ object

# Syntax

public static class StringExtensions

# Method UrlDecode(String)

# Syntax
public static string UrlDecode(this string input)
# Parameters
Name Type Description
input string
# Returns
Type Description
string

# Method UrlEncode(String)

Uses Uri.EscapeDataString() based on recommendations on MSDN http://blogs.msdn.com/b/yangxind/archive/2006/11/09/don-t-use-net-system-uri-unescapedatastring-in-url-decoding.aspx

# Syntax
public static string UrlEncode(this string input)
# Parameters
Name Type Description
input string
# Returns
Type Description
string

# Method UrlEncode(String, Encoding)

# Syntax
public static string UrlEncode(this string input, Encoding encoding)
# Parameters
Name Type Description
input string
encoding System.Text.Encoding
# Returns
Type Description
string

# Method HasValue(String)

Check that a string is not null or empty

# Syntax
public static bool HasValue(this string input)
# Parameters
Name Type Description
input string String to check
# Returns
Type Description
bool bool

# Method RemoveUnderscoresAndDashes(String)

Remove underscores from a string

# Syntax
public static string RemoveUnderscoresAndDashes(this string input)
# Parameters
Name Type Description
input string String to process
# Returns
Type Description
string string

# Method ParseJsonDate(String, CultureInfo)

Parses most common JSON date formats

# Syntax
public static DateTime ParseJsonDate(this string input, CultureInfo culture)
# Parameters
Name Type Description
input string JSON value to parse
culture System.Globalization.CultureInfo
# Returns
Type Description
System.DateTime DateTime

# Method ToPascalCase(String, CultureInfo)

Converts a string to pascal case

# Syntax
public static string ToPascalCase(this string lowercaseAndUnderscoredWord, CultureInfo culture)
# Parameters
Name Type Description
lowercaseAndUnderscoredWord string String to convert
culture System.Globalization.CultureInfo
# Returns
Type Description
string string

# Method ToPascalCase(String, Boolean, CultureInfo)

Converts a string to pascal case with the option to remove underscores

# Syntax
public static string ToPascalCase(this string text, bool removeUnderscores, CultureInfo culture)
# Parameters
Name Type Description
text string String to convert
removeUnderscores bool Option to remove underscores
culture System.Globalization.CultureInfo
# Returns
Type Description
string

# Method ToCamelCase(String, CultureInfo)

Converts a string to camel case

# Syntax
public static string ToCamelCase(this string lowercaseAndUnderscoredWord, CultureInfo culture)
# Parameters
Name Type Description
lowercaseAndUnderscoredWord string String to convert
culture System.Globalization.CultureInfo
# Returns
Type Description
string String

# Method MakeInitialLowerCase(String)

Convert the first letter of a string to lower case

# Syntax
public static string MakeInitialLowerCase(this string word)
# Parameters
Name Type Description
word string String to convert
# Returns
Type Description
string string

# Method AddUnderscores(String)

Add underscores to a pascal-cased string

# Syntax
public static string AddUnderscores(this string pascalCasedWord)
# Parameters
Name Type Description
pascalCasedWord string String to convert
# Returns
Type Description
string string

# Method AddDashes(String)

Add dashes to a pascal-cased string

# Syntax
public static string AddDashes(this string pascalCasedWord)
# Parameters
Name Type Description
pascalCasedWord string String to convert
# Returns
Type Description
string string

# Method AddUnderscorePrefix(String)

Add an underscore prefix to a pascal-cased string

# Syntax
public static string AddUnderscorePrefix(this string pascalCasedWord)
# Parameters
Name Type Description
pascalCasedWord string
# Returns
Type Description
string

# Method AddSpaces(String)

Add spaces to a pascal-cased string

# Syntax
public static string AddSpaces(this string pascalCasedWord)
# Parameters
Name Type Description
pascalCasedWord string String to convert
# Returns
Type Description
string string

# Method GetNameVariants(String, CultureInfo)

Return possible variants of a name for name matching.

# Syntax
public static IEnumerable<string> GetNameVariants(this string name, CultureInfo culture)
# Parameters
Name Type Description
name string String to convert
culture System.Globalization.CultureInfo The culture to use for conversion
# Returns
Type Description
System.Collections.Generic.IEnumerable<string> IEnumerable<string>

# Class WebRequestExtensions

# Inheritance

↳ object

# Syntax

public static class WebRequestExtensions

# Method GetRequestStreamAsync(WebRequest, CancellationToken)

# Syntax
public static Task<Stream> GetRequestStreamAsync(this WebRequest webRequest, CancellationToken cancellationToken)
# Parameters
Name Type Description
webRequest WebRequest
cancellationToken System.Threading.CancellationToken
# Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

# Method GetResponseAsync(WebRequest, CancellationToken)

# Syntax
public static Task<WebResponse> GetResponseAsync(this WebRequest webRequest, CancellationToken cancellationToken)
# Parameters
Name Type Description
webRequest WebRequest
cancellationToken System.Threading.CancellationToken
# Returns
Type Description
System.Threading.Tasks.Task<WebResponse>

# Class XmlExtensions

XML Extension Methods

# Inheritance

↳ object

# Syntax

public static class XmlExtensions

# Method AsNamespaced(String, String)

Returns the name of an element with the namespace if specified

# Syntax
public static XName AsNamespaced(this string name, string namespace)
# Parameters
Name Type Description
name string Element name
namespace string XML Namespace
# Returns
Type Description
XName

# Namespace: RestSharp.Serialization

# Class ContentType

# Inheritance

↳ object

# Syntax

public static class ContentType

# Field Json

# Syntax
public static string Json = "application/json"

# Field Xml

# Syntax
public static string Xml = "application/xml"

# Field FromDataFormat

# Syntax
public static Dictionary<DataFormat, string> FromDataFormat

# Field JsonAccept

# Syntax
public static string[] JsonAccept

# Field XmlAccept

# Syntax
public static string[] XmlAccept

# Interface IRestSerializer

# Syntax

public interface IRestSerializer : ISerializer, IDeserializer

# Property SupportedContentTypes

# Syntax
string[] SupportedContentTypes { get; }

# Property DataFormat

# Syntax
DataFormat DataFormat { get; }

# Method Serialize(Parameter)

# Syntax
string Serialize(Parameter parameter)
# Parameters
Name Type Description
parameter RestSharp.Parameter
# Returns
Type Description
string

# Interface IWithRootElement

# Syntax

public interface IWithRootElement

# Property RootElement

# Syntax
string RootElement { get; set; }

# Namespace: RestSharp.Serialization.Json

# Class JsonSerializer

# Inheritance

↳ object

# Syntax

public class JsonSerializer : IRestSerializer, ISerializer, IDeserializer, IWithRootElement

# Property DateFormat

# Syntax
public string DateFormat { get; set; }

# Property Culture

# Syntax
public CultureInfo Culture { get; set; }

# Method Serialize(Object)

Serialize the object as JSON If the object is already a serialized string returns it's value

# Syntax
public string Serialize(object obj)
# Parameters
Name Type Description
obj object Object to serialize
# Returns
Type Description
string JSON as String

# Property ContentType

Content type for serialized content

# Syntax
public string ContentType { get; set; }

# Property SupportedContentTypes

# Syntax
public string[] SupportedContentTypes { get; }

# Property DataFormat

# Syntax
public DataFormat DataFormat { get; }

# Method Serialize(Parameter)

# Syntax
public string Serialize(Parameter parameter)
# Parameters
Name Type Description
parameter RestSharp.Parameter
# Returns
Type Description
string

# Method Deserialize<T>(IRestResponse)

# Syntax
public T Deserialize<T>(IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
T

# Property RootElement

# Syntax
public string RootElement { get; set; }

# Class JsonDeserializer

# Inheritance

↳ object
  ↳ RestSharp.Serialization.Json.JsonSerializer

# Inherited members

  • RestSharp.Serialization.Json.JsonSerializer.DateFormat

# Syntax

public class JsonDeserializer : JsonSerializer, IRestSerializer, ISerializer, IDeserializer, IWithRootElement

# Namespace: RestSharp.Serialization.Xml

# Class DotNetXmlSerializerClientExtensions

# Inheritance

↳ object

# Syntax

public static class DotNetXmlSerializerClientExtensions

# Method UseDotNetXmlSerializer(IRestClient, String, Encoding)

# Syntax
public static IRestClient UseDotNetXmlSerializer(this IRestClient restClient, string xmlNamespace = null, Encoding encoding = null)
# Parameters
Name Type Description
restClient RestSharp.IRestClient
xmlNamespace string
encoding System.Text.Encoding
# Returns
Type Description
RestSharp.IRestClient

# Interface IXmlDeserializer

# Syntax

public interface IXmlDeserializer : IDeserializer, IWithRootElement

# Property Namespace

# Syntax
string Namespace { get; set; }

# Property DateFormat

# Syntax
string DateFormat { get; set; }

# Interface IXmlSerializer

# Syntax

public interface IXmlSerializer : ISerializer, IWithRootElement

# Property Namespace

# Syntax
string Namespace { get; set; }

# Property DateFormat

# Syntax
string DateFormat { get; set; }

# Class XmlAttributeDeserializer

# Inheritance

↳ object
  ↳ RestSharp.Deserializers.XmlDeserializer

# Syntax

public class XmlAttributeDeserializer : XmlDeserializer, IXmlDeserializer, IDeserializer, IWithRootElement

# Method GetValueFromXml(XElement, XName, PropertyInfo, Boolean)

# Syntax
protected override object GetValueFromXml(XElement root, XName name, PropertyInfo prop, bool useExactName)
# Parameters
Name Type Description
root XElement
name XName
prop System.Reflection.PropertyInfo
useExactName bool
# Returns
Type Description
object

# Class XmlRestSerializer

# Inheritance

↳ object

# Syntax

public class XmlRestSerializer : IRestSerializer, IXmlSerializer, ISerializer, IXmlDeserializer, IDeserializer, IWithRootElement

# Property SupportedContentTypes

# Syntax
public string[] SupportedContentTypes { get; }

# Property DataFormat

# Syntax
public DataFormat DataFormat { get; }

# Property ContentType

# Syntax
public string ContentType { get; set; }

# Method Serialize(Object)

# Syntax
public string Serialize(object obj)
# Parameters
Name Type Description
obj object
# Returns
Type Description
string

# Method Deserialize<T>(IRestResponse)

# Syntax
public T Deserialize<T>(IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
T

# Method Serialize(Parameter)

# Syntax
public string Serialize(Parameter parameter)
# Parameters
Name Type Description
parameter RestSharp.Parameter
# Returns
Type Description
string

# Property RootElement

# Syntax
public string RootElement { get; set; }

# Property Namespace

# Syntax
public string Namespace { get; set; }

# Property DateFormat

# Syntax
public string DateFormat { get; set; }

# Method WithOptions(XmlSerilizationOptions)

# Syntax
public XmlRestSerializer WithOptions(XmlSerilizationOptions options)
# Parameters
Name Type Description
options RestSharp.Serialization.Xml.XmlSerilizationOptions
# Returns
Type Description
RestSharp.Serialization.Xml.XmlRestSerializer

# Method WithXmlSerializer<T>(XmlSerilizationOptions)

# Syntax
public XmlRestSerializer WithXmlSerializer<T>(XmlSerilizationOptions options = null)
    where T : IXmlSerializer, new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
options RestSharp.Serialization.Xml.XmlSerilizationOptions
# Returns
Type Description
RestSharp.Serialization.Xml.XmlRestSerializer

# Method WithXmlSerializer(IXmlSerializer)

# Syntax
public XmlRestSerializer WithXmlSerializer(IXmlSerializer xmlSerializer)
# Parameters
Name Type Description
xmlSerializer RestSharp.Serialization.Xml.IXmlSerializer
# Returns
Type Description
RestSharp.Serialization.Xml.XmlRestSerializer

# Method WithXmlDeserialzier<T>(XmlSerilizationOptions)

# Syntax
public XmlRestSerializer WithXmlDeserialzier<T>(XmlSerilizationOptions options = null)
    where T : IXmlDeserializer, new()
# Generic parameters
Name Description
T
# Parameters
Name Type Description
options RestSharp.Serialization.Xml.XmlSerilizationOptions
# Returns
Type Description
RestSharp.Serialization.Xml.XmlRestSerializer

# Method WithXmlDeserializer(IXmlDeserializer)

# Syntax
public XmlRestSerializer WithXmlDeserializer(IXmlDeserializer xmlDeserializer)
# Parameters
Name Type Description
xmlDeserializer RestSharp.Serialization.Xml.IXmlDeserializer
# Returns
Type Description
RestSharp.Serialization.Xml.XmlRestSerializer

# Class XmlSerilizationOptions

# Inheritance

↳ object

# Syntax

public class XmlSerilizationOptions

# Property RootElement

Name of the root element to use when serializing

# Syntax
public string RootElement { get; set; }

# Property Namespace

XML namespace to use when serializing

# Syntax
public string Namespace { get; set; }

# Property DateFormat

Format string to use when serializing dates

# Syntax
public string DateFormat { get; set; }

# Property Culture

# Syntax
public CultureInfo Culture { get; set; }

# Property Default

# Syntax
public static XmlSerilizationOptions Default { get; }

# Namespace: RestSharp.Deserializers

# Class DeserializeAsAttribute

Allows control how class and property names and values are deserialized by XmlAttributeDeserializer

# Inheritance

↳ object
  ↳ System.Attribute

# Syntax

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property, Inherited = false)]
public sealed class DeserializeAsAttribute : Attribute

# Property Name

The name to use for the serialized element

# Syntax
public string Name { get; set; }

# Property Attribute

Sets if the property to Deserialize is an Attribute or Element (Default: false)

# Syntax
public bool Attribute { get; set; }

# Property Content

Sets if the property to Deserialize is a content of current Element (Default: false)

# Syntax
public bool Content { get; set; }

# Interface IDeserializer

# Syntax

public interface IDeserializer

# Method Deserialize<T>(IRestResponse)

# Syntax
T Deserialize<T>(IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
T

# Class DotNetXmlDeserializer

Wrapper for System.Xml.Serialization.XmlSerializer.

# Inheritance

↳ object

# Syntax

public class DotNetXmlDeserializer : IXmlDeserializer, IDeserializer, IWithRootElement

# Property Encoding

Encoding for serialized content

# Syntax
public Encoding Encoding { get; set; }

# Property RootElement

Name of the root element to use when serializing

# Syntax
public string RootElement { get; set; }

# Property Namespace

XML namespace to use when serializing

# Syntax
public string Namespace { get; set; }

# Property DateFormat

# Syntax
public string DateFormat { get; set; }

# Method Deserialize<T>(IRestResponse)

# Syntax
public T Deserialize<T>(IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
T

# Class XmlDeserializer

# Inheritance

↳ object

# Syntax

public class XmlDeserializer : IXmlDeserializer, IDeserializer, IWithRootElement

# Constructor XmlDeserializer()

# Syntax
public XmlDeserializer()

# Property Culture

# Syntax
public CultureInfo Culture { get; set; }

# Property RootElement

# Syntax
public string RootElement { get; set; }

# Property Namespace

# Syntax
public string Namespace { get; set; }

# Property DateFormat

# Syntax
public string DateFormat { get; set; }

# Method Deserialize<T>(IRestResponse)

# Syntax
public virtual T Deserialize<T>(IRestResponse response)
# Generic parameters
Name Description
T
# Parameters
Name Type Description
response RestSharp.IRestResponse
# Returns
Type Description
T

# Method Map(Object, XElement)

# Syntax
protected virtual object Map(object x, XElement root)
# Parameters
Name Type Description
x object
root XElement
# Returns
Type Description
object

# Method CreateAndMap(Type, XElement)

# Syntax
protected virtual object CreateAndMap(Type t, XElement element)
# Parameters
Name Type Description
t System.Type
element XElement
# Returns
Type Description
object

# Method GetValueFromXml(XElement, XName, PropertyInfo, Boolean)

# Syntax
protected virtual object GetValueFromXml(XElement root, XName name, PropertyInfo prop, bool useExactName)
# Parameters
Name Type Description
root XElement
name XName
prop System.Reflection.PropertyInfo
useExactName bool
# Returns
Type Description
object

# Method GetElementByName(XElement, XName)

# Syntax
protected virtual XElement GetElementByName(XElement root, XName name)
# Parameters
Name Type Description
root XElement
name XName
# Returns
Type Description
XElement

# Method GetAttributeByName(XElement, XName, Boolean)

# Syntax
protected virtual XAttribute GetAttributeByName(XElement root, XName name, bool useExactName)
# Parameters
Name Type Description
root XElement
name XName
useExactName bool
# Returns
Type Description
XAttribute

# Namespace: RestSharp.Serializers

# Interface ISerializer

# Syntax

public interface ISerializer

# Property ContentType

# Syntax
string ContentType { get; set; }

# Method Serialize(Object)

# Syntax
string Serialize(object obj)
# Parameters
Name Type Description
obj object
# Returns
Type Description
string

# Class SerializeAsAttribute

Allows control how class and property names and values are serialized by XmlSerializer Currently not supported with the JsonSerializer When specified at the property level the class-level specification is overridden

# Inheritance

↳ object
  ↳ System.Attribute

# Syntax

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property, Inherited = false)]
public sealed class SerializeAsAttribute : Attribute

# Constructor SerializeAsAttribute()

# Syntax
public SerializeAsAttribute()

# Property Name

The name to use for the serialized element

# Syntax
public string Name { get; set; }

# Property Attribute

Sets the value to be serialized as an Attribute instead of an Element

# Syntax
public bool Attribute { get; set; }

# Property Content

Sets the value to be serialized as text content of current Element instead of an new Element

# Syntax
public bool Content { get; set; }

# Property Culture

The culture to use when serializing

# Syntax
public CultureInfo Culture { get; set; }

# Property NameStyle

Transforms the casing of the name based on the selected value.

# Syntax
public NameStyle NameStyle { get; set; }

# Property Index

The order to serialize the element. Default is int.MaxValue.

# Syntax
public int Index { get; set; }

# Method TransformName(String)

Called by the attribute when NameStyle is speficied

# Syntax
public string TransformName(string input)
# Parameters
Name Type Description
input string The string to transform
# Returns
Type Description
string String

# Enum NameStyle

Options for transforming casing of element names

# Syntax

public enum NameStyle

# Fields

Name Description
AsIs
CamelCase
LowerCase
PascalCase

# Class DotNetXmlSerializer

Wrapper for System.Xml.Serialization.XmlSerializer.

# Inheritance

↳ object

# Syntax

public class DotNetXmlSerializer : IXmlSerializer, ISerializer, IWithRootElement

# Constructor DotNetXmlSerializer()

Default constructor, does not specify namespace

# Syntax
public DotNetXmlSerializer()

# Constructor DotNetXmlSerializer(String)

Specify the namespaced to be used when serializing

# Syntax
public DotNetXmlSerializer(string namespace)
# Parameters
Name Type Description
namespace string XML namespace

# Property Encoding

Encoding for serialized content

# Syntax
public Encoding Encoding { get; set; }

# Method Serialize(Object)

Serialize the object as XML

# Syntax
public string Serialize(object obj)
# Parameters
Name Type Description
obj object Object to serialize
# Returns
Type Description
string XML as string

# Property RootElement

Name of the root element to use when serializing

# Syntax
public string RootElement { get; set; }

# Property Namespace

XML namespace to use when serializing

# Syntax
public string Namespace { get; set; }

# Property DateFormat

Format string to use when serializing dates

# Syntax
public string DateFormat { get; set; }

# Property ContentType

Content type for serialized content

# Syntax
public string ContentType { get; set; }

# Class XmlSerializer

Default XML Serializer

# Inheritance

↳ object

# Syntax

public class XmlSerializer : IXmlSerializer, ISerializer, IWithRootElement

# Constructor XmlSerializer()

Default constructor, does not specify namespace

# Syntax
public XmlSerializer()

# Constructor XmlSerializer(String)

Specify the namespaced to be used when serializing

# Syntax
public XmlSerializer(string namespace)
# Parameters
Name Type Description
namespace string XML namespace

# Method Serialize(Object)

Serialize the object as XML

# Syntax
public string Serialize(object obj)
# Parameters
Name Type Description
obj object Object to serialize
# Returns
Type Description
string XML as string

# Property RootElement

Name of the root element to use when serializing

# Syntax
public string RootElement { get; set; }

# Property Namespace

XML namespace to use when serializing

# Syntax
public string Namespace { get; set; }

# Property DateFormat

Format string to use when serializing dates

# Syntax
public string DateFormat { get; set; }

# Property ContentType

Content type for serialized content

# Syntax
public string ContentType { get; set; }

# Namespace: RestSharp.Validation

# Class Ensure

# Inheritance

↳ object

# Syntax

public static class Ensure

# Method NotNull(Object, String)

# Syntax
public static void NotNull(object parameter, string name)
# Parameters
Name Type Description
parameter object
name string

# Method NotEmpty(String, String)

# Syntax
public static void NotEmpty(string parameter, string name)
# Parameters
Name Type Description
parameter string
name string

# Class Require

Helper methods for validating required values

# Inheritance

↳ object

# Syntax

public class Require

# Method Argument(String, Object)

Require a parameter to not be null

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static void Argument(string argumentName, object argumentValue)
# Parameters
Name Type Description
argumentName string Name of the parameter
argumentValue object Value of the parameter

# Class Validate

Helper methods for validating values

# Inheritance

↳ object

# Syntax

public class Validate

# Method IsBetween(Int32, Int32, Int32)

Validate an integer value is between the specified values (exclusive of min/max)

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static void IsBetween(int value, int min, int max)
# Parameters
Name Type Description
value int Value to validate
min int Exclusive minimum value
max int Exclusive maximum value

# Method IsValidLength(String, Int32)

Validate a string length

# Syntax
[Obsolete("This method will be removed soon. If you use it, please copy the code to your project.")]
public static void IsValidLength(string value, int maxSize)
# Parameters
Name Type Description
value string String to be validated
maxSize int Maximum length of the string

← RestSharp.Serializers.NewtonsoftJson →