This API returns all events with specified IDs.
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/event/Request parameters
| Parameter | Required | Description |
|---|---|---|
|
format |
NO |
Response format. It can be bytes or text. The default is bytes. |
|
eventId |
NO |
Event identifier. You can also specify a list of n events, in the format: eventId=ID1&eventId=ID2&...&eventId=IDn. If no event ID is specified, the endpoint returns all PuT events. |
Request content-type
Not applicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
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 or protobuf packet containing all information about the retrieved PuT events.
Example
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event?format=text&eventId=2&eventId=3
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
The processing request has been accepted. |
Response content-type
text/plain
Response output
header {
gtfs_real time_version: "1.0"
incrementality: FULL_DATASET
timestamp: 1464271895
}
entity {
id: "2"
trip_update {
trip {
trip_id: "915422"
schedule_relationship: SCHEDULED
route_id: "371"
}
stop_time_update {
stop_sequence: 1
stop_id: "5301"
schedule_relationship: SKIPPED
}
}
}
entity {
id: "3"
trip_update {
trip {
schedule_relationship: CANCELED
route_id: "371"
}
}
}