Movia Assignment REST Service

Version 1.1

This document describes Version 1.1 of the Movia Assignment REST Service. The service is available through the following base path:

https://wsilb.moviatrafik.dk/assignment/v1

Formal specification and live demonstration

Formal specification is available in:
- Swagger JSON

Live demonstration is available in:
- Swagger UI

Intended usage

The Assignment REST Service is intended for presenting journey candidates prior to vehicle assignment based on the current position of the vehicle and historic observations. Furthermore, the service informs the driver about potential conflicts and lastly handles the actual assignment.

The intended usage pattern is as follows:

  1. Get relevant lines departing from the area where the bus is currently located using the GET /{vehicleId}@{lat},{lng}/lines endpoint. Present the lines to the driver to select one.

  2. Get relevant journeys on the selected line using the GET /{vehicleId}@{lat},{lng}/lines/{lineNumber}/journeys endpoint. Present the journeys to the driver to select one. Use the built-in scoring of the journeys to present the driver with more likely journeys prior to less likely journeys.

  3. Accept a journey by using the POST /{vehicleId}/assignment/{journeyId} endpoint. If needed resolve any conflicts by presenting the conflict message to the driver to either reject or accept. When assignment is completed include the resulting journey id in the position reports.

Besides the assignment process, the service also allows to query information and current state of a vehi-cle by using GET /{vehicleId}/journey. This includes information about the assigned journey, depar-tures and arrivals and is thus useful for keeping the driver updated after he has accepted a journey.

Authentication

Currently no authentication is required for accessing the service, however Movia reserve the right to apply authentication to the service. If this is decided the approved users will be notified prior to the enforcement.