POST api/Dispatch/ValidateDispatchCodeByUID

Validate Dispatch Code By UID

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
Code	string	Required
UserId	integer	Required
VerificationType	integer	None.
DeviceCode	string	None.
SiesaSalesOrderNumber	string	None.
SiesaSOID	integer	None.
TotalItemFound	integer	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "apiKey": "sample string 1",
  "code": "sample string 2",
  "userId": 3,
  "verificationType": 4,
  "deviceCode": "sample string 5",
  "siesaSalesOrderNumber": "sample string 6",
  "siesaSOID": 1,
  "totalItemFound": 1
}

application/xml, text/xml

Sample:

<ValidateDispatchCodeRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <APIKey>sample string 1</APIKey>
  <Code>sample string 2</Code>
  <DeviceCode>sample string 5</DeviceCode>
  <SiesaSOID>1</SiesaSOID>
  <SiesaSalesOrderNumber>sample string 6</SiesaSalesOrderNumber>
  <TotalItemFound>1</TotalItemFound>
  <UserId>3</UserId>
  <VerificationType>4</VerificationType>
</ValidateDispatchCodeRequestModel>

multipart/form-data

Sample:

<ValidateDispatchCodeRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><APIKey>sample string 1</APIKey><Code>sample string 2</Code><DeviceCode>sample string 5</DeviceCode><SiesaSOID>1</SiesaSOID><SiesaSalesOrderNumber>sample string 6</SiesaSalesOrderNumber><TotalItemFound>1</TotalItemFound><UserId>3</UserId><VerificationType>4</VerificationType></ValidateDispatchCodeRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>