Creating transfers

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_public_stop_id	String	Mandatory. It contains a valid identifier of a public stop, as specified in the model.
to_public_stop_id	String	Mandatory. It contains a valid identifier of a public 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. This property coincides with t_min in → Transfer alert service.
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).

Request endpoint

Request

POST

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/predefined/

Request parameters

Not applicable.

Request content-type

application/json or application/xml

Request body (payload)

A JSON or XML structure to create predefined transfers.

Response

Response status

HTTP status	Description
200 OK	The request has been partially satisfied. At least one transfer was created successfully, but one or more failed due to validation errors or other issues. The response body contains the text describing the error.
201 Created	The request has been satisfied.
304 Not Modified	No valid transfers to process due to validation errors or other issues.
400 Bad Request	Input transfers list is null.
500 Internal Server Error	Transfer creation failed and threw an exception. The response body contains the text describing the error.

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_public_stop_id": "3382"
      ,"from_route_id": "280"
      ,"to_public_stop_id": "3382"
      ,"to_route_id": "292"
      ,"min_transfer_time": 10
      ,"threshold": 300
    }
  ]
}

Response status

HTTP status	Description
201 Created	The request has been satisfied.