Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Topic

{PTO}/ruter/{vehicleID}/ei/transfer_information

(was {PTO}/ruter/{vehicleID}/ei/expected_call/transfer_information )

Retain

Yes

QoS

1

 

This topic provides an adapted selection of real time information describing connecting lines at the current or the coming stop that passengers onboard this vehicle could transfer to. The information is provided in the form of a list of possible transfer options at the next stop.

...

Topic

{PTO}/ruter/{vehicleID}/ei/due_information

(was {PTO}/ruter/{vehicleID}/ei/expected_call/due_information/)

Retain

No

QoS

0

This topic provides an adapted text indicating that the vehicle is about to arrive at a stop according to what the coordinating application has concluded.

...

Name

Type

Description

fromDateTime

string

Time from which the sign on/off was supposed to apply. ISO 8601, UTC

blockRef

string

Optional. Not provided for sign off. Otherwise the Block identifier.

result

string

Possible values: “INTERNAL_ERROR”, “TIMEOUT”, “SERVICE_CLOSED”, “NOT_SUCCEEDED”, “NOT_GRANTED”, “NOT_SUPPORTED”, “NOT_UNDERSTOOD”

errorText

string

Optional. Only provided if there is an error text.

...

Name

Type

Description

eventTimestamp

string

ISO 8601, UTC. The time of this diagnostics message generation

nfcReaderConnected

boolean

True if the NFC reader is discovered and connected by the app

printerConnected

boolean

True if the printer is discovered and connected, and if the previous communication with the printer was a print operation the print was a success

printerStatus

string

Optional. If printerConnected is false, printerStatus might contain last errorMessage from printer if available, or error message from the sales device if unavailable

nodAvailable

boolean

True if the app can contact the NOD backend

sapiAvailable

boolean

True if the app can contact the SAPI backend

loggedIn

boolean

True if a user is logged into the app

journeyRef

string

Last received journeyRef. Obtained from last received Journey message.

stopPlaceId

string

Last received stopPlaceId. Obtained from last received NextStop message with a valid Ruter zone

Mistyped in v. 2.1

Example

Code Block
{
   "eventTimestamp":"2020-04-27T12:56:47.110Z",
   "nfcReaderConnected":true,
   "printerConnected":false,
   "printerStatus":"Deksel er åpnet",
   "nodAvailable":true,
   "sapiAvailable":true,
   "loggedIn":true,
   "journeyRef":"42911-2020-05-25T16:42:00+02:00",
   "stopPlaceId":"NSR:StopPlace:59734"
}

...