GET api/Shipper/GetGeoLocation/{UserGUID}/{ShipmentGUID}
Use this method to get the current Geo Location of a shipment
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique system generated user identifier |
string |
Required |
| ShipmentGUID |
Unique system generated shipment identifier |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
GetGeoLocationResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
| ErrorMessage |
The error message if method call was not successful |
string |
None. |
| ShipmentNumber | string |
None. |
|
| ShipmentGUID | string |
None. |
|
| Latitude | string |
None. |
|
| Longitude | string |
None. |
|
| EstimatedDeliveryDateTime | string |
None. |
|
| PushPinType | string |
None. |
|
| DisplayDateTime | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"ShipmentNumber": "sample string 3",
"ShipmentGUID": "sample string 4",
"Latitude": "sample string 5",
"Longitude": "sample string 6",
"EstimatedDeliveryDateTime": "sample string 7",
"PushPinType": "sample string 8",
"DisplayDateTime": "sample string 9"
}
application/xml, text/xml
Sample:
<GetGeoLocationResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models"> <DisplayDateTime>sample string 9</DisplayDateTime> <ErrorMessage>sample string 2</ErrorMessage> <EstimatedDeliveryDateTime>sample string 7</EstimatedDeliveryDateTime> <IsSuccessful>true</IsSuccessful> <Latitude>sample string 5</Latitude> <Longitude>sample string 6</Longitude> <PushPinType>sample string 8</PushPinType> <ShipmentGUID>sample string 4</ShipmentGUID> <ShipmentNumber>sample string 3</ShipmentNumber> </GetGeoLocationResp>