POST api/TDClose

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Key		string	None.
TrackingNumbers		Collection of string	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<TDCloseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Iparcel.TradeDirect.Models">
  <Key>sample string 1</Key>
  <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>
</TDCloseRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TDCloseResponse

Name	Type	Additional information
ResponseCode	TDResponseCode	None.
ResponseDescription	string	None.
TotalParcelCount	integer	None.
EndOfDayCounts	Collection of CloseCount	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "ResponseDescription": "sample string 1",
  "TotalParcelCount": 2,
  "EndOfDayCounts": [
    {
      "Port": "sample string 1",
      "Service": "sample string 2",
      "EndOfDayParcelCount": 3,
      "TrackingNumbers": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Port": "sample string 1",
      "Service": "sample string 2",
      "EndOfDayParcelCount": 3,
      "TrackingNumbers": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<TDCloseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Iparcel.TradeDirect.Models">
  <EndOfDayCounts>
    <CloseCount>
      <EndOfDayParcelCount>3</EndOfDayParcelCount>
      <Port>sample string 1</Port>
      <Service>sample string 2</Service>
      <TrackingNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TrackingNumbers>
    </CloseCount>
    <CloseCount>
      <EndOfDayParcelCount>3</EndOfDayParcelCount>
      <Port>sample string 1</Port>
      <Service>sample string 2</Service>
      <TrackingNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TrackingNumbers>
    </CloseCount>
  </EndOfDayCounts>
  <ResponseCode>Ok</ResponseCode>
  <ResponseDescription>sample string 1</ResponseDescription>
  <TotalParcelCount>2</TotalParcelCount>
</TDCloseResponse>