Schemas

The http status code.

The main error message.

The unique correlation id for the request.

The main error message.

Validation error on a specific field.

Customer id

The organisation this member belongs to

Metadata needed for the processing of events

The name of the program

If program is active. Inactive programs are excluded from triggering effects.

Id of organisation owning the program

A list of organisations that can consume the program

A list of organisations that can administrate the program

A link to information about the program

Unique reference for the program. Meant to be used to identify which program this is, across different environments where the id might be different. This enables clients of the api to more easily identify the program, for example to enrich the presentation, beyond what this api delivers (for example with an icon, or more descriptive text).

All items for this page

Total items which could be returned

Total number of pages

Id of the level in the reward ladder

Rewards for this level

The ID of the point period

The end time of the point period

The start time of the point period

Metadata for a point period. Example:

Code
{"userType": "ADULT",
    "stationPair": {
        "to": "NSR:StopPlace:337",
        "from": "NSR:StopPlace:11"
    }
}

The amount of points given

Reference to the point definition given point for

The ID of the point period the points were given in, if applicable

The ID of the transaction for the given points. Null if the points given amount is 0.

Generated identifier

The number of points of the definition this transaction gives

The date and time when the transaction was created

The id of the program this transaction belongs to

The date and time the transaction is valid from.

The id of the point definition this transaction gives points of

The date and time when the transaction expires. If null, the transaction never expires.

Metadata for the transaction

The date and time when the transaction was last updated

The date and time when the transaction was cancelled. If not null, the transaction is valid until this time.

Unique reference for this transaction. Populated from the event that created the transaction, based on the effect configuration.

The reference of the point definition this transaction gives points of

Whether the capping amount has been reached by the member

The amount that this point definition is capped at

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

Generated identifier

When the suspension period ends

When the suspension period starts

The date and time when the period was created

Code
    Id to match multiple suspension periods.
    Can for example be the id of the ticket, so that all periods for that ticket gets the same suspensionId.
    Used for cancelling suspensions. See the CancelSuspensions effect.

Metadata for the suspension period

The date and time when the period was last updated

When the suspension period was cancelled from.

When the suspension will end

When the suspension started

The reference id of the suspension

Code
    The type of suspension:
    - Rewards: Member is suspended from receiving rewards
    - GivePointsEffect: Member is suspended from being given points
    - ConsumePointsEffect: Member is suspended from using points
    - UpdateMemberMetadata: Member is suspended from updating their metadata. 
    - SuspendRewardsEffect: Member is suspended from being put into reward suspension
    - SuspendEffectEffect: Member is suspended from being put into effect suspension

List of points given per point definition

Required amount to reach a program level

Id of the point definition

Point definition reference

The ID for the customer's membership in the program

Metadata about the member

Unique reference for the program.

Level name

Rewards when the level is reached

Whether any or all requirements need to be fulfilled

Requirements for reaching the level

Program level details, including the specific requirements and rewards for each level in the program

Generated identifier

The number of points of the definition this transaction gives

The ID of the member in the program this transaction belongs to

The date and time when the transaction was created

The id of the program this transaction belongs to

The date and time the transaction is valid from.

The id of the point definition this transaction gives points of

The date and time when the transaction expires. If null, the transaction never expires.

Metadata for the transaction

The date and time when the transaction was last updated

The date and time when the transaction was cancelled. If not null, the transaction is valid until this time.

The id of the point period this transaction belongs to, if applicable

The reference of the point definition this transaction gives points of

Id of the member within the program. Can be used to look up more information about the member.

Id 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

Reference 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.

The start of the period for which the current points are valid

The end of the period for which the current points are valid

Reason why no points were given

The http status code.

The order ID for which to register

The customer ID for which to register the order

The order line ID for which to register

All items for this page

Total items which could be returned

Total number of pages

The amount of points the member currently has of this point definition

The amount of points the member has received, but are not valid yet. If the point definition is periodic, this field will only contain the pending points in the current point period.

Id of the point definition

Unique reference for the point. Meant to be used to identify what kind of point this is, across different environments where the id might be different. This enables clients of the api to enrich the presentation of the point definition, beyond what this api delivers (for example giving the point definition an icon, or more descriptive text).

Plural name of the point definition

Singular name of the point definition

The capping status for this point definition, if capping is enabled

The period for which the current points are valid. Only filled out if the point definition is periodic. Can return the first active period after the queried time if there is no period active at that point.

Generated identifier

When the suspension period ends

When the suspension period starts

The date and time when the period was created

Code
    Id to match multiple suspension periods.
    Can for example be the id of the ticket, so that all periods for that ticket gets the same suspensionId.
    Used for cancelling suspensions. See the CancelSuspensions effect.

The type of effect that this period suspends

Metadata for the suspension period

The date and time when the period was last updated

When the suspension period was cancelled from.

Generated identifier

When the suspension period ends

When the suspension period starts

The date and time when the period was created

Code
    Id to match multiple suspension periods.
    Can for example be the id of the ticket, so that all periods for that ticket gets the same suspensionId.
    Used for cancelling suspensions. See the CancelSuspensions effect.

Metadata for the suspension period

The date and time when the period was last updated

When the suspension period was cancelled from.

Customer id of the member

Get current level summary at a given date and time. Defaults to now if not set.

Id of the program to query. If null, will return summary of all programs the customer is enrolled in.

Reference to the program to query. Better to use than programId, since programId might vary in different environments.

List of reference to the programs to query. If given then it overrides the programReference parameter.

Customer id of the member

List of reference to the programs to query.

The percentage discount this reward gives

The percentage discount this reward gives

The percentage discount this reward gives