travelDocument

Type: object

semantics [{'transmodel': 'TRAVEL DOCUMENT'}]

---

Properties overview

Property	Type	Required	Description
id	string
type	string	✓
validity	dateTimeRange	✓
package	packageReference		default string, full names etc (length 0-200)
leg	legReference		default string, full names etc (length 0-200)
asset	assetReference		default string, full names etc (length 0-200)
traveller	travellerReference		default string, full names etc (length 0-200)
travelDocumentType	typeOfTravelDocument	✓	A way to open/access the asset OR a proof of travel rights BARCODE ...

Detailed Properties

• id (string) - optional

• type (string) - required
  value: "travelDocument"

• validity (dateTimeRange) - required

• package (packageReference) - optional
  default string, full names etc (length 0-200)

• leg (legReference) - optional
  default string, full names etc (length 0-200)

• asset (assetReference) - optional
  default string, full names etc (length 0-200)

• traveller (travellerReference) - optional
  default string, full names etc (length 0-200)

• travelDocumentType (typeOfTravelDocument) - required
  A way to open/access the asset OR a proof of travel rights
  
  BARCODE a barcode can be retrieved from the links and used to access the purchased service
  QRCODE a QR code can be retrieved from the links
  AZTECCODE an Aztec code can be retrieved from the links
  REMOTE the /processes/start-leg/execution must be used to open the asset
  DEEP_LINK a deep link into a proprietary app is provided in the links to open the asset (NFC, Bluetooth)
  KEY a physical key must be obtained (see instructions) to open the asset
  

Composition (oneOf)

This schema must match exactly one of the following schemas:

1. externalDigitalTicket
   • External ticket, can be accessed using the links collection, with rel=ticket the mediatype tells what it refers to.
   • Properties: customFields
2. binaryTicket
   • Binary information, like a image or certificate
   • Properties: contentType, base64
3. eKey
   • Axa EKey information
   • Properties: ekey, lock
4. customProperties
   • dictionary for extra fields (bilatural agreements)

Example

{
  "validity": [
    "2024-01-15T10:30:00Z",
    "2024-01-15T10:30:00Z"
  ],
  "travelDocumentType": "BARCODE",
  "type": "travelDocument",
  "id": "identifier",
  "package": "example-string",
  "leg": "example-string"
}