Entitlements
API for handling personnel ticket entitlements.
Gets entitlements for a customer
Gets entitlements for a customer by customer number, including information about the product, contract and contract holder.
path Parameters
customerNumberquery Parameters
travelDateGet valid entitlements for travel date
excludeSubContractsExclude day trip entitlements. Default is false
Headers
AuthorizationET-Client-NameEntur 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-IdCorrelation id
Gets entitlements for a customer › Responses
OK
productIdId of the product connected to the contracts loyalty program
contractUUIDContract UUID, used to identify a contract
productVersionVersion of the product connected to the contracts loyalty program
contractValidFromContract consumable from date
passengerCategoryPassenger category.
contractOwnerDisplayNameContract owners first and last name
contractOwnerCustomerNumberContract owner customer number
Display name for loyalty program
couponsLimitHow many coupons the contract has. Default is cascaded from Loyalty Program Version. If set, the contract will be blocked for usage when all coupons are used. Coupons are registered via an OrderLineEvent.
ticketOrderIdIf present, a ticket is included in this right. It may be distributed or redistributed to this device.
contractParentIf present, contract UUID of the parent contract. This field is usually set if the contract is created by a coupon usage, whereas this contract has a time constraint and the parent has a coupon constraint.
contractValidToContract expiration date
remainingCouponsRemaining coupons connected to the contract
contractExternalRefExternal contract reference if set.
Contract owners birth day
isSeniorCitizenWhether the contract owner is considered a senior citizen