Maxxton External API

Sections

Get a location

Path Parameters

locationIdinteger Required

locationId to fetch location

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

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

GET

/

Select
1

Response