Visits to coordinates

/v2/areas/visitsToCoordinates

Starts an operation of searching for visits of the vehicles of a fleet to a circle defined by a central coordinate and a radius arround it, during a specified period.

This search is time and resource consuming so, it is done asynchronously; this means that the endpoint will return imediately - probably before the calculation is completed.

This endpoint returns a token (requestId) that must be used as parameter of the endpoint Visits To Coordinates Result to get the results.
to check if the requested search was already completed and what is it's result.

Requests with more than 7 days are not calculated - they will be assumed as completed but the search is not really made. It is the responsibility of the caller to have this condition in mind.

Parameters

latitude

The latitude of the coordinate of the center of the circle where to search for vehicles visits. decimal yes

longitude

The longitude of the coordinate of the center of the circle where to search for vehicles visits. decimal yes

radius

The radius arround the point defined with the latitude and longitude where to look for vehicles coordinates.
The radius is specified in Kilometers. decimal yes

from

The begining of the interval when to search for visits to the defined area.
yes

to

The ending of the interval when to search for visits to the defined area.
yes

Return

The expected return of the endpoint when the request is valid is a JSON object with the folowing format:

{
    "requestId": "041e75f1-e8d4-479e-b9cc-1232b4803232"
}

Field	Description
requestId	The identifier to use as parameters in the call to the endpoint Visits To Coordinates Result when quering for results. string/GUID

Response HTTP Codes

200

The request to find the visits of the vehicles to the defined area was accepted.

400 - Bad request

• If the radius is zero

• If a parameter is specified in an invalid format

In these cases, a JSON object may also be returned in the response body, identifying the reason of the error. Example:

{
    "message": "string",
    "messageDetail": "string"
}

Field	Description
message	A message presenting the occured error. Example: Radius must be greater than 0. string
messageDetail	If specified, contains more detail about the error message. string