POST api/GetOrderIdByOrderNumber

This API is meant primarily for testing and setting up and tearing down. Hiding this API in release, and not allowing it to run in release.

Request Information

URI Parameters

None.

Body Parameters

OrderIdByOrderNumberRequest

Name	Type	Additional Information
OrderNumber	string	None.
SiteCode	string	None.
VerificationKey	string	None.
TimestampUTC	string	None.
APIUsername	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderNumber": "sample string 1",
  "SiteCode": "sample string 2",
  "VerificationKey": "sample string 3",
  "TimestampUTC": "sample string 4",
  "APIUsername": "sample string 5"
}

application/xml, text/xml

Sample:

<OrderIdByOrderNumberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <APIUsername>sample string 5</APIUsername>
  <OrderNumber>sample string 1</OrderNumber>
  <SiteCode>sample string 2</SiteCode>
  <TimestampUTC>sample string 4</TimestampUTC>
  <VerificationKey>sample string 3</VerificationKey>
</OrderIdByOrderNumberRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

Name	Type	Additional 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>