POST api/Custom

Request Information

URI Parameters

None.

Body Parameters

CustomModel

NameDescriptionTypeAdditional Information
SiteCode

Site Code

 string

None.
VerificationKey

Verification Key

 string

None.
TimestampUTC

Current Time in UTC format

 string

None.
APIUsername

Use it to get the API key from user table to verify the verification key (optional)

 string

None.
CustomPlugin

Decides if a SQL transaction should be used for the process.

 string

None.
Command

String to start the custom code.

 string

None.
StartupValues

Custom values to start the custom code.

 Object

None.

Request Formats

application/json, text/json

Sample: 
{
  "SiteCode": "sample string 1",
  "VerificationKey": "sample string 2",
  "TimestampUTC": "sample string 3",
  "APIUsername": "sample string 4",
  "CustomPlugin": "sample string 5",
  "Command": "sample string 6",
  "StartupValues": {}
}

application/xml, text/xml

Sample: 
<CustomModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.WebApi.Controllers">
  <APIUsername>sample string 4</APIUsername>
  <Command>sample string 6</Command>
  <CustomPlugin>sample string 5</CustomPlugin>
  <SiteCode>sample string 1</SiteCode>
  <StartupValues />
  <TimestampUTC>sample string 3</TimestampUTC>
  <VerificationKey>sample string 2</VerificationKey>
</CustomModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.
Message

string

None.
CorrelationId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample: 
<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>