Maxxton External API

Sections

Get all subjects for a location

Path Parameters

locationIdinteger Required

locationId to fetch subjects

Response

200
Object
The request is completed successfully without any errors

Response Attributes

subjectIdinteger

Unique id associated with each subject

typestring

Type of the subject who will come for stay. Possible values that can be encountered are: PET, CATEGORY, PERSON, VEHICLE, OTHER

Enum values:
PETCATEGORYPERSONVEHICLEOTHEREQUIPMENT
maxAgeinteger

Maximum age of the subject who is allowed under the given type

controlAccessboolean

If the checkbox is checked in the system then the value is true else false. The default value for this is true

endDatestring

Date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd)

includeInTotalboolean

If the cost related to the subject is already included in the bill, then this value is true else false

subjectOrderinteger

Order in which the subject is configured

subjectCategoryIdinteger

The subject category id is the same across all locations and will map the subjects over the locations even though that the max Age can be different. This can be used to add an icon or styling based on the subject or equipment without making rules based on location-specific subject data.

translationsarray

Information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.

Show child attributes

500
Object
Error occurred while fetching Subjects for Location.

GET

/

Select
1

Response