POST api/TrackingRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserCredential	UserCredential	Required
ClientDetails	ClientDetails	Required
VersionDetails	VersionDetails	Required
TrackingDetails	TrackingDetails	Required

Request Formats

application/json, text/json

Sample:

{
  "UserCredential": {
    "UserKey": "sample string 1",
    "UserPassword": "sample string 2",
    "UserPIN": "sample string 3"
  },
  "ClientDetails": {
    "AccountNumber": "sample string 1"
  },
  "VersionDetails": {
    "RequestType": "sample string 1",
    "VersionMinor": 2,
    "VersionMajor": 3
  },
  "TrackingDetails": {
    "ReferenceNumber": [
      1,
      2
    ]
  }
}

application/xml, text/xml

Sample:

<TrackingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ClientDetails>
    <AccountNumber>sample string 1</AccountNumber>
  </ClientDetails>
  <TrackingDetails>
    <ReferenceNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </ReferenceNumber>
  </TrackingDetails>
  <UserCredential>
    <UserKey>sample string 1</UserKey>
    <UserPIN>sample string 3</UserPIN>
    <UserPassword>sample string 2</UserPassword>
  </UserCredential>
  <VersionDetails>
    <RequestType>sample string 1</RequestType>
    <VersionMajor>3</VersionMajor>
    <VersionMinor>2</VersionMinor>
  </VersionDetails>
</TrackingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TrackingResponse

Name	Description	Type	Additional information
ResponseStatus		TrackingResponseStatus	None.
ResponseTrackingDetails		Collection of ResponseTrackingDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseStatus": {
    "Status": "sample string 1",
    "StatusDetails": "sample string 2",
    "RecordCount": 3
  },
  "ResponseTrackingDetails": [
    {
      "TrackingReference": "sample string 1",
      "TrackingRecordId": 2,
      "TrackingDate": "sample string 3",
      "TrackingStatus": "sample string 4",
      "TrackingDetails": "sample string 5",
      "TrackingCheckPoint": "sample string 6"
    },
    {
      "TrackingReference": "sample string 1",
      "TrackingRecordId": 2,
      "TrackingDate": "sample string 3",
      "TrackingStatus": "sample string 4",
      "TrackingDetails": "sample string 5",
      "TrackingCheckPoint": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<TrackingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ResponseStatus>
    <RecordCount>3</RecordCount>
    <Status>sample string 1</Status>
    <StatusDetails>sample string 2</StatusDetails>
  </ResponseStatus>
  <ResponseTrackingDetails>
    <ResponseTrackingDetails>
      <TrackingCheckPoint>sample string 6</TrackingCheckPoint>
      <TrackingDate>sample string 3</TrackingDate>
      <TrackingDetails>sample string 5</TrackingDetails>
      <TrackingRecordId>2</TrackingRecordId>
      <TrackingReference>sample string 1</TrackingReference>
      <TrackingStatus>sample string 4</TrackingStatus>
    </ResponseTrackingDetails>
    <ResponseTrackingDetails>
      <TrackingCheckPoint>sample string 6</TrackingCheckPoint>
      <TrackingDate>sample string 3</TrackingDate>
      <TrackingDetails>sample string 5</TrackingDetails>
      <TrackingRecordId>2</TrackingRecordId>
      <TrackingReference>sample string 1</TrackingReference>
      <TrackingStatus>sample string 4</TrackingStatus>
    </ResponseTrackingDetails>
  </ResponseTrackingDetails>
</TrackingResponse>