Maxxton External API

Sections

Get specific location details

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 AMENITYCATEGORYSETS, DYNAMICFIELDS, IMAGES, MAILADDRESS, LOCATIONMAP, SUBJECTS, VIDEOS, VISITADDRESS, 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:
AMENITYCATEGORYSETSDYNAMICFIELDSIMAGESMAILADDRESSLOCATIONMAPSUBJECTSVIDEOSVISITADDRESSTRANSLATIONS
Allow unique items
true
startDatestring

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

Path Parameters

locationIdinteger Required

locationId to fetch location details

Response

200
Object
The request is completed successfully without any errors

Response Attributes

locationPriorityinteger

Priority set to the location in which it will be visible to the user

locationNumberinteger

Number associated with each location

resArrivalDateFromstring

Date on which the user can arrive

internalLocationNumberstring

Automatic generated location number from where the reservation number will start

codestring

Unique code associated with each location

locationIdinteger

Unique id associated with each location

parentIdinteger

If location is a child of another location then the id of the parent location is displayed

archivedFromstring

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

translationsarray

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

Show child attributes

mailAddressobject

The details of the mailing address of the user

Show child attributes

visitAddressobject

Details of the visit address of the user

Show child attributes

adminOrganisationIdinteger

Id of the admin organisation to which location is linked.

originstring
originIdstring
bookableLocationboolean

To show if location contains actual accommodation types and not just used for defining hierarchy

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

minAgeForBookinginteger

Field to denote the minAge of the customer for making a reservation on the location

amenityCategorySetsarray

Details related to the group of amenity categories

Show child attributes

subjectsarray

Details related to the subject(people) coming for stay

Show child attributes

dynamicFieldsarray

User-defined and customized fields

Show child attributes

imagesarray

Details of the images associated to the location

Show child attributes

videosarray

Details associated with videos related to the accommodationtype

Show child attributes

regionIdinteger

Region of the location. This is the id of the lowest level region where the location is in.

breadCrumbstring

BreadCrumb of all regions the location lies in. This is calculated based on the long and latitude set on the location which is within the configured geo shape of the regions. The regions can be nested and based on this the breadcrumb is created from the biggest parent and all children within.

locationMapobject

Location map detail of the location

Show child attributes

404
Object
No location details found for given criteria.
500
Object
Error occurred while fetching location details.

GET

/

Select
1

Response