Skip to content

Get all age categories

POST
/api/connector/v1/ageCategories/getAll

Returns all age categories filtered by Service. Note this operation uses Pagination and supports Portfolio Access Tokens.

AgeCategoryParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

Array<string>
nullable >= 1 items <= 1000 items
AgeCategoryIds

Unique identifiers of Age categories.

Array<string>
nullable >= 1 items <= 1000 items
ServiceIds

Unique identifiers of Service associated with the age categories. If not provided, defaults to all bookable services.

Array<string>
nullable >= 1 items <= 1000 items
UpdatedUtc
TimeFilterInterval

Interval in which the age category was updated.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
ActivityStates

Whether to return only active, only deleted or both records.

Array<string>
nullable
Allowed values: Deleted Active
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
],
"ServiceIds": [
"bd26d8db-86da-4f96-9efc-e5a4654a4a94"
],
"AgeCategoryIds": [
"fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
"ab58c939-be30-4a60-8f75-ae1600c60c9f"
],
"UpdatedUtc": {
"StartUtc": "2023-10-01T00:00:00Z",
"EndUtc": "2023-10-31T00:00:00Z"
},
"ActivityStates": [
"Active"
],
"Limitation": {
"Count": 10
}
}

OK

AgeCategoryResult
object
AgeCategories
required

Age category of the enterprise.

Array<object>
Age category
object
Id
required

Unique identifier of age category.

string format: uuid
ServiceId
required

Unique identifier of Service the age category belongs to.

string format: uuid
MinimalAge

Minimal age for the age category.

integer format: int32
nullable
MaximalAge

Maximal age for the age category.

integer format: int32
nullable
Names
required
Localized text

All translations of the name of the age category.

object
key
additional properties
string
ShortNames
Localized text

All translations of the short name of the age category.

object
key
additional properties
string
CreatedUtc
required

Creation date and time of the age category in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the age category in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Classification
required
Age category classification

The classification of the age category.

Adult

Child

string
Allowed values: Adult Child
IsActive
required

Whether the age category is still active.

boolean
ExternalIdentifier

Identifier of the age category from external system.

string
nullable <= 255 characters
Cursor

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.

string format: uuid
nullable
Example
{
"AgeCategories": [
{
"Id": "ab58c939-be30-4a60-8f75-ae1600c60c9f",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
"MinimalAge": null,
"MaximalAge": null,
"Names": {
"cs-CZ": "Dospělí",
"da-DK": "Voksne",
"de-CH": "Erwachsene",
"de-DE": "Erwachsene",
"el-GR": "Ενήλικοι",
"en-GB": "Adults"
},
"ShortNames": null,
"CreatedUtc": "2023-10-01T11:48:57Z",
"UpdatedUtc": "2023-10-28T11:48:57Z",
"Classification": "Adult",
"IsActive": false,
"ExternalIdentifier": "Adult"
},
{
"Id": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
"MinimalAge": 0,
"MaximalAge": 18,
"Names": {
"cs-CZ": "Děti",
"da-DK": "Børn",
"de-CH": "Kinder",
"de-DE": "Kinder",
"el-GR": "Παιδιά",
"en-GB": "Children"
},
"ShortNames": null,
"CreatedUtc": "2023-10-01T11:48:57Z",
"UpdatedUtc": "2023-10-28T11:48:57Z",
"Classification": "Child",
"IsActive": false,
"ExternalIdentifier": null
}
],
"Cursor": "0b9560fb-055d-47d3-a6d4-e579c44ca558"
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable