Customers
Find information about memberships and status a customer might have in programs.
Query program memberships of a customer
Query the memberships of a customer using customer ID. Returns list of program memberships, with the member ID and any member data that is stored in each program.
Headers
ET-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
Query program memberships of a customer › Request Body
customerIdCustomer id of the member
programReferencesList of reference to the programs to query.
Query program memberships of a customer › Responses
OK
memberIdThe ID for the customer's membership in the program
programIdMetadata about the member
programReferenceUnique reference for the program.
Current status of a customer
Current Level Summary contains information about the current status of a customer in a program, with information about how many points the customer has, what level on the reward ladder they're at, the rewards they have achieved and any suspensions they might have.
By default, the endpoint will return the customers status at the time the request was made. However, you can specify the request parameter statusAt to set which time to query the status for.
Returns a list of summaries, one for each program the customer is a member of. You can choose to filter on programs, using the program reference. Will return empty list if customer is not a member of any programs.
Headers
ET-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
Current status of a customer › Request Body
customerIdCustomer id of the member
statusAtGet current level summary at a given date and time. Defaults to now if not set.
programIdId of the program to query. If null, will return summary of all programs the customer is enrolled in.
programReferenceReference to the program to query. Better to use than programId, since programId might vary in different environments.
programReferencesList of reference to the programs to query. If given then it overrides the programReference parameter.
Current status of a customer › Responses
OK
memberIdId of the member within the program. Can be used to look up more information about the member.
programIdId of the program. WARNING: Don't use this for matching with a specific program, since it may vary across environments. Use "programReference" instead.
The current rewards the member has achieved in the program
The current status of each point definition in the program
The current level in the reward ladder the member has achieved
programReferenceReference to the program. This is a unique reference that is the same in all environments, and can be used to identify the program. Nullable for backwards compatibility reasons. Should be filled out in most cases.