Versions Compared

Key

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

...

Minor changes in the document are flagged either by color, or by specifying (NEW or UPD (updated) version x.y) in the heading.

  • Yellow represents changes in version 2.1 compared to 2.0.

  • Blue represents changes in version 2.2 compared to 2.0 or 2.1

  • Green represents changes in version 2.3 compared to 2.0, 2.1 or 2.2

...

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

status

string

  “OK”, or “ERROR”

validationOk

string

True if validation is positive

validationText

string

Text result from NOD

validationColor

string

Color result from NOD

validationSound

string

Sound result from NOD

nfcReaderConnected

string

True if NFC reader is connected

printerConnected

string

True if last connection attempt/print was successful

printerStatus

string

Latest status from printer if printerConnected is false

nodAvailable

string

True if app is able to reach NOD

sapiAvailable

string

True if app is able to reach NOD

loggedIn

string

True if a user currently is logged in

atDateTime

string

When the ticket is sold/validated or the timestamp for periodic reporting e.g. 1/min.

appVersion

string

Version of the client application on Semantic Versioning format

 

6.2 Sales: Diagnostics (new version 2.1)

...

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

appVersion

string

Version of the client application on Semantic Versioning format

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"
}

...