Class RequestModel

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

Configuration for a request

public class RequestModel

Inheritance

object

RequestModel

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Description

Optional description of the request

[JsonProperty("Description", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[StringLength(4096)]
public string Description { get; set; }

Property Value

string

Headers

Collection of headers used when posting the request

[JsonProperty("Headers", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<RequestHeaderModel> Headers { get; set; }

Property Value

ICollection<RequestHeaderModel>

HelpUri

Optional help URI towards extensive documentation for the request

[JsonProperty("HelpUri", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[StringLength(1024)]
public string HelpUri { get; set; }

Property Value

string

Id

The id of the request

[JsonProperty("Id", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public int Id { get; set; }

Property Value

int

Name

Name of the request used in the *REQUEST command

[JsonProperty("Name", Required = Required.Always)]
[Required]
[StringLength(16, MinimumLength = 1)]
public string Name { get; set; }

Property Value

string

PayloadTemplate

The template of the payload

[JsonProperty("PayloadTemplate", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string PayloadTemplate { get; set; }

Property Value

string

RequestHttpMethod

The method of the request

[JsonProperty("RequestHttpMethod", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public RequestHttpMethod RequestHttpMethod { get; set; }

Property Value

RequestHttpMethod

Uri

Endpoint (URI) of the request

[JsonProperty("Uri", Required = Required.Always)]
[Required]
[StringLength(1024, MinimumLength = 1)]
public string Uri { get; set; }

Property Value

string