Help Page Home

GET api/public/v2/driverProximity?ApiKey={ApiKey}&Latitude={Latitude}&Longitude={Longitude}

Request Information

URI Parameters

Name	Description	Type	Additional information
ApiKey	Your merchant API key	globally unique identifier	Required
Latitude		decimal number	None.
Longitude		decimal number	None.

Body Parameters

None.

Response Information

Resource Description

Collection of DriverProximityModel

Name	Description	Type	Additional information
DriverIdentifier		globally unique identifier	None.
DistanceKm		decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "driverIdentifier": "cf7a8fc5-b96c-45ac-a764-ef11546b9ec6",
    "distanceKm": 2.1
  },
  {
    "driverIdentifier": "cf7a8fc5-b96c-45ac-a764-ef11546b9ec6",
    "distanceKm": 2.1
  }
]

text/xml

Sample:

<ArrayOfDriverProximityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2">
  <DriverProximityModel>
    <DistanceKm>2.1</DistanceKm>
    <DriverIdentifier>cf7a8fc5-b96c-45ac-a764-ef11546b9ec6</DriverIdentifier>
  </DriverProximityModel>
  <DriverProximityModel>
    <DistanceKm>2.1</DistanceKm>
    <DriverIdentifier>cf7a8fc5-b96c-45ac-a764-ef11546b9ec6</DriverIdentifier>
  </DriverProximityModel>
</ArrayOfDriverProximityModel>