processes

Server

Download schema

Process endpoints for creating and mutating packages, offers, and refunds.

Search available travel offers

POST

https://api.entur.io/omsa/v1

/processes/search-offers/execute

Searches for available offers based on travel and traveller criteria.

Search available travel offers › query Parameters

limit

integer · min: 1 · max: 10000 · style: form

The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.

Default: 100

offset

integer · min: 0 · style: form

The optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.

Default: 0

bbox

number[] · style: form

Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional) If the value consists of four numbers, the coordinate reference system is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs. If the value consists of six numbers, the coordinate reference system is WGS 84 longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h) unless a different coordinate reference system is specified in the parameter bbox-crs. The query parameter bbox-crs is specified in OGC API - Features - Part 2: Coordinate Reference Systems by Reference. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

Search available travel offers › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Search available travel offers › Request Body

searchOfferInput

A package planning request, resulting in package options

subscriber

Optional URIs for callbacks for this job.

Support for this parameter is not required and the parameter may be removed from the API definition, if conformance class 'callback' is not listed in the conformance declaration under /conformance.

Search available travel offers › Responses

a search offer response

offerCollection

type

string · pattern: ^(OfferCollection)$ · required

offer[]

numberMatched

integer

numberReturned

integer

link[]

actions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.

POST/processes/search-offers/execute

curl https://api.entur.io/omsa/v1/processes/search-offers/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "type": "type",
    "specification": {
      "from": {
        "placeId": "placeId",
        "name": "name"
      },
      "via": [
        {
          "placeId": "placeId",
          "name": "name"
        }
      ],
      "to": {
        "placeId": "placeId",
        "name": "name"
      },
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "placeDefinitions": [
        {
          "placeId": {
            "placeId": "placeId",
            "name": "name"
          },
          "addressLine1": "addressLine1",
          "addressLine2": "addressLine2",
          "street": "street",
          "houseNumber": 0,
          "houseNumberAddition": "houseNumberAddition",
          "postalCode": "postalCode",
          "city": "city",
          "province": "province",
          "state": "state",
          "country": "country",
          "additionalInfo": "additionalInfo"
        }
      ]
    },
    "filters": [
      {
        "type": "type",
        "productId": "productId",
        "serviceJourney": "serviceJourney",
        "class": "FIRST_CLASS",
        "berthTypes": [
          "SLEEPER"
        ]
      }
    ],
    "pattern": [
      {
        "serviceJourney": "serviceJourney",
        "date": "date",
        "from": {
          "placeId": "placeId",
          "name": "name"
        },
        "to": {
          "placeId": "placeId",
          "name": "name"
        }
      }
    ],
    "packageToExchange": "packageToExchange",
    "travellers": [
      {
        "type": "type",
        "entitlements": {
          "commercialProfiles": [
            {
              "id": "id",
              "type": "type",
              "code": "code",
              "name": "name"
            }
          ],
          "entitlementsGiven": [
            {
              "id": "id",
              "type": "type",
              "entitlementType": "entitlementType"
            }
          ],
          "cardTypes": [
            {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            }
          ],
          "cards": [
            {
              "type": "type",
              "cardType": {
                "id": "id",
                "type": "type",
                "cardCategory": "DISCOUNT",
                "subCategory": "subCategory",
                "relatedProduct": {
                  "productId": "productId",
                  "name": "name"
                },
                "transportOrganisations": [
                  {
                    "organisationId": "organisationId",
                    "name": "name"
                  }
                ],
                "customFields": {}
              },
              "cardNumber": "cardNumber",
              "description": "description",
              "additionalNumber": "additionalNumber",
              "endValidity": "endValidity",
              "country": "country"
            }
          ],
          "licenseTypes": [
            {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            }
          ],
          "licenses": [
            {
              "type": "type",
              "licenseType": {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              },
              "licenseNumber": "licenseNumber",
              "endValidity": "endValidity"
            }
          ]
        },
        "requirements": {
          "organisational": [
            {
              "id": "id",
              "type": "type",
              "name": "name",
              "legalName": "legalName"
            }
          ],
          "spotReservations": [
            {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "deck": "deck",
              "space": "space",
              "spot": "spot",
              "width": 0,
              "length": 0,
              "height": 0,
              "fuel": "fuel",
              "weight": "weight",
              "mode": "AIR"
            }
          ],
          "distribution": [
            {
              "type": "type",
              "fulfilmentMethod": "fulfilmentMethod",
              "distributionChannel": "distributionChannel"
            }
          ],
          "network": [
            {
              "type": "type",
              "location": {
                "placeId": "placeId",
                "name": "name"
              },
              "line": "line",
              "zones": [
                {
                  "zoneId": "zoneId",
                  "name": "name"
                }
              ]
            }
          ],
          "routing": [
            {
              "type": "type",
              "journeyPattern": [
                "string"
              ]
            }
          ],
          "service": [
            {
              "type": "type",
              "product": {
                "productId": "productId",
                "name": "name"
              },
              "asset": "asset",
              "serviceJourney": "serviceJourney",
              "userNeeds": [
                {
                  "id": "id",
                  "name": "name"
                }
              ],
              "class": "FIRST_CLASS",
              "onboardStay": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "permission": true,
                  "duration": "duration"
                }
              ],
              "accommodations": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "name": "name",
                  "gender": "M",
                  "berthType": "SLEEPER",
                  "nuisanceFacility": [
                    "string"
                  ]
                }
              ]
            }
          ],
          "temporal": [
            {
              "type": "type",
              "startTime": "2024-08-25T15:00:00Z",
              "endTime": "2024-08-25T15:00:00Z",
              "duration": 0,
              "dayType": "MON"
            }
          ],
          "equipment": [
            {
              "type": "type",
              "id": {
                "equipmentId": "equipmentId",
                "name": "name"
              },
              "name": "name",
              "description": "description",
              "infoLink": "https://www.example.com/path/to/resource",
              "image": "https://www.example.com/path/to/resource"
            }
          ],
          "cancellation": [
            {
              "type": "type",
              "cancellationAllowed": true,
              "cancellationFee": {
                "amount": 0,
                "taxPercentageUsed": 0,
                "currencyCode": "currencyCode",
                "vatCountryCode": "vatCountryCode"
              },
              "cancellationFeePercentage": 0
            }
          ],
          "purchase": [
            {
              "type": "type",
              "maximumPeriodBeforeDeparture": 0,
              "requiredLicenseTypes": [
                {
                  "type": "type",
                  "modes": [
                    "AIR"
                  ],
                  "licenseCode": "licenseCode",
                  "issuingCountry": "issuingCountry",
                  "customFields": {}
                }
              ]
            }
          ]
        },
        "id": "id",
        "isValidated": true,
        "age": 0,
        "gender": "M",
        "fullName": "fullName",
        "customerReference": "customerReference",
        "customFields": {}
      }
    ],
    "profiles": [
      {
        "type": "type",
        "entitlements": {
          "commercialProfiles": [
            {
              "id": "id",
              "type": "type",
              "code": "code",
              "name": "name"
            }
          ],
          "entitlementsGiven": [
            {
              "id": "id",
              "type": "type",
              "entitlementType": "entitlementType"
            }
          ],
          "cardTypes": [
            {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            }
          ],
          "cards": [
            {
              "type": "type",
              "cardType": {
                "id": "id",
                "type": "type",
                "cardCategory": "DISCOUNT",
                "subCategory": "subCategory",
                "relatedProduct": {
                  "productId": "productId",
                  "name": "name"
                },
                "transportOrganisations": [
                  {
                    "organisationId": "organisationId",
                    "name": "name"
                  }
                ],
                "customFields": {}
              },
              "cardNumber": "cardNumber",
              "description": "description",
              "additionalNumber": "additionalNumber",
              "endValidity": "endValidity",
              "country": "country"
            }
          ],
          "licenseTypes": [
            {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            }
          ],
          "licenses": [
            {
              "type": "type",
              "licenseType": {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              },
              "licenseNumber": "licenseNumber",
              "endValidity": "endValidity"
            }
          ]
        },
        "requirements": {
          "organisational": [
            {
              "id": "id",
              "type": "type",
              "name": "name",
              "legalName": "legalName"
            }
          ],
          "spotReservations": [
            {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "deck": "deck",
              "space": "space",
              "spot": "spot",
              "width": 0,
              "length": 0,
              "height": 0,
              "fuel": "fuel",
              "weight": "weight",
              "mode": "AIR"
            }
          ],
          "distribution": [
            {
              "type": "type",
              "fulfilmentMethod": "fulfilmentMethod",
              "distributionChannel": "distributionChannel"
            }
          ],
          "network": [
            {
              "type": "type",
              "location": {
                "placeId": "placeId",
                "name": "name"
              },
              "line": "line",
              "zones": [
                {
                  "zoneId": "zoneId",
                  "name": "name"
                }
              ]
            }
          ],
          "routing": [
            {
              "type": "type",
              "journeyPattern": [
                "string"
              ]
            }
          ],
          "service": [
            {
              "type": "type",
              "product": {
                "productId": "productId",
                "name": "name"
              },
              "asset": "asset",
              "serviceJourney": "serviceJourney",
              "userNeeds": [
                {
                  "id": "id",
                  "name": "name"
                }
              ],
              "class": "FIRST_CLASS",
              "onboardStay": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "permission": true,
                  "duration": "duration"
                }
              ],
              "accommodations": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "name": "name",
                  "gender": "M",
                  "berthType": "SLEEPER",
                  "nuisanceFacility": [
                    "string"
                  ]
                }
              ]
            }
          ],
          "temporal": [
            {
              "type": "type",
              "startTime": "2024-08-25T15:00:00Z",
              "endTime": "2024-08-25T15:00:00Z",
              "duration": 0,
              "dayType": "MON"
            }
          ],
          "equipment": [
            {
              "type": "type",
              "id": {
                "equipmentId": "equipmentId",
                "name": "name"
              },
              "name": "name",
              "description": "description",
              "infoLink": "https://www.example.com/path/to/resource",
              "image": "https://www.example.com/path/to/resource"
            }
          ],
          "cancellation": [
            {
              "type": "type",
              "cancellationAllowed": true,
              "cancellationFee": {
                "amount": 0,
                "taxPercentageUsed": 0,
                "currencyCode": "currencyCode",
                "vatCountryCode": "vatCountryCode"
              },
              "cancellationFeePercentage": 0
            }
          ],
          "purchase": [
            {
              "type": "type",
              "maximumPeriodBeforeDeparture": 0,
              "requiredLicenseTypes": [
                {
                  "type": "type",
                  "modes": [
                    "AIR"
                  ],
                  "licenseCode": "licenseCode",
                  "issuingCountry": "issuingCountry",
                  "customFields": {}
                }
              ]
            }
          ]
        },
        "id": "id",
        "count": 0,
        "minimumAge": 0,
        "maximumAge": 0,
        "monthDayOnWhichAgeApplies": 0,
        "ageGroup": "ANYONE",
        "minimumHeight": 0,
        "maximumHeight": 0,
        "localResident": true,
        "genderLimitation": true
      }
    ],
    "travellingAssets": [
      {
        "type": "type",
        "id": "id"
      }
    ],
    "entur": {
      "recommendationControl": {
        "enabled": false,
        "types": [
          "FLEXIBLE"
        ],
        "stripDuplicates": false
      }
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "type": "type",
    "specification": {
      "from": {
        "placeId": "placeId",
        "name": "name"
      },
      "via": [
        {
          "placeId": "placeId",
          "name": "name"
        }
      ],
      "to": {
        "placeId": "placeId",
        "name": "name"
      },
      "startTime": "2024-08-25T15:00:00Z",
      "endTime": "2024-08-25T15:00:00Z",
      "placeDefinitions": [
        {
          "placeId": {
            "placeId": "placeId",
            "name": "name"
          },
          "addressLine1": "addressLine1",
          "addressLine2": "addressLine2",
          "street": "street",
          "houseNumber": 0,
          "houseNumberAddition": "houseNumberAddition",
          "postalCode": "postalCode",
          "city": "city",
          "province": "province",
          "state": "state",
          "country": "country",
          "additionalInfo": "additionalInfo"
        }
      ]
    },
    "filters": [
      {
        "type": "type",
        "productId": "productId",
        "serviceJourney": "serviceJourney",
        "class": "FIRST_CLASS",
        "berthTypes": [
          "SLEEPER"
        ]
      }
    ],
    "pattern": [
      {
        "serviceJourney": "serviceJourney",
        "date": "date",
        "from": {
          "placeId": "placeId",
          "name": "name"
        },
        "to": {
          "placeId": "placeId",
          "name": "name"
        }
      }
    ],
    "packageToExchange": "packageToExchange",
    "travellers": [
      {
        "type": "type",
        "entitlements": {
          "commercialProfiles": [
            {
              "id": "id",
              "type": "type",
              "code": "code",
              "name": "name"
            }
          ],
          "entitlementsGiven": [
            {
              "id": "id",
              "type": "type",
              "entitlementType": "entitlementType"
            }
          ],
          "cardTypes": [
            {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            }
          ],
          "cards": [
            {
              "type": "type",
              "cardType": {
                "id": "id",
                "type": "type",
                "cardCategory": "DISCOUNT",
                "subCategory": "subCategory",
                "relatedProduct": {
                  "productId": "productId",
                  "name": "name"
                },
                "transportOrganisations": [
                  {
                    "organisationId": "organisationId",
                    "name": "name"
                  }
                ],
                "customFields": {}
              },
              "cardNumber": "cardNumber",
              "description": "description",
              "additionalNumber": "additionalNumber",
              "endValidity": "endValidity",
              "country": "country"
            }
          ],
          "licenseTypes": [
            {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            }
          ],
          "licenses": [
            {
              "type": "type",
              "licenseType": {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              },
              "licenseNumber": "licenseNumber",
              "endValidity": "endValidity"
            }
          ]
        },
        "requirements": {
          "organisational": [
            {
              "id": "id",
              "type": "type",
              "name": "name",
              "legalName": "legalName"
            }
          ],
          "spotReservations": [
            {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "deck": "deck",
              "space": "space",
              "spot": "spot",
              "width": 0,
              "length": 0,
              "height": 0,
              "fuel": "fuel",
              "weight": "weight",
              "mode": "AIR"
            }
          ],
          "distribution": [
            {
              "type": "type",
              "fulfilmentMethod": "fulfilmentMethod",
              "distributionChannel": "distributionChannel"
            }
          ],
          "network": [
            {
              "type": "type",
              "location": {
                "placeId": "placeId",
                "name": "name"
              },
              "line": "line",
              "zones": [
                {
                  "zoneId": "zoneId",
                  "name": "name"
                }
              ]
            }
          ],
          "routing": [
            {
              "type": "type",
              "journeyPattern": [
                "string"
              ]
            }
          ],
          "service": [
            {
              "type": "type",
              "product": {
                "productId": "productId",
                "name": "name"
              },
              "asset": "asset",
              "serviceJourney": "serviceJourney",
              "userNeeds": [
                {
                  "id": "id",
                  "name": "name"
                }
              ],
              "class": "FIRST_CLASS",
              "onboardStay": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "permission": true,
                  "duration": "duration"
                }
              ],
              "accommodations": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "name": "name",
                  "gender": "M",
                  "berthType": "SLEEPER",
                  "nuisanceFacility": [
                    "string"
                  ]
                }
              ]
            }
          ],
          "temporal": [
            {
              "type": "type",
              "startTime": "2024-08-25T15:00:00Z",
              "endTime": "2024-08-25T15:00:00Z",
              "duration": 0,
              "dayType": "MON"
            }
          ],
          "equipment": [
            {
              "type": "type",
              "id": {
                "equipmentId": "equipmentId",
                "name": "name"
              },
              "name": "name",
              "description": "description",
              "infoLink": "https://www.example.com/path/to/resource",
              "image": "https://www.example.com/path/to/resource"
            }
          ],
          "cancellation": [
            {
              "type": "type",
              "cancellationAllowed": true,
              "cancellationFee": {
                "amount": 0,
                "taxPercentageUsed": 0,
                "currencyCode": "currencyCode",
                "vatCountryCode": "vatCountryCode"
              },
              "cancellationFeePercentage": 0
            }
          ],
          "purchase": [
            {
              "type": "type",
              "maximumPeriodBeforeDeparture": 0,
              "requiredLicenseTypes": [
                {
                  "type": "type",
                  "modes": [
                    "AIR"
                  ],
                  "licenseCode": "licenseCode",
                  "issuingCountry": "issuingCountry",
                  "customFields": {}
                }
              ]
            }
          ]
        },
        "id": "id",
        "isValidated": true,
        "age": 0,
        "gender": "M",
        "fullName": "fullName",
        "customerReference": "customerReference",
        "customFields": {}
      }
    ],
    "profiles": [
      {
        "type": "type",
        "entitlements": {
          "commercialProfiles": [
            {
              "id": "id",
              "type": "type",
              "code": "code",
              "name": "name"
            }
          ],
          "entitlementsGiven": [
            {
              "id": "id",
              "type": "type",
              "entitlementType": "entitlementType"
            }
          ],
          "cardTypes": [
            {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            }
          ],
          "cards": [
            {
              "type": "type",
              "cardType": {
                "id": "id",
                "type": "type",
                "cardCategory": "DISCOUNT",
                "subCategory": "subCategory",
                "relatedProduct": {
                  "productId": "productId",
                  "name": "name"
                },
                "transportOrganisations": [
                  {
                    "organisationId": "organisationId",
                    "name": "name"
                  }
                ],
                "customFields": {}
              },
              "cardNumber": "cardNumber",
              "description": "description",
              "additionalNumber": "additionalNumber",
              "endValidity": "endValidity",
              "country": "country"
            }
          ],
          "licenseTypes": [
            {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            }
          ],
          "licenses": [
            {
              "type": "type",
              "licenseType": {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              },
              "licenseNumber": "licenseNumber",
              "endValidity": "endValidity"
            }
          ]
        },
        "requirements": {
          "organisational": [
            {
              "id": "id",
              "type": "type",
              "name": "name",
              "legalName": "legalName"
            }
          ],
          "spotReservations": [
            {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "deck": "deck",
              "space": "space",
              "spot": "spot",
              "width": 0,
              "length": 0,
              "height": 0,
              "fuel": "fuel",
              "weight": "weight",
              "mode": "AIR"
            }
          ],
          "distribution": [
            {
              "type": "type",
              "fulfilmentMethod": "fulfilmentMethod",
              "distributionChannel": "distributionChannel"
            }
          ],
          "network": [
            {
              "type": "type",
              "location": {
                "placeId": "placeId",
                "name": "name"
              },
              "line": "line",
              "zones": [
                {
                  "zoneId": "zoneId",
                  "name": "name"
                }
              ]
            }
          ],
          "routing": [
            {
              "type": "type",
              "journeyPattern": [
                "string"
              ]
            }
          ],
          "service": [
            {
              "type": "type",
              "product": {
                "productId": "productId",
                "name": "name"
              },
              "asset": "asset",
              "serviceJourney": "serviceJourney",
              "userNeeds": [
                {
                  "id": "id",
                  "name": "name"
                }
              ],
              "class": "FIRST_CLASS",
              "onboardStay": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "permission": true,
                  "duration": "duration"
                }
              ],
              "accommodations": [
                {
                  "type": "type",
                  "description": "description",
                  "classOfUse": "FIRST_CLASS",
                  "name": "name",
                  "gender": "M",
                  "berthType": "SLEEPER",
                  "nuisanceFacility": [
                    "string"
                  ]
                }
              ]
            }
          ],
          "temporal": [
            {
              "type": "type",
              "startTime": "2024-08-25T15:00:00Z",
              "endTime": "2024-08-25T15:00:00Z",
              "duration": 0,
              "dayType": "MON"
            }
          ],
          "equipment": [
            {
              "type": "type",
              "id": {
                "equipmentId": "equipmentId",
                "name": "name"
              },
              "name": "name",
              "description": "description",
              "infoLink": "https://www.example.com/path/to/resource",
              "image": "https://www.example.com/path/to/resource"
            }
          ],
          "cancellation": [
            {
              "type": "type",
              "cancellationAllowed": true,
              "cancellationFee": {
                "amount": 0,
                "taxPercentageUsed": 0,
                "currencyCode": "currencyCode",
                "vatCountryCode": "vatCountryCode"
              },
              "cancellationFeePercentage": 0
            }
          ],
          "purchase": [
            {
              "type": "type",
              "maximumPeriodBeforeDeparture": 0,
              "requiredLicenseTypes": [
                {
                  "type": "type",
                  "modes": [
                    "AIR"
                  ],
                  "licenseCode": "licenseCode",
                  "issuingCountry": "issuingCountry",
                  "customFields": {}
                }
              ]
            }
          ]
        },
        "id": "id",
        "count": 0,
        "minimumAge": 0,
        "maximumAge": 0,
        "monthDayOnWhichAgeApplies": 0,
        "ageGroup": "ANYONE",
        "minimumHeight": 0,
        "maximumHeight": 0,
        "localResident": true,
        "genderLimitation": true
      }
    ],
    "travellingAssets": [
      {
        "type": "type",
        "id": "id"
      }
    ],
    "entur": {
      "recommendationControl": {
        "enabled": false,
        "types": [
          "FLEXIBLE"
        ],
        "stripDuplicates": false
      }
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "type": "type",
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "numberMatched": 0,
  "numberReturned": 0,
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Create draft package from selected offers

POST

https://api.entur.io/omsa/v1

/processes/select-offers/execute

Creates or updates a draft package from selected offer identifiers.

Create draft package from selected offers › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create draft package from selected offers › Request Body

selectOffersInput

subscriber

Optional URIs for callbacks for this job.

Create draft package from selected offers › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

The life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/select-offers/execute

curl https://api.entur.io/omsa/v1/processes/select-offers/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "offerIds": [
      "string"
    ],
    "type": "type",
    "customer": {
      "id": "id"
    },
    "contact": {
      "id": "id"
    },
    "externalReference": "externalReference"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "offerIds": [
      "string"
    ],
    "type": "type",
    "customer": {
      "id": "id"
    },
    "contact": {
      "id": "id"
    },
    "externalReference": "externalReference"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Add traveller to package

POST

https://api.entur.io/omsa/v1

/processes/add-traveller/execute

Adds a traveller to an existing package.

Add traveller to package › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Add traveller to package › Request Body

addTravellerInput

subscriber

Optional URIs for callbacks for this job.

Add traveller to package › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/add-traveller/execute

curl https://api.entur.io/omsa/v1/processes/add-traveller/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "type": "type",
    "packageId": "packageId",
    "individualTraveller": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    },
    "userProfile": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "count": 0,
      "minimumAge": 0,
      "maximumAge": 0,
      "monthDayOnWhichAgeApplies": 0,
      "ageGroup": "ANYONE",
      "minimumHeight": 0,
      "maximumHeight": 0,
      "localResident": true,
      "genderLimitation": true
    },
    "travellingAsset": {
      "type": "type",
      "id": "id"
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "type": "type",
    "packageId": "packageId",
    "individualTraveller": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    },
    "userProfile": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "count": 0,
      "minimumAge": 0,
      "maximumAge": 0,
      "monthDayOnWhichAgeApplies": 0,
      "ageGroup": "ANYONE",
      "minimumHeight": 0,
      "maximumHeight": 0,
      "localResident": true,
      "genderLimitation": true
    },
    "travellingAsset": {
      "type": "type",
      "id": "id"
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Update traveller in package

POST

https://api.entur.io/omsa/v1

/processes/update-traveller/execute

Updates traveller details in an existing package.

Update traveller in package › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Update traveller in package › Request Body

updateTravellerInput

subscriber

Optional URIs for callbacks for this job.

Update traveller in package › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/update-traveller/execute

curl https://api.entur.io/omsa/v1/processes/update-traveller/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "type": "type",
    "packageId": "packageId",
    "travellerId": "travellerId",
    "individualTraveller": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    },
    "userProfile": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "count": 0,
      "minimumAge": 0,
      "maximumAge": 0,
      "monthDayOnWhichAgeApplies": 0,
      "ageGroup": "ANYONE",
      "minimumHeight": 0,
      "maximumHeight": 0,
      "localResident": true,
      "genderLimitation": true
    },
    "travellingAsset": {
      "type": "type",
      "id": "id"
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "type": "type",
    "packageId": "packageId",
    "travellerId": "travellerId",
    "individualTraveller": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    },
    "userProfile": {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "count": 0,
      "minimumAge": 0,
      "maximumAge": 0,
      "monthDayOnWhichAgeApplies": 0,
      "ageGroup": "ANYONE",
      "minimumHeight": 0,
      "maximumHeight": 0,
      "localResident": true,
      "genderLimitation": true
    },
    "travellingAsset": {
      "type": "type",
      "id": "id"
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Remove traveller from package

POST

https://api.entur.io/omsa/v1

/processes/remove-traveller/execute

Removes a traveller from an existing package.

Remove traveller from package › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Remove traveller from package › Request Body

removeTravellerInput

subscriber

Optional URIs for callbacks for this job.

Remove traveller from package › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/remove-traveller/execute

curl https://api.entur.io/omsa/v1/processes/remove-traveller/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "type": "type",
    "travellerId": "travellerId",
    "packageId": "packageId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "type": "type",
    "travellerId": "travellerId",
    "packageId": "packageId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Assign asset to package leg

POST

https://api.entur.io/omsa/v1

/processes/assign-asset/execute

Assigns an asset to a specific package leg.

Assign asset to package leg › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Assign asset to package leg › Request Body

assetInput

subscriber

Optional URIs for callbacks for this job.

Assign asset to package leg › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/assign-asset/execute

curl https://api.entur.io/omsa/v1/processes/assign-asset/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "offerId": "offerId",
    "legId": "legId",
    "location": {
      "placeId": "placeId",
      "name": "name"
    },
    "assetId": "assetId",
    "replaceAssetId": "replaceAssetId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "offerId": "offerId",
    "legId": "legId",
    "location": {
      "placeId": "placeId",
      "name": "name"
    },
    "assetId": "assetId",
    "replaceAssetId": "replaceAssetId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Assign ancillary products to package

POST

https://api.entur.io/omsa/v1

/processes/assign-ancillary/execute

Assigns ancillary products to a package or a package leg.

Assign ancillary products to package › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Assign ancillary products to package › Request Body

ancillaryInput

subscriber

Optional URIs for callbacks for this job.

Assign ancillary products to package › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/assign-ancillary/execute

curl https://api.entur.io/omsa/v1/processes/assign-ancillary/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "offerId": "offerId",
    "legId": "legId",
    "location": {
      "placeId": "placeId",
      "name": "name"
    },
    "ancillaryId": {
      "ancillaryId": "ancillaryId",
      "name": "name"
    },
    "replaceAncillaryId": {
      "ancillaryId": "ancillaryId",
      "name": "name"
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "offerId": "offerId",
    "legId": "legId",
    "location": {
      "placeId": "placeId",
      "name": "name"
    },
    "ancillaryId": {
      "ancillaryId": "ancillaryId",
      "name": "name"
    },
    "replaceAncillaryId": {
      "ancillaryId": "ancillaryId",
      "name": "name"
    }
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Purchase selected offers directly

POST

https://api.entur.io/omsa/v1

/processes/purchase-offers/execute

Purchases selected offers directly and returns the resulting package.

Purchase selected offers directly › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Purchase selected offers directly › Request Body

purchaseOffersInput

subscriber

Optional URIs for callbacks for this job.

Purchase selected offers directly › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/purchase-offers/execute

curl https://api.entur.io/omsa/v1/processes/purchase-offers/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "offerIds": [
      "string"
    ],
    "type": "type",
    "customer": {
      "id": "id"
    },
    "contact": {
      "id": "id"
    },
    "externalReference": "externalReference"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "offerIds": [
      "string"
    ],
    "type": "type",
    "customer": {
      "id": "id"
    },
    "contact": {
      "id": "id"
    },
    "externalReference": "externalReference"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Purchase existing package

POST

https://api.entur.io/omsa/v1

/processes/purchase-package/execute

Purchases a previously created package.

Purchase existing package › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Purchase existing package › Request Body

packageInput

subscriber

Optional URIs for callbacks for this job.

Purchase existing package › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/purchase-package/execute

curl https://api.entur.io/omsa/v1/processes/purchase-package/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Confirm package before purchase

POST

https://api.entur.io/omsa/v1

/processes/confirm-package/execute

Confirms a package before final purchase.

Confirm package before purchase › query Parameters

limit

integer · min: 1 · max: 10000 · style: form

Default: 100

offset

integer · min: 0 · style: form

Default: 0

bbox

number[] · style: form

Confirm package before purchase › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Confirm package before purchase › Request Body

packageInput

subscriber

Optional URIs for callbacks for this job.

Confirm package before purchase › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/confirm-package/execute

curl https://api.entur.io/omsa/v1/processes/confirm-package/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Release package reservation

POST

https://api.entur.io/omsa/v1

/processes/release-package/execute

Releases a package reservation.

Release package reservation › query Parameters

limit

integer · min: 1 · max: 10000 · style: form

Default: 100

offset

integer · min: 0 · style: form

Default: 0

bbox

number[] · style: form

Release package reservation › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Release package reservation › Request Body

packageInput

subscriber

Optional URIs for callbacks for this job.

Release package reservation › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/release-package/execute

curl https://api.entur.io/omsa/v1/processes/release-package/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Extend package reservation expiry

POST

https://api.entur.io/omsa/v1

/processes/extend-expiry-time/execute

Extends the expiry time for a reserved package.

Extend package reservation expiry › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Extend package reservation expiry › Request Body

extendExpiryTimeInput

subscriber

Optional URIs for callbacks for this job.

Extend package reservation expiry › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/extend-expiry-time/execute

curl https://api.entur.io/omsa/v1/processes/extend-expiry-time/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "extensionReason": "extensionReason"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "extensionReason": "extensionReason"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Update travel document validity start

POST

https://api.entur.io/omsa/v1

/processes/update-travel-document-validity/execute

Updates the validity start time for a travel document in a package.

Update travel document validity start › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Update travel document validity start › Request Body

updateTravelDocumentValidityInput

subscriber

Optional URIs for callbacks for this job.

Update travel document validity start › Responses

Validity updated successfully.

updateTravelDocumentValidityResponse

previousTravelDocumentId

string · required

The travel document id that was replaced

newTravelDocumentId

string · required

The new travel document id with updated validity

POST/processes/update-travel-document-validity/execute

curl https://api.entur.io/omsa/v1/processes/update-travel-document-validity/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "travelDocumentId": "travelDocumentId",
    "newStartTime": "newStartTime"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type",
    "travelDocumentId": "travelDocumentId",
    "newStartTime": "newStartTime"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "previousTravelDocumentId": "previousTravelDocumentId",
  "newTravelDocumentId": "newTravelDocumentId"
}

json

application/json

Cancel package

POST

https://api.entur.io/omsa/v1

/processes/cancel-package/execute

Cancels an existing purchased or reserved package.

Cancel package › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Cancel package › Request Body

packageInput

subscriber

Optional URIs for callbacks for this job.

Cancel package › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/cancel-package/execute

curl https://api.entur.io/omsa/v1/processes/cancel-package/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "packageId": "packageId",
    "type": "type"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Claim refund option for package

POST

https://api.entur.io/omsa/v1

/processes/claim-refund-option/execute

Claims a refund option for the selected package content.

Claim refund option for package › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier used by downstream sales and ticket distribution services.

Entur-POS

string · required · style: simple

Point-of-sale identifier used by downstream sales and ticket distribution services.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Claim refund option for package › Request Body

refundOptionInput

subscriber

Optional URIs for callbacks for this job.

Claim refund option for package › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/claim-refund-option/execute

curl https://api.entur.io/omsa/v1/processes/claim-refund-option/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-POS: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "type": "type",
    "optionId": "optionId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "type": "type",
    "optionId": "optionId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Confirm claimed refund option

POST

https://api.entur.io/omsa/v1

/processes/confirm-refund-option/execute

Confirms a previously claimed refund option.

Confirm claimed refund option › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

authorization

string · required · style: simple

Header field, JWT must be supplied

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Confirm claimed refund option › Request Body

refundOptionInput

subscriber

Optional URIs for callbacks for this job.

Confirm claimed refund option › Responses

a geojson response, containing the package details in the main properties and the legs are represented in the features

a purchased package is a registration of an agreement between end user and TO, to execute a package (=set of legs) according a specification, including all conditions

package

type

string · pattern: ^(package)$ · required

status

packageStatus · enum · required

Enum values:

OFFERED

SELECTED

PENDING

CONFIRMED

RELEASED

EXPIRED

CANCELLED

REFUND_CLAIMED

amountOfMoney · required

an amount of money, usable in fares, fare calculations or in extra costs.

offer[] · required

placeReference

placeReference[] · minItems: 0 · maxItems: 3

use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'

placeReference

startTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

endTime

dateTime · date-time

https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)

postalAddress[] · minItems: 0 · maxItems: 3

Places that are not specified in an external data source (like a home address)

id

string

externalReference

normalString · maxLength: 200

default string, full names etc (length 0-200)

guarantees

normalString[]

array

link[]

POST/processes/confirm-refund-option/execute

curl https://api.entur.io/omsa/v1/processes/confirm-refund-option/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Language: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "inputs": {
    "type": "type",
    "optionId": "optionId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "inputs": {
    "type": "type",
    "optionId": "optionId"
  },
  "subscriber": {
    "successUri": "https://www.example.com/path/to/resource",
    "inProgressUri": "https://www.example.com/path/to/resource",
    "failedUri": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "from": {
    "placeId": "placeId",
    "name": "name"
  },
  "via": [
    {
      "placeId": "placeId",
      "name": "name"
    }
  ],
  "to": {
    "placeId": "placeId",
    "name": "name"
  },
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "placeDefinitions": [
    {
      "placeId": {
        "placeId": "placeId",
        "name": "name"
      },
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "street": "street",
      "houseNumber": 0,
      "houseNumberAddition": "houseNumberAddition",
      "postalCode": "postalCode",
      "city": "city",
      "province": "province",
      "state": "state",
      "country": "country",
      "additionalInfo": "additionalInfo"
    }
  ],
  "type": "type",
  "id": "id",
  "externalReference": "externalReference",
  "status": "OFFERED",
  "price": {
    "amount": 0,
    "taxPercentageUsed": 0,
    "currencyCode": "currencyCode",
    "vatCountryCode": "vatCountryCode"
  },
  "offers": [
    {
      "id": "id",
      "type": "type",
      "properties": {
        "legs": [
          {
            "from": {
              "placeId": "placeId",
              "name": "name"
            },
            "via": [
              {
                "placeId": "placeId",
                "name": "name"
              }
            ],
            "to": {
              "placeId": "placeId",
              "name": "name"
            },
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "id": "id",
            "type": "type",
            "sequenceNumber": 0,
            "traveller": "traveller",
            "state": "NOT_STARTED",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "products": [
              "string"
            ],
            "ancillaries": [
              "string"
            ],
            "usageValidityPeriods": [
              "string"
            ],
            "frequenciesOfUse": [
              "string"
            ],
            "mode": "AIR",
            "assets": [
              "string"
            ],
            "reservationRequirement": {
              "type": "type",
              "spotType": "VEHICLE_SPOT",
              "reservationPolicy": "NOT_POSSIBLE",
              "sourceReservationPolicy": "sourceReservationPolicy",
              "assetSelection": "NOT_AVAILABLE",
              "serviceJourney": "serviceJourney",
              "fulfilledByAncillaries": [
                {
                  "ancillaryId": "ancillaryId",
                  "name": "name"
                }
              ]
            },
            "operator": {
              "organisationId": "organisationId",
              "name": "name"
            }
          }
        ],
        "usageValidityPeriods": [
          {
            "id": "id",
            "type": "type",
            "validityPeriodType": "SINGLE_RIDE",
            "usageTrigger": "ENROLMENT",
            "usageEnd": "STANDARD_DURATION",
            "standardDuration": "P3D",
            "activationMeans": "NONE_REQUIRED",
            "startDate": "startDate",
            "startTime": "15:00:00",
            "endDate": "endDate",
            "endTime": "15:00:00",
            "usageStartConstraintType": "VARIABLE",
            "blackoutUse": "MAY_TRAVEL_ANYTIME"
          }
        ],
        "frequenciesOfUse": [
          {
            "id": "id",
            "type": "type",
            "frequencyOfUseType": "NONE",
            "minimalFrequency": 0,
            "maximalFrequency": 0,
            "frequencyInterval": "P3D"
          }
        ],
        "ancillaries": [
          {
            "ancillaryId": "ancillaryId",
            "name": "name",
            "type": "type",
            "price": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "description": "description",
            "available": 0,
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ],
            "links": [
              {
                "rel": "rel",
                "href": "https://www.example.com/path/to/resource",
                "type": "type",
                "method": "POST",
                "description": "description",
                "body": {},
                "headers": {
                  "key": "string"
                },
                "isMandatory": true,
                "hash": "hash",
                "validity": {
                  "type": "type",
                  "startTime": "2024-08-25T15:00:00Z",
                  "endTime": "2024-08-25T15:00:00Z",
                  "duration": 0,
                  "dayType": "MON"
                }
              }
            ]
          }
        ],
        "products": [
          {
            "type": "type",
            "productId": {
              "productId": "productId",
              "name": "name"
            },
            "productName": "productName",
            "guarantees": [
              {
                "id": "id",
                "type": "type"
              }
            ],
            "service": [
              {
                "type": "type",
                "product": {
                  "productId": "productId",
                  "name": "name"
                },
                "asset": "asset",
                "serviceJourney": "serviceJourney",
                "userNeeds": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "class": "FIRST_CLASS",
                "onboardStay": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "permission": true,
                    "duration": "duration"
                  }
                ],
                "accommodations": [
                  {
                    "type": "type",
                    "description": "description",
                    "classOfUse": "FIRST_CLASS",
                    "name": "name",
                    "gender": "M",
                    "berthType": "SLEEPER",
                    "nuisanceFacility": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "reservationRequirements": [
              {
                "type": "type",
                "spotType": "VEHICLE_SPOT",
                "reservationPolicy": "NOT_POSSIBLE",
                "sourceReservationPolicy": "sourceReservationPolicy",
                "assetSelection": "NOT_AVAILABLE",
                "serviceJourney": "serviceJourney",
                "fulfilledByAncillaries": [
                  {
                    "ancillaryId": "ancillaryId",
                    "name": "name"
                  }
                ]
              }
            ]
          }
        ],
        "price": {
          "amount": 0,
          "taxPercentageUsed": 0,
          "currencyCode": "currencyCode",
          "vatCountryCode": "vatCountryCode"
        },
        "summary": {},
        "guarantees": [
          {
            "id": "id",
            "type": "type"
          }
        ],
        "expiryTime": "2024-08-25T15:00:00Z"
      },
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "guarantees": [
    "string"
  ],
  "travellers": [
    {
      "type": "type",
      "entitlements": {
        "commercialProfiles": [
          {
            "id": "id",
            "type": "type",
            "code": "code",
            "name": "name"
          }
        ],
        "entitlementsGiven": [
          {
            "id": "id",
            "type": "type",
            "entitlementType": "entitlementType"
          }
        ],
        "cardTypes": [
          {
            "id": "id",
            "type": "type",
            "cardCategory": "DISCOUNT",
            "subCategory": "subCategory",
            "relatedProduct": {
              "productId": "productId",
              "name": "name"
            },
            "transportOrganisations": [
              {
                "organisationId": "organisationId",
                "name": "name"
              }
            ],
            "customFields": {}
          }
        ],
        "cards": [
          {
            "type": "type",
            "cardType": {
              "id": "id",
              "type": "type",
              "cardCategory": "DISCOUNT",
              "subCategory": "subCategory",
              "relatedProduct": {
                "productId": "productId",
                "name": "name"
              },
              "transportOrganisations": [
                {
                  "organisationId": "organisationId",
                  "name": "name"
                }
              ],
              "customFields": {}
            },
            "cardNumber": "cardNumber",
            "description": "description",
            "additionalNumber": "additionalNumber",
            "endValidity": "endValidity",
            "country": "country"
          }
        ],
        "licenseTypes": [
          {
            "type": "type",
            "modes": [
              "AIR"
            ],
            "licenseCode": "licenseCode",
            "issuingCountry": "issuingCountry",
            "customFields": {}
          }
        ],
        "licenses": [
          {
            "type": "type",
            "licenseType": {
              "type": "type",
              "modes": [
                "AIR"
              ],
              "licenseCode": "licenseCode",
              "issuingCountry": "issuingCountry",
              "customFields": {}
            },
            "licenseNumber": "licenseNumber",
            "endValidity": "endValidity"
          }
        ]
      },
      "requirements": {
        "organisational": [
          {
            "id": "id",
            "type": "type",
            "name": "name",
            "legalName": "legalName"
          }
        ],
        "spotReservations": [
          {
            "type": "type",
            "spotType": "VEHICLE_SPOT",
            "deck": "deck",
            "space": "space",
            "spot": "spot",
            "width": 0,
            "length": 0,
            "height": 0,
            "fuel": "fuel",
            "weight": "weight",
            "mode": "AIR"
          }
        ],
        "distribution": [
          {
            "type": "type",
            "fulfilmentMethod": "fulfilmentMethod",
            "distributionChannel": "distributionChannel"
          }
        ],
        "network": [
          {
            "type": "type",
            "location": {
              "placeId": "placeId",
              "name": "name"
            },
            "line": "line",
            "zones": [
              {
                "zoneId": "zoneId",
                "name": "name"
              }
            ]
          }
        ],
        "routing": [
          {
            "type": "type",
            "journeyPattern": [
              "string"
            ]
          }
        ],
        "service": [
          {
            "type": "type",
            "product": {
              "productId": "productId",
              "name": "name"
            },
            "asset": "asset",
            "serviceJourney": "serviceJourney",
            "userNeeds": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "class": "FIRST_CLASS",
            "onboardStay": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "permission": true,
                "duration": "duration"
              }
            ],
            "accommodations": [
              {
                "type": "type",
                "description": "description",
                "classOfUse": "FIRST_CLASS",
                "name": "name",
                "gender": "M",
                "berthType": "SLEEPER",
                "nuisanceFacility": [
                  "string"
                ]
              }
            ]
          }
        ],
        "temporal": [
          {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        ],
        "equipment": [
          {
            "type": "type",
            "id": {
              "equipmentId": "equipmentId",
              "name": "name"
            },
            "name": "name",
            "description": "description",
            "infoLink": "https://www.example.com/path/to/resource",
            "image": "https://www.example.com/path/to/resource"
          }
        ],
        "cancellation": [
          {
            "type": "type",
            "cancellationAllowed": true,
            "cancellationFee": {
              "amount": 0,
              "taxPercentageUsed": 0,
              "currencyCode": "currencyCode",
              "vatCountryCode": "vatCountryCode"
            },
            "cancellationFeePercentage": 0
          }
        ],
        "purchase": [
          {
            "type": "type",
            "maximumPeriodBeforeDeparture": 0,
            "requiredLicenseTypes": [
              {
                "type": "type",
                "modes": [
                  "AIR"
                ],
                "licenseCode": "licenseCode",
                "issuingCountry": "issuingCountry",
                "customFields": {}
              }
            ]
          }
        ]
      },
      "id": "id",
      "isValidated": true,
      "age": 0,
      "gender": "M",
      "fullName": "fullName",
      "customerReference": "customerReference",
      "customFields": {}
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

collections authentication

Did you find what you were looking for?