POST api/MailTracking/GetFirstClassTrackingDetails

Gets all tracking details for a given list of DocumentIds.

Request Information

URI Parameters

None.

Body Parameters

GetFirstClassTrackingDetailsRequestModel

Name	Type	Additional information
UserId	integer	None.
AuthToken	string	None.
TrackingNumbers	Collection of string	Required

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

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 IMB tracking details for the provided list of tracking numbers

GetFirstClassTrackingDetailsListResponseModel

Name	Description	Type	Additional information
FirstClassDetails		Collection of GetFirstClassTrackingDetailsResponseModel	None.
ErrorDetails		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "FirstClassDetails": [
    {
      "TrackingNumber": "sample string 1",
      "ClientId": 2,
      "AccountNumber": "sample string 3",
      "ScanCode": "sample string 4",
      "ScanTimestamp": "sample string 5",
      "ScanZipCode": "sample string 6"
    },
    {
      "TrackingNumber": "sample string 1",
      "ClientId": 2,
      "AccountNumber": "sample string 3",
      "ScanCode": "sample string 4",
      "ScanTimestamp": "sample string 5",
      "ScanZipCode": "sample string 6"
    }
  ],
  "ErrorDetails": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetFirstClassTrackingDetailsListResponseModel 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>
  <FirstClassDetails>
    <GetFirstClassTrackingDetailsResponseModel>
      <AccountNumber>sample string 3</AccountNumber>
      <ClientId>2</ClientId>
      <ScanCode>sample string 4</ScanCode>
      <ScanTimestamp>sample string 5</ScanTimestamp>
      <ScanZipCode>sample string 6</ScanZipCode>
      <TrackingNumber>sample string 1</TrackingNumber>
    </GetFirstClassTrackingDetailsResponseModel>
    <GetFirstClassTrackingDetailsResponseModel>
      <AccountNumber>sample string 3</AccountNumber>
      <ClientId>2</ClientId>
      <ScanCode>sample string 4</ScanCode>
      <ScanTimestamp>sample string 5</ScanTimestamp>
      <ScanZipCode>sample string 6</ScanZipCode>
      <TrackingNumber>sample string 1</TrackingNumber>
    </GetFirstClassTrackingDetailsResponseModel>
  </FirstClassDetails>
</GetFirstClassTrackingDetailsListResponseModel>