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

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional information
DriverIdentifier

globally unique identifier

None.

DistanceKm

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "driverIdentifier": "d79691fe-73a4-40f9-a0ee-adfd58524689",
    "distanceKm": 2.1
  },
  {
    "driverIdentifier": "d79691fe-73a4-40f9-a0ee-adfd58524689",
    "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>d79691fe-73a4-40f9-a0ee-adfd58524689</DriverIdentifier>
  </DriverProximityModel>
  <DriverProximityModel>
    <DistanceKm>2.1</DistanceKm>
    <DriverIdentifier>d79691fe-73a4-40f9-a0ee-adfd58524689</DriverIdentifier>
  </DriverProximityModel>
</ArrayOfDriverProximityModel>