Family members

Download schema

Administration of family members. Each family member must be connected to an employee

Fetches the full list of family members

GET

https://api.entur.io

/personnelticket/v2/family-members

Get all family members

Fetches the full list of family members › query Parameters

companyId

integer · int64 · style: form · explode: true

page

integer · int32 · style: form · explode: true

perPage

integer · int32 · style: form · explode: true

Fetches the full list of family members › Headers

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

Fetches the full list of family members › Responses

Paged content

PageFamilyMemberResponse

FamilyMemberResponse[] · 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/family-members

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

Example Responses

{
  "items": [
    {
      "id": 0,
      "employeeId": 0,
      "relation": {
        "code": "code",
        "description": "description"
      },
      "dateOfBirth": "2023-01-01",
      "ssn": "12345",
      "firstName": "firstName",
      "surname": "surname",
      "abstainFromTicket": true,
      "note": "note",
      "isDeleted": true,
      "ticketRights": [
        {
          "ticketrightId": 0,
          "ticketHolderId": 0,
          "employeeId": 0,
          "validFrom": "2019-03-13",
          "validUntil": "2019-06-13",
          "ticketType": {
            "id": 0,
            "code": "code",
            "description": "description",
            "countryCode": "countryCode",
            "generatesTicketRights": true,
            "canHaveStationPairs": true,
            "isDeleted": true
          },
          "note": "note",
          "canSendTicket": true,
          "ticketCreated": "2024-08-25T15:00:00Z",
          "errorMessage": "errorMessage",
          "createdByRule": {
            "id": 0,
            "name": "name"
          },
          "calculationTimestamp": "2024-08-25T15:00:00Z",
          "ticketRightsHolder": {
            "id": 0,
            "ticketHolderCode": "ticketHolderCode",
            "firstName": "firstName",
            "surname": "surname",
            "addressLine": "addressLine",
            "postalCode": "postalCode",
            "postalPlace": "postalPlace",
            "countryCode": "countryCode",
            "dateOfBirth": "2023-01-01"
          },
          "legacySyncStatus": {
            "isReadyToSync": true,
            "syncTimestamp": "2019-06-13T12:34:56+01:00",
            "errorMessage": "errorMessage"
          },
          "essSyncStatus": {
            "isReadyToSync": true,
            "syncTimestamp": "2019-06-13T12:34:56+01:00",
            "errorMessage": "errorMessage"
          },
          "manualOrder": {
            "id": 0,
            "ticketType": {
              "id": 0,
              "code": "code",
              "description": "description",
              "countryCode": "countryCode",
              "generatesTicketRights": true,
              "canHaveStationPairs": true,
              "isDeleted": true
            },
            "issueDate": "2024-08-25T15:00:00Z",
            "fromDate": "2023-01-01",
            "toDate": "2023-01-01",
            "stations": [
              {
                "id": 0,
                "fromStation": {
                  "id": "id",
                  "name": "name"
                },
                "toStation": {
                  "id": "id",
                  "name": "name"
                }
              }
            ],
            "isDeleted": true
          }
        }
      ],
      "ticketHolderCode": "JDSF-DGJE-SHU4",
      "createdAt": "2024-08-25T15:00:00Z",
      "createdBy": "createdBy",
      "updatedAt": "2024-08-25T15:00:00Z",
      "updatedBy": "updatedBy",
      "lowIncomes": [
        {
          "year": 2015,
          "isRegistered": true
        }
      ],
      "customerNumber": 1337370
    }
  ],
  "totalItems": 1,
  "totalPages": 1
}

json

application/json

Ticket rights Codes

Did you find what you were looking for?

Family members

Fetches the full list of family members

Fetches the full list of family members › query Parameters

Fetches the full list of family members › Headers

Fetches the full list of family members › Responses

Build with Entur

Contribute

Terms & Policies