Maxxton External API

Sections

Create amenity links for a unit

Path Parameters

unitIdinteger Required

Body Parameters

amenityIdinteger

Unique id associated with each amenity

startDatestring

Date from which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

endDatestring

Date till which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

numberValuenumber

If the amenity is of type number then the value provided to the amenity is displayed here

textValuestring

If the amenity is of type text then the value provided to the amenity is displayed here

visibleboolean

If the amenity should be visible to the user then this field is true else false

preferenceExtraIdinteger

The id associated to the extra

Response

200
Object
The request is completed without any error.

Response Attributes

amenityLinkIdinteger

Unique id associated with each amenity link

amenityIdinteger

Unique id associated with each amenity

endDatestring

Date till which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

startDatestring

Date from which the linked amenity is applicable for usage. The format of the date wil be shown using ISO 8601 standard(yyyy-MM-dd)

numberValuenumber

If the amenity is of type number then the value provided to the amenity is displayed here

textValuestring

If the amenity is of type text then the value provided to the amenity is displayed here

visibleboolean

If the amenity should be visible to the user then this field is true else false

preferenceExtraIdinteger

The id associated to the extra

originstring

The field tells if the amenity is of the resource itself or is inherited from the parent resource. Possible values can be: SELF, PARENT, CHILD

Enum values:
SELFPARENTCHILD
translationsarray

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

Show child attributes

typestring

Type of the amenity. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP

Enum values:
SIMPLENUMBERTEXTLISTGROUP
identifierstring

Value of the identifier associated with an amenity linked

metricobject

Details of metric

Show child attributes

parentAmenityIdinteger

If the amenity has a parent then the id of the parent amenity is displayed in this field

categoriesarray

Details related to group of amenities

Show child attributes

archivedFromstring

Date from which the amenity was archived. The amenities will not be displayed if the amenity is archived. Thus for all amenities which are being displayed the value will be null.Date should be added using ISO 8601 standard(yyyy-MM-dd)

500
Object
Error occurred while creating new unit link with amenity.

POST

/

Select
1

Response