This API creates the specified predefined transfers.
Each transfer is composed of the following elements:
|
Property |
Type |
Description |
|---|---|---|
|
id |
String |
Mandatory. It contains the unique identifier of all transfers provided in the JSON object. The id must be set by the user. |
|
from_route_id |
String |
Mandatory. It contains a valid identifier of a line, as specified in the model. |
|
from_stop_id |
String |
Mandatory. It contains a valid identifier of a stop, as specified in the model. |
|
to_stop_id |
String |
Mandatory. It contains a valid identifier of a stop, as specified in the model. |
|
to_route_id |
String |
Mandatory. It contains a valid identifier of a line, as specified in the model. |
|
min_transfer_time |
Integer |
It contains the minimum transfer time, measured in seconds. |
|
threshold |
Integer |
It contains the minimum transfer time, measured in seconds, to raise an alert. |
If you need additional details, see → Transfer alert service.
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).
Response
Response status
| HTTP status | Description |
|---|---|
| 201 | Created |
| 304 | Not modified |
Response content-type
application/octet-stream
Example
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/predefined
Request content-type
application/json
Request body (payload)
{
"transfers" :
[
{
"id" : "1"
,"from_stop_id": "3382"
,"from_route_id": "280"
,"to_stop_id": "3382"
,"to_route_id": "292"
,"min_transfer_time": 10
,"threshold": 300
}
]
}
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
The processing request has been accepted. |