POST api/OmsApiHistory/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderNumber	string	Required
ReportStartDate	date	Required
ReportEndDate	date	Required
ArchivePathTypeId	ArchivePathType	Required
SiteId	integer	Required
Locale	string	Required

Request Formats

application/json, text/json

Sample:

{
  "OrderNumber": "sample string 1",
  "ReportStartDate": "2025-12-20T20:12:00.3645324+00:00",
  "ReportEndDate": "2025-12-20T20:12:00.3645324+00:00",
  "ArchivePathTypeId": 0,
  "SiteId": 4,
  "Locale": "sample string 5"
}

application/xml, text/xml

Sample:

<ApiHistorySearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
  <ArchivePathTypeId>All</ArchivePathTypeId>
  <Locale>sample string 5</Locale>
  <OrderNumber>sample string 1</OrderNumber>
  <ReportEndDate>2025-12-20T20:12:00.3645324+00:00</ReportEndDate>
  <ReportStartDate>2025-12-20T20:12:00.3645324+00:00</ReportStartDate>
  <SiteId>4</SiteId>
</ApiHistorySearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiHistoryPathResponse

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

Response Formats

application/json, text/json

Sample:

{
  "ArchivePaths": null,
  "ErrorMessages": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<ApiHistoryPathResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <ArchivePaths xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <CorrelationId>sample string 2</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>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</ApiHistoryPathResponse>