Skip to content

Latest commit

 

History

History
125 lines (112 loc) · 5.09 KB

agecategories.md

File metadata and controls

125 lines (112 loc) · 5.09 KB
Raw

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": "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
  }
}
Property Type Contract Description
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 Unique identifiers of Age categories.
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 Time interval optional, max length 3 months Interval in which the age category was updated.
ActivityStates array of Activity state optional Whether to return only active, only deleted or both records.
Limitation Limitation required Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "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
    },
    {
      "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
    }
  ],
  "Cursor": "0b9560fb-055d-47d3-a6d4-e579c44ca558"
}
Property Type Contract Description
AgeCategories array of Age category 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

Property Type Contract Description
Id string required Unique identifier of age category.
ServiceId string required Unique identifier of Service the age category belongs to.
MinimalAge integer optional Minimal age for the age category.
MaximalAge integer optional Maximal age for the age category.
Names Localized text required All translations of the name of the age category.
ShortNames Localized text 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 Age category classification required The classification of the age category.
IsActive boolean required Whether the age category is still active.

Age category classification

  • Adult
  • Child