Maxxton External API

Sections

Get accommodationtype detail for a specific resource

Query Parameters

endDatestring

Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

returnSectionsarray

List of constant strings to return only the selected sections in the response. The possible values are ADDRESS, AMENITYCATEGORYSETS, CAPACITIES, CAPACITYREQUIREMENTS, DYNAMICFIELDS, IMAGES, ROOMS, VIDEOS, TRANSLATIONS. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

Enum values:
ADDRESSAMENITYCATEGORYSETSCAPACITIESCAPACITYREQUIREMENTSDYNAMICFIELDSIMAGESROOMSVIDEOSTRANSLATIONSUNITS
... 1 other enums
Allow unique items
true
returnWorkOrderTypesboolean
startDatestring

Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

Path Parameters

resourceIdinteger Required

resourceId to fetch accommodationtypedetail

Response

200
Object
The request is completed successfully without any errors

Response Attributes

resourceIdinteger

Unique id associated with each accommodationtype

codestring

Unique code associated with each accommodationtype

ledgerGroupIdinteger
locationIdinteger

Unique id associated with each location to which the accommodationtype belong

brandIdinteger

Unique id associated with each brand

priorityinteger

The sequence in which the accommodationtype will be visible to the user

nrOfBedroomsnumber

Number of bedrooms that an accommodationtype possess

nrOfBathroomsnumber

Number of bathrooms that an accommodationtype can possess

hasObjectsboolean

If an accommodation is to be created having some predefined units then hasObjects check-box is checked and the value is true else the value is false.

pathstring

The field denotes where the accommodationtype is located

checkinTimestring

The checkin time for the accommodationtype

checkoutTimestring

The checkout time for the accommodationtype

lateCheckoutTimestring

The late checkout time for the accommodationtype

earlyCheckinTimestring

The early checkin time for the accommodationtype

translationsarray

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

Show child attributes

dynamicFieldsarray

User-defined and customized fields

Show child attributes

addressobject

Information related to where the accommodationtype is located

Show child attributes

imagesarray

Details of the images associated to the accommodationtype

Show child attributes

videosarray

Details associated with videos related to the accommodationtype

Show child attributes

amenityCategorySetsarray

Group of amenity categories

Show child attributes

capacitiesarray

The maximum number of subjects for which the accommodation can be booked including all the younger subjects than adult for e.g Child and Infant

Show child attributes

capacityRequirementsarray

The minimum number of subjects which are mandatory for making a reservation. If requirement of 4 adults is configured then 4 adults are mandatory for making a reservation

Show child attributes

roomsarray

Different part of units in an accommodation are considered as rooms ex: bedrooms, living rooms etc

Show child attributes

brandstring

Label associated with the accommodationtype by which an accommodationtype can be sold out. It can vary from website to website for same accommodationtype.

archivedFromstring

Date from which the accommodationtype was archived. The accommodationtypes will not be displayed if the accommodationtype is archived. Thus for all accommodationtypes which are being displayed the value will be null. The format of the date will be in ISO 8601 standard(yyyy-MM-dd)

ledgerIdinteger
parentIdinteger
numberOfPersonsinteger
accotypeKindIdinteger
originstring
originIdstring
powerplayGroupIdinteger
resourceGroupobject

Show child attributes

qualityLevelIdinteger
previousPmsIdstring

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

accotypeDoorlockinteger

Number cards/keys for accommodation

accotypeBarrierinteger

Number of access cards for entry barrier at a location

accommodationTypeKindCodestring

Unique code associated with each accommodationtypekind

500
Object
Error occurred while fetching AccommodationTypeDetail.

GET

/

Select
1

Response