Get AgeGroupSpecification entities.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.ageGroupSpecifications.list({
  organization: 0,
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 0,
    "type": "type",
    "description": "description",
    "excludedFromMaxNumOfPersons": true,
    "required": true,
    "relatedToCustomAccommodations": true,
    "locale": "locale",
    "priority": 0,
    "minNumOfPersons": 0,
    "maxNumOfPersons": 0,
    "minAge": 0,
    "maxAge": 0,
    "created": "created",
    "modified": "modified"
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• organizationnumberrequired

  Organization ID

• accommodationnumberoptional
• accommodationCategorynumberoptional
• localityCategorynumberoptional
• generalbooleanoptional

  Indicates if only generally available AgeGroupSpecifications should be shown.

Returns

Array of AgeGroupSpecification

Schema shown for 200 · application/json

• idnumber
• typestring
• descriptionstring
• prioritynumberoptional
• excludedFromMaxNumOfPersonsboolean
• requiredbooleandeprecated
• minNumOfPersonsnumberoptional
• maxNumOfPersonsnumberoptional
• relatedToCustomAccommodationsboolean
• minAgenumberoptional
• maxAgenumberoptional
• localestring
• createdstringoptional
• modifiedstringoptional