Table of Contents

Class HttpApiRequest

Namespace: Casewhere.Runtime.DSL.Api
Assembly: Casewhere.Runtime.dll

Support the methods to create HttpApiRequests like HttpApiGetRequest

public abstract class HttpApiRequest

Inheritance

objectHttpApiRequest

Derived

HttpApiGetRequest

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Extension Methods

ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<HttpApiRequest>(HttpApiRequest)

Constructors

HttpApiRequest()

protected HttpApiRequest()

Properties

AdditionalHeaders

Additional headers if any

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

Property Value

IDictionary<string, string>

Timeout

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

Url

An request url

public string Url { get; set; }

Property Value

string

Methods

CreateGetRequest(string)

Create a GET request with a given url.

public static HttpApiGetRequest CreateGetRequest(string url)

Parameters

url string

A given url

Returns

HttpApiGetRequest

Return ![CDATA[HttpApiGetRequest]]

CreateGetRequest(string, IDictionary<string, string>)

Create a GET request with a given url and url parameters

public static HttpApiGetRequest CreateGetRequest(string url, IDictionary<string, string> urlParameters)

Parameters

url string

A give url

urlParameters IDictionary<string, string>

Url parameters

Returns

HttpApiGetRequest

Return ![CDATA[HttpApiGetRequest]]

CreateGetRequest(string, IDictionary<string, string>, IDictionary<string, string>)

Create a GET request with a given url, url parameters, and additional headers

public static HttpApiGetRequest CreateGetRequest(string url, IDictionary<string, string> urlParameters, IDictionary<string, string> additionalHeaders)

Parameters

url string

A give url

urlParameters IDictionary<string, string>

Url parameters

additionalHeaders IDictionary<string, string>

Additional headers

Returns

HttpApiGetRequest

Return ![CDATA[HttpApiGetRequest]]

Validate()

public virtual void Validate()