POST api/OmsMissingStorefrontOrderCheck
Request Information
URI Parameters
None.
Body Parameters
MissingStorefrontOrderCheckModel
| Name | Description | Type | Additional 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. |
| JobCodeList |
Decides if a SQL transaction should be used for the process. |
Collection of string |
None. |
| ConfigValues | Dictionary of string [key] and string [value] |
None. |
|
| WorkerName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteCode": "sample string 1",
"VerificationKey": "sample string 2",
"TimestampUTC": "sample string 3",
"APIUsername": "sample string 4",
"JobCodeList": [
"sample string 1",
"sample string 2"
],
"ConfigValues": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"WorkerName": "sample string 5"
}
application/xml, text/xml
Sample:
<OmsMissingStorefrontOrderCheckController.MissingStorefrontOrderCheckModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.WebApi.Controllers.OMS">
<APIUsername>sample string 4</APIUsername>
<ConfigValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</ConfigValues>
<JobCodeList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</JobCodeList>
<SiteCode>sample string 1</SiteCode>
<TimestampUTC>sample string 3</TimestampUTC>
<VerificationKey>sample string 2</VerificationKey>
<WorkerName>sample string 5</WorkerName>
</OmsMissingStorefrontOrderCheckController.MissingStorefrontOrderCheckModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseCode | APIResponseCodes |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 0,
"Message": "sample string 1"
}
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"> <Message>sample string 1</Message> <ResponseCode>Success</ResponseCode> </GenericResponse>