Maxxton External API

Sections

Get a unit with details.

Query Parameters

amenityCategoryCodestring

amenityCategoryCode to be passed to filter the response of the amenityCategories

distributionChannelIdinteger

A distributionChannelId to fetch Unit

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, DOORLOCKTYPES. 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:
ADDRESSAMENITYCATEGORYSETSCAPACITIESCAPACITYREQUIREMENTSDYNAMICFIELDSIMAGESROOMSTRANSLATIONSVIDEOSDOORLOCKTYPES
Allow unique items
true
returnWorkOrderUnitsboolean

Work order type units are not returned by default. To get work order type units, this request parameter can be used

startDatestring

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

Path Parameters

unitIdinteger Required

Unit id of the unit

Response

200
Object
The request is completed successfully without any errors

Response Attributes

unitIdinteger

Unique id associated with each unit

resourceIdinteger

Unique id associated with the accommodationtype to which the unit belong

codestring

Unique code associated with each unit

nrOfBathroomsnumber

Total number of bathrooms that a unit possess

pathstring

The field denotes where the unit is located

excludeQuestionnaireStatsboolean

If the questionnaire is to be excluded then the checkbox is selected in the system and the value is true else false

choosableOnInternetboolean

If this is selected then the unit will be available in the dropdownbox on internet, then the value is true else

resourceGroupIdinteger

Unique id associated with the group of accommodationtype to which the unit belongs

cleaningStatusstring

Status of clean is defined i.e

Enum values:
CLEANTO_BE_CLEANEDIN_PROGRESSCHECKEDPOSTPONEDOCCUPIED_CLEANTOUCH_UP
roomCodestring

Unique code associated with each room which lies in the unit

nrOfBedroomsinteger

Total number of bedrooms in the unit

archivedFromstring

Date from which the unit was archived. The unit will not be displayed if the unit is archived. Thus for all units which are being displayed the value will be null

vsiinteger

Vsi value of unit

addressobject

Details of the address where the unit is located

readOnly

Show child attributes

translationsarray

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

Show child attributes

capacitiesarray

The maximum number of subjects for which the unit 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 are considered as rooms ex: bedrooms, living rooms etc

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

dynamicFieldsarray

User-defined and customized fields

Show child attributes

amenityCategorySetsarray

Details related to group of amenity categories

Show child attributes

originstring
originIdstring
doorLockTypesarray

SAFLOKCARD (key cards) or KOOLECONTROLS (doorlock pincodes). for normal key the doorLockTypes list will be empty.

Show child attributes

energyLabelRegistrationNumberstring

Energy Label RegistrationNumber associated with each unit

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

rentableUnitIdinteger
bfeIdstring

Unique identifier for a property in the Danish land and building registers.

regionalIdstring

Identifies the Danish administrative region associated with the property or address.

500
Object
Error occurred while fetching the unit.

GET

/

Select
1

Response