For a given trip, this endpoint returns all PuT events that have an effect on the trip.
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
GET https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/disruption/trip/{tripId}
The path parameter tripId is required. It is a specific identifier of a trip.
Request parameters
| Parameter | Required | Description |
|---|---|---|
|
format |
NO |
Response format. It can be bytes or text. The default is bytes. |
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 disruptions of the trip.
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/disruption/trip/915422?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: 1464271895
}
entity {
id: "1"
trip_update {
trip {
trip_id: "915422"
schedule_relationship: CANCELED
route_id: "371"
}
}
}