Class Request<TRequestData, TResponseData>

Request is base class for all requests

Inheritance

System.Object

RequestDefaults

Request<TRequestData, TResponseData>

DeleteRequest<TRequestData, TResponseData>

GetRequest<TRequestData, TResponseData>

PostRequest<TRequestData, TResponseData>

PutRequest<TRequestData, TResponseData>

Inherited Members

RequestDefaults.DefaultBaseUrl

RequestDefaults.DefaultAuthToken

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: KuberWMS.API

Assembly: KuberWMS.dll

Syntax

public abstract class Request<TRequestData, TResponseData> : RequestDefaults

Type Parameters

Name	Description
TRequestData	The type of the request data.
TResponseData	The type of the response data.

Constructors

Request()

Initializes a new instance of the Request<TRequestData, TResponseData> class.

Declaration

public Request()

Properties

AuthToken

Gets or sets the authentication token.

Declaration

public string AuthToken { get; set; }

Property Value

Type	Description
System.String	The authentication token.

BaseUrl

Gets or sets the base URL.

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
System.String	The base URL.

Body

Gets or sets the body.

Declaration

public TRequestData Body { get; set; }

Property Value

Type	Description
TRequestData	The body.

BodyParams

Gets or sets the body parameters.

Declaration

public IDictionary<string, string> BodyParams { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>	The body parameters.

FilePaths

Gets or sets the file paths.

Declaration

public List<string> FilePaths { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	The file paths.

Headers

Gets or sets the headers.

Declaration

public IDictionary<string, string> Headers { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>	The headers.

IsAuthRequired

Gets or sets a value indicating whether this instance is authentication required.

Declaration

public bool IsAuthRequired { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is authentication required; otherwise, false.

Method

Gets or sets the method.

Declaration

public Method Method { get; set; }

Property Value

Type	Description
RestSharp.Method	The method.

PathParams

Gets or sets the path parameters.

Declaration

public IDictionary<string, string> PathParams { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>	The path parameters.

QueryParams

Gets or sets the query parameters.

Declaration

public IDictionary<string, string> QueryParams { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>	The query parameters.

ServiceUrl

Gets or sets the service URL.

Declaration

public string ServiceUrl { get; set; }

Property Value

Type	Description
System.String	The service URL.

Methods

AddHeader(String, String)

Adds the header.

Declaration

protected void AddHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	value	The value.

Execute(TRequestData)

Executes the specified request data.

Declaration

public Response<TRequestData, TResponseData> Execute(TRequestData requestData)

Parameters

Type	Name	Description
TRequestData	requestData	The request data.

Returns

Type	Description
Response<TRequestData, TResponseData>

GetBodyParam(String)

Gets the path parameter.

Declaration

protected string GetBodyParam(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Returns

Type	Description
System.String

GetPathParam(String)

Gets the path parameter.

Declaration

protected string GetPathParam(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Returns

Type	Description
System.String

GetResponse(IRestResponse)

Gets the response.

Declaration

protected virtual Response<TRequestData, TResponseData> GetResponse(IRestResponse restResponse)

Parameters

Type	Name	Description
RestSharp.IRestResponse	restResponse	The rest response.

Returns

Type	Description
Response<TRequestData, TResponseData>

SetBodyParam(String, String)

Sets the path parameter.

Declaration

protected void SetBodyParam(string key, string value)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	value	The value.

SetPathParam(String, String)

Sets the path parameter.

Declaration

protected void SetPathParam(string key, string value)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	value	The value.

See Also

RequestDefaults