Estimated Time of Arrival for vehicles
This API returns the ETA for the next reachable stops, either:
- For a given, real vehicle and a starting timestamp.
- For all real vehicles.
Authentication phase
Before using the endpoint, you must run the authentication phase (→ Login).
After the authentication, a session opens and a valid session token persists until:
- The end of the session time-out, that is set through the parameter sessionTimeout (→ OptimaWSI configuration > OptimaAuth section).
- An explicit Logout call (→ Logout).
Request endpoint
Request
GET
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/eta/vehicle/{vehicleId}To get the ETA for a given vehicle, you need to specify the path parameter vehicleId, that is a specific identifier of a vehicle. If vehicleId is not specified, the response returns the ETA of all vehicles.
Request parameters
| Parameter | Required | Description |
|---|---|---|
|
format |
NO |
Response format. It can be bytes or text. The default is bytes. |
|
timeStamp |
NO |
Reference timestamp associated to the ETA. The default is now. |
Request content-type
Not applicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
|
400 Bad request |
Several conditions can be classified under this code. Generally, when the API has been called with wrong arguments. |
Response content-type
If in the request:
- format=bytes, the format of the response is application/x-google-protobuf.
- format=text, the format of the response is text/plain.
Response output
Text containing all information about the ETA.
In case of a bad request, a text message is returned, explaining what has caused the problem.
Example
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/eta/vehicle/M1502?timeStamp=2016-05-27T04:00:00&format=text
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
The processing request has been accepted. |
Response output
header {
gtfs_real time_version: "1.0"
incrementality: FULL_DATASET
timestamp: 1464335803
}
entity {
id: "1"
trip_update {
trip {
trip_id: "915421"
route_id: "371"
}
stop_time_update {
stop_sequence: 1
arrival {
delay: 0
time: 1464338100
}
stop_id: "5301"
}
stop_time_update {
stop_sequence: 33
arrival {
delay: -3599
time: 1464336000
}
stop_id: "6165"
}
vehicle {
id: "M1502"
}
}
}