GET api/Vendor/Ping/{UserGUID}/{LocationData}

Get updated geolocation and check for new alert

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UserGUID

string

Required
LocationData

string

None.

Body Parameters

None.

Response Information

Resource Description

PingResponse
NameDescriptionTypeAdditional information
NotificationMsg

Set if a notification message to appear to the courier (new pickup, etc)

 string

None.
IsSuccessful

Used to determine if method call was successful (true) or failure (false)

 boolean

Required
ErrorMessage

The error message if method call was not successful

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "NotificationMsg": "sample string 1",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample: 
<PingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 3</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <NotificationMsg>sample string 1</NotificationMsg>
</PingResponse>