Age categories
Get all age categories
Returns all age categories filtered by Service. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/ageCategories/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
AgeCategoryIds
array of string
optional, max 1000 items
ServiceIds
array of string
optional, max 1000 items
Unique identifiers of Services
associated with the age categories. If not provided, defaults to all bookable services.
UpdatedUtc
optional, max length 3 months
Interval in which the age category was updated.
ActivityStates
optional
Whether to return only active, only deleted or both records.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Response
AgeCategories
required
Age category of the enterprise.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Age category
Id
string
required
Unique identifier of age category.
ServiceId
string
required
MinimalAge
integer
optional
Minimal age for the age category.
MaximalAge
integer
optional
Maximal age for the age category.
Names
required
All translations of the name of the age category.
ShortNames
optional
All translations of the short name of the age category.
CreatedUtc
string
required
Creation date and time of the age category in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the age category in UTC timezone in ISO 8601 format.
Classification
required
The classification of the age category.
IsActive
boolean
required
Whether the age category is still active.
ExternalIdentifier
string
optional, max length 255 characters
Identifier of the age category from external system.
Age category classification
Adult
Child
Last updated
Was this helpful?