CustomerAccount

EARLY RELEASE NOTICE
This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. IT IS STILL SUBJECT TO CHANGE, as the Customer Accounts proposal evolves.
Properties
Optional properties
Property
Expected Type
Description
@type
​Text​
Must always be present and set to "@type": "CustomerAccount"
@id
​URL​
A unique URI-based identifier for the record.
@id properties are used as identifiers for compatibility with JSON-LD. The value of such a property must always be an absolute URI that provides a stable globally unique identifier for the resource, as described in RFC3986.
The primary purpose of the URI format in this context is to provide natural namespacing for the identifier. Hence, the URI itself may not resolve to a valid endpoint, but must use a domain name controlled by the resource owner (the organisation responsible for the OpenActive open data feed).

Example
"@id": "https://id.bookingsystem.example.com/customer-accounts/fdc14503-275e-46d3-9922-45b986c9f9aa"
accessPass
Array of Barcode​
The barcode, QR code, magnetic stripe, or swipe card associated with this Customer Account, within their own namespaces.
accountNumber
​Text​
The customer-facing identifier for the Customer Account.
customer
​Person
- or -
Organization​
The person or organization to whom this Customer Account belongs.
entitlement
Array of Entitlement​
The current valid and active entitlements associated with this customer. Note that expired or inactive entitlements are not included in this list.
hasHiddenEntitlements
​Boolean​
Whether there are any additional entitlements (other than those listed in entitlement) or other types of discounts are associated with the Customer Account that will influence pricing, and therefore whether the pricing for the entitlement in the feed should be treated as indicative.

Example
"hasHiddenEntitlements": "true"
identifier
​Text​
The identifier of the Customer Account used by the Booking System.

Example
"identifier": "fdc14503-275e-46d3-9922-45b986c9f9aa"
outstandingAction
Array of Action​
Outstanding actions on this Customer Account, such as the resolution of outstanding debts or membership renewal. These may prevent the Customer from making bookings.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution License (CC-BY V4.0), and code samples are licensed under the MIT License, for anyone to access, use and share; using attribution "OpenActive".

Creche

DataCatalog

Last modified 10mo ago

Copy link

Edit on GitHub

On this page

EARLY RELEASE NOTICE

Properties

Optional properties