Skip to content

Latest commit

 

History

History
98 lines (87 loc) · 4.2 KB

agecategories.md

File metadata and controls

98 lines (87 loc) · 4.2 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"
    ],
    "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.
ServiceIds array of string required, max 1000 items Unique identifiers of Services where the age category belong to.
AgeCategoryIds array of string optional, max 1000 items Unique identifiers of Age categories.
ActivityStates array of string Activity state optional Whether to return only active, only deleted or both records.
Limitation Limitation required Limitation on the quantity of data returned.

Response

{
    "AgeCategories": [
        {
            "Id": "ab58c939-be30-4a60-8f75-ae1600c60c9f",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "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"
            }
        },
        {
            "Id": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
            "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
            "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"
            }
        }
    ],
    "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.
EnterpriseId string required Unique identifier of the Enterprise.
ServiceId string required Unique identifier of Service the age category belongs to.
MinimalAge number optional Minimal age for the age category.
MaximalAge number optional Maximal age for the age category.
Names Localized text required All translations of the name of the age category.