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

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

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,
      "ssn": "12345",
      "note": "note",
      "surname": "surname",
      "relation": {
        "code": "Barn",
        "description": "description"
      },
      "createdAt": "2024-08-25T15:00:00Z",
      "createdBy": "createdBy",
      "firstName": "firstName",
      "isDeleted": true,
      "updatedAt": "2024-08-25T15:00:00Z",
      "updatedBy": "updatedBy",
      "employeeId": 0,
      "lowIncomes": [
        {
          "year": 2015,
          "isRegistered": true
        }
      ],
      "dateOfBirth": "2023-01-01",
      "ticketRights": [
        {
          "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"
        }
      ],
      "customerNumber": 1337370,
      "ticketHolderCode": "JDSF-DGJE-SHU4",
      "abstainFromTicket": true
    }
  ],
  "totalItems": 1,
  "totalPages": 1
}

json

application/json

Ticket rights Codes

Personnel tickets

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

X-Correlation-Id

string

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,
      "ssn": "12345",
      "note": "note",
      "surname": "surname",
      "relation": {
        "code": "Barn",
        "description": "description"
      },
      "createdAt": "2024-08-25T15:00:00Z",
      "createdBy": "createdBy",
      "firstName": "firstName",
      "isDeleted": true,
      "updatedAt": "2024-08-25T15:00:00Z",
      "updatedBy": "updatedBy",
      "employeeId": 0,
      "lowIncomes": [
        {
          "year": 2015,
          "isRegistered": true
        }
      ],
      "dateOfBirth": "2023-01-01",
      "ticketRights": [
        {
          "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"
        }
      ],
      "customerNumber": 1337370,
      "ticketHolderCode": "JDSF-DGJE-SHU4",
      "abstainFromTicket": true
    }
  ],
  "totalItems": 1,
  "totalPages": 1
}

json

application/json

Ticket rights Codes

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

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