POST api/OmsApiHistory/file

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
PathId	integer	Required
Hash	string	Required
OrderNumber	string	Required
Locale	string	Required
ReportStartDate	string	Required
ReportEndDate	string	Required

Request Formats

application/json, text/json

Sample:

{
  "PathId": 1,
  "Hash": "sample string 2",
  "OrderNumber": "sample string 3",
  "Locale": "sample string 4",
  "ReportStartDate": "sample string 5",
  "ReportEndDate": "sample string 6"
}

application/xml, text/xml

Sample:

<ApiHistoryFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
  <Hash>sample string 2</Hash>
  <Locale>sample string 4</Locale>
  <OrderNumber>sample string 3</OrderNumber>
  <PathId>1</PathId>
  <ReportEndDate>sample string 6</ReportEndDate>
  <ReportStartDate>sample string 5</ReportStartDate>
</ApiHistoryFileRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiHistoryFileResponse

Name	Type	Additional Information
ErrorMessages	Dictionary of string [key] and string [value]	None.
Content	Collection of byte	None.
FileName	string	None.
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessages": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Content": "QEA=",
  "FileName": "sample string 1",
  "ResponseCode": 0,
  "Message": "sample string 2",
  "CorrelationId": "sample string 3"
}

application/xml, text/xml

Sample:

<ApiHistoryFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <Content>QEA=</Content>
  <CorrelationId>sample string 3</CorrelationId>
  <ErrorMessages 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>
  </ErrorMessages>
  <FileName>sample string 1</FileName>
  <Message>sample string 2</Message>
  <ResponseCode>Success</ResponseCode>
</ApiHistoryFileResponse>