POST api/MailTracking/GetCertifiedTrackingDetailsByOrder

Gets all tracking details for a given list of order numbers.

Request Information

URI Parameters

None.

Body Parameters

GetCertifiedTrackingDetailsByOrderRequestModel

Name	Description	Type	Additional information
UserId		integer	None.
AuthToken		string	None.
OrderIdList	The Order IDs that will be used to search for tracking details. OrderIdList is required and must be a positive number.	Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "AuthToken": "sample string 2",
  "OrderIdList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<GetCertifiedTrackingDetailsByOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <OrderIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderIdList>
  <UserId>1</UserId>
</GetCertifiedTrackingDetailsByOrderRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model containing certified tracking details for the list of orders

GetCertifiedTrackingDetailsListResponseModel

Name	Description	Type	Additional information
MailTrackingDetails		Collection of GetCertifiedTrackingDetailsResponseModel	None.
ErrorDetails		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "MailTrackingDetails": [
    {
      "ClientId": 1,
      "OrderId": 2,
      "AccountNumber": "sample string 3",
      "ReceiptNumber": "sample string 4",
      "ScanFacility": "sample string 5",
      "EventDate": "sample string 6",
      "EventTime": "sample string 7",
      "EventName": "sample string 8"
    },
    {
      "ClientId": 1,
      "OrderId": 2,
      "AccountNumber": "sample string 3",
      "ReceiptNumber": "sample string 4",
      "ScanFacility": "sample string 5",
      "EventDate": "sample string 6",
      "EventTime": "sample string 7",
      "EventName": "sample string 8"
    }
  ],
  "ErrorDetails": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetCertifiedTrackingDetailsListResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <ErrorDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorDetails>
  <MailTrackingDetails>
    <GetCertifiedTrackingDetailsResponseModel>
      <AccountNumber>sample string 3</AccountNumber>
      <ClientId>1</ClientId>
      <EventDate>sample string 6</EventDate>
      <EventName>sample string 8</EventName>
      <EventTime>sample string 7</EventTime>
      <OrderId>2</OrderId>
      <ReceiptNumber>sample string 4</ReceiptNumber>
      <ScanFacility>sample string 5</ScanFacility>
    </GetCertifiedTrackingDetailsResponseModel>
    <GetCertifiedTrackingDetailsResponseModel>
      <AccountNumber>sample string 3</AccountNumber>
      <ClientId>1</ClientId>
      <EventDate>sample string 6</EventDate>
      <EventName>sample string 8</EventName>
      <EventTime>sample string 7</EventTime>
      <OrderId>2</OrderId>
      <ReceiptNumber>sample string 4</ReceiptNumber>
      <ScanFacility>sample string 5</ScanFacility>
    </GetCertifiedTrackingDetailsResponseModel>
  </MailTrackingDetails>
</GetCertifiedTrackingDetailsListResponseModel>