POST api/Tracking/Track
Action to get the data of a package according to an object request Object that contain properties to request the API
Request Information
URI Parameters
None.
Body Parameters
WebScrapRequestModelName | Description | Type | Additional information |
---|---|---|---|
LanguageCodeIso | string |
Required |
|
ShipmentNumber | string |
Required |
|
Token | string |
Required |
|
ShipperCode | string |
Required |
Request Formats
application/json, text/json
Sample:
{ "LanguageCodeIso": "sample string 1", "ShipmentNumber": "sample string 2", "Token": "sample string 3", "ShipperCode": "sample string 4" }
application/xml, text/xml
Sample:
<WebScrapRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dds.Join2Ship.WS.Api.Models"> <LanguageCodeIso>sample string 1</LanguageCodeIso> <ShipmentNumber>sample string 2</ShipmentNumber> <ShipperCode>sample string 4</ShipperCode> <Token>sample string 3</Token> </WebScrapRequestModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Return an Tracing Response with an collection of details line and an header if the shipper has one
WebScrapResponseName | Description | Type | Additional information |
---|---|---|---|
IsError | boolean |
None. |
|
ErrorCode | integer |
None. |
|
ErrorMessage | string |
None. |
|
Header | ShipWSHeader |
None. |
|
DetailsLines | Collection of ShipWSDetailsLine |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsError": true, "ErrorCode": 2, "ErrorMessage": "sample string 3", "Header": {}, "DetailsLines": [ { "ShipWSDate": "sample string 1", "ShipWSTime": "sample string 2", "ShipWSDescription": "sample string 3", "ShipWSLocalization": "sample string 4" }, { "ShipWSDate": "sample string 1", "ShipWSTime": "sample string 2", "ShipWSDescription": "sample string 3", "ShipWSLocalization": "sample string 4" } ] }
application/xml, text/xml
Sample:
<WebScrapResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dds.Join2Ship.Entities.WebScrap"> <DetailsLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/Dds.Join2Ship.Entities.WebScrap.Core"> <d2p1:ShipWSDetailsLine> <d2p1:ShipWSDate>sample string 1</d2p1:ShipWSDate> <d2p1:ShipWSDescription>sample string 3</d2p1:ShipWSDescription> <d2p1:ShipWSLocalization>sample string 4</d2p1:ShipWSLocalization> <d2p1:ShipWSTime>sample string 2</d2p1:ShipWSTime> </d2p1:ShipWSDetailsLine> <d2p1:ShipWSDetailsLine> <d2p1:ShipWSDate>sample string 1</d2p1:ShipWSDate> <d2p1:ShipWSDescription>sample string 3</d2p1:ShipWSDescription> <d2p1:ShipWSLocalization>sample string 4</d2p1:ShipWSLocalization> <d2p1:ShipWSTime>sample string 2</d2p1:ShipWSTime> </d2p1:ShipWSDetailsLine> </DetailsLines> <ErrorCode>2</ErrorCode> <ErrorMessage>sample string 3</ErrorMessage> <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/Dds.Join2Ship.Entities.WebScrap.Core" /> <IsError>true</IsError> </WebScrapResponse>