Visits to Coordinates Result

This endpoint is used in conjunction with the endpoint Visits To Coordinates.

Use this endpoint to obtain the results of a previous request made to Visits To Coordinates.

Since the operation is asynchronous, you will probably need make multiple requests to this endpoint until the processing is completed. Until the results are available, the property ready in the result will have the value false; As soon as the results are available, the property ready should be true and the result should the list of visits, which may be empty, if no visits were detected.

Since this is resource intensive calculation, the results may take several minutes before they are available. This time depends on the size of the fleet and the span of the queried period.

There is no advantage in trying to get results too soon or too often.

Note: requests refering intervals greater than seven days will not be handled.

Parameters

requestId

This parameter is a string value in the for of a GUID and is the result of the call to the endpoint Visits To Coordinates.

Return

{
  "ready": true,
  "result": [
    {
      "id": 0,
      "requestId": "00000000-0000-0000-0000-000000000000",
      "vehicleId": 0,
      "licensePlate": "string",
      "arrivalTime": "2023-09-15T13:31:06.040Z",
      "stopDuration": 0
    }
  ]
}

Field	Description
ready	Informs if the processing has been completed and it's results are already available. bool
result	The array of objects that specify the data about each visit to the specified place array
result[i].id	The identifier of the response. integer
result[i].requestId	The identifier to use as parameters in the call to the endpoint Visits To Coordinates Result when quering for results. string/GUID
result[i].licensePlate	The license place of the vehicle that made a visit to the defined area. string
result[i].arrivalTime	The timestamp of the first position after the vehicle entrance in the specified radius.
result[i].stopDuration	The time, in seconds, that the vehicle remained inside the specified radius. integer

Visits to Coordinates Result

Parameters

requestId

Return

Response HTTP Codes

200 - OK

400 - Bad Request