Ticket rights

Download schema

List generated ticket rights

Find ticket rights by params

GET

https://api.entur.io

/personnelticket/v2/ticketrights

Find ticket rights by params › query Parameters

employeeNo

string · style: form · explode: true

companyId

integer · int64 · style: form · explode: true

fromDate

string · date · style: form · explode: true

includeTicketRightsHolder

boolean · style: form · explode: true

page

integer · int32 · style: form · explode: true

perPage

integer · int32 · style: form · explode: true

Find ticket rights by params › Headers

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

Correlation id

Find ticket rights by params › Responses

Paged content

PageTicketRightResponse

TicketRightResponse[] · required

All items for this page

totalItems

integer · int64 · required

Total items which could be returned

Example: 1

totalPages

integer · int64 · required

Total number of pages

Example: 1

GET/personnelticket/v2/ticketrights

curl https://api.entur.io/personnelticket/v2/ticketrights \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "items": [
    {
      "note": "note",
      "validFrom": "2019-03-13",
      "employeeId": 0,
      "ticketType": {
        "id": 0,
        "code": "code",
        "isDeleted": true,
        "countryCode": "countryCode",
        "description": "description",
        "canHaveStationPairs": true,
        "generatesTicketRights": true
      },
      "validUntil": "2019-06-13",
      "manualOrder": {
        "id": 0,
        "toDate": "2023-01-01",
        "fromDate": "2023-01-01",
        "stations": [
          {
            "id": 0,
            "toStation": {
              "id": "id",
              "name": "name"
            },
            "fromStation": {
              "id": "id",
              "name": "name"
            }
          }
        ],
        "isDeleted": true,
        "issueDate": "2024-08-25T15:00:00Z",
        "ticketType": {
          "id": 0,
          "code": "code",
          "isDeleted": true,
          "countryCode": "countryCode",
          "description": "description",
          "canHaveStationPairs": true,
          "generatesTicketRights": true
        }
      },
      "errorMessage": "errorMessage",
      "canSendTicket": true,
      "createdByRule": {
        "id": 0,
        "name": "name"
      },
      "essSyncStatus": {
        "errorMessage": "errorMessage",
        "isReadyToSync": true,
        "syncTimestamp": "2019-06-13T12:34:56+01:00"
      },
      "ticketCreated": "2024-08-25T15:00:00Z",
      "ticketrightId": 0,
      "ticketHolderId": 0,
      "legacySyncStatus": {
        "errorMessage": "errorMessage",
        "isReadyToSync": true,
        "syncTimestamp": "2019-06-13T12:34:56+01:00"
      },
      "ticketRightsHolder": {
        "id": 0,
        "surname": "surname",
        "firstName": "firstName",
        "postalCode": "postalCode",
        "addressLine": "addressLine",
        "countryCode": "countryCode",
        "dateOfBirth": "2023-01-01",
        "postalPlace": "postalPlace",
        "ticketHolderCode": "ticketHolderCode"
      },
      "calculationTimestamp": "2024-08-25T15:00:00Z"
    }
  ],
  "totalItems": 1,
  "totalPages": 1
}

json

application/json

Entitlements Family members

Personnel tickets

Ticket rights

Download schema

List generated ticket rights

Find ticket rights by params

GET

https://api.entur.io

/personnelticket/v2/ticketrights

Find ticket rights by params › query Parameters

employeeNo

string · style: form · explode: true

companyId

integer · int64 · style: form · explode: true

fromDate

string · date · style: form · explode: true

includeTicketRightsHolder

boolean · style: form · explode: true

page

integer · int32 · style: form · explode: true

perPage

integer · int32 · style: form · explode: true

Find ticket rights by params › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Find ticket rights by params › Responses

Paged content

PageTicketRightResponse

TicketRightResponse[] · required

All items for this page

totalItems

integer · int64 · required

Total items which could be returned

Example: 1

totalPages

integer · int64 · required

Total number of pages

Example: 1

GET/personnelticket/v2/ticketrights

curl https://api.entur.io/personnelticket/v2/ticketrights \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "items": [
    {
      "note": "note",
      "validFrom": "2019-03-13",
      "employeeId": 0,
      "ticketType": {
        "id": 0,
        "code": "code",
        "isDeleted": true,
        "countryCode": "countryCode",
        "description": "description",
        "canHaveStationPairs": true,
        "generatesTicketRights": true
      },
      "validUntil": "2019-06-13",
      "manualOrder": {
        "id": 0,
        "toDate": "2023-01-01",
        "fromDate": "2023-01-01",
        "stations": [
          {
            "id": 0,
            "toStation": {
              "id": "id",
              "name": "name"
            },
            "fromStation": {
              "id": "id",
              "name": "name"
            }
          }
        ],
        "isDeleted": true,
        "issueDate": "2024-08-25T15:00:00Z",
        "ticketType": {
          "id": 0,
          "code": "code",
          "isDeleted": true,
          "countryCode": "countryCode",
          "description": "description",
          "canHaveStationPairs": true,
          "generatesTicketRights": true
        }
      },
      "errorMessage": "errorMessage",
      "canSendTicket": true,
      "createdByRule": {
        "id": 0,
        "name": "name"
      },
      "essSyncStatus": {
        "errorMessage": "errorMessage",
        "isReadyToSync": true,
        "syncTimestamp": "2019-06-13T12:34:56+01:00"
      },
      "ticketCreated": "2024-08-25T15:00:00Z",
      "ticketrightId": 0,
      "ticketHolderId": 0,
      "legacySyncStatus": {
        "errorMessage": "errorMessage",
        "isReadyToSync": true,
        "syncTimestamp": "2019-06-13T12:34:56+01:00"
      },
      "ticketRightsHolder": {
        "id": 0,
        "surname": "surname",
        "firstName": "firstName",
        "postalCode": "postalCode",
        "addressLine": "addressLine",
        "countryCode": "countryCode",
        "dateOfBirth": "2023-01-01",
        "postalPlace": "postalPlace",
        "ticketHolderCode": "ticketHolderCode"
      },
      "calculationTimestamp": "2024-08-25T15:00:00Z"
    }
  ],
  "totalItems": 1,
  "totalPages": 1
}

json

application/json

Entitlements Family members

Ticket rights

Find ticket rights by params

Find ticket rights by params › query Parameters

Find ticket rights by params › Headers

Find ticket rights by params › Responses

Build with Entur

Contribute

Terms & Policies

Ticket rights

Find ticket rights by params

Find ticket rights by params › query Parameters

Find ticket rights by params › Headers

Find ticket rights by params › Responses