Entur · Schema

PageFamilyMemberResponse

Paged content

CompanyPublic TransportJourney PlanningMobilityOpen DataNorwayTransitGraphQL

Properties

Name Type Description
items array All items for this page
totalItems integer Total items which could be returned
totalPages integer Total number of pages
View JSON Schema on GitHub

JSON Schema

entur-page-family-member-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/entur/json-schema/entur-page-family-member-response-schema.json",
  "title": "PageFamilyMemberResponse",
  "description": "Paged content",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/entur-family-members-api-openapi.yml#/components/schemas/PageFamilyMemberResponse",
  "required": [
    "items",
    "totalItems",
    "totalPages"
  ],
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "All items for this page",
      "items": {
        "$ref": "#/$defs/FamilyMemberResponse"
      }
    },
    "totalItems": {
      "type": "integer",
      "description": "Total items which could be returned",
      "format": "int64"
    },
    "totalPages": {
      "type": "integer",
      "description": "Total number of pages",
      "format": "int64"
    }
  },
  "$defs": {
    "FamilyMemberLowIncomeResponse": {
      "required": [
        "isRegistered",
        "year"
      ],
      "type": "object",
      "properties": {
        "year": {
          "type": "integer",
          "description": "Year of registered low income",
          "format": "int32"
        },
        "isRegistered": {
          "type": "boolean",
          "description": "Whether low income is registered"
        }
      },
      "description": "Low income information"
    },
    "FamilyMemberResponse": {
      "required": [
        "employeeId",
        "firstName",
        "id",
        "isDeleted",
        "relation",
        "surname"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The ID of the family member",
          "format": "int64"
        },
        "employeeId": {
          "type": "integer",
          "description": "The ID of the employee",
          "format": "int64"
        },
        "relation": {
          "$ref": "#/$defs/FamilyRelation"
        },
        "dateOfBirth": {
          "type": "string",
          "description": "When the family member was born",
          "format": "date"
        },
        "ssn": {
          "type": "string",
          "description": "The family members social security number"
        },
        "firstName": {
          "type": "string",
          "description": "The family member's first name"
        },
        "surname": {
          "type": "string",
          "description": "The family member's surname"
        },
        "abstainFromTicket": {
          "type": "boolean",
          "description": "Whether a ticket should be created"
        },
        "note": {
          "type": "string",
          "description": "Any additional information"
        },
        "isDeleted": {
          "type": "boolean",
          "description": "Whether the family member has been marked for deletion"
        },
        "ticketRights": {
          "type": "array",
          "description": "A list of the family member's ticket rights",
          "items": {
            "$ref": "#/$defs/TicketRightResponse"
          }
        },
        "ticketHolderCode": {
          "type": "string",
          "description": "The family members ticket holder code"
        },
        "createdAt": {
          "type": "string",
          "description": "The date of creation.",
          "format": "date-time"
        },
        "createdBy": {
          "type": "string",
          "description": "The source for the first creation"
        },
        "updatedAt": {
          "type": "string",
          "description": "The date the last time the family member was updated",
          "format": "date-time"
        },
        "updatedBy": {
          "type": "string",
          "description": "The source for the last update"
        },
        "lowIncomes": {
          "type": "array",
          "description": "The low income registrations for the current and the next year",
          "items": {
            "$ref": "#/$defs/FamilyMemberLowIncomeResponse"
          }
        },
        "customerNumber": {
          "type": "integer",
          "description": "The employees customer number in ESS. Note this profile is owned by JBD and is the profile connected to the ticket right. A 'null'-value here may indicate that the ticket right is not yet synced to ESS.",
          "format": "int64"
        }
      },
      "description": "A family member must be connected to an employee"
    },
    "FamilyRelation": {
      "required": [
        "code",
        "description"
      ],
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The code used for input",
          "readOnly": true
        },
        "description": {
          "type": "string",
          "description": "A description of the particular code's meaning",
          "readOnly": true
        }
      },
      "description": "The relation a family member has to an employee"
    },
    "ManualOrderResponse": {
      "required": [
        "fromDate",
        "id",
        "isDeleted",
        "issueDate",
        "ticketType",
        "toDate"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id of this manual order.",
          "format": "int64"
        },
        "ticketType": {
          "$ref": "#/$defs/TicketTypeResponse"
        },
        "issueDate": {
          "type": "string",
          "description": "When this manual order was first issued.",
          "format": "date-time"
        },
        "fromDate": {
          "type": "string",
          "description": "First date the ticket right should be available.",
          "format": "date"
        },
        "toDate": {
          "type": "string",
          "description": "Last date the ticket right should be available.",
          "format": "date"
        },
        "stations": {
          "uniqueItems": true,
          "type": "array",
          "description": "Any station pairs for this manual order.",
          "items": {
            "$ref": "#/$defs/StationPairResponse"
          }
        },
        "isDeleted": {
          "type": "boolean",
          "description": "Whether this manual order is deleted or not."
        }
      },
      "description": "A manual order. This may contain a list of station pairs."
    },
    "SimpleRule": {
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Rule id",
          "format": "int64"
        },
        "name": {
          "type": "string",
          "description": "Rule name"
        }
      },
      "description": "Rule describing who are eligible for what ticket right"
    },
    "StationPairResponse": {
      "required": [
        "fromStation",
        "id",
        "toStation"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id of this station pair",
          "format": "int64"
        },
        "fromStation": {
          "$ref": "#/$defs/StationResponse"
        },
        "toStation": {
          "$ref": "#/$defs/StationResponse"
        }
      },
      "description": "A set of stations on NetEX format."
    },
    "StationResponse": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Station in NetEX format."
        },
        "name": {
          "type": "string",
          "description": "Station name"
        }
      },
      "description": "Station with NetEX and name"
    },
    "SyncStatus": {
      "type": "object",
      "properties": {
        "isReadyToSync": {
          "type": "boolean",
          "description": "Whether the ticket right is ready to be sent to the ticketing system"
        },
        "syncTimestamp": {
          "type": "string",
          "description": "When the ticket right was sync'ed",
          "format": "date-time"
        },
        "errorMessage": {
          "type": "string",
          "description": "If the system has failed in sending the ticket right to the ticketing system, this will hold the error message. Default is null"
        }
      },
      "description": "Status fields related to synchronization with other services"
    },
    "TicketRightResponse": {
      "required": [
        "calculationTimestamp",
        "employeeId",
        "ticketHolderId",
        "ticketType",
        "ticketrightId",
        "validFrom",
        "validUntil"
      ],
      "type": "object",
      "properties": {
        "ticketrightId": {
          "type": "integer",
          "description": "The ticket right id",
          "format": "int64"
        },
        "ticketHolderId": {
          "type": "integer",
          "description": "The id of the ticket holder, either an employee or a family member",
          "format": "int64"
        },
        "employeeId": {
          "type": "integer",
          "description": "The id of the employee who is responsible",
          "format": "int64"
        },
        "validFrom": {
          "type": "string",
          "description": "The date from when the ticket right is valid",
          "format": "date"
        },
        "validUntil": {
          "type": "string",
          "description": "The date from when the ticket right stops being valid",
          "format": "date"
        },
        "ticketType": {
          "$ref": "#/$defs/TicketTypeResponse"
        },
        "note": {
          "type": "string",
          "description": "Any additional information"
        },
        "canSendTicket": {
          "type": "boolean",
          "description": "This field will be discontinued in the next vesion of the API.",
          "deprecated": true
        },
        "ticketCreated": {
          "type": "string",
          "description": "This field will be discontinued in the next vesion of the API.",
          "format": "date-time",
          "deprecated": true
        },
        "errorMessage": {
          "type": "string",
          "description": "This field will be discontinued in the next vesion of the API.",
          "deprecated": true
        },
        "createdByRule": {
          "$ref": "#/$defs/SimpleRule"
        },
        "calculationTimestamp": {
          "type": "string",
          "description": "When the ticketright was calculated",
          "format": "date-time"
        },
        "ticketRightsHolder": {
          "$ref": "#/$defs/TicketRightsHolderResponse"
        },
        "legacySyncStatus": {
          "$ref": "#/$defs/SyncStatus"
        },
        "essSyncStatus": {
          "$ref": "#/$defs/SyncStatus"
        },
        "manualOrder": {
          "$ref": "#/$defs/ManualOrderResponse"
        }
      },
      "description": "A ticket right granted to an employee or a family member"
    },
    "TicketRightsHolderResponse": {
      "required": [
        "id",
        "ticketHolderCode"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The ticket right holder id",
          "format": "int64"
        },
        "ticketHolderCode": {
          "type": "string",
          "description": "The personnel ticket code for the ticket rights holder"
        },
        "ticketRight": {
          "$ref": "#/$defs/TicketRightResponse"
        },
        "firstName": {
          "type": "string",
          "description": "Unused. This field is populated by employee / family member data and will be removed in future versions.",
          "deprecated": true
        },
        "surname": {
          "type": "string",
          "description": "Unused. This field is populated by employee / family member data and will be removed in future versions.",
          "deprecated": true
        },
        "addressLine": {
          "type": "string",
          "description": "Unused. This field is populated by employee / family member data and will be removed in future versions.",
          "deprecated": true
        },
        "postalCode": {
          "type": "string",
          "description": "Unused. This field is populated by employee / family member data and will be removed in future versions.",
          "deprecated": true
        },
        "postalPlace": {
          "type": "string",
          "description": "Unused. This field is populated by employee / family member data and will be removed in future versions.",
          "deprecated": true
        },
        "countryCode": {
          "type": "string",
          "description": "Unused. This field is populated by employee / family member data and will be removed in future versions.",
          "deprecated": true
        },
        "dateOfBirth": {
          "type": "string",
          "description": "Unused. This field is populated by employee / family member data and will be removed in future versions.",
          "format": "date",
          "deprecated": true
        }
      },
      "description": "All items for this page"
    },
    "TicketTypeResponse": {
      "required": [
        "canHaveStationPairs",
        "code",
        "countryCode",
        "description",
        "generatesTicketRights",
        "id",
        "isDeleted"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Ticket type id",
          "format": "int64"
        },
        "code": {
          "type": "string",
          "description": "Ticket type"
        },
        "description": {
          "type": "string",
          "description": "Ticket type description"
        },
        "countryCode": {
          "type": "string",
          "description": "Country code"
        },
        "generatesTicketRights": {
          "type": "boolean",
          "description": "Whether or not this this ticket type is relevant for sending as input to a Manual order. If this = false (the default), it will not generate new tickets rights by manual order."
        },
        "canHaveStationPairs": {
          "type": "boolean",
          "description": "Whether or not this ticket type is compatible with station pairs when placing a manual order. The default = false. "
        },
        "isDeleted": {
          "type": "boolean",
          "description": "Whether the ticket type is deleted."
        }
      },
      "description": "The Ticket type informs of which country it is valid in and what train class it covers."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/entur-page-family-member-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.