![Maxxton](https://newyse-res.cloudinary.com/image/upload/maxxton2/logo.png)
Maxxton External API
1. Overview
The document comprises RESTful web services which refers to the methods (GET, POST, PUT, DELETE), endpoints of the APIs, required fields and explains what services consumes and produces.
It also tells what data is to be sent in request body and what will be returned in response body.
The dates that are being entered along with time depicts the UTC time zone and the one without time represents just that day.
1.1. Version information
Version :1.0
1.2. Contact information
Contact : Maxxton Group
Contact Email : api@maxxton.com
1.3. URI scheme
Host : Test: https://api-test.maxxton.net , Production: https://api.maxxton.net
BasePath : /maxxton/v1
Schemes : HTTPS
1.4. Tags
-
Accommodation Types : A group of similar units
-
AddOn : Extras and products that can be booked with an accommodation type
-
AdminOrganisation : List of AdminOrganisation
-
Allotment : Guaranteed availability for a specific distribution channel
-
Amenity : Features or facilities available on a resort or an accommodation type
-
Authentication : Authentication
-
Brands : Different labels used for marketing of an accommodation type
-
Cash Clearance : Informations related to cash reservations and company.
-
Contracts : Formal legal agreement between the owner and the resort
-
Countries : List of countries.
-
Currency : List of currencies
-
Customer Status : Statuses given to customers as per customer’s reservation history
-
Customers : Guest who can book reservations
-
DistributionChannels : Channel through which reservations can be booked
-
Employee : Employees
-
Events : Events occurred in the system due to modifications of the entities
-
Facilities : Different labels used for facilities
-
Groups : Grouping different kind of entities
-
Housekeeping : Information related to housekeeping
-
Icals : Icals
-
Infotexts : Information related to all the infotexts.
-
Languages : Available languages in the system
-
Ledgers : Ledgers
-
Locks : Locks
-
Memos : Informative text on different entities
-
Offer : Discounts or special offers on accommodations
-
Operations : Operations
-
Owners : Someone who owns an accommodation
-
Packages : Packages
-
Payment Term Set : Informations related to payment term sets.
-
PointsOfInterests : PointsOfInterests
-
PredefinedMemo : Informative text on different entities
-
Rate Types : A group of different prices of an accommodation type
-
Region : Defines region on a map
-
Rentability : Possible arrival and departure days
-
Representation : Defines accommodation type configuration valid for a distribution channel
-
Resellers : Agent who are selling accommodation types
-
Reservability : Number of units available
-
Reservations : Customer booking of an accommodation
-
Resorts : Group of accommodation types at the same location
-
Room types : Defines type of room in an unit
-
Rooms : Defines a room in an unit
-
Send Methods : Send methods of reservation
-
Subjects : Subjects for accommodation types
-
Units : Physical accommodation where customer stays
1.5. Authentication
Maxxton External APIs are secure RESTful web services and authentication(OAuth2) is required to access them, user will be authenticated based on the token passed in the request.
1.5.1. Endpoint used to generate access token
POST /maxxton/v1/authenticate?grant_type=client_credentials&client_id={api username}&client_secret={api key}&scope={concern code}
Parameters
Name | Description |
---|---|
grant_type |
Authentication type, this is 'client_credentials' for API. |
concern |
3 letter code which specifies the environment used, usually an abbreviation of the clients name(deprecated in favor of scope). |
scope |
3 letter code which specifies the environment used, usually an abbreviation of the clients name(this can be found in the Maxxton software URL). |
client_id |
The unique client identifier to access the API. This can be found in the Maxxton software backoffice where API users are configured. |
client_secret |
The secret associated with client id to access the API. This can be found in the Maxxton software backoffice where API users are configured. |
The response that can be returned are:
Responses
HTTP Code | Description |
---|---|
500 |
Error occurred while processing |
200 |
OK. Access token is generated which is used for further calls to authenticate. |
After generating the token, the access token can be used by adding it to the header parameters with
key: Authorization and value: {token_type} {access_token}
-
The client_id and the client_secret will be provided by Maxxton/Maxxton client as part of API credentials.
-
Please contact the particular Maxxton client to request API credentials to access their Maxxton environment and data.
-
Concern or scope can be used for passing the concern parameter but scope is preferred as it is fully oauth2 compatible.
Note: Either of the two parameters i.e Concern or Scope is mandatory.
For more information: Login
1.6. API Pricing
The API costs are based on the number of requests per month, the first 750,000 requests per month(25,000 requests per day) are not charged. Subsequent requests are charged as per the API price calculator. The processes can be speeded up by making multiple API requests at the same time, this is called concurrent calls in the model. Concurrent calls have a bigger impact on the Maxxton API resources, therefore extra costs are charged.
Estimate standard API costs based on usage.
0
Free
per1.6.1. Notes applicable to the API Pricing
-
The number of concurrent calls is limited to the maximum number per IP, by default this is 15.
-
The number of concurrent calls will be used as a logarithmic parameter in the pay-per-use model and will impact the charges on actual usage.
-
The number of requests is not limited and will be charged based on actual usage.
-
Costs only apply to the new Maxxton REST API.
-
The number of requests only applies to the production API (api.maxxton.net).
-
The acceptance (api-test.maxxton.net) API can be used free of charge, subject to adherence to the fair use policy.
-
Fair use policy applies to both production and acceptance API.
-
API Support is included for daily support questions
-
Development of new features and project guidance/management is charged per hour.
-
Clients can request new features to decrease the REST API usage. Maxxton will, commercially reasonable, develop new features on request to decrease API usage.
1.6.2. Fair Use Policy
On our API we do not have a fixed restriction on the number of api calls. However, a Fair Use Policy applies to the usage of the API.
Normal usage is permitted. Excessive usage is not permitted. Excessive usage means, the usage which has an impact on our server performance or impact on other customers who use the API.
1.7. Filtering
Many calls contain filtering, this is a way to filter the output of the calls. In swagger(url can be found in documentation) it says filter parameter where this can be used. filtering means you can filter on any non-nested field in the output with the following features:
Definition | Symbol | Usage | Result |
---|---|---|---|
Equals |
: |
?filter=name:bob |
Selects all the records where the name contains the String bob. |
Strict Equals |
:: |
?filter=name::bob |
Selects all the records where the name is strictly equals to bob. |
Not Equals |
!: |
?filter=name!:bob |
Selects all the records where the name is not equal to bob. |
Greater Than |
> |
?filter=age>30 |
Selects all the records where the age is greater than 30. |
Greater Than Equals |
>: |
?filter=age>:30 |
Selects all the records where the age is greater than or equal to 30. |
Less Than |
< |
?filter=age<30 |
Selects all the records where the age is less than 30. |
Less Than Equals |
<: |
?filter=age <: 30 |
Selects all the records where the age is less than or equal to 30. |
These are the operators you can use in the filtering of the filter:
Definition | Symbol | Usage | Result |
---|---|---|---|
Chain multiple filters (OR) |
|| |
?filter=name:Bob||age=30 |
Selects all the records where name is Bob or age is 30. |
Creating a single filter or chain multiple(AND) |
& |
?filter=name:Bob&filter=age:30 |
Selects all the records where name is Bob and age is 30. |
1.8. Pagination
Pagination is used to divide large response into small response which leads minimizing the response time. General concept is separating a large page into small pages.
Most of the Maxxton External API endpoints follow pagination
You can control the number of results returned in a single request by specifying the page number and page size.
Page and Size are 2 request parameters that can be used with request to control pagination.
Name | Description |
---|---|
page |
Default page is 0, Page can be used to extract response of specific page. |
size |
Default size is 20, Size can be used to extract required no of elements per specific page. |
With every response, there are few parameters in response that gives information about the pagination followed in request.
size | Size value considered for request |
---|---|
number |
Page no considered for request |
numberOfElements |
No of elements fetched in the response |
totalElements |
Total no of elements that can be fetched |
totalPages |
Total no of pages that can be requested |
first |
True if its a first page, else False |
last |
True if its a last page, else False |
1.9. Sorting
Sorting is used to order the response based on the values of a particular field of the response. General concept is fetching a page/list of response in the ascending or descending order of the specified field.
Sorting is possible in all the endpoints where pagination is supported.
This can be done by specifying the sort request parameter with the field name and order of descending, as follows:
sort=fieldname,desc or sort=fieldname,asc
Name | Description |
---|---|
sort |
Default sorting is asc if only sort=fieldname is used, orders the response based on a particular field of the response. |
With every sorted response, there are few parameters under the section sort at the end of page that gives information about the sorting followed in request.
direction | The order of the sorting. ASC for ascending or DESC for descending |
---|---|
property |
the fieldname in the response whose value was used for sorting the response |
ignoreCase |
whether casing of alphanumberic values was considered in sorting in case of string fields |
nullHandling |
enumeration for null handling hints that can be used in the sorting. typical values are NATIVE, NULLS_FIRST or NULLS_LAST |
ascending |
True if sorting was ascending, else False |
descending |
True if sorting was descending, else False |
1.10. Date Fields
Following is the description of different date fields used in various domains of API endpoints.
Name | Description |
---|---|
reservationDate |
date the guest creates the reservation. |
arrivalDate |
date the guest arrives. |
departureDate |
date the guest leaves. |
stayDateFrom |
start of period within a period of the reservation(between and including arrival and departure date). |
stayDateTo |
end of period within a period of the reservation(between and including arrival and departure date). |
1.11. Header
Header parameters contain information that are an important part of the API request and response as they represent the meta-data associated with the API request and response.
Following header parameters can be used with Maxxton APIs:
Name | Description | Example |
---|---|---|
locale |
This header can be passed in the request to filter all the translations in the response in any specific language. The user can pass the language code as value of the locale header to filter the translations. The value of the locale header can also be passed in the following format "en_US" (language code followed by country code). |
locale=en |
x-show-archived |
This header can be used to get archived data in the response. The user can pass "true" as value of the header to view the archived data in the response and if the value of this header is passed as "false" then the archived data is not displayed in the response. |
x-show-archived=true |
1.12. Error Codes
Following error codes are available in response of Maxxton APIs:
Error Code | Description | HTTP Status |
---|---|---|
ThirdParty-101 |
Resource not found |
404 |
ThirdParty-102 |
Unit not found |
404 |
ThirdParty-103 |
Locks not found |
404 |
ThirdParty-104 |
Unable to load addresses |
500 |
ThirdParty-105 |
Offer is not found |
404 |
ThirdParty-107 |
Distribution channel id is not valid or is null |
400 |
ThirdParty-108 |
Manager id is not found. |
400 |
ThirdParty-109 |
Accommodation type is not found |
404 |
ThirdParty-110 |
Representation is not found |
404 |
ThirdParty-111 |
add-ons is not found |
404 |
ThirdParty-112 |
Group type is not correct. |
400 |
ThirdParty-113 |
Wrong input |
400 |
ThirdParty-114 |
Unable to generate or use property descriptor for field |
500 |
ThirdParty-115 |
Resort not found |
404 |
ThirdParty-116 |
Unable to filter translation |
500 |
ThirdParty-117 |
Year paramater is missing |
400 |
ThirdParty-118 |
Configuration is missing |
500 |
ThirdParty-122 |
The category code does not exist or not equivalent to the token reservation category or not linked with input distribution channel |
400 |
ThirdParty-123 |
The distribution channel code does not exist or null |
400 |
ThirdParty-124 |
The subject does not exist with subjectId or null |
400 |
ThirdParty-125 |
The resource does not exist with resourceId |
400 |
ThirdParty-126 |
Customer details not provided. |
400 |
ThirdParty-127 |
There is no availability for the given criteria |
400 |
ThirdParty-128 |
Status should be QUOTATION or OPTIONAL |
400 |
ThirdParty-129 |
The request has an incorrect body |
400 |
ThirdParty-130 |
Reservation does not exist. |
404 |
ThirdParty-131 |
Rate type does not exist or null. |
404 |
ThirdParty-132 |
No default rate type is selected for given distribution channel. |
404 |
ThirdParty-133 |
You are not allowed to create reservation with given distribution channel code. |
400 |
ThirdParty-134 |
The header IF_MODIFIED_SINCE is missing. |
400 |
ThirdParty-135 |
Internal server error occurred. |
500 |
ThirdParty-136 |
Missing or invalid parameter |
400 |
ThirdParty-137 |
Reservation category not found. |
404 |
ThirdParty-138 |
Accommodation does not exists. |
404 |
ThirdParty-139 |
Invalid subject |
400 |
ThirdParty-140 |
Property preference not found. |
400 |
ThirdParty-141 |
No choice found for the given criteria. |
400 |
ThirdParty-142 |
No customer found for the customer id |
400 |
ThirdParty-143 |
No modified records found. |
404 |
ThirdParty-144 |
start/end date should not be null and startDate should be less than endDate and the period should be in between reservation period. |
400 |
ThirdParty-145 |
Additions not found. |
400 |
ThirdParty-146 |
Quantity should not be null, less than or equal to 0. |
400 |
ThirdParty-147 |
Unable to retrieve turnover for the reservation |
404 |
ThirdParty-148 |
The unit does not exist with unitId. |
400 |
ThirdParty-149 |
The given addition criteria does not match or addition’s show moment is incorrect. |
400 |
ThirdParty-150 |
Accommodation not available. |
400 |
ThirdParty-151 |
Distribution channel code is not valid or is null |
400 |
ThirdParty-152 |
Section parameters are invalid in batch request |
400 |
ThirdParty-153 |
Capacities are not configured on accommodationtype. |
404 |
ThirdParty-154 |
The incorrect format of input parameter. |
400 |
ThirdParty-155 |
The quantiy and price should not be passed with unitId |
400 |
ThirdParty-156 |
Resource quantity is not valid or can not be changable |
400 |
ThirdParty-157 |
Reservation can not be updated because of some internal error |
400 |
ThirdParty-158 |
The header IF_MODIFIED_SINCE is incorrect. |
400 |
ThirdParty-159 |
The date in IF_MODIFIED_SINCE should not be greater than current date |
400 |
ThirdParty-160 |
Modify the time stamp format. Should be : EEE, dd MMM yyyy HH:mm:ss |
400 |
ThirdParty-161 |
No currency found for the currency id |
404 |
ThirdParty-162 |
Concern or scope not found |
400 |
ThirdParty-163 |
Required parameter is missing in new-reservation customer request body |
400 |
ThirdParty-164 |
Language not available for Locale or Locale is incorrect |
400 |
ThirdParty-165 |
Invalid region id |
404 |
ThirdParty-166 |
Brand not found |
404 |
ThirdParty-167 |
start/end or actual start/end date can not be update for the reserved resource |
400 |
ThirdParty-168 |
Invalid ownerId |
404 |
ThirdParty-169 |
The distribution channel does not exist |
404 |
ThirdParty-170 |
No data found |
404 |
ThirdParty-171 |
Invalid ownerGroupId |
404 |
ThirdParty-172 |
Requested page size is invalid |
400 |
ThirdParty-173 |
Invalid memoCategoryId |
400 |
ThirdParty-174 |
Seasonality not found |
404 |
ThirdParty-175 |
Either Fiscal year or startDate/endDate allowed |
400 |
ThirdParty-176 |
Resource type is invalid |
400 |
ThirdParty-177 |
the url passed is invalid |
400 |
ThirdParty-178 |
Given fiscal year is not configured |
400 |
ThirdParty-179 |
Update reservation request has invalid reservation status |
400 |
ThirdParty-180 |
Payer type is invalid |
400 |
ThirdParty-181 |
ArrivalDate field cannot be null or empty |
400 |
ThirdParty-182 |
Arrival date passed in invalid |
400 |
ThirdParty-183 |
NumberOfDaysInResult is mandatory, cannot be null or greater than 30 |
400 |
ThirdParty-184 |
Invalid room id |
404 |
ThirdParty-185 |
ResourceIds is mandatory, cannot be null |
400 |
ThirdParty-186 |
Invalid preference type |
400 |
ThirdParty-187 |
Invalid reservation status |
400 |
ThirdParty-188 |
Maximum size of paged response is limited to 2000 |
400 |
ThirdParty-189 |
Request body can’t be empty or blank with post method |
400 |
ThirdParty-190 |
You have insufficient permission to update the field provided in request body |
403 |
ThirdParty-191 |
Customer not found |
404 |
ThirdParty-192 |
Resource does not allow price change |
400 |
ThirdParty-193 |
Reseller not found |
404 |
ThirdParty-194 |
Reservation status cannot be changed as a unit is not available. |
400 |
ThirdParty-195 |
Cannot change the reservation status as the reservation config is missing. |
400 |
ThirdParty-196 |
Invalid countryId. |
400 |
ThirdParty-197 |
Quantity too high for addition. |
400 |
ThirdParty-198 |
Quantity too low for addition. |
400 |
ThirdParty-199 |
Group type is invalid |
400 |
ThirdParty-200 |
Either reservationIds or customerIds should be passed in request with accommodationKindIds. |
400 |
ThirdParty-201 |
The startDate and endDate of accommodation or special cannot be updated. |
400 |
ThirdParty-202 |
Only one resourceId could be passed in resourceIds. |
400 |
ThirdParty-203 |
Invalid field name passed in the request body. |
400 |
ThirdParty-204 |
Missing required parameter. |
400 |
ThirdParty-205 |
DateRange is exceeded limit. |
400 |
ThirdParty-206 |
The amenity passed in preferences is not valid for reservation stay. |
400 |
ThirdParty-207 |
Accommodation is of work order type. |
400 |
ThirdParty-208 |
AdditionResourceId is either invalid or is not available for reservation stay. |
400 |
ThirdParty-209 |
ResourceId is invalid |
400 |
ThirdParty-210 |
Incorrect reservedResourceId for reservation. |
400 |
ThirdParty-211 |
Invalid titleId passed in the request. |
400 |
ThirdParty-212 |
Price engine General Error. |
400 |
ThirdParty-213 |
contractTypId passed in the request is invalid. |
400 |
ThirdParty-214 |
Contract can be created for either resourceId or unitId |
400 |
ThirdParty-215 |
Credentials null or invalid. |
400 |
ThirdParty-216 |
Representation for the resourceIds and distribution channel is archived. |
400 |
ThirdParty-217 |
Invalid rentability period. |
400 |
ThirdParty-218 |
Record already exists with same criteria, but with different priority value and rate type id |
400 |
ThirdParty-219 |
Error while creating addition. |
400 |
ThirdParty-220 |
Total number of subjects and travel parties doesn’t match. |
400 |
ThirdParty-221 |
Subjects or travel parties should be passed in the request to make reservation. |
400 |
ThirdParty-222 |
The dateMargin parameter cannot be used in combination with includeAllPrices parameter. |
400 |
ThirdParty-223 |
Travel parties should be passed with travel insurance addon. |
400 |
ThirdParty-224 |
Supplier addition not available. |
400 |
ThirdParty-225 |
Invalid amenityId. |
400 |
ThirdParty-226 |
Value field passed in the request does not match amenity type. |
400 |
ThirdParty-227 |
Only one type of subject list is allowed for insertion at a time. |
400 |
ThirdParty-228 |
Invalid powerPlayGroupId passed in the request. |
400 |
ThirdParty-229 |
Invalid offerType passed in the request. |
400 |
ThirdParty-230 |
The startDate should be less than endDate. |
400 |
ThirdParty-231 |
Cannot create reservation with current GDPR access. |
401 |
ThirdParty-232 |
Voucher was not found. |
400 |
ThirdParty-233 |
Either offerCode or voucherCode should be passed. |
400 |
ThirdParty-234 |
Voucher is not valid for this period. |
400 |
ThirdParty-235 |
Voucher is blocked. |
400 |
ThirdParty-236 |
Voucher is already redeemed. |
400 |
ThirdParty-237 |
Voucher is not allowed on this distribution channel. |
400 |
ThirdParty-238 |
Voucher is not allowed with this accommodation type and period. |
400 |
ThirdParty-239 |
There is no valid offer/resource linked to this voucher. |
400 |
ThirdParty-240 |
Invalid preferenceId. |
400 |
ThirdParty-241 |
Modification not allowed. |
400 |
ThirdParty-242 |
Checked out reservation cannot be modified from API. |
401 |
ThirdParty-243 |
Failed to generate JWT token response. |
500 |
ThirdParty-244 |
Language passed in request is incorrect. |
400 |
ThirdParty-245 |
Authentication token created with invalid api_key. |
400 |
1.13. Release Notes
We are continuously improving and extending the REST API. The release notes of each release can be found here.
Release Notes
2. Swagger UI
2.1. Go to the Swagger UI
Swagger documentation can be used for executing the calls as well apart from the available endpoint list and descriptions.
NOTE: The Swagger UI Rest client
3. Flows
3.1. Maxxton environments
Maxxton works using a DTAP(Development, Testing, Acceptance, Production) approach. For this there are 4 environments available and the code is promoted from the left to the right. The staging is not available for all clients. In case no staging is available the test can be used.
The development environment is not externally available and only available to the Maxxton developers.
Both staging and production environments use the same API URLs because it’s using the same infrastructure with the difference that the database used is a test/staging database on staging.
![Maxxton environment flow overview](images/MaxxtonEnvironments.png)
3.1.1. Environment refresh
The Test environment can be refreshed with production data. In this case all test environment data will be overriden with the data from the production environment, including the API users.
For security reasons the API keys are excluded and the test API keys which existed before the refresh are kept during the refresh process. This means the API keys from the production and test environment will always be different and never overriden.
However the API users are the same. In case no api user is available on the production environment, the API key on the test environment is removed by the refresh process. This means after a refresh, users who don’t have access to the production environment will also not have access to the test environment.
This can result in a scenario where it will no longer be possible to login to the test environment. This can be solved by creating a new API user and API key after the refresh process is finished. If the user already existed on the production environment and no API key was available on the test environment a new API key has to be generated as well to gain access.
Contact the Maxxton client to provide you with new API details if necessary.
3.2. Events Flow
Any change(creation, deletion or modification) made in any of the entities will generate events, which are stored and can be fetched using the Events endpoint. Below are the events generated with their description. The details of the entity along with the changes can be fetched through separate endpoints mentioned for every event type below.
Events are not logged for entity records which become invalid or inactive after a given date.
For ex. validTo date in cashflowrule. In this case, no events will be logged for cashflowrule entity, after the respective validTo date of that cashflowrule is passed.
3.2.1. Events Generated
1) ACCOMMODATION_TYPE_EVENT
Any change made to the accommodationtype, which includes creation, modification or deletion of accommodationtype or any of its entities like address, images, amenities, capacities etc. will generate an ACCOMMODATION_TYPE_EVENT. In case of an ACCOMMODATION_TYPE_EVENT, the entity id logged will be the resourceId of the accommodationtype that was changed.
To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/accommodationtypes/{resourceId}/details
To refresh specific data following endpoints can be used:
-
GET: maxxton/v1/accommodationtypes/{resourceId}
-
GET: maxxton/v1/accommodationtypes/{resourceId}/capacities
-
GET: maxxton/v1/accommodationtypes/{resourceId}/images
-
GET: maxxton/v1/accommodationtypes/{resourceId}/amenitylinks
To refresh the data for multiple accommodationtypes at the same time the resourceId can be combined using the following endpoint:
-
GET: /maxxton/v1/accommodationtypes?filter=resourceId:[resourceId1,resourceId2,resourceId3…]
2)ADDITION_EVENT
Any change made to the additions, which includes creation, modification or deletion of an addition will generate an ADDITION_EVENT. The entity id logged will be the resourceId of the accommodationtype, addition or offer on which the addition was added.
To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/accommodationtypes/{resourceId}/additions
-
GET: maxxton/v1/offers/{resourceId}/additions
-
GET: maxxton/v1/accommodationtypes/additions?filter=resourceId:[resourceId1,resourceId2,resourceId3…]
-
GET: maxxton/v1/offers/additions?filter=resourceId:[resourceId1,resourceId2,resourceId3…]
3) ADDON_EVENT
Any changes which includes creation, modification or deletion of extras or products will generate an ADDON_EVENT. The entity id logged will be the resourceId of the add-on that was changed.
To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/add-ons/{resourceId}
4) AVAILABILITY_EVENT
Changes in the availability of resources will generate an AVAILABILITY_EVENT. The event is created once the available is processed in the availability indexes and available from below defined endpoints. The following scenarios will generate an availability event:
-
When the prices or availability of a certain accommodation type changes this will be processed in the availability index once running. When this is processed an availability event is created
-
When the prices or rentability of an offer change this will be processed in the availability index once running. When this is processed an availability event is created for all the accommodation types for which this offer is applicable.
-
When the last unit of an accommodation type is booked, it is removed from the availability index right away and an availability event is created near real-time.
The entity id logged will be the resourceId of the accommodation type whose availability was changed.
To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/accommodationtypes/availability
5) CUSTOMER_EVENT
Any change made to the customers, which includes creation, modification or deletion of a customer or any of its fields will generate CUSTOMER_EVENT. The entity id logged will be the customerId of the customer that was changed.
To refresh the data the following endpoints can be used with the customerId fetched from the event endpoint:
-
GET: maxxton/v1/customers/{customerId}
-
GET: maxxton/v1/customers/{customerId}/communications
-
GET: maxxton/v1/customers/{customerId}/files
To refresh the data for multiple customers at the same time the customerIds can be combined using the following endpoint:
-
GET: maxxton/v1/customers?filter=customerId:[customerId1,customerId2,customerId3…]
The customer event also contains events about merged customer by the deduplication script running in the Maxxton system.
This is indicated by the "entityAction" MERGE and will provide the customer id which is removed in the "oldEntityId" field and the customer id where the data is merged to(the customerId it has become) in the "entityId" field.
Incase of changes to the loyalty status or loyalty transactions also a customer event is generated.
To refresh this data the following endpoints can be used:
GET: maxxton/v1/customers/{customerId}/loyalty
GET: maxxton/v1/customerstatus?filter=customerId:{customerId}
6) DISTRIBUTIONCHANNEL_EVENT
Any change made to a distribution channel, which includes creation, modification or deletion of a distribution channel or any of its fields will generate DISTRIBUTIONCHANNEL_EVENT. The entity id logged will be the distributionChannelId of the distribution channel that was changed.
To refresh the data the following endpoints can be used with the distributionChannelId fetched from the event endpoint:
-
GET: maxxton/v1/distributionchannels/{distributionChannelId}
To refresh the data for multiple distribution channels at the same time the distributionChannelIds can be combined using the following endpoint:
-
GET: maxxton/v1/distributionchannels?filter=distributionChannelId:[distributionChannelId1,distributionChannelId2,distributionChannelId3…]
7) IMPLY_EVENT
Any change made to the implies, which includes creation, modification or deletion of the imply of an accommodationtype, unit, add-on or offer will generate an IMPLY_EVENT. The entity id logged will be the resourceId of the accommodationtype, add-on or offer. In case of a unit it will be unitId. Based on the entityType it can be identified if it’s an accommodationtype, unit, add-on or offer.
To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/accommodationtypes/{resourceId}/implies
-
GET: maxxton/v1/add-ons/{resourceId}/implies
-
GET: maxxton/v1/offers/{resourceId}/implies
-
GET: maxxton/v1/units/{unitId}/implies
8) OFFER_EVENT
Any change made to the offers, which includes creation, modification or deletion will generate an OFFER_EVENT. The entity id logged will be the resourceId of the offer that was changed.
To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/offers/{resourceId}
-
GET: maxxton/v1/offers?filter=resourceId:[resourceId1,resourceId2,resourceId3…]
9) OWNER_EVENT
Any change made to the owners, which includes creation, modification or deletion of an owner or any of its fields will generate OWNER_EVENT. The entity id logged will be the ownerId of the owner that was changed.
To refresh the data the following endpoints can be used with the ownerId fetched from the event endpoint:
-
GET: maxxton/v1/owners/{ownerId}
To refresh the data for multiple owners at the same time the ownerIds can be combined using the following endpoint:
-
GET: maxxton/v1/owners?filter=ownerId:[ownerId1,ownerId2,ownerId3…]
10) RATE_EVENT
Any change made to the rates, which includes creation, modification or deletion of the rate of an accommodationtype, add-on or offer will generate a RATE_EVENT. The entity id logged will be the resourceId of the accommodationtype or offer. Based on the entityType it can be identified if it’s an accommodationtype or offer.
To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/accommodationtype/{resourceId}/rates
-
GET: maxxton/v1/offers/{resourceId}/rates
11) RENTABILITY_EVENT
Any change made to the rentability, which includes creation, modification or deletion of the rentability of an accommodationtype or offer will generate a RENTABILITY_EVENT. The entity id logged will be the resourceId of the accommodationtype, add-on or offer. Based on the entityType it can be identified if it’s an accommodationtype or offer.
To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:
-
GET /maxxton/v1/rentability/config?resourceId={resourceId}
-
GET /maxxton/v1/rentability/stays?resourceId={resourceId}&distributionChannelId={distributionchannelId}
12) RESERVABILITY_EVENT
Any change made to the reservability, which includes creation, modification or deletion in the reservability of an accommodationtype, unit, add-on or offer will generate RESERVABILITY_EVENT. The entity id logged will be the resourceId of the accommodationtype, add-on or offer. In case of a unit it will be unitId. Based on the entityType it can be identified if it’s an accommodationtype, add-on, offer or unit,.
To refresh the data the following endpoints can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/resourcereservability?resourceId={resourceId}
-
GET: maxxton/v1/unitreservability?unitId={unitId}
13) RESERVATION_EVENT
Any change made to the reservations, which includes creation, modification or deletion in the reservation will generate RESERVATION_EVENT. The entity id logged will be the reservationId of the reservation that was changed.
To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:
-
GET: maxxton/v1/reservations/{reservationId}/details
To refresh specific data following endpoints can be used:
-
GET: maxxton/v1/reservations/{reservationId}
-
GET: maxxton/v1/reservations/{reservationId}/preferences
-
GET: maxxton/v1/reservations/{reservationId}/bills
-
GET: maxxton/v1/reservations/{reservationId}/content
-
GET: maxxton/v1/reservations/{reservationId}/subjects
To refresh the data for multiple reservations at the same time the reservationIds can be combined using the following endpoint:
-
GET: maxxton/v1/reservations?filter=reservationId:[reservationId1,reservationId2,reservationId3,…]
14) RESORT_EVENT
Any change made to the resorts, which includes creation, modification or deletion of the resort will generate RESORT_EVENT. The entity id logged will be the resortId of the resort that was changed.
To refresh the data the following endpoint can be used with the resortId fetched from the event endpoint:
-
GET: maxxton/v1/resorts/{resortId}/details
To refresh specific data following endpoints can be used:
-
GET: maxxton/v1/resorts/{resortId}
-
GET: maxxton/v1/resorts/{resortId}/amenitylinks
-
GET: maxxton/v1/resorts/{resortId}/subjects
To refresh the data for multiple resorts at the same time the resortIds can be combined using the following endpoint:
-
GET: maxxton/v1/resorts?filter=resortId:[resortId1,resortId2,resortId3,…]
15) UNIT_EVENT
Any change made to the units, which includes creation, modification or deletion of the unit will generate UNIT_EVENT. The entity id logged will be the unitId of the unit that was changed.
To refresh the data the following endpoint can be used with the unitId fetched from the event endpoint:
-
GET: maxxton/v1/units/{unitId}/details
To refresh specific data following endpoints can be used:
-
GET: maxxton/v1/units/{unitId}
-
GET: maxxton/v1/units/{unitId}/capacities
-
GET: maxxton/v1/units/{unitId}/amenitylinks
To refresh the data for multiple units at the same time the unitIds can be combined using the following endpoint:
-
GET: maxxton/v1/units?filter=unitId:[unitId1,unitId2,unitId3,…]
16) ALLOTMENT_EVENT
Any change made to the allotments, which includes creation, modification or deletion of the allotment will generate ALLOTMENT_EVENT. The entity id logged will be the resourceId of the accommodationtype whose allotment was changed.
To refresh the data the following endpoint can be used with the resourceId fetched from the event endpoint:
-
GET: /maxxton/v1/accommodationtypes/{resourceId}/allotments
To refresh the data for multiple accommodationtypes at the same time the resourceIds can be combined using the following endpoint:
-
GET: /maxxton/v1/allotments?filter=resourceId:[resourceId1,resourceId2,resourceId3…]
3.3. Reservation Flow
A reservation is basically used for booking or reserving an accommodationtype by a guest. Reservations include reserving a particular type of accommodationtype for a particular guest for a given period of time.
-
Availability and prices
There are 2 options to fetch the availability. One is to call the Maxxton API realtime and show it on the website, this also provides filter possibilities. Option 2 is to fetch all possible availabilities and prices and popuplate your own availability and price index to search offline on the external application.
Option 1:
Using the availability search you can search what accommodation types are available and for which periods. This endpoint also makes it possible to filter the search results and provide you with all possible filter options.
There are two search endpoints for different purposes:
POST /maxxton/v1/accommodationtypes/search
POST /maxxton/v1/accommodationtypes/arrivalrangesearch
Check the accommodation type search and arrival range search endpoints for details.
Option 2:
Using the availability call you can fetch all available stays and prices for all accommodation types. This endpoint is usually used to fill a dedicated availability/price index at the third party side.
POST /maxxton/v1/accommodationtypes/availability
Check the accommodation type availability endpoint for details.
Optional: In case you also would like to fetch all the mandatory costs(implies) to add this to your index the following call can be used:
POST /maxxton/v1/accommodationtypes/availability/implies
Check the accommodation type availability implies endpoint for details.
-
Accommodation types configuration/master data
Using the accommodation type endpoints you can get the accommodation type configuration i.e. translatable name and descriptions, units, amenities, images etc. It is also possible to filter the response.
There are multiple endpoints available for different purposes below two will contain most information regarding acommodation types and units:
GET /maxxton/v1/accommodationtypes/{resourceId}/details
GET /maxxton/v1/units/{unitId}/details
If only specific data is needed the following endpoints can be used:
GET /maxxton/v1/accommodationtypes
GET /maxxton/v1/units
GET /maxxton/v1/accommodationtypes/{resourceId}/amenitylinks
GET /maxxton/v1/accommodationtypes/{resourceId}/images
Check full list of accommodation type and related endpoints here.
-
Reservation proposal
POST: https://api.maxxton.net/maxxton/v1/reservations/proposals
When a possibility is chosen based on the search endpoints a reservation proposal can be created. A reservation proposal provides the proposal on reservation costs for the specified criteria in the request and doesn’t create an actual reservation in the system.
It is used to validate if the accommodation type is available for the specified arrival date and duration.
The reservation id and reservation number is not generated since no reservation is created. The proposal also provides you with all possible additions that can be added in the reservation. It also include instalments as per the reservation bill.
This proposal can be used multiple times, till you are totally fine with the reservation, nothing is saved in our system and no reservation costs apply by using this.
Check the reservation proposal endpoint for details.
-
NewReservation
POST: https://api.maxxton.net/maxxton/v1/reservations
When the reservation is correct and you have checked this with the proposal call, you can use the new reservation endpoint to create an actual reservation.
At this moment the new reservation is stored in our system and the reservation id and reservation number is generated.
-
Once the request is sent by the user, the request is validated as per the availability of the resource for which the reservation needs to be created. The mandatory parameters that needs to be passed in the new reservation request are as follows:
-
accommodationTypes: the details of the accommodationtype on which reservation is to be made
-
duration: the duration for which a user wants to make a reservation and the duration should be passed in days ex: 7.
-
resourceId: unique id associated with the accommodationtype.
-
subjects: details related to the subjects who will come for stay in an accommodationtype for whom reservation is to be created
-
persons: details related to the persons for whom the accommodationtype is booked in reservation.
-
age: age of the person
-
quantity: total number of persons for whom the accommodationtype is booked in reservation.
-
-
-
-
categoryCode: unique code associated with reservation category.
-
distributionChannelCode: unique code associated with distribution channel.
-
customer: details of guest doing the booking. Or, you can use customerId field instead of customer in case you have customerId of the guest who is doing the booking.
-
-
If the resource is available as per the request criteria, then the reservation will be created successfully and the status of the reservation can be provisional, optional, quotation, or request reservation(see reservation status flow, refer point 6 below).
Check the new reservation endpoint for details.
-
-
Update reservation
The reservation status can be updated to different status using:
PUT: https://api.maxxton.net/maxxton/v1/reservations/{reservationId}
The status which can be updated to different status. Please refer to below status chart:
-
QUOTATION(-5) → CONFIRM(will result in PROVISIONAL(12) or DEFINITIVE(21)), DECLINE(-10)
-
OPTIONAL(11) → CONFIRM(will result in PROVISIONAL(12) or DEFINITIVE(21)), DECLINE(-10)
-
REQUEST(10)→DECLINE(-10), CONFIRM(will result in PROVISIONAL(12) or DEFINITIVE(21))
-
PROVISIONAL(12) → CANCEL(-12), DECLINE(-10)
-
DEFINITIVE(21)→CANCEL(-12), CHECKED_IN(31)
-
CHECKED_IN(31)→CHECKED_OUT(41).
The user can change the status of the reservation as per the above status flow specified.
It’s also possible to update the expectedArrivalDateTime and expectedDepartureDateTime, the value should be passed in the below format ,
'YYYY-MM-DDThh:mm:ss'
The above fields are mainly used by the receptionist of the resort, by maintenance department and housekeeping.
Check the update reservation endpoint for details.
-
-
Reservation status flow overview
After creating a reservation it start with the INIT (an initial reservation) status. After completing the reservation, having added a customer and some add-ons, there are multiple options. We can update it to DELETED(these reservations are removed regularly), to OPTIONAL(which is a temporary confirmation) or PROVISIONAL(a confirmed reservation without a payment). Both OPTIONAL and PROVISIONAL get a reservation number assigned. This means they may no longer be deleted from the system, for financial reasons.
Reservation starts with OPTIONAL, QUOTATION, PROVISIONAL or DEFINITVE status when it is confirmed through the API.
OPTIONAL: will go to EXPIRED if not confirmed (after x number of hours/days based on configuration) or to PROVISIONAL/DEFINITIVE based on the API user configuration settings if confirmed. With this status the accommodation type price and availability are guaranteed for the reservation.
QUOTATION: will go to the EXPIRED if not confirmed after x number of hours/days based on configuration or to PROVISIONAL/DEFINITIVE based on API user if confirmed. With this status the accommodation type rates are guaranteed for the reservation period and not the availability. So, some other guest can also book the reservation and then it is no more available to the guest who created a QUOTATION reservation.
PROVISIONAL: A confirmed booking without a payment.
DEFINITIVE: If a payment is made(partial or full), a PROVISIONAL reservation will be changed to DEFINITIVE. When the guest arrives it will change to CHECKED_IN and finally to CHECKED_OUT when the guest leaves.
If a guest decides not to use the reservation, it can be changed from PROVISIONAL to DECLINED or to CANCELLED and from DEFINITIVE to CANCELLED.
DECLINED: There are no costs for the guest and the reservation is no more available.
CANCELLED: It implies that some sort of payment is involved. That is why DEFINITIVE can only go to CANCELLED(since something was paid already). From CANCELLED it can go to DEF_CANCELLED(if the guest decides to cancel absolutely), or back to either PROVISIONAL or DEFINITIVE (depending on payments made) if the guest opt for reservation again.
![Reservation status flow overview](images/ReservationStatus_Updated.png)
3.4. Ingenico Integration
Maxxton is using Ingenico as a default PSP(Payment service provider). Because of this, the payments can be automatically added to a reservation made in the Maxxton system using an integration that is already in place, however, to do this a couple of additional parameters is needed.
The integration works as follow
![Ingenico integration overview](images/PSP_Integration.png)
1) Recommended option: The flow 1 in the above diagram is the redirect URL. This can be generated from the Maxxton REST API by using the Reservation payment link endpoint. The endpoint will automatically provide the url to the correct Ingenico platform(Ingenico direct or the legacy version of Ingenico). The url provided from the response can be used in the website or application created by the company that is creating the booking module or website.
Alternative option: Previously this payment link had to be created manually. Below provides the url for the legacy Ingenico platform(Non Ingenico direct), this is not needed if you use the above endpoint to generate the payment link:
POST https://secure.ogone.com/ncol/prod/orderstandard_utf8.asp
POST request
Headers:
Content-Type: application/x-www-form-urlencoded
Request body(key-value pair):
PSPID=ClientPSPID //Ingenico PSPID to use
orderID=00019026850000_827efb46dc7bb2f //the order id should have the following structure: reservationNumber_anyRandomNumber
amount=1234 //the amount to be paid in the below-defined currency in cents(for example 12,35 should be defined as 1235)
currency=EUR //currency of the payment
language=nl_ //The language the Ingenico Hosted Payment Page is displayed to your customer. The value is a combination of ISO 639-1 (language) and ISO 3166-1 (country) for example: nl_NL, en_US, fr_FR
EMAIL=customer@maxxton.com //email of the customer
SHASign=0b105725955aa9e0cba8d9906ccd64d66b0ca422 //see Ingenico backoffice how this is created and what needs to be used here. Now we are supporting SHA-512 and SHA-1 is deprecated.
accepturl=https://book.maxxton.com/reservation/success //URL where the customer should be redirected to in case of a successful payment
declineurl=https://book.maxxton.com/reservation/cancel //URL where the customer should be redirected to in case of a declined payment
exceptionurl=https://book.maxxton.com/reservation/cancel //URL where the customer should be redirected to in case of a failed payment
cancelurl=https://book.maxxton.com/reservation/cancel //URL where the customer should be redirected to in case of a canceled payment
PARAMPLUS=distributionchannelId%3D51142%26reservationId%3D4181444%26employeeId%3D80041%26concernId%3D22 //mandatory parameters which will be used by Maxxton to process the payment on the proper reservation.
a) distributionchannelId: id of the distribution channel where the reservation is created for, this can be found in the response of the reservation confirm call
b) reservationId: id of the reservation that was just created to make the payment for, this can be found in the response of the reservation confirm call
c) employeeId: id of the employee which should add the payment in the Maxxton system, this can be found in the response "client_id" of the REST API authentication call
d) concernId: id of the concern/environment of the Maxton client, this can be found in the response "concern_id" of the REST API authentication call
TP=https://book.maxxton.com/ingenico/template.html //the URL to the Ingenico template to be used, this is optional.
Incase you would like to integrate directly with Ingenico direct. The Ingenico direct documentation can be found here.
2) This is the redirect from the Ingenico hosted payment page to the website, see Ingenico documentation for all possible parameters. This can be used by the booking module or website to provide feedback that the payment has been processed.
For Ingenico Direct you have to call the Ingenico hosted checkout status Endpoint to fetch the status. This can be done using this endpoint. The "hostedCheckoutId" to provide is returned from the redirect url(when using Reservation payment link endpoint you can add this in the "returnUrl" parameter) of Ingenico hosted payment page to your website. The "merchantId" is the PSPId used for the payment.
For the Ingenico legacy platform: Incase using the Maxxton Reservation payment link endpoint this can be provided in the fields(acceptUrl, cancelUrl, exceptionUrl, declineUrl).
3) The asynchronous callback from Ingenico to Maxxton. There is no additional development needed here and this will work right away if the correct structure for the redirect URL(number 1) is used. In the Ingenico backoffice the "URL of the merchant’s post-payment page" should be configured and point to Maxxton(this is already configured for existing Maxxton clients using Ingenico most of the time).
4. Entity Relations
4.1. Resort, Accommodation Type, Unit
-
Resort(called "location" in Maxxton Software):
A resort is group of accommodation types at the same location which provides an array of accommodation types typically including entertainment and recreational activities.
A resort may contain one or multiple accommodation types. -
Accommodation Type:
An accommodation type is group of similar units, here the units are configured that defines type of unit(Room, Bungalow, Chalet etc) and other possible configuration(Representation, Capacity, Cashflow, Rentability, Reserability, Amenities etc), which can be done per resort or condo.
An accommodation type may contain one or multiple units. -
Unit:
A room, group of rooms, or bungalow in which someone may live or stay, it can be a single room, bungalow, chalet etc.
Diagrammatic representation of Resort, Accommodation Types, Units:
![Resort, Accommodation types and Units](./images/ResortAccommodationtypeUnits.png)
4.2. Resources and reserved resources
In the Maxxton system, there are many resources(items) available, these resources can be of multiple types. For example Accommodation type, add-on, or offers are all resources. These resources can be booked while creating a reservation, in this case, a resource is added to the reservation which is called a reserved resource. This is basically a booked version of the actual resource. A resource is unique in the system and used across multiple reservations, a reserved resource is unique to the reservation.
Diagrammatic representation of Resources and reserved resources:
![Resources and reserved resources](./images/ResourcesAndReservedresources.png)
5. Resources
5.1. Accommodation Types
A group of similar units
5.1.1. Add new accommodation type
POST /maxxton/v1/accommodationtypes
Description
Add the new accommodation type.The details are to be mentioned in the resquest body.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request body to create new accommodation type. |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while adding new accommodation type. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes
Request body
{
"accotypeKindId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"brandId" : 1,
"code" : "string",
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : "string",
"priority" : 1,
"resortId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"name" : "string",
"shortDescription" : "string"
} ]
}
Example HTTP response
Response 200
{
"accommodationTypeKindCode" : "string",
"accotypeAddressmanagerId" : 1,
"accotypeBarrier" : 1,
"accotypeDoorlock" : 1,
"accotypeKindId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"brand" : "string",
"brandId" : 1,
"capacityManagerId" : 1,
"cashflowManagerId" : 1,
"code" : "string",
"dependsOnLedgerGroup" : true,
"description" : "string",
"groupId" : 1,
"hasObjects" : true,
"i18n" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"ledgerGroupId" : 1,
"ledgerId" : 1,
"name" : "string",
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"numberOfPersons" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"path" : "string",
"powerplayGroupId" : 1,
"previousPmsId" : "string",
"priority" : 1,
"qualityLevelId" : 1,
"realRentabilityManagerId" : 1,
"resortId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"shortDescription" : "string",
"supplierOrigin" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
}
5.1.2. Add rentability for accommodation type
POST /maxxton/v1/accommodationtypes/{resourceId}/rentability
Description
Rentability defines a specific period in which the accommodation type is rentable. The rentability details are to be added to the request body.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id for which rentability will be added for accommodation type |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while adding rentability. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rentability
Request body
{
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"dayMax" : 1,
"dayMin" : 1,
"daysOfWeek" : [ "string" ],
"isArrival" : true,
"isDeparture" : true,
"isTemporary" : 1,
"managerId" : 1,
"maxDeviationArrDepDate" : 1,
"maxTimeAfterBookDate" : 1,
"minDeviationArrDepDate" : 1,
"minTimeAfterBookDate" : 1
}
5.1.3. Calculate total price of given accommodation type
POST /maxxton/v1/accommodationtypes/{resourceId}/calculateprices
Description
This call will calculate the accommodation type price in real-time based on the current configuration in Maxxton software. This price is not based on the indexes and for this reason, there is no delay, however, the performance will be less. This feature should be implemented in a proper way, this means it’s recommended to lazy load the price after the actual availability search result is populated. Also, it’s recommended to only calculate the prices which are actually shown on the screen.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
removeWarrant |
The basePrice and totalPrice without the warrant costs bill will be returned when the value is set to true |
boolean |
Path |
resourceId |
resourceId of accommodation type for which the total price needs to be calculated |
integer (int64) |
Body |
requestBody |
Request body to calculate total price of new accommodation type. |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
|
500 |
Error occurred while adding new accommodation type. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/calculateprices
Request body
{
"arrivalDate" : "01-01-2023",
"distributionChannelId" : 1,
"duration" : 1,
"offerCode" : "string",
"petQuantity" : 1,
"rateTypeId" : 1,
"redeemableLoyaltyPoints" : 1,
"reservationCategoryId" : 1,
"subjects" : {
"persons" : [ {
"maxAge" : 1,
"quantity" : 1
} ]
}
}
Example HTTP response
Response 204
{
"basePrice" : 1,
"loyaltyDiscount" : 1,
"offerPrice" : 1,
"totalPrice" : 1,
"warrantTotalPrice" : 1
}
5.1.4. Create accommodationType representation
POST /maxxton/v1/accommodationtypes/{resourceId}/representations
Description
Create accommodationType representations. The representation details are to be passed in the request body.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
resourceId of accommodation for which representations are to be created |
integer (int64) |
Body |
requestBody |
representation object to create represenation for accommodation type |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating accommodation type representation. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/representations
Request body
{
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
}
Example HTTP response
Response 200
{
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
}
5.1.5. Create accommodationtype budgets.
POST /maxxton/v1/accommodationtypes/{resourceId}/budgets
Description
Create accommodationtype budgets.", notes = "Create or update the daily budget for the specific accommodation type based on id. This will set the modifiedBudget and originalBudget based on the following logic: when no budget is available for the date and accommodationtype it will set the originalbudget, every time after this when a new budget is sent it will store this in the modifiedbudget field.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
resourceId of accommodation type for which the budget needs to be created |
integer (int64) |
Body |
requestBody |
< ResourceBudgetRequest |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while creating the accommodation type budget. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/budgets
Request body
[ {
"budgetDate" : "01-01-2023",
"turnoverBudget" : 1
} ]
5.1.6. Get accommodation kinds
GET /maxxton/v1/accommodationtypes/kinds
Description
Gets a page with accommodation kinds.The records can be filtered based on accommodation kind object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching AccommodationKind. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/kinds
Example HTTP response
Response 200
{
"content" : [ {
"accommodationkindId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"excludeFromReporting" : true,
"priority" : 1,
"translations" : [ {
"accommodationkindId" : 1,
"description" : "string",
"i18nAccommodationkindId" : 1,
"languageId" : 1,
"name" : "string"
} ],
"workOrderUnits" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.7. Get capacities of the accommodation type
GET /maxxton/v1/accommodationtypes/{resourceId}/capacities
Description
Capacity specify the details about the number persons (Adult, Youngster, Baby etc.) or pets that can be accommodated in the accommodation type. This endpoint provides capacities for an accommodation type.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
resourceId to fetch capacities |
integer (int64) |
Query |
returnWorkOrderTypes |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< Capacity |
500 |
Error occurred while fetching capacities for AccommodationType. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/capacities
Example HTTP response
Response 200
[ {
"capacity" : 1,
"capacityId" : 1,
"endDate" : "01-01-2023",
"managerId" : 1,
"name" : "string",
"startDate" : "01-01-2023",
"subjectId" : 1
} ]
5.1.8. Get resource availability based on provided criteria.
GET /maxxton/v1/accommodationtypes/availability
Description
The endpoint can be used in following way:
1.If resourceId is passed in the request then it will return next four month’s availability from currentDate.
2.If only resortId is passed in the request then it will return two months availability of accommodations for that resort.
3.If only offerCode is passed in the request then it will return two months availability for all the types for which the requested offer is valid.
4.The arrivalDateFrom & arrivalDateTo fields could be used to limit the availability response for specific arrival date range.
5.There is a max limit on the arrival range period of four months together with resourceId field in the request and max limit of two months if only resortId or offercode field value is passed in the request.
6.In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
duration |
integer (int32) |
|
Query |
includeAllPrices |
boolean |
|
Query |
rateTypeId |
integer (int64) |
|
Query |
resourceId |
integer (int64) |
|
Query |
offerCode |
string |
|
Query |
resortId |
integer (int64) |
|
Query |
arrivalDateFrom |
string (date) |
|
Query |
offerId |
integer (int64) |
|
Query |
distributionChannelId |
integer (int64) |
|
Query |
arrivalDateTo |
string (date) |
|
Query |
includeHiddenOffers |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< ResourceAvailability |
500 |
Error occurred while fetching availability of resource |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability
Example HTTP response
Response 200
[ {
"accommodationKindId" : 1,
"arrivalDate" : "01-01-2023",
"departureDate" : "01-01-2023",
"duration" : 1,
"maxCapacity" : 1,
"petCapacity" : 1,
"prices" : [ {
"basePrice" : 1,
"basePriceInclusive" : 1,
"calculationDate" : "01-01-2023T11:23:45Z",
"offer" : {
"maxAge" : 1,
"minAge" : 1,
"minCapacity" : 1,
"offerCode" : "string",
"offerId" : 1,
"offerPolicy" : "string",
"offerPrice" : 1,
"offerPriceInclusive" : 1
},
"rateTypeId" : 1,
"referencePrice" : 1,
"referencePriceInclusive" : 1
} ],
"resortCode" : "string",
"resortId" : 1,
"resourceId" : 1,
"units" : [ "integer" ]
} ]
5.1.9. Get rooms on a specific resource id
GET /maxxton/v1/accommodationtypes/{resourceId}/rooms
Description
Provides the details of the rooms specific to a particular resource id.. The records can be filtered based on rooms object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which rooms are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Rooms |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rooms
Example HTTP response
Response 200
{
"content" : [ {
"amenities" : [ {
"amenityLinkId" : 1,
"numberValue" : 1,
"textValue" : "string"
} ],
"code" : "string",
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"roomId" : 1,
"roomManagerId" : 1,
"roomType" : {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.10. Gets resource implies
GET /maxxton/v1/accommodationtypes/implies
Description
Gets a page with resource implies. Implies are the extras that can be linked to the special. The records can be filtered based on implies object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resource implies. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : 1,
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"countFromMin" : true,
"ignoreRentability" : true,
"implicationManagerId" : 1,
"implied" : [ {
"objectId" : 1,
"resourceId" : 1
} ],
"impliesId" : 1,
"implyOnce" : true,
"included" : true,
"onBill" : true,
"parent" : true,
"parentId" : 1,
"priority" : 1,
"quantityMax" : 1,
"quantityMin" : 1,
"removable" : true,
"required" : true,
"resourceId" : 1,
"resourceIds" : [ "integer" ],
"showOnAllInPriceBill" : true,
"showPrice" : true,
"stay" : true,
"subjectsMax" : 1,
"subjectsMin" : 1,
"supplierImpliesId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.11. Gets Cost prices on a specific resource id.
GET /maxxton/v1/accommodationtypes/{resourceId}/costprices
Description
Gets Cost prices based on resource id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id for which cost prices are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching cost prices of resource |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/costprices
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"costPriceId" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"duration" : 1,
"maxDuration" : 1,
"minDuration" : 1,
"resourceId" : 1,
"usageDowList" : [ "string" ],
"value" : 1,
"valueType" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.12. Gets a Resource locks on specified resource id
GET /maxxton/v1/accommodationtypes/{resourceId}/locks
Description
Gets a page with resource locks specified with a particular resource id.The records can be filtered based on resource lock object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which locks are to be fetched |
integer (int64) |
Query |
unitId |
unitId to filter the records |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resource locks. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/locks
Example HTTP response
Response 200
{
"content" : [ {
"accoCreatedLock" : 1,
"blockDate" : "01-01-2023",
"clientId" : 1,
"created" : "01-01-2023T11:23:45Z",
"createdOn" : "01-01-2023T11:23:45Z",
"detailDescription" : "string",
"endDate" : "01-01-2023",
"objectId" : 1,
"reasonId" : 1,
"resourceId" : 1,
"resourceLockId" : 1,
"resourceManagerId" : 1,
"startDate" : "01-01-2023",
"type" : "string",
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.13. Gets a resource releases on specified resource id
GET /maxxton/v1/accommodationtypes/{resourceId}/releases
Description
Accommodation type release specifies that the accommodation type is available for booking for which period and to which users i.e. all, owners or test,It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which to fetch releases |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching AccommodationType releases. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/releases
Example HTTP response
Response 200
{
"content" : [ {
"createdDate" : "01-01-2023T11:23:45Z",
"maxArrivalDate" : "01-01-2023",
"minArrivalDate" : "01-01-2023",
"modifiedDate" : "01-01-2023T11:23:45Z",
"releaseId" : 1,
"releasedDays" : 1,
"resourceId" : 1,
"status" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.14. Gets a single price for each stay (combination of arrival date and duration) for a given resource
POST /maxxton/v1/accommodationtypes/arrivalrangesearch
Description
Gets accommodationtype range search based on provided criteria. This endpoint supports prebooking prices, only if the field preBooking = true in the request body. If not specified, prebooking prices are not considered in the response.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown. In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
400 |
Either offerCode or voucherCode should be passed |
No Content |
500 |
Error occurred while fetching accommodationTypes |
No Content |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/arrivalrangesearch
Request body
{
"accommodationKindIds" : [ "integer" ],
"amenityIds" : [ "integer" ],
"arrivalDateFrom" : "01-01-2023",
"distributionChannelId" : 1,
"filterOptions" : [ "string" ],
"numberOfDaysInResult" : 1,
"offerCode" : "string",
"offerId" : 1,
"petQuantity" : 1,
"preBooking" : true,
"qualityLevelIds" : [ "integer" ],
"rateTypeId" : 1,
"redeemableLoyaltyPoints" : 1,
"resortIds" : [ "integer" ],
"resourceIds" : [ "integer" ],
"subjects" : {
"persons" : [ {
"maxAge" : "string",
"quantity" : 1
} ]
},
"unitId" : 1,
"voucherCode" : "string"
}
Example HTTP response
Response 200
{
"filterOptionsResult" : {
"arrivals" : [ "string" ],
"departures" : [ "string" ],
"qualityLevels" : [ "integer" ]
},
"results" : {
"content" : [ {
"accommodationKindId" : 1,
"arrivalDate" : "01-01-2023",
"arrivalDowMask" : "string",
"basePrice" : 1,
"basePriceInclusive" : 1,
"departureDate" : "01-01-2023",
"duration" : 1,
"freeLoyaltyDuration" : 1,
"loyaltyPrice" : 1,
"loyaltyPriceInclusive" : 1,
"maxCapacity" : 1,
"maxPetCapacity" : 1,
"offerCode" : "string",
"offerName" : "string",
"offerPolicy" : "string",
"offerPrice" : 1,
"offerPriceInclusive" : 1,
"preBooking" : true,
"qualityLevelId" : 1,
"rateTypeId" : 1,
"referencePrice" : 1,
"referencePriceInclusive" : 1,
"requiredLoyaltyPoints" : 1,
"resortId" : 1,
"resourceCode" : "string",
"resourceId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
}
5.1.15. Gets accommodation Type Detail
GET /maxxton/v1/accommodationtypes/details
Description
Gets a page of accommodationtype details. Maximum and default page size for this endpoint is 10.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
endDate |
Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Query |
returnWorkOrderTypes |
boolean |
|
Query |
brand |
brand to filter records based on brand. |
string |
Query |
returnSections |
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. |
< string > array |
Query |
startDate |
Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Query |
resourceIds |
List of resourceIds to fetch the details. |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching AccommodationTypeUnitDetail. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/details
Example HTTP response
Response 200
{
"content" : [ {
"accommodationKind" : {
"accommodationkindId" : 1,
"code" : "string",
"isWorkOrderObject" : true,
"name" : "string",
"translations" : [ {
"accommodationkindId" : 1,
"description" : "string",
"i18nAccommodationkindId" : 1,
"languageId" : 1,
"name" : "string"
} ]
},
"accommodationTypeKindCode" : "string",
"accotypeBarrier" : 1,
"accotypeDoorlock" : 1,
"accotypeKindId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityCategorySets" : [ {
"categories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ { } ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : { },
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"archivedFrom" : "01-01-2023",
"brand" : "string",
"brandId" : 1,
"capacities" : [ {
"capacity" : 1,
"capacityId" : 1,
"endDate" : "01-01-2023",
"managerId" : 1,
"startDate" : "01-01-2023",
"subject" : {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
},
"subjectId" : 1
} ],
"capacityRequirements" : [ {
"managerId" : 1,
"required" : 1,
"subject" : [ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
} ],
"checkinTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"checkoutTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"code" : "string",
"dynamicFields" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"earlyCheckinTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"hasObjects" : true,
"i18n" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"lateCheckoutTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"ledgerGroupId" : 1,
"ledgerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"numberOfPersons" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"path" : "string",
"powerplayGroupId" : 1,
"previousPmsId" : "string",
"priority" : 1,
"qualityLevelId" : 1,
"resortId" : 1,
"resourceGroup" : {
"code" : "string",
"groupId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
},
"resourceId" : 1,
"resourcegroupId" : 1,
"rooms" : [ {
"amenities" : [ {
"amenityLinkId" : 1,
"numberValue" : 1,
"textValue" : "string"
} ],
"code" : "string",
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"roomId" : 1,
"roomManagerId" : 1,
"roomType" : {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"videos" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.16. Gets accommodation Type Detail
GET /maxxton/v1/accommodationtypes/{resourceId}/details
Description
Gets a detailed decription of the particular resource accommodationtypes.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
resourceId to fetch accommodationtypedetail |
integer (int64) |
Query |
endDate |
Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Query |
returnWorkOrderTypes |
boolean |
|
Query |
returnSections |
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. |
< string > array |
Query |
startDate |
Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching AccommodationTypeDetail. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/details
Example HTTP response
Response 200
{
"accommodationKind" : {
"accommodationkindId" : 1,
"code" : "string",
"isWorkOrderObject" : true,
"name" : "string",
"translations" : [ {
"accommodationkindId" : 1,
"description" : "string",
"i18nAccommodationkindId" : 1,
"languageId" : 1,
"name" : "string"
} ]
},
"accommodationTypeKindCode" : "string",
"accotypeBarrier" : 1,
"accotypeDoorlock" : 1,
"accotypeKindId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityCategorySets" : [ {
"categories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ { } ],
"thumbnailUrl" : "string",
"translations" : [ { } ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"managerId" : 1,
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"archivedFrom" : "01-01-2023",
"brand" : "string",
"brandId" : 1,
"capacities" : [ {
"capacity" : 1,
"capacityId" : 1,
"endDate" : "01-01-2023",
"managerId" : 1,
"startDate" : "01-01-2023",
"subject" : {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
},
"subjectId" : 1
} ],
"capacityRequirements" : [ {
"managerId" : 1,
"required" : 1,
"subject" : [ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
} ],
"checkinTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"checkoutTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"code" : "string",
"dynamicFields" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"earlyCheckinTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"hasObjects" : true,
"i18n" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"lateCheckoutTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"ledgerGroupId" : 1,
"ledgerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"numberOfPersons" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"path" : "string",
"powerplayGroupId" : 1,
"previousPmsId" : "string",
"priority" : 1,
"qualityLevelId" : 1,
"resortId" : 1,
"resourceGroup" : {
"code" : "string",
"groupId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
},
"resourceId" : 1,
"resourcegroupId" : 1,
"rooms" : [ {
"amenities" : [ {
"amenityLinkId" : 1,
"numberValue" : 1,
"textValue" : "string"
} ],
"code" : "string",
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"roomId" : 1,
"roomManagerId" : 1,
"roomType" : {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"videos" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ]
}
5.1.17. Gets accommodation type additions
GET /maxxton/v1/accommodationtypes/{resourceId}/additions
Description
Gets a page with AccommodationType additions for a particular resource. The record can be filtered based on resource addition object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
resourceId of accommodation for which additions are to be fetched |
integer (int64) |
Query |
type |
type to filter records based on the type on the resource addition |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching accommodation type additions. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/additions
Example HTTP response
Response 200
{
"content" : [ {
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.18. Gets accommodationType representations
GET /maxxton/v1/accommodationtypes/{resourceId}/representations
Description
Gets a page with accommodationType representations for a resource. The records can be filtered based on representation object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
resourceId of accommodation for which representations are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching accommodation type representations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/representations
Example HTTP response
Response 200
{
"content" : [ {
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.19. Gets accommodationTypes additions
GET /maxxton/v1/accommodationtypes/additions
Description
Get a page with accommodation types additions.Additions are defining recommended goods during the booking process(upselling). The products are linked to the accommodation where they may be booked. The data can be filtered based on resource addition object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
type |
type to filter records based on the type on the resource addition |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching accommodation types additions. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/additions
Example HTTP response
Response 200
{
"content" : [ {
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.20. Gets accommodationtype rates
GET /maxxton/v1/accommodationtypes/{resourceId}/rates
Description
Gets a page with rates of accommodation of a particular resource.The records can be filtered based on rate object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which Rates are to be fetched |
integer (int64) |
Query |
rateTypeIds |
RateTypeIds to filter accommodation type Rates. |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching accommodation type rates. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rates
Example HTTP response
Response 200
{
"content" : [ {
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"daysOfWeek" : [ "string" ],
"duration" : 1,
"maxDeviation" : 1,
"maxDuration" : 1,
"maxDurationMinutes" : 1,
"minDeviation" : 1,
"minDuration" : 1,
"minDurationMinutes" : 1,
"priority" : 1,
"qrvType" : "string",
"qrvValues" : [ {
"minQuantity" : 1,
"value" : 1
} ],
"quantifier" : "string",
"rateId" : 1,
"rateTypeIds" : [ "integer" ],
"rateTypes" : [ {
"rateTypeId" : 1
} ],
"remark" : "string",
"resourceId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"usageDowList" : [ "string" ],
"usageDurationFrom" : 1,
"usageDurationTo" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023",
"value" : 1,
"valueType" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.21. Gets all accommodation types
GET /maxxton/v1/accommodationtypes
Description
Gets a page with accommodation types. The records can be filtered based on accommodation type object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
countryCode |
Country code to filter accommodation types. |
string |
Query |
returnWorkOrderTypes |
boolean |
|
Query |
brand |
brand to filter records based on brand. |
string |
Query |
resourceIds |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching AccommodationTypes. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes
Example HTTP response
Response 200
{
"content" : [ {
"accommodationTypeKindCode" : "string",
"accotypeAddressmanagerId" : 1,
"accotypeBarrier" : 1,
"accotypeDoorlock" : 1,
"accotypeKindId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"brand" : "string",
"brandId" : 1,
"capacityManagerId" : 1,
"cashflowManagerId" : 1,
"code" : "string",
"dependsOnLedgerGroup" : true,
"description" : "string",
"groupId" : 1,
"hasObjects" : true,
"i18n" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"ledgerGroupId" : 1,
"ledgerId" : 1,
"name" : "string",
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"numberOfPersons" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"path" : "string",
"powerplayGroupId" : 1,
"previousPmsId" : "string",
"priority" : 1,
"qualityLevelId" : 1,
"realRentabilityManagerId" : 1,
"resortId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"shortDescription" : "string",
"supplierOrigin" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.22. Gets allotments for Resource
GET /maxxton/v1/accommodationtypes/{resourceId}/allotments
Description
Gets allotments for Resource of a specific resourceId. The records can be filtered based on allotment object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which to fetch Allotments |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Allotments. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/allotments
Example HTTP response
Response 200
{
"content" : [ {
"allotmentId" : 1,
"amount" : 1,
"description" : "string",
"distributionChannelId" : 1,
"exceedLimit" : 1,
"expirePeriod" : 1,
"hasObjects" : true,
"isEnactive" : true,
"modified" : "01-01-2023",
"name" : "string",
"periods" : [ {
"endDate" : "01-01-2023",
"quantity" : 1,
"startDate" : "01-01-2023",
"unitIds" : [ "integer" ]
} ],
"resourceId" : 1,
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.23. Gets allotments releases of a specific resource
GET /maxxton/v1/accommodationtypes/{resourceId}/allotments/releases
Description
Gets allotment releases for a resource with particular resource id.The records can be fetched based on allotment release object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which to fetch Allotment releases |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Allotment releases. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/allotments/releases
Example HTTP response
Response 200
{
"content" : [ {
"allotmentReleaseId" : 1,
"distributionChannelId" : 1,
"endDate" : "01-01-2023",
"isEnactive" : true,
"name" : "string",
"performedDate" : "01-01-2023",
"releaseDate" : "01-01-2023",
"releasePeriod" : 1,
"resortId" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.24. Gets amenity links page
GET /maxxton/v1/accommodationtypes/amenitylinks
Description
Gets a page with amenity links. The records can be filtered based on accommodation type amenity link object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Amenity links. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"accommodationTypeId" : 1,
"amenityId" : 1,
"amenityLinkId" : 1,
"code" : "string",
"endDate" : "01-01-2023",
"numberValue" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.25. Gets amenity links page for a resource
GET /maxxton/v1/accommodationtypes/{resourceId}/amenitylinks
Description
Gets a page with amenity links to a particular resource.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
resourceId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Amenity links. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"code" : "string",
"endDate" : "01-01-2023",
"numberValue" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.26. Gets an accommodation Type on a specific resource id.
GET /maxxton/v1/accommodationtypes/{resourceId}
Description
Gets accommodation types based on its resource id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id to fetch accommodationtype |
integer (int64) |
Query |
returnWorkOrderTypes |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching AccommodationType. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}
Example HTTP response
Response 200
{
"accommodationTypeKindCode" : "string",
"accotypeAddressmanagerId" : 1,
"accotypeBarrier" : 1,
"accotypeDoorlock" : 1,
"accotypeKindId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"brand" : "string",
"brandId" : 1,
"capacityManagerId" : 1,
"cashflowManagerId" : 1,
"code" : "string",
"dependsOnLedgerGroup" : true,
"description" : "string",
"groupId" : 1,
"hasObjects" : true,
"i18n" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"ledgerGroupId" : 1,
"ledgerId" : 1,
"name" : "string",
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"numberOfPersons" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"path" : "string",
"powerplayGroupId" : 1,
"previousPmsId" : "string",
"priority" : 1,
"qualityLevelId" : 1,
"realRentabilityManagerId" : 1,
"resortId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"shortDescription" : "string",
"supplierOrigin" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
}
5.1.27. Gets an accommodationType budget of a resource.
GET /maxxton/v1/accommodationtypes/{resourceId}/budgets
Description
Get the daily budget for the specific accommodation type based on id.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
resourceId of accommodation type for which the budget needs to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching accommodation type budget. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/budgets
Example HTTP response
Response 200
{
"content" : [ {
"budgetDate" : "01-01-2023",
"budgetId" : 1,
"modifiedBudget" : 1,
"originalBudget" : 1,
"resourceId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.28. Gets cost prices for all accommodationtype
GET /maxxton/v1/accommodationtypes/costprices
Description
Gets a page with Cost prices. The records can be filtered based on Cost price object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching cost prices |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/costprices
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"costPriceId" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"duration" : 1,
"maxDuration" : 1,
"minDuration" : 1,
"resourceId" : 1,
"usageDowList" : [ "string" ],
"value" : 1,
"valueType" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.29. Gets dynamic fields for a particular resource
GET /maxxton/v1/accommodationtypes/{resourceId}/dynamicfields
Description
Gets a page with dynamic fields to a specific resource. The records can be filtered based on the DynamicField object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which dynamic fieilds are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resource dynamic fields. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/dynamicfields
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.30. Gets images for a particular resource
GET /maxxton/v1/accommodationtypes/{resourceId}/images
Description
Gets a page with images to a specific resource. The records can be filtered based on the image object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which images are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resource images. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/images
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.31. Gets implies linked to a particular resource
GET /maxxton/v1/accommodationtypes/{resourceId}/implies
Description
Gets a page with resource implies. Implies are the extras that can be linked to the special.The records can be filtered based on the implies object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which implies are to be fetched |
integer (int64) |
Query |
parentImplies |
Get a parent implies or resource implies |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resource implies. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : 1,
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"countFromMin" : true,
"ignoreRentability" : true,
"implicationManagerId" : 1,
"implied" : [ {
"objectId" : 1,
"resourceId" : 1
} ],
"impliesId" : 1,
"implyOnce" : true,
"included" : true,
"onBill" : true,
"parent" : true,
"parentId" : 1,
"priority" : 1,
"quantityMax" : 1,
"quantityMin" : 1,
"removable" : true,
"required" : true,
"resourceId" : 1,
"resourceIds" : [ "integer" ],
"showOnAllInPriceBill" : true,
"showPrice" : true,
"stay" : true,
"subjectsMax" : 1,
"subjectsMin" : 1,
"supplierImpliesId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.32. Gets priorities for particular resourceid.
GET /maxxton/v1/accommodationtypes/{resourceId}/priorities
Description
Get priorites for the specific accommodation type based on resourceid.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
resourceId of accommodation type for which the priorities needs to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching accommodation type priority. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/priorities
Example HTTP response
Response 200
{
"content" : [ {
"accommodationtypePriorityId" : 1,
"fiscalYear" : {
"arrivalLimit" : "01-01-2023",
"departureLimit" : "01-01-2023",
"financiallyClosed" : true,
"fiscalYear" : 1,
"fiscalYearId" : 1
},
"fiscalyearId" : 1,
"prioritySequence" : "string",
"reservationFrom" : "01-01-2023",
"reservationTo" : "01-01-2023",
"resourceId" : 1,
"useContractPriority" : true,
"useOccupation" : true,
"usePlanboardFitting" : true,
"useQuestionnaire" : true,
"useTargetAmount" : true,
"useVsi" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.33. Gets the List of applicable preference fee for the accommodationType.
GET /maxxton/v1/accommodationtypes/availability/preferences
Description
Gets the list of applicable preference fee for the accommodationtypes.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
distributionChannelCode |
distributionChannelCode for which addons are to be fetched |
string |
Query |
resourceId |
Resource id for which addons are to be fetched |
integer (int64) |
Query |
reservationCategoryCode |
reservationCategoryCode for which addons are to be fetched. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< AccommodationTypePreference |
500 |
Error occurred while fetching preference fee. |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability/preferences
Example HTTP response
Response 200
[ {
"preferenceTypes" : [ "string" ],
"prices" : [ {
"appliedPerSubject" : true,
"price" : 1,
"priceArrivalDateFrom" : "01-01-2023",
"priceArrivalDateTo" : "01-01-2023",
"priceBookDateFrom" : "01-01-2023T11:23:45Z",
"priceBookDateTo" : "01-01-2023T11:23:45Z",
"subjectIds" : [ "integer" ],
"subjectPrices" : [ {
"minQuantity" : 1,
"price" : 1,
"subjectIds" : [ "integer" ]
} ]
} ],
"resortId" : 1,
"resourceId" : 1
} ]
5.1.34. Gets the Page of Quality Levels
GET /maxxton/v1/accommodationtypes/qualitylevels
Description
Gets the Page of Quality Levels.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Quality levels |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/qualitylevels
Example HTTP response
Response 200
{
"content" : [ {
"archivedFrom" : "01-01-2023",
"code" : "string",
"priority" : 1,
"qualityLevelId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.35. Gets the Page of target amount for a particular resourceId,accommodationPriorityId.
GET /maxxton/v1/accommodationtypes/{resourceId}/priorities/{accommodationtypePriorityId}/targetAmounts
Description
Gets a page with target amount. The records can be filtered based on target amount object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
resourceId for which target amount are to be fetched. |
integer (int64) |
Path |
accommodationtypePriorityId |
accommodationTypePriorityId for which target amount are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching target amount. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/priorities/{accommodationtypePriorityId}/targetAmounts
Example HTTP response
Response 200
{
"content" : [ {
"accommodationtypePriorityId" : 1,
"contractTypeId" : 1,
"fiscalYear" : {
"arrivalLimit" : "01-01-2023",
"departureLimit" : "01-01-2023",
"financiallyClosed" : true,
"fiscalYear" : 1,
"fiscalYearId" : 1
},
"fiscalyearId" : 1,
"maxFundPerInvForMaterial" : 1,
"maxFundPerInvForWorktime" : 1,
"maxFundPerInvReservation" : 1,
"maxFundPerWorkorder" : 1,
"maxMaintenanceFund" : 1,
"ownerId" : 1,
"rentAssuranceBase" : 1,
"resourceId" : 1,
"resourceTargetAmountId" : 1,
"targetAmount" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.36. Gets the page of available addons for the accommodationType.
GET /maxxton/v1/accommodationtypes/availability/additions
Description
This endpoint is used to fetch all the available implies along with available prices.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
distributionChannelCode |
distributionChannelCode for which addons are to be fetched |
string |
Query |
resourceId |
Resource id for which addons are to be fetched |
integer (int64) |
Query |
advancedCalculation |
Flag for calculating the relative rate configuration for all the addons if configured. enabling this flag will give you the information about the percentage price and the resources that particular price depends on. |
boolean |
Query |
reservationCategoryCode |
reservationCategoryCode for which addons are to be fetched. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching prices of resource |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability/additions
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"maxQuantity" : 1,
"minQuantity" : 1,
"prices" : [ {
"addonIds" : [ "integer" ],
"appliedPerSubject" : true,
"daysOfWeek" : [ "string" ],
"dependsOnAccommodationtypes" : true,
"dependsOnAddon" : true,
"dependsOnOffer" : true,
"duration" : 1,
"maxQuantity" : 1,
"minQuantity" : 1,
"offerIds" : [ "integer" ],
"perDay" : "string",
"percentagePrice" : true,
"price" : 1,
"priceArrivalDateFrom" : "01-01-2023",
"priceArrivalDateTo" : "01-01-2023",
"subjectIds" : [ "integer" ],
"subjectPrices" : [ {
"minQuantity" : 1,
"price" : 1,
"subjectIds" : [ "integer" ]
} ]
} ],
"resortId" : 1,
"resourceId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"resourceId" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.37. Gets the page of available implies for the accommodationType.
GET /maxxton/v1/accommodationtypes/availability/implies
Description
This endpoint is used to fetch all the available implies along with available prices.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
distributionChannelCode |
DistributionChannelCode for which implies are to be fetched |
string |
Query |
resourceId |
Resource id for which implies are to be fetched |
integer (int64) |
Query |
advancedCalculation |
Flag for calculating the relative rate configuration for all the implies if configured. enabling this flag will give you the information about the percentage price and the resources that particular price depends on. |
boolean |
Query |
reservationCategoryCode |
reservationCategoryCode for which implies are to be fetched. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching cost prices of resource |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/availability/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : true,
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"included" : true,
"maxQuantity" : 1,
"minQuantity" : 1,
"prices" : [ {
"addonIds" : [ "integer" ],
"appliedPerSubject" : true,
"daysOfWeek" : [ "string" ],
"dependsOnAccommodationtypes" : true,
"dependsOnAddon" : true,
"dependsOnOffer" : true,
"duration" : 1,
"included" : true,
"maxNights" : 1,
"maxQuantity" : 1,
"minNights" : 1,
"minQuantity" : 1,
"offerIds" : [ "integer" ],
"perDay" : "string",
"percentagePrice" : true,
"price" : 1,
"priceArrivalDateFrom" : "01-01-2023",
"priceArrivalDateTo" : "01-01-2023",
"subjectIds" : [ "integer" ],
"subjectPrices" : [ {
"minQuantity" : 1,
"price" : 1,
"subjectIds" : [ "integer" ]
} ]
} ],
"required" : true,
"resortId" : 1,
"resourceId" : 1,
"stayDate" : [ "string" ],
"subjectsMax" : 1,
"subjectsMin" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.38. Gets videos for accommodation type
GET /maxxton/v1/accommodationtypes/{resourceId}/videos
Description
Gets a page with videos to a specific resource. The records can be filtered based on the video object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which videos are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resource videos. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/videos
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.1.39. Insert accommodation rate
POST /maxxton/v1/accommodationtypes/{resourceId}/rates
Description
Inserts the accommodation rate type. The details are to be mentioned in the request body. The rates cannot be inserted for derived rate option.x-allow-past-price : This header is passed in the request to allow the user to pass past book dates. The user can pass "true" as the value of the header if past book dates are provided in the request and if the value of this header is "false" the user will not be able to pass book dates that lie in the past. Rates in the past can only be inserted for accommodation types that currently have no rates at all or in case no reservations have been made for the particular accommodation type yet.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id for which resource rate will inserted |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while insert resource rate. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/rates
Request body
{
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"cashflowruleId" : 1,
"daysOfWeek" : [ "string" ],
"duration" : 1,
"maxDeviation" : 1,
"maxDuration" : 1,
"maxUnit" : 1,
"minDeviation" : 1,
"minDuration" : 1,
"minUnit" : 1,
"priority" : 1,
"quantifier" : "string",
"rateLevelId" : 1,
"rateOptionId" : 1,
"rateTypeIds" : [ "integer" ],
"remark" : "string",
"repeatable" : 1,
"resourceId" : 1,
"status" : 1,
"stay" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"usageDowList" : [ "string" ],
"usageDurationFrom" : 1,
"usageDurationTo" : 1,
"usageUnitFrom" : 1,
"usageUnitTo" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023",
"value" : 1,
"valueType" : "string"
}
5.1.40. Search accommodationtypes based on provided criteria
POST /maxxton/v1/accommodationtypes/search
Description
The above endpoint is used to search through the availability of the whole inventory based on all accommodation types, this can be filtered by providing request criteria. For example: arrival date , duration , resort , accommodation type , amenities and subjects are possible filters. The result can contain filter options, filter options provide all possible filter possibilities based on the currently provided filter options. This provides you with all possible arrivals , departures , resorts and amenities as per the criteria passed in the request. If "Includeallprices" field is passed as true in the request, it will provide 10 records in the response this is only possible for one specific resourceId, if it is provided as false, then only the first record is displayed in the response.
In case of prebooking, the prices returned would be null.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.
The "dateMargin" request parameter will provide up to 4 alternative stays according to the number that is supplied in "dateMargin" in case there is no match with the requested criteria. It’s up to the client to choose which of these alternatives to use. In case there is an exact match with the requested stay dates only 1 available stay is provided in the result. In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay. See below diagram for an explanation on how the alternative stays work:
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Query |
defaultSelection |
single possible value - nearest_arrival [First available arrival if no arrival date is provided based on todays date, by default sort is based on cheapest_price] |
string |
Query |
sort |
Sort parameter is used to sort the response in ascending or descending order on the basis of offer price, offer price inclusive and priority. In order to sort the response in ascending order of offer price 'offer_price_asc' is used and to sort in descending order the value of sort that should be passed is 'offer_price_desc' similarly offer_price_inclusive_asc and offer_price_inclusive_desc can be used to sort on offer price inclusive like wise priority_asc and priority_desc can be used to sort on priority. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
400 |
|
No Content |
500 |
Error occurred while fetching accommodationTypes |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/search
Request body
{
"accommodationKindIds" : [ "integer" ],
"amenityIds" : [ "integer" ],
"arrivalDate" : "01-01-2023",
"dateMargin" : 1,
"dateMarginMethod" : "string",
"distributionChannelId" : 1,
"duration" : 1,
"filterOptions" : [ "string" ],
"includeAllPrices" : true,
"includeFilterOptionCounts" : true,
"maxNrOfBathrooms" : 1,
"maxNrOfBedrooms" : 1,
"minNrOfBathrooms" : 1,
"minNrOfBedrooms" : 1,
"offerCode" : "string",
"offerId" : 1,
"petQuantity" : 1,
"qualityLevelIds" : [ "integer" ],
"redeemableLoyaltyPoints" : 1,
"regionId" : 1,
"resortIds" : [ "integer" ],
"resourceIds" : [ "integer" ],
"subjects" : {
"persons" : [ {
"maxAge" : "string",
"quantity" : 1
} ]
},
"voucherCode" : "string"
}
Example HTTP response
Response 200
{
"filterOptionsResult" : {
"accommodationKinds" : [ "object" ],
"amenities" : [ "object" ],
"arrivals" : [ "string" ],
"departures" : [ "string" ],
"qualityLevels" : [ "integer" ],
"resorts" : [ "object" ]
},
"result" : {
"content" : [ {
"accommodationKindId" : 1,
"arrivalDate" : "01-01-2023",
"basePrice" : 1,
"basePriceInclusive" : 1,
"departureDate" : "01-01-2023",
"duration" : 1,
"freeLoyaltyDuration" : 1,
"loyaltyPrice" : 1,
"loyaltyPriceInclusive" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"offerCode" : "string",
"offerName" : "string",
"offerPrice" : 1,
"offerPriceInclusive" : 1,
"priority" : 1,
"qualityLevelId" : 1,
"rateTypeId" : 1,
"rating" : 1,
"referencePrice" : 1,
"referencePriceInclusive" : 1,
"requiredLoyaltyPoints" : 1,
"resortId" : 1,
"resourceId" : 1,
"totalCapacity" : 1,
"units" : [ "integer" ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
}
5.1.41. Update/insert accommodation dynamic field
PUT /maxxton/v1/accommodationtypes/{resourceId}/dynamicfields/{fieldId}
Description
The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for accommodation type, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the accommodation type, then the text field will be modified
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
resourceId to fetch accommodationtypedetail |
integer (int64) |
Body |
requestBody |
< DynamicFieldDataCriteria |
|
Path |
fieldId |
fieldId to fetch dynamic field |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while fetching updating/inserting the accommodation dynamic fields. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}/dynamicfields/{fieldId}
Request body
[ {
"language" : "string",
"text" : "string"
} ]
5.1.42. Updates an accommodation type on a specific resource id.
PUT /maxxton/v1/accommodationtypes/{resourceId}
Description
Updates accommodation types based on its resource id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id to update accommodationtype |
integer (int64) |
Body |
requestBody |
Body to update accommodationType |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while fetching AccommodationType. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/accommodationtypes/{resourceId}
Request body
{
"accotypeKindId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"brandId" : 1,
"checkinTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"checkoutTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"code" : "string",
"earlyCheckinTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"priority" : 1,
"resortId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
}
5.2. AddOn
Extras and products that can be booked with an accommodation type
5.2.1. Get implies of add-ons
GET /maxxton/v1/add-ons/implies
Description
Get page with implies of add-ons.The records can be filtered based on implies object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching implies of add-ons. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : 1,
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"countFromMin" : true,
"ignoreRentability" : true,
"implicationManagerId" : 1,
"implied" : [ {
"objectId" : 1,
"resourceId" : 1
} ],
"impliesId" : 1,
"implyOnce" : true,
"included" : true,
"onBill" : true,
"parent" : true,
"parentId" : 1,
"priority" : 1,
"quantityMax" : 1,
"quantityMin" : 1,
"removable" : true,
"required" : true,
"resourceId" : 1,
"resourceIds" : [ "integer" ],
"showOnAllInPriceBill" : true,
"showPrice" : true,
"stay" : true,
"subjectsMax" : 1,
"subjectsMin" : 1,
"supplierImpliesId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.2.2. Gets Add-on additions by addition resource id
GET /maxxton/v1/add-ons/{additionResourceId}/additions
Description
Gets a page with add-ons additions.The additions of an add-on will provide all accommodation types where the add-on is applicable to.The records can be filtered based on resource addition object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
additionResourceId |
resourceId of add-on for which additions are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching add-ons additions. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/{additionResourceId}/additions
Example HTTP response
Response 200
{
"content" : [ {
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.2.3. Gets Add-ons additions
GET /maxxton/v1/add-ons/additions
Description
Gets a page with add-ons additions. The records can be filtered based on resource addition object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching add-ons additions. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/additions
Example HTTP response
Response 200
{
"content" : [ {
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.2.4. Gets a page with add-ons
GET /maxxton/v1/add-ons
Description
Gets page with add-ons.The records can be filtered based on add-on object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching add-ons. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons
Example HTTP response
Response 200
{
"content" : [ {
"addonType" : "string",
"adjustment" : true,
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToAddInCiCo" : true,
"archivedFrom" : "01-01-2023",
"autoValidate" : true,
"autoValidateValue" : 1,
"cancelCompensation" : true,
"cancelPremium" : true,
"cashArticle" : true,
"cashflowManagerId" : 1,
"code" : "string",
"commission" : true,
"commissionVatIncluded" : true,
"correction" : true,
"customizable" : true,
"dependencyMask" : "string",
"dependsOnLedgerGroup" : true,
"description" : "string",
"earlyCheckin" : true,
"excludePriceCache" : true,
"i18n" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"implicationManagerId" : 1,
"invoiceArticle" : true,
"ledgerGroupId" : 1,
"ledgerId" : 1,
"maxQuantity" : 1,
"name" : "string",
"ownerArticle" : true,
"parentId" : 1,
"path" : "string",
"perDay" : true,
"powerplaygroupId" : 1,
"repaymentVoucher" : true,
"reservationArticle" : true,
"resortArticle" : true,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"shortDescription" : "string",
"showDatesOnInternet" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"specialPriority" : 1,
"stayArticle" : true,
"stockType" : "string",
"tax" : true,
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string",
"vatCommission" : true,
"warrant" : true,
"withholdingArticle" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.2.5. Gets add-ons for specific resource id
GET /maxxton/v1/add-ons/{resourceId}
Description
Gets add-ons by resource id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching add-ons for the given resource id. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}
Example HTTP response
Response 200
{
"addonType" : "string",
"adjustment" : true,
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToAddInCiCo" : true,
"archivedFrom" : "01-01-2023",
"autoValidate" : true,
"autoValidateValue" : 1,
"cancelCompensation" : true,
"cancelPremium" : true,
"cashArticle" : true,
"cashflowManagerId" : 1,
"code" : "string",
"commission" : true,
"commissionVatIncluded" : true,
"correction" : true,
"customizable" : true,
"dependencyMask" : "string",
"dependsOnLedgerGroup" : true,
"description" : "string",
"earlyCheckin" : true,
"excludePriceCache" : true,
"i18n" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"implicationManagerId" : 1,
"invoiceArticle" : true,
"ledgerGroupId" : 1,
"ledgerId" : 1,
"maxQuantity" : 1,
"name" : "string",
"ownerArticle" : true,
"parentId" : 1,
"path" : "string",
"perDay" : true,
"powerplaygroupId" : 1,
"repaymentVoucher" : true,
"reservationArticle" : true,
"resortArticle" : true,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"shortDescription" : "string",
"showDatesOnInternet" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"specialPriority" : 1,
"stayArticle" : true,
"stockType" : "string",
"tax" : true,
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string",
"vatCommission" : true,
"warrant" : true,
"withholdingArticle" : true
}
5.2.6. Gets dynamic fields for a particular addon
GET /maxxton/v1/add-ons/{resourceId}/dynamicfields
Description
Gets a page with dynamic fields to a specific addon. The records can be filtered based on the DynamicField object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id of addon for which dynamic fields are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching addon dynamic fields. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/dynamicfields
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.2.7. Gets images for a particular addon
GET /maxxton/v1/add-ons/{resourceId}/images
Description
Gets a page with images to a specific addon. The records can be filtered based on the image object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id of add-on for which images are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
add-ons is not found. |
No Content |
500 |
Error occurred while fetching addon images. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/images
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.2.8. Gets implies of add-ons
GET /maxxton/v1/add-ons/{resourceId}/implies
Description
Gets implies of add-ons.The records can be filtered based on implies object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
ResourceId of offer for which the implies needs to be fetched. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching implies of add-ons. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : 1,
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"countFromMin" : true,
"ignoreRentability" : true,
"implicationManagerId" : 1,
"implied" : [ {
"objectId" : 1,
"resourceId" : 1
} ],
"impliesId" : 1,
"implyOnce" : true,
"included" : true,
"onBill" : true,
"parent" : true,
"parentId" : 1,
"priority" : 1,
"quantityMax" : 1,
"quantityMin" : 1,
"removable" : true,
"required" : true,
"resourceId" : 1,
"resourceIds" : [ "integer" ],
"showOnAllInPriceBill" : true,
"showPrice" : true,
"stay" : true,
"subjectsMax" : 1,
"subjectsMin" : 1,
"supplierImpliesId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.2.9. Update/insert addon dynamic field
PUT /maxxton/v1/add-ons/{resourceId}/dynamicfields/{fieldId}
Description
The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for addon, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the addon, then the text field will be modified
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
resourceId to update or insert dynamic field |
integer (int64) |
Body |
requestBody |
< DynamicFieldDataCriteria |
|
Path |
fieldId |
fieldId to update dynamic field |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors. |
No Content |
500 |
Error occurred while fetching updating/inserting the addon dynamic fields. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/add-ons/{resourceId}/dynamicfields/{fieldId}
Request body
[ {
"language" : "string",
"text" : "string"
} ]
5.3. AdminOrganisation
List of AdminOrganisation
5.3.1. Gets a page with revenue distribution journal of admin organisation
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}/journals
Description
Gets a page with revenue distribution journal of admin organisation. The records can be filtered based on the RevenueDistributionJournal object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
Id of the admin organisation for which revenue distribution journals has to be fetched |
integer (int64) |
Path |
revenueDistributionId |
revenue distribution id for which revenue distribution journals has to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fethcing revenue distribution journals of admin organisations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}/journals
Example HTTP response
Response 200
{
"content" : [ {
"adminCurrencyCode" : "string",
"adminCurrencyId" : 1,
"adminOrganisationId" : 1,
"adminOrganistationCurrency" : {
"creditVatExcluded" : 1,
"creditVatIncluded" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1
},
"costCenter" : "string",
"costUnit" : "string",
"creditVatExcluded" : 1,
"creditVatExcludedDistributionChannelCurrency" : 1,
"creditVatIncluded" : 1,
"creditVatIncludedDistributionChannelCurrency" : 1,
"debitVatExcluded" : 1,
"debitVatExcludedDistributionChannelCurrency" : 1,
"debitVatIncluded" : 1,
"debitVatIncludedDistributionChannelCurrency" : 1,
"description" : "string",
"distributionChannelCurrencyCode" : "string",
"distributionChannelCurrencyId" : 1,
"distributionchannelCurrency" : {
"creditVatExcluded" : 1,
"creditVatIncluded" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1,
"exchangeRate" : 1
},
"exchangeValue" : 1,
"journalNumber" : "string",
"journalPeriodNumber" : 1,
"journalType" : "string",
"ledgerNumber" : "string",
"revenueDistributionId" : 1,
"revenueDistributionJournalId" : 1,
"secondLedgerNumber" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.2. Create new admin organisation
POST /maxxton/v1/adminorganisations
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating admin organisation. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations
Request body
{
"code" : "string",
"currencyId" : 1,
"description" : "string",
"name" : "string",
"origin" : "string",
"originId" : "string"
}
Example HTTP response
Response 200
{
"adminOrganisationId" : 1,
"code" : "string",
"currencyCode" : "string",
"currencyId" : 1,
"description" : "string",
"journalId" : 1,
"name" : "string",
"origin" : "string",
"originId" : "string"
}
5.3.3. Gets a page with Accounts of an admin organisation
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/accounts
Description
Gets a page with Accounts of an admin organisation. The records can be filtered based on the account object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching accounts of the admin organisations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/accounts
Example HTTP response
Response 200
{
"content" : [ {
"accountId" : 1,
"bankAccount" : {
"bankAccountName" : "string",
"code" : "string",
"currencyCode" : "string",
"name" : "string",
"paymentMethodDefinition" : {
"brandName" : "string",
"code" : "string",
"name" : "string"
}
},
"currencyCode" : "string",
"currencyId" : 1,
"name" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.4. Gets a page with admin organisations
GET /maxxton/v1/adminorganisations
Description
Gets a page with admin organisations. The records can be filtered based on the adminorganisation object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching admin organisations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations
Example HTTP response
Response 200
{
"content" : [ {
"adminOrganisationId" : 1,
"code" : "string",
"currencyCode" : "string",
"currencyId" : 1,
"description" : "string",
"journalId" : 1,
"name" : "string",
"origin" : "string",
"originId" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.5. Gets a page with financial transactions
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions
Description
Gets a page with financial transactions.The records can be filtered based on the FinancialTransactionReport object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
Id of the admin organisation for which financial transactions has to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching financial transactions. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions
Example HTTP response
Response 200
{
"content" : [ {
"adminOrganisationId" : 1,
"creationDate" : "01-01-2023T11:23:45Z",
"financialTransactionReportId" : 1,
"reportNumber" : 1,
"status" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.6. Gets a page with financial transactions journal report of admin organisation
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}/journals
Description
Gets a page with financial transactions journal report of admin organisation. The records can be filtered based on the FinancialTransactionJournalsReport object.
The field statementHeader in the response denotes the start of a statement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
Id of the admin organisation for which financial transactions journals report has to be fetched |
integer (int64) |
Path |
financialTransactionReportId |
Financial transaction report id for which financial transactions journals report has to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching financial transaction journals report of admin organisations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}/journals
Example HTTP response
Response 200
{
"content" : [ {
"accountCurrency" : {
"creditVatExcluded" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1,
"exchangeRate" : 1,
"getcreditVatIncluded" : 1
},
"accountCurrencyCode" : "string",
"accountCurrencyId" : 1,
"accountId" : 1,
"adminCurrencyCode" : "string",
"adminCurrencyId" : 1,
"adminOrganisationId" : 1,
"adminOrganistationCurrency" : {
"creditVatExcluded" : 1,
"creditVatIncluded" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1
},
"costCenter" : "string",
"costUnit" : "string",
"creditVatExcluded" : 1,
"creditVatExcludedAccCurr" : 1,
"creditVatIncluded" : 1,
"creditVatIncludedAccCurr" : 1,
"debitVatExcluded" : 1,
"debitVatExcludedAccCurr" : 1,
"debitVatIncluded" : 1,
"debitVatIncludedAccCurr" : 1,
"description" : "string",
"exchangeValue" : 1,
"financialTransactionReportId" : 1,
"financialTransactionReportJournalId" : 1,
"journalNumber" : "string",
"journalPeriodNumber" : "string",
"journalType" : "string",
"ledgerNumber" : "string",
"secondLedgerNumber" : "string",
"statementDate" : "01-01-2023",
"statementHeader" : true,
"statementNumber" : "string",
"status" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.7. Gets a page with owner financial transaction journals details of admin organisation
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals/entries
Description
Detailed journal entries of the owner financial transaction report. All details from this endpoint summed will be the total journal entry. Based on the settlementId and settlementEntryId the owner settlement and it’s entries can be retrieved. The records can be filtered based on the OwnerFinancialTransactionJournalsDetailReport object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
Id of the admin organisation for which owner financial transactions journals report has to be fetched |
integer (int64) |
Path |
ownerFinancialTransactionReportId |
Financial transaction report id for which owner financial transactions journals report has to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fethcing owner financial transaction journals report details of admin organisations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals/entries
Example HTTP response
Response 200
{
"content" : [ {
"costCenterId" : 1,
"costCenterName" : "string",
"costCenterNumber" : "string",
"costUnitId" : 1,
"costUnitName" : "string",
"costUnitNumber" : "string",
"creditVatExcluded" : 1,
"creditVatIncluded" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1,
"ledgerId" : 1,
"ledgerName" : "string",
"ledgerNumber" : "string",
"ownerCurrencyId" : 1,
"ownerFinancialTransactionReportId" : 1,
"secondLedgerId" : 1,
"secondLedgerName" : "string",
"secondLedgerNumber" : "string",
"settlementEntryId" : 1,
"settlementId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.8. Gets a page with owner financial transactions
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions
Description
Gets a page with owner financial transactions.The records can be filtered based on the OwnerFinancialTransaction object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
Id of the admin organisation for which owner financial transactions has to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owner financial transactions. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions
Example HTTP response
Response 200
{
"content" : [ {
"bookDate" : "01-01-2023",
"creationDate" : "01-01-2023T11:23:45Z",
"ownerFinancialTransactionReportId" : 1,
"reportNumber" : 1,
"status" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.9. Gets a page with owner financial transactions journal report of admin organisation
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals
Description
Gets a page with owner financial transactions journal report of admin organisation. The records can be filtered based on the OwnerFinancialTransactionJournalsReport object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
Id of the admin organisation for which owner financial transactions journals report has to be fetched |
integer (int64) |
Path |
ownerFinancialTransactionReportId |
Financial transaction report id for which owner financial transactions journals report has to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fethcing owner financial transaction journals report of admin organisations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionReportId}/journals
Example HTTP response
Response 200
{
"content" : [ {
"accountId" : 1,
"adminOrganisationCurrency" : {
"creditVatExcluded" : 1,
"creditVatIncluded" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1
},
"adminOrganisationCurrencyCode" : "string",
"adminOrganisationCurrencyId" : 1,
"costCenter" : "string",
"costUnit" : "string",
"creditVatExcluded" : 1,
"creditVatExcludedInAdminOrganisationCurrency" : 1,
"creditVatIncluded" : 1,
"creditVatIncludedInAdminOrganisationCurrency" : 1,
"debitVatExcluded" : 1,
"debitVatExcludedInAdminOrganisationCurrency" : 1,
"debitVatIncluded" : 1,
"debitVatIncludedInAdminOrganisationCurrency" : 1,
"description" : "string",
"exchangeValue" : 1,
"journalNumber" : "string",
"journalPeriodNumber" : 1,
"journalType" : "string",
"ledgerNumber" : "string",
"ownerCrrencyCode" : "string",
"ownerCurrency" : {
"creditVatExcluded" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1,
"exchangeRate" : 1,
"getcreditVatIncluded" : 1
},
"ownerCurrencyId" : 1,
"secondLedgerNumber" : "string",
"statementDate" : "01-01-2023",
"statementNumber" : "string",
"status" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.10. Gets a page with revenue distributions of an admin organisation
GET /maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions
Description
Gets a page with revenue distributions of an admin organisation. The records can be filtered based on the RevenueDistribution object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
adminOrganisationId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching revenue distributions of the admin organisations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions
Example HTTP response
Response 200
{
"content" : [ {
"adminOrganisationId" : 1,
"bookDate" : "01-01-2023T11:23:45Z",
"creationDate" : "01-01-2023T11:23:45Z",
"revenueDistributionId" : 1,
"revenueDistributionNumber" : 1,
"status" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.3.11. Update existing admin organisation
PUT /maxxton/v1/adminorganisations/{adminOrganisationId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
adminOrganisationId |
integer (int64) |
|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating admin organisation. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}
Request body
{
"code" : "string",
"currencyId" : 1,
"description" : "string",
"name" : "string",
"origin" : "string",
"originId" : "string"
}
Example HTTP response
Response 200
{
"code" : "string",
"currencyId" : 1,
"description" : "string",
"name" : "string",
"origin" : "string",
"originId" : "string"
}
5.3.12. Update’s the revenue distribution of specific admin organisation id and revenue distribution id
PUT /maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}
Description
Updates the revenue distribution of specific admin organisation id and revenue distribution id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
adminOrganisationId |
Id of the admin organisation for which revenue distribution has to be updated |
integer (int64) |
Body |
requestBody |
Body to update revenue distribution |
|
Path |
revenueDistributionId |
Revenue distribution id for which revenue distribution has to be updated |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating revenue distribution. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/revenuedistributions/{revenueDistributionId}
Request body
{
"status" : "string"
}
Example HTTP response
Response 200
{
"adminOrganisationId" : 1,
"bookDate" : "01-01-2023T11:23:45Z",
"creationDate" : "01-01-2023T11:23:45Z",
"revenueDistributionId" : 1,
"revenueDistributionNumber" : 1,
"status" : "string"
}
5.3.13. Updates the owner financial transactions for specific admin organisation id and owner financial transaction id
PUT /maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionId}
Description
Updates the owner financial transactions for specific admin organisation id and owner financial transaction id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
adminOrganisationId |
Id of the admin organisation for which owner financial transactions has to be updated |
integer (int64) |
Path |
ownerFinancialTransactionId |
Id of the owner financial transaction for which owner financial transactions has to be updated |
integer (int64) |
Body |
requestBody |
Body of the owner financial transaction to be updated |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating owner financial transactions. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/ownerfinancialtransactions/{ownerFinancialTransactionId}
Request body
{
"status" : "string"
}
Example HTTP response
Response 200
{
"bookDate" : "01-01-2023",
"creationDate" : "01-01-2023T11:23:45Z",
"ownerFinancialTransactionReportId" : 1,
"reportNumber" : 1,
"status" : "string"
}
5.3.14. update’s the financial transactions report of specific admin organisation id and financial transaction report id
PUT /maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}
Description
updates financial transactions report of specific admin organisation id and financial transaction report id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
adminOrganisationId |
Id of the admin organisation for which financial transactions has to be fetched |
integer (int64) |
Path |
financialTransactionReportId |
Financial transaction report id for which financial transactions has to be fetched |
integer (int64) |
Body |
requestBody |
Body to update financial transaction report |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating financial transactions. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/adminorganisations/{adminOrganisationId}/financialtransactions/{financialTransactionReportId}
Request body
{
"status" : "string"
}
Example HTTP response
Response 200
{
"adminOrganisationId" : 1,
"creationDate" : "01-01-2023T11:23:45Z",
"financialTransactionReportId" : 1,
"reportNumber" : 1,
"status" : "string"
}
5.4. Allotment
Guaranteed availability for a specific distribution channel
5.4.1. Get allotment releases
GET /maxxton/v1/allotments/releases
Description
Allotment releases are rules which needs to be combined with allotment to release the allotment so it will be available to other distribution channels again. This can be done partially or totally. The allotment rules will not be removed in case it is released because of this it should be combined with the allotment call.<r>The difference between removing allotment and releasing allotment is that when you remove the allotment its gone, when it is released it can reduce the allotment or completely removeit. If there are 4 units available in allotment, 2 are released. That would mean 2 units are still available from allotment.It also supports pageable.The allotment release is active when the performedDate is not null and enactive is false. isEnactive is true when the allotment release is removed.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
204 |
No allotment releases found for given criteria. |
No Content |
500 |
Error occurred while fetching allotment releases |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/allotments/releases
Example HTTP response
Response 200
{
"content" : [ {
"allotmentReleaseId" : 1,
"distributionChannelId" : 1,
"endDate" : "01-01-2023",
"isEnactive" : true,
"name" : "string",
"performedDate" : "01-01-2023",
"releaseDate" : "01-01-2023",
"releasePeriod" : 1,
"resortId" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.4.2. Get allotments
GET /maxxton/v1/allotments
Description
Gets a page with allotments. The allotment is active when not removed(isEnactive false) and no allotment release rules are valid(allotment can be released partially). A distribution channel is only allowed to book from allotment or the usual reservability not both.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
204 |
No allotments found for given criteria. |
No Content |
500 |
Error occurred while fetching allotments |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/allotments
Example HTTP response
Response 200
{
"content" : [ {
"allotmentId" : 1,
"amount" : 1,
"description" : "string",
"distributionChannelId" : 1,
"exceedLimit" : 1,
"expirePeriod" : 1,
"hasObjects" : true,
"isEnactive" : true,
"modified" : "01-01-2023",
"name" : "string",
"periods" : [ {
"endDate" : "01-01-2023",
"quantity" : 1,
"startDate" : "01-01-2023",
"unitIds" : [ "integer" ]
} ],
"resourceId" : 1,
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.5. Amenity
Features or facilities available on a resort or an accommodation type
5.5.1. Add new amenities
POST /maxxton/v1/amenities
Description
Adds new amenities.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request body to create new amenity. |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while adding amenities. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/amenities
Request body
{
"amenityCategoryIds" : [ "integer" ],
"amenityStandardCode" : "string",
"childAmenityIds" : [ "integer" ],
"code" : "string",
"linkedAmenityId" : 1,
"numberMaximum" : 1,
"numberMinimum" : 1,
"origin" : "string",
"originId" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"name" : "string"
} ],
"type" : "string"
}
Example HTTP response
Response 200
{
"amenityCategoryIds" : [ "integer" ],
"amenityId" : 1,
"amenityStandardCode" : "string",
"childAmenityIds" : [ "integer" ],
"code" : "string",
"linkedAmenityId" : 1,
"numberMaximum" : 1,
"numberMinimum" : 1,
"origin" : "string",
"originId" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string"
}
5.5.2. Gets a page with Amenities
GET /maxxton/v1/amenities
Description
Gets a page with amenities.The records can be filtered based on amenity object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Amenities. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/amenities
Example HTTP response
Response 200
{
"content" : [ {
"amenityCategoryIds" : [ "integer" ],
"amenityId" : 1,
"archivedFrom" : "01-01-2023",
"categories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"identifier" : "string",
"linkedAmenityId" : 1,
"listMulti" : true,
"metric" : {
"code" : "string",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"metricId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"metricDetail" : {
"code" : "string",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"metricId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"numberMaximum" : 1,
"numberMinimum" : 1,
"parentAmenityId" : 1,
"percentageDiscountPriority" : 1,
"source" : "string",
"standardCodeAmenityId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.5.3. Gets a page with amenity categories
GET /maxxton/v1/amenities/categories
Description
Gets a page with amenity categories.The records can be filtered based on category set object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnSections |
To return only the selected sections in the response, use the constant string IMAGES. This can reduce the response body size and improve the performance of the call. |
< string > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching amenity categories. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/amenities/categories
Example HTTP response
Response 200
{
"content" : [ {
"amenityCategories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"amenityCategorySetId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"isInternalUse" : true,
"parentId" : 1,
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.5.4. Gets a page with amenity categories
GET /maxxton/v1/amenities/details
Description
Gets a page with amenity categories.The records can be filtered based on category set object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnSections |
List of constant strings to return only the selected sections in the response. The possible values are IMAGES. This is recommended to use to reduce the size of the response body and improve the performance of the call. |
< string > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching amenity categories. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/amenities/details
Example HTTP response
Response 200
{
"content" : [ {
"amenityCategories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ { } ],
"thumbnailUrl" : "string",
"translations" : [ { } ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"managerId" : 1,
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"amenityCategorySetId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"parentId" : 1,
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.6. Authentication
Authentication
5.6.1. Login
POST /maxxton/v1/authenticate
Description
Returns generated access token. This can be used in further calls to authenticate by adding this to the header parameters with key: Authorization and value: {token_type} {access_token}.Concern or scope can be used for passing the concern parameter but scope is preferred as it is fully oauth2 compatible. Either of the two parameters i.e Concern or Scope is mandatory.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
grant_type |
GrantType which is used to authenticate (client_credentials etc) |
string |
Query |
scope |
scope of authorization.Contains a concern parameter to make it compatible with oauth2 standard. |
string |
Query |
client_secret |
This is the API key provided by Maxxton as part of API credentials. |
string |
Query |
client_id |
This is the maxxton login name provided by Maxxton as part of API credentials. |
string |
Query |
concern |
Concern code where you want to login(3 digits), alias for scope(deprecated) |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while processing. |
No Content |
Produces
-
application/json;charset=UTF-8
Example HTTP request
Request path
/maxxton/v1/authenticate
Example HTTP response
Response 200
{
"access_token" : "string",
"expires_in" : 1,
"jti" : "string",
"scope" : "string",
"token_type" : "string"
}
5.7. Brands
Different labels used for marketing of an accommodation type
5.7.1. Get brands
GET /maxxton/v1/brands
Description
Gets a page with brands. The records can be filtered based on the brand object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching brands. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/brands
Example HTTP response
Response 200
{
"content" : [ {
"brandId" : 1,
"defaultBrand" : true,
"name" : "string",
"reservationCategoryId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.7.2. Gets an brand of a specific brand id.
GET /maxxton/v1/brands/{brandId}
Description
Gets brand based on Brand Id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
brandId |
Brand id to fetch brand |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Brand. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/brands/{brandId}
Example HTTP response
Response 200
{
"brandId" : 1,
"defaultBrand" : true,
"name" : "string",
"reservationCategoryId" : 1
}
5.8. Cash Clearance
Informations related to cash reservations and company.
5.8.1. Get a company on a specific company id.
GET /maxxton/v1/companies/{companyId}
Description
Get a company based on its company id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
companyId |
Company id to fetch particular company |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching specific company. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/companies/{companyId}
Example HTTP response
Response 200
{
"adminOrganisationId" : "string",
"companyId" : 1,
"companyNumber" : "string",
"currencyId" : 1,
"description" : "string",
"name" : "string"
}
5.8.2. Gets all cashaccounts.
GET /maxxton/v1/cashreservations/accounts
Description
Gets a page of all cashaccounts, records can be filtered based on fields on cashaccount object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching cashaccount |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/cashreservations/accounts
Example HTTP response
Response 200
{
"content" : [ {
"accountId" : 1,
"accountType" : "string",
"companyId" : 1,
"description" : "string",
"name" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.8.3. Gets all cashclearance.
GET /maxxton/v1/cashreservations/clearance
Description
Gets a page of all cashclearance, records can be filtered based on fields on cashclearance object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching cashclearance |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/cashreservations/clearance
Example HTTP response
Response 200
{
"content" : [ {
"cashClearanceId" : 1,
"cashDifference" : 1,
"companyId" : 1,
"creationDate" : "01-01-2023T11:23:45Z",
"currencyId" : 1,
"employeeId" : 1,
"reasonCashDifference" : "string",
"receivedAmount" : 1,
"reportNumber" : 1,
"safeDepositAmount" : 1,
"safeWithdrawalAmount" : 1,
"startBalanceNextDay" : 1,
"tillAmountNextDay" : 1,
"totalCardAmount" : 1,
"totalMutationAmount" : 1,
"totalValueAmount" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.8.4. Gets all companies.
GET /maxxton/v1/companies
Description
Gets a page of all companies, records can be filtered based on fields on country object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching companies |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/companies
Example HTTP response
Response 200
{
"content" : [ {
"adminOrganisationId" : "string",
"companyId" : 1,
"companyNumber" : "string",
"currencyId" : 1,
"description" : "string",
"name" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.9. Contracts
Formal legal agreement between the owner and the resort
5.9.1. Creats a new Contract
POST /maxxton/v1/contracts
Description
Gets a newly created Contract
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request Body for new contract. |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contract. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/contracts
Request body
{
"code" : "string",
"contractId" : 1,
"contractRenewalReminder" : "01-01-2023",
"contractTypeId" : 1,
"endDate" : "01-01-2023",
"name" : "string",
"origin" : "string",
"originId" : "string",
"ownerId" : 1,
"poolOwnerId" : 1,
"rentAssurance" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"targetAmount" : 1,
"unitId" : 1
}
Example HTTP response
Response 200
{
"code" : "string",
"contractId" : 1,
"contractRenewalReminder" : "01-01-2023",
"contractTypeId" : 1,
"endDate" : "01-01-2023",
"name" : "string",
"origin" : "string",
"originId" : "string",
"ownerId" : 1,
"poolOwnerId" : 1,
"rentAssurance" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"targetAmount" : 1,
"unitId" : 1
}
5.9.2. Gets a Contract by contract id
GET /maxxton/v1/contracts/{contractId}
Description
Gets a Contract associated with the contractId
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
contractId |
Contract Id to fetch contract. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contract. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/contracts/{contractId}
Example HTTP response
Response 200
{
"code" : "string",
"contractId" : 1,
"contractRenewalReminder" : "01-01-2023",
"contractTypeId" : 1,
"endDate" : "01-01-2023",
"name" : "string",
"origin" : "string",
"originId" : "string",
"ownerId" : 1,
"poolOwnerId" : 1,
"rentAssurance" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"targetAmount" : 1,
"unitId" : 1
}
5.9.3. Gets a page with Contracts
GET /maxxton/v1/contracts
Description
Gets a Page of Contracts. The records can be filtered based on contract object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contracts. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/contracts
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"contractId" : 1,
"contractRenewalReminder" : "01-01-2023",
"contractTypeId" : 1,
"endDate" : "01-01-2023",
"name" : "string",
"origin" : "string",
"originId" : "string",
"ownerId" : 1,
"poolOwnerId" : 1,
"rentAssurance" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"targetAmount" : 1,
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.9.4. Gets a page with contract rules
GET /maxxton/v1/contracts/types/rules
Description
Gets a Page of Contract Rules. These records can be filtered based on contract rule object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contract Rules. |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/contracts/types/rules
Example HTTP response
Response 200
{
"content" : [ {
"archivedFrom" : "01-01-2023",
"arrivalDateEnd" : "01-01-2023",
"arrivalDateStart" : "01-01-2023",
"baseSumIncludingTax" : true,
"beneficiary" : "string",
"calculateAbsolutePerNight" : true,
"calculationSource" : "string",
"commissionInculdingTax" : true,
"commissionOnly" : true,
"commissionTaxrate" : 1,
"contractRuleId" : 1,
"contractTypeId" : 1,
"departureDateEnd" : "01-01-2023T11:23:45Z",
"departureDateStart" : "01-01-2023T11:23:45Z",
"dependsOnLedgerGroup" : true,
"introducerInOwnObject" : true,
"ledgerGroupId" : 1,
"ledgerId" : 1,
"name" : "string",
"ownerSpecific" : true,
"ownerVatRateExclude" : 1,
"owners" : [ {
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"birthPlace" : "string",
"company" : true,
"companyIdentificationNumber" : "string",
"companyName" : "string",
"dac7OwnerVerified" : true,
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"languageId" : 1,
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ { } ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"owner" : true,
"ownerGroupId" : 1,
"ownerId" : 1,
"ownerPool" : "string",
"ownerType" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"sharedOwnerShips" : [ {
"ownerId" : 1,
"realOwnerId" : 1
} ],
"socialSecurityNumber" : "string",
"socialSecurityNumberIssuingCountryId" : 1,
"taxNumber" : "string",
"taxNumberIssuingCountryId" : 1,
"titleId" : 1
} ],
"priority" : 1,
"purchaseLedgerGroupId" : 1,
"purchaseLedgerId" : 1,
"purchaseSecondLedgerId" : 1,
"reservationDateEnd" : "01-01-2023",
"reservationDateStart" : "01-01-2023",
"resort" : [ {
"contractRuleResortId" : 1,
"contractruleId" : 1,
"resortId" : 1
} ],
"resourceBeneficiary" : true,
"resourceId" : 1,
"resourceType" : "string",
"resourceTypeSelected" : true,
"secondLedgerId" : 1,
"settlementOwnerId" : 1,
"settlementOwnerResortId" : 1,
"stayDateFrom" : "01-01-2023",
"stayDateTo" : "01-01-2023",
"substractDistributionChannelCommission" : true,
"substractDistributionChannelIncludingTax" : true,
"taxSumInCommission" : 1,
"time" : 1,
"type" : "string",
"unit" : "string",
"validity" : {
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"departureDateFrom" : "01-01-2023",
"departureDateTo" : "01-01-2023",
"distributionChannelIds" : [ "integer" ],
"ownerIds" : [ "integer" ],
"reservationCategoryIds" : [ "integer" ],
"reservationDateFrom" : "01-01-2023",
"reservationDateTo" : "01-01-2023",
"resortIds" : [ "integer" ],
"stayDateFrom" : "01-01-2023",
"stayDateTo" : "01-01-2023"
},
"value" : 1,
"valueOnStayBasis" : true,
"vatForPrivateOwner" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.9.5. Gets a page with contract types
GET /maxxton/v1/contracts/types
Description
Gets a Page of Contract Types. The records can be filtered based on contract type object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contract Types. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/contracts/types
Example HTTP response
Response 200
{
"content" : [ {
"archivedFrom" : "01-01-2023",
"code" : "string",
"contractKind" : "string",
"contractTypeId" : 1,
"i18n" : [ {
"contractTypeId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"nonRentable" : true,
"ownUsageAllowed" : true,
"priority" : 1,
"redirectionMinAmount" : 1,
"remark" : "string",
"resourceGroupId" : 1,
"round" : true,
"settlementMethod" : "string",
"settlementPct" : 1,
"translations" : [ {
"contractTypeId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.9.6. updates a Contract
PUT /maxxton/v1/contracts/{contractId}
Description
Updates a Contract associated with the contractId
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request Body for update contract. |
|
Path |
contractId |
Contract Id to fetch contract. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contract. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/contracts/{contractId}
Request body
{
"code" : "string",
"contractId" : 1,
"contractTypeId" : 1,
"endDate" : "01-01-2023",
"name" : "string",
"origin" : "string",
"originId" : "string",
"ownerId" : 1,
"poolOwnerId" : 1,
"rentAssurance" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"targetAmount" : 1,
"unitId" : 1
}
Example HTTP response
Response 200
{
"code" : "string",
"contractId" : 1,
"contractRenewalReminder" : "01-01-2023",
"contractTypeId" : 1,
"endDate" : "01-01-2023",
"name" : "string",
"origin" : "string",
"originId" : "string",
"ownerId" : 1,
"poolOwnerId" : 1,
"rentAssurance" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"targetAmount" : 1,
"unitId" : 1
}
5.10. Countries
List of countries.
5.10.1. Gets all countries.
GET /maxxton/v1/countries
Description
Gets a list of all countries, records can be filtered based on fields on country object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< Country |
500 |
Error occurred while fetching countries |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/countries
Example HTTP response
Response 200
[ {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
} ]
5.10.2. Gets all states.
GET /maxxton/v1/countries/states
Description
Gets a page of all states, records can be filtered based on fields on state object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching countries |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/countries/states
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"countryId" : 1,
"description" : "string",
"name" : "string",
"stateId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.11. Currency
List of currencies
5.11.1. Gets a page with currencies
GET /maxxton/v1/currencies
Description
Gets a page with currencies.The records can be filtered based on the currency object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching currencies. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/currencies
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"currencyCountry" : "string",
"currencyId" : 1,
"currencyLanguage" : "string",
"name" : "string",
"symbol" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.11.2. Gets the details of specific currency
GET /maxxton/v1/currencies/{currencyId}
Description
Gets details of the currency associated with a particular currencyId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
currencyId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching details for specific currency. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/currencies/{currencyId}
Example HTTP response
Response 200
{
"code" : "string",
"currencyCountry" : "string",
"currencyId" : 1,
"currencyLanguage" : "string",
"name" : "string",
"symbol" : "string"
}
5.12. Customer Status
Statuses given to customers as per customer’s reservation history
5.12.1. Gets customers' status
GET /maxxton/v1/customerstatus
Description
Gets a page with customers' status. The records can be filtered based on customerstatus object and entities in customercluster which is present in customerstatus object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching customers' status |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customerstatus
Example HTTP response
Response 200
{
"content" : [ {
"customerClusters" : [ {
"clusterId" : 1,
"code" : "string",
"description" : "string",
"name" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"customerId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.13. Customers
Guest who can book reservations
5.13.1. Adds a new Customer
POST /maxxton/v1/customers
Description
Adds a new Customer. The details are to be added in request body.
Note: The country field in mailAddress is not allowed while adding a customer. Email id field in the customer address entity is also used as customer login
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
A customer object to be added |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating customers |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers
Request body
{
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerGroupId" : 1,
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"languageId" : 1,
"lastName" : "string",
"login" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"phoneCallAllowed" : true,
"previousPmsId" : 1,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"signatureDate" : "01-01-2023",
"socialSecurityNumber" : "string",
"textMsgAllowed" : true,
"titleId" : 1
}
Example HTTP response
Response 200
{
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerGroupId" : 1,
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"languageId" : 1,
"lastName" : "string",
"login" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"phoneCallAllowed" : true,
"previousPmsId" : 1,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"signatureDate" : "01-01-2023",
"socialSecurityNumber" : "string",
"textMsgAllowed" : true,
"titleId" : 1
}
5.13.2. Authenticate a customer
POST /maxxton/v1/customers/login
Description
Authenticate a customer based on login credentials and return customer details if the customer credentials are authentic.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Login credentials of the customer to be authenticated. |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
401 |
Invalid credentials. |
No Content |
500 |
Error occurred while authenticating this customer |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/login
Request body
{
"login" : "string",
"password" : "string"
}
Example HTTP response
Response 200
{
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerGroupId" : 1,
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"languageId" : 1,
"lastName" : "string",
"login" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"passwordModifiedDate" : "01-01-2023T11:23:45Z",
"phoneCallAllowed" : true,
"previousPmsId" : 1,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"signatureDate" : "01-01-2023",
"socialSecurityNumber" : "string",
"textMsgAllowed" : true,
"titleId" : 1
}
5.13.3. Create customer memo
POST /maxxton/v1/customers/{customerId}/memos
Description
Create customer memo
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request body for customer memo. |
|
Path |
customerId |
Customer id to fetch files associated with the customer |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
401 |
Invalid credentials. |
No Content |
500 |
Error occurred while creating customer memo |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/memos
Request body
{
"memoCategoryId" : 1,
"onCheckin" : true,
"onInvoice" : true,
"sensitive" : true,
"text" : "string"
}
Example HTTP response
Response 200
{
"content" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"employeeId" : 1,
"memoCategoryId" : 1,
"memoId" : 1,
"predefinedMemoId" : 1
}
5.13.4. Get a single Customer by customer id
GET /maxxton/v1/customers/{customerId}
Description
Gets the details of the customer specified to a particular id passed in the endpoint.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
customerId |
An Id of customer to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No customer found for given customer id. |
No Content |
500 |
Error occurred while fetching this customer |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}
Example HTTP response
Response 200
{
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerGroupId" : 1,
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"languageId" : 1,
"lastName" : "string",
"login" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"phoneCallAllowed" : true,
"previousPmsId" : 1,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"signatureDate" : "01-01-2023",
"socialSecurityNumber" : "string",
"textMsgAllowed" : true,
"titleId" : 1
}
5.13.5. Get all customer titles.
GET /maxxton/v1/titles
Description
Get list of all customer titles, records can be filtered based on fields of customer title object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching customer titles |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/titles
Example HTTP response
Response 200
{
"code" : "string",
"priority" : 1,
"titleId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"title" : "string"
} ]
}
5.13.6. Get memos for a specific customer
GET /maxxton/v1/customers/{customerId}/memos
Description
Gets the memos of the customer specified to a particular id passed in the endpoint.The records can be filtered based on memo object. In order to filter creationDate the format of date passed should be: YYYY-MM-DDThh:mm:ss. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
customerId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No customer found for given customer id. |
No Content |
500 |
Error occurred while fetching memo for this customer |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/memos
Example HTTP response
Response 200
{
"content" : [ {
"content" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"employeeId" : 1,
"memoCategoryId" : 1,
"memoId" : 1,
"predefinedMemoId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.13.7. Get status for a specific customer
GET /maxxton/v1/customers/{customerId}/customerstatus
Description
Gets the status of the customer specified to a particular id passed in the endpoint.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
customerId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No customer found for given customer id. |
No Content |
500 |
Error occurred while fetching this customer |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/customerstatus
Example HTTP response
Response 200
{
"customerClusters" : [ {
"clusterId" : 1,
"code" : "string",
"description" : "string",
"name" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"customerId" : 1
}
5.13.8. Get the generated hash and provides link
GET /maxxton/v1/customers/{customerId}/files/{fileId}
Description
Get the generated hash for specific file which has information related to file
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
customerId |
Customer id to fetch files associated with the customer |
integer (int64) |
Path |
fileId |
file id to fetch a specific file |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No document found for specific file id. |
No Content |
500 |
Error occured while generating hash |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/files/{fileId}
Example HTTP response
Response 200
{
"downloadLink" : "string"
}
5.13.9. Gets a page of customer phone calls
GET /maxxton/v1/customers/phonecalls
Description
Gets a page with customerPhonecalls. The records can be filtered based on customerPhoneCall object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
employeeGroupId |
customer phone calls will be returned based on the employeeGroupId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching customer phone calls |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/phonecalls
Example HTTP response
Response 200
{
"content" : [ {
"customerId" : 1,
"customerPhoneCallId" : 1,
"employeeId" : 1,
"endTime" : "01-01-2023T11:23:45Z",
"memoCategoryId" : 1,
"note" : "string",
"phoneNumber" : "string",
"resortId" : 1,
"startTime" : "01-01-2023T11:23:45Z",
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.13.10. Gets all files
GET /maxxton/v1/customers/{customerId}/files
Description
Get a page with files associated with a customer.The records are filtered based on filebase object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
customerId |
Customer id for which the files are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No customer or files found for given customer id. |
No Content |
500 |
Error occurred while fetching files |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/files
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"fileId" : 1,
"fileName" : "string",
"fileSize" : 1,
"fileType" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"uploadDate" : "01-01-2023",
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.13.11. Gets customers
GET /maxxton/v1/customers
Description
Gets a page with customers. The records can be filtered based on customer object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
email |
Filter customer’s on email id |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching customers |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers
Example HTTP response
Response 200
{
"content" : [ {
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerGroupId" : 1,
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"languageId" : 1,
"lastName" : "string",
"login" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"phoneCallAllowed" : true,
"previousPmsId" : 1,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"signatureDate" : "01-01-2023",
"socialSecurityNumber" : "string",
"textMsgAllowed" : true,
"titleId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.13.12. Gets history associated with customers
GET /maxxton/v1/customers/{customerId}/communications
Description
Get a page with communication call done with a client associated with a customer on reservation basis.The records are filtered based on communication object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
customerId |
Customer id for which the communication calls are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No customer or customer communication found for given customer id. |
No Content |
500 |
Error occurred while fetching customer communication calls |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/communications
Example HTTP response
Response 200
{
"content" : [ {
"attachments" : [ {
"endDate" : "01-01-2023T11:23:45Z",
"fileId" : 1,
"fileName" : "string",
"fileSize" : 1,
"fileType" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"uploadDate" : "01-01-2023T11:23:45Z",
"validFrom" : "01-01-2023T11:23:45Z",
"validTo" : "01-01-2023T11:23:45Z"
} ],
"customerCommunicationId" : 1,
"message" : "string",
"report" : {
"reportCode" : "string"
},
"reportCode" : "string",
"reportType" : "string",
"reportUrl" : [ {
"reportType" : "string"
} ],
"reportUrls" : [ {
"reportType" : "string"
} ],
"reservationId" : 1,
"sendDate" : "01-01-2023T11:23:45Z",
"senderEmail" : "string",
"sendingType" : "string",
"staticAttachments" : [ {
"endDate" : "01-01-2023T11:23:45Z",
"fileId" : 1,
"fileName" : "string",
"fileSize" : 1,
"fileType" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"uploadDate" : "01-01-2023T11:23:45Z",
"validFrom" : "01-01-2023T11:23:45Z",
"validTo" : "01-01-2023T11:23:45Z"
} ],
"subject" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.13.13. Update customer details
PUT /maxxton/v1/customers/{customerId}
Description
Update an existing customer based on given details.
Note: Some of the fields of customer entity are restricted fields based on access rights. So, such fields data will be masked as \* in GET customer endpoints, if your login client id doesn’t have access to those fields. The fields which are not masked in the response to GET customer endpoints, could only can be modified using this endpoint.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request body to specify the modifications needed for a customer. |
|
Path |
customerId |
Customer id to fetch files associated with the customer |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No customer found for given customer id. |
No Content |
500 |
Error occurred while updating details for this customer |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}
Request body
{
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"lastName" : "string",
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"boxNumber" : "string",
"city" : "string",
"countryCode" : "string",
"district" : "string",
"email" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"phoneCallAllowed" : true,
"sex" : "string",
"textMsgAllowed" : true,
"titleId" : 1
}
Example HTTP response
Response 200
{
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerGroupId" : 1,
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"languageId" : 1,
"lastName" : "string",
"login" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"phoneCallAllowed" : true,
"previousPmsId" : 1,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"signatureDate" : "01-01-2023",
"socialSecurityNumber" : "string",
"textMsgAllowed" : true,
"titleId" : 1
}
5.13.14. retrieve Customer balance
GET /maxxton/v1/customers/{customerId}/loyalty
Description
Gets the balance of the customer specified to a particular id passed in the endpoint.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
customerId |
Customer id for which the Customer Loyalty balance to be fetched |
integer (int64) |
Query |
returnTransaction |
Transaction will be return if this is true. |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No customer found for given customer id. |
No Content |
500 |
Error occurred while fetching this customer |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/loyalty
Example HTTP response
Response 200
{
"activePoints" : 1,
"customerId" : 1,
"expiredPoints" : 1,
"pendingPoints" : 1,
"spentPoints" : 1,
"transactions" : [ {
"activationDate" : "01-01-2023",
"customerId" : 1,
"employeeId" : 1,
"expirationDate" : "01-01-2023",
"originalPoints" : 1,
"remainingPoints" : 1,
"remark" : "string",
"reservationId" : 1,
"reservedResourceId" : 1,
"transactionDate" : "01-01-2023T11:23:45Z",
"transactionId" : 1,
"transactionType" : "string"
} ]
}
5.13.15. retrieve loyalty transactions
GET /maxxton/v1/customers/loyalty/transactions
Description
Gets the loyalty transactions. The records can be filtered based on the Transaction object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching customer loyalty transaction |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/loyalty/transactions
Example HTTP response
Response 200
{
"content" : [ {
"activationDate" : "01-01-2023",
"customerId" : 1,
"employeeId" : 1,
"expirationDate" : "01-01-2023",
"originalPoints" : 1,
"remainingPoints" : 1,
"remark" : "string",
"reservationId" : 1,
"reservedResourceId" : 1,
"transactionDate" : "01-01-2023T11:23:45Z",
"transactionId" : 1,
"transactionType" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.13.16. updates the customer credentials
PUT /maxxton/v1/customers/{customerId}/credentials
Description
This endpoint can update password of a customer in Maxxton based on the customerId and the login field. The /maxxton/v1/customers/login can be used to check if this login is correct and can be used to authenticate a user in an external system. There is no user session management available. The password can be changed in this call. The password can not be fetched from the API because of security reasons. In case the password field is kept empty the existing value will be kept.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Login credentials of the customer to be updated. |
|
Path |
customerId |
Customer id to fetch files associated with the customer |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while updating this customer credentials |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/customers/{customerId}/credentials
Request body
{
"login" : "string",
"password" : "string"
}
5.14. DistributionChannels
Channel through which reservations can be booked
5.14.1. Gets a page of resorts
GET /maxxton/v1/distributionchannels/{distributionChannelId}/resorts
Description
This endpoint returns the resorts applicable to specific distribution channel.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
distributionChannelId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching the resorts |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/distributionchannels/{distributionChannelId}/resorts
Example HTTP response
Response 200
{
"content" : [ {
"archivedFrom" : "01-01-2023",
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"parentId" : 1,
"resortId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.14.2. Gets a page with distribution channels
GET /maxxton/v1/distributionchannels
Description
Get a page with distribution channels. The records can be filtered based on distribution channel object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
204 |
No distributionChannels found for given criteria. |
No Content |
500 |
Error occurred while fetching these distributionChannels |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/distributionchannels
Example HTTP response
Response 200
{
"content" : [ {
"activeEndDate" : "01-01-2023",
"activeStartDate" : "01-01-2023",
"allotmentOnly" : true,
"allotmentSetting" : "string",
"archivedFrom" : "01-01-2023",
"brand" : "string",
"brandId" : 1,
"code" : "string",
"communicationPermission" : "string",
"currencyCode" : "string",
"currencyId" : 1,
"customerRequiredFieldsSetId" : 1,
"distributionChannelId" : 1,
"inheritedType" : "string",
"invoiceAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"invoiceaddressManagerId" : 1,
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"name" : "string",
"parentId" : 1,
"representationSetParentId" : 1,
"resellerId" : 1,
"showAgentBill" : 1,
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.14.3. Gets a single distributionChannel
GET /maxxton/v1/distributionchannels/{distributionChannelId}
Description
This endpoint returns the specific distribution channel including mail, invoice address and currency.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
distributionChannelId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No distributionChannel found for given distributionChannel id. |
No Content |
500 |
Error occurred while fetching this distributionChannel |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/distributionchannels/{distributionChannelId}
Example HTTP response
Response 200
{
"activeEndDate" : "01-01-2023",
"activeStartDate" : "01-01-2023",
"allotmentOnly" : true,
"allotmentSetting" : "string",
"archivedFrom" : "01-01-2023",
"brand" : "string",
"brandId" : 1,
"code" : "string",
"communicationPermission" : "string",
"currencyCode" : "string",
"currencyId" : 1,
"customerRequiredFieldsSetId" : 1,
"distributionChannelId" : 1,
"inheritedType" : "string",
"invoiceAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"invoiceaddressManagerId" : 1,
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"name" : "string",
"parentId" : 1,
"representationSetParentId" : 1,
"resellerId" : 1,
"showAgentBill" : 1,
"type" : "string"
}
5.14.4. Gets page of distributionchannel’s payent methods
GET /maxxton/v1/distributionchannels/{distributionchannelId}/paymentmethods
Description
Get payment methods for distributionchannel based on distributionchannelId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
distributionchannelId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching payment methods for the given distributionchannel |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/distributionchannels/{distributionchannelId}/paymentmethods
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"maxDaysBetweenBookAndArrivalDate" : 1,
"minDaysBeforeArrival" : 1,
"paymentMethod" : "string",
"paymentProvider" : "string",
"paymentType" : "string",
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.14.5. Gets page of payment methods of all distributionChannels
GET /maxxton/v1/distributionchannels/paymentmethods
Description
Get payment methods for all distributionchannels.
Maximum page size for this endpoint is 10.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
distributionChannelCode |
distributionChannelCode to filter records. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching payment methods |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/distributionchannels/paymentmethods
Example HTTP response
Response 200
{
"content" : [ {
"distributionChannelCode" : "string",
"paymentMethods" : [ {
"code" : "string",
"maxDaysBetweenBookAndArrivalDate" : 1,
"minDaysBeforeArrival" : 1,
"paymentMethod" : "string",
"paymentProvider" : "string",
"paymentType" : "string",
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.15. Employee
Employees
5.15.1. Create a new employee
POST /maxxton/v1/employees
Description
Create a new employee with the details
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/employees
Request body
{
"adminorganisationIds" : [ "integer" ],
"cashAccountIds" : [ "integer" ],
"clientType" : "string",
"distributionchannelCode" : "string",
"email" : "string",
"employeeGroupId" : 1,
"firstName" : "string",
"lastName" : "string",
"locale" : "string",
"login" : "string",
"middleName" : "string",
"offDuty" : "01-01-2023",
"onDuty" : "01-01-2023",
"permissionGroupIds" : [ "integer" ],
"privacyAccessLevel" : "string",
"privacyDbAccessLevel" : "string",
"reservationcategoryCode" : "string",
"resortIds" : [ "integer" ],
"sectorIds" : [ "integer" ],
"sex" : "string",
"type" : "string",
"unifiedInboxIds" : [ "integer" ]
}
Example HTTP response
Response 200
{
"adminorganisationIds" : [ "integer" ],
"cashAccountIds" : [ "integer" ],
"clientType" : "string",
"distributionchannelId" : 1,
"empEmailId" : "string",
"employeeId" : 1,
"firstName" : "string",
"groupId" : 1,
"lastName" : "string",
"locale" : "string",
"login" : "string",
"middleName" : "string",
"offDuty" : "01-01-2023",
"onDuty" : "01-01-2023",
"permissionGroupIds" : [ "integer" ],
"privacyAccessLevel" : "string",
"privacyDbAccessLevel" : "string",
"reservationcategoryId" : 1,
"resortIds" : [ "integer" ],
"sectorIds" : [ "integer" ],
"sex" : "string",
"type" : "string",
"unifiedInboxIds" : [ "integer" ]
}
5.15.2. Gets the details of employees
GET /maxxton/v1/employees
Description
Gets the details of all employess.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
employeeIds |
List of employee Ids to fetch in response |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
OK |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/employees
Example HTTP response
Response 200
{
"content" : [ {
"clientGroupId" : 1,
"empEmailId" : "string",
"employeeGroup" : {
"code" : "string",
"description" : "string",
"employeeGroupId" : 1,
"name" : "string"
},
"employeeId" : 1,
"firstName" : "string",
"lastName" : "string",
"middleName" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.15.3. Update an existing employee
PUT /maxxton/v1/employees/{employeeId}
Description
Update an existing employee
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Path |
employeeId |
Id of the employee that needs to be updated |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
OK |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/employees/{employeeId}
Request body
{
"adminorganisationIds" : [ "integer" ],
"cashAccountIds" : [ "integer" ],
"distributionchannelCode" : "string",
"email" : "string",
"employeeGroupId" : 1,
"firstName" : "string",
"lastName" : "string",
"locale" : "string",
"login" : "string",
"middleName" : "string",
"offDuty" : "01-01-2023",
"onDuty" : "01-01-2023",
"permissionGroupIds" : [ "integer" ],
"privacyAccessLevel" : "string",
"privacyDbAccessLevel" : "string",
"reservationcategoryCode" : "string",
"resortIds" : [ "integer" ],
"sectorIds" : [ "integer" ],
"sex" : "string",
"type" : "string",
"unifiedInboxIds" : [ "integer" ]
}
Example HTTP response
Response 200
{
"adminorganisationIds" : [ "integer" ],
"cashAccountIds" : [ "integer" ],
"clientType" : "string",
"distributionchannelId" : 1,
"empEmailId" : "string",
"employeeId" : 1,
"firstName" : "string",
"groupId" : 1,
"lastName" : "string",
"locale" : "string",
"login" : "string",
"middleName" : "string",
"offDuty" : "01-01-2023",
"onDuty" : "01-01-2023",
"permissionGroupIds" : [ "integer" ],
"privacyAccessLevel" : "string",
"privacyDbAccessLevel" : "string",
"reservationcategoryId" : 1,
"resortIds" : [ "integer" ],
"sectorIds" : [ "integer" ],
"sex" : "string",
"type" : "string",
"unifiedInboxIds" : [ "integer" ]
}
5.16. Events
Events occurred in the system due to modifications of the entities
5.16.1. Gets page of events
GET /maxxton/v1/events
Description
Gets a page of events. Any change done to any of the data will trigger notifications. The notification is checked for the type of event and logged as an event along with entity id, event id and timestamps. The response of the above event endpoint can be filtered on the basis of criteria for e.g eventId , entityId , entityType etc., in combination with below mentioned parameters. For instance, /maxxton/v1/events?filter=type:UNIT_EVENT&modifiedAfter=2019-03-01T01:00:00.000
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
modifiedAfter |
modifiedAfter parameter will set a limit on the delta events so it will return all changes which occured on the environment after the provided date. If this parameter is not passed then the request will consider no start date limit and return everything available. However the delta events are only kept for 7 days. The parameter should be provided in UTC timezone with the following dateformat: yyyy-MM-dd’T’HH:mm:ss.SSS (for example: modifiedAfter:2018-10-18T10:00:00.000) |
string (date-time) |
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
modifiedBefore |
modifiedBefore parameter will set a limit on the delta events so it will return all changes which occured on the environment before the provided date. If this parameter is not passed then the request will consider no end date limit and return everything available. However the delta events are only kept for 7 days. The parameter should be provided in UTC timezone with the following dateformat: yyyy-MM-dd’T’HH:mm:ss.SSS (for example: modifiedBefore:2018-10-18T10:00:00.000) |
string (date-time) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching events. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/events
Example HTTP response
Response 200
{
"content" : [ {
"entityAction" : "string",
"entityId" : 1,
"entityType" : "string",
"eventId" : 1,
"eventTimestamp" : "01-01-2023T11:23:45Z",
"oldEntityId" : 1,
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.17. Facilities
Different labels used for facilities
5.17.1. Get facilities
GET /maxxton/v1/facilities
Description
Gets a page with facilities. The records can be filtered based on the facility object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnOpeningTimes |
Returns Facility opening times. By default, this request param is false, and should be used in the request opening times are expected. If this parameter is requested, only 10 facilities per page will be returned. |
boolean |
Query |
size |
integer (int32) |
|
Query |
openingTimeFrom |
The opening times of the facilities can be limited by requesting a start date. This will work only when returnOpeningTimes=true, and must be passed along with openingDateTo. The difference between openingTimeFrom and openingDateTo should not be greater than 31 days. |
string (date) |
Query |
openingTimeTo |
The opening times of the facilities can be limited by requesting an end date. This will work only when returnOpeningTimes=true, and must be passed along with openingTimeFrom. The difference between openingTimeFrom and openingDateTo should not be greater than 31 days. |
string (date) |
Query |
returnUnpublished |
This will return unpublished Facility opening times. |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching facilities. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/facilities
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"facilityId" : 1,
"internalUse" : true,
"openingTimes" : [ {
"date" : "01-01-2023",
"day" : "01-01-2023",
"endTime" : "01-01-2023T11:23:45Z",
"managerId" : 1,
"openingComment" : "string",
"openingTimeId" : 1,
"published" : true,
"startTime" : "01-01-2023T11:23:45Z",
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"openingComment" : "string"
} ]
} ],
"priority" : 1,
"resortId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.17.2. Gets an facility of a specific facility id.
GET /maxxton/v1/facilities/{facilityId}
Description
Gets facility based on Facility Id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
facilityId |
Facility id to fetch facility |
integer (int64) |
Query |
returnOpeningTimes |
Returns Facility opening times. By default, this request param is false, and should be used in the request opening times are expected. |
boolean |
Query |
openingTimeFrom |
The opening times of the facilities can be limited by requesting a start date. This will work only when returnOpeningTimes=true, and must be passed along with openingDateTo. The maximum time between openingTimeFrom and openingDateTo is one month. |
string (date) |
Query |
openingTimeTo |
The opening times of the facilities can be limited by requesting an end date. This will work only when returnOpeningTimes=true, and must be passed along with openingTimeFrom. The maximum time between openingTimeFrom and openingDateTo is one month. |
string (date) |
Query |
returnUnpublished |
This will return unpublished Facility opening times. |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Facility. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/facilities/{facilityId}
Example HTTP response
Response 200
{
"code" : "string",
"facilityId" : 1,
"internalUse" : true,
"openingTimes" : [ {
"date" : "01-01-2023",
"day" : "01-01-2023",
"endTime" : "01-01-2023T11:23:45Z",
"managerId" : 1,
"openingComment" : "string",
"openingTimeId" : 1,
"published" : true,
"startTime" : "01-01-2023T11:23:45Z",
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"openingComment" : "string"
} ]
} ],
"priority" : 1,
"resortId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
}
5.18. Groups
Grouping different kind of entities
5.18.1. Get a page with Groups
GET /maxxton/v1/groups
Description
Get a page with Groups. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
type |
Specify the Group type criteria. To get the "linkedIds" it’s mandatory to provide the type parameter in the request. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
204 |
No Groups found for given criteria. |
No Content |
500 |
Error occurred while fetching these Groups |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/groups
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"groupId" : 1,
"linkedIds" : [ "integer" ],
"parentId" : 1,
"priority" : 1,
"resortId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.18.2. Gets an Group for a specific groupId
GET /maxxton/v1/groups/{groupId}
Description
Gets an Groups based on specific groupId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupId |
group id to fetch group |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching the Group |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/groups/{groupId}
Example HTTP response
Response 200
{
"code" : "string",
"groupId" : 1,
"linkedIds" : [ "integer" ],
"parentId" : 1,
"priority" : 1,
"resortId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string"
}
5.19. Housekeeping
Information related to housekeeping
5.19.1. Gets a Page of housekeeping details
GET /maxxton/v1/housekeeping
Description
Gets a Page of housekeeping details.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching housekeeping details. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/housekeeping
Example HTTP response
Response 200
{
"content" : [ {
"executionDate" : "01-01-2023",
"executionMoment" : "string",
"resortId" : 1,
"resourceId" : 1,
"sector" : {
"name" : "string",
"sectorId" : 1
},
"tasks" : [ {
"assignee" : "string",
"duration" : 1,
"employeeId" : 1,
"planningId" : 1,
"remark" : "string",
"status" : "string",
"taskId" : 1
} ],
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.19.2. Gets a Page of housekeeping tasks
GET /maxxton/v1/housekeeping/tasks
Description
Gets a Page of housekeeping tasks.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching housekeeping tasks. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/housekeeping/tasks
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"taskId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.20. Icals
Icals
5.20.1. Gets a ical link for single unit.
GET /maxxton/v1/units/{unitId}/icals/links
Description
Gets a link to download the specific unit ical file.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
unitId |
Unit id of the unit |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching the ical link. |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/icals/links
Example HTTP response
Response 200
{
"downloadLink" : "string"
}
5.21. Infotexts
Information related to all the infotexts.
5.21.1. Gets a page with infotexts.
POST /maxxton/v1/infotexts/search
Description
Gets a page with infotexts.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while searching infotexts |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/infotexts/search
Request body
{
"addonIds" : [ "integer" ],
"amenityIds" : [ "integer" ],
"arrivalDate" : "01-01-2023",
"departureDate" : "01-01-2023",
"distributionChannelId" : 1,
"infotextCategoryId" : 1,
"offerIds" : [ "integer" ],
"reservationCategoryId" : 1,
"resortId" : 1,
"resourceId" : 1,
"showMomentId" : 1,
"subjectIds" : [ "integer" ],
"unitIds" : [ "integer" ]
}
Example HTTP response
Response 200
{
"content" : [ {
"content" : "string",
"infoTextId" : 1,
"name" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.21.2. Gets a page with show moments.
GET /maxxton/v1/infotexts/showmoments
Description
Gets a page with show moments. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching show moments. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/infotexts/showmoments
Example HTTP response
Response 200
{
"content" : [ {
"description" : "string",
"momentId" : 1,
"name" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.22. Languages
Available languages in the system
5.22.1. Gets languages
GET /maxxton/v1/languages
Description
Gets List of languages. The records can be filtered based on the language object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< Language |
500 |
Error occurred while fetching languages. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/languages
Example HTTP response
Response 200
[ {
"defaultLanguage" : true,
"languageId" : "string",
"shortName" : "string"
} ]
5.23. Ledgers
Ledgers
5.23.1. Gets LedgerGroup for specific ledgerGroupId
GET /maxxton/v1/ledgers/groups/{ledgerGroupId}
Description
Gets LedgerGroup by LedgerGroup id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
ledgerGroupId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching ledger for the given ledger group id. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/ledgers/groups/{ledgerGroupId}
Example HTTP response
Response 200
{
"code" : "string",
"ledgerGroupId" : 1,
"resortsGroups" : [ {
"costCenter" : {
"costCenterId" : 1,
"costCenterNumber" : "string",
"description" : "string",
"name" : "string"
},
"costCenterDependsResort" : true,
"costCenterId" : 1,
"costUnitId" : 1,
"costcenterDependsonResortRc" : true,
"costcenterDependsonWorkorder" : true,
"ledgerId" : 1,
"resortgroupId" : 1,
"resortgroupPriority" : 1,
"secondLedgerId" : 1
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
}
5.23.2. Gets Ledger for specific ledger id
GET /maxxton/v1/ledgers/{ledgerId}
Description
Gets ledger by ledger id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
ledgerId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching ledger for the given ledger id. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/ledgers/{ledgerId}
Example HTTP response
Response 200
{
"description" : "string",
"ledgerId" : 1,
"ledgerNumber" : "string",
"name" : "string"
}
5.23.3. Gets a page with ledger groups
GET /maxxton/v1/ledgers/groups
Description
Gets page with ledgers. The records can be filtered based on ledger object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnResortGroups |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching ledger groups. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/ledgers/groups
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"ledgerGroupId" : 1,
"resortsGroups" : [ {
"costCenter" : {
"costCenterId" : 1,
"costCenterNumber" : "string",
"description" : "string",
"name" : "string"
},
"costCenterDependsResort" : true,
"costCenterId" : 1,
"costUnitId" : 1,
"costcenterDependsonResortRc" : true,
"costcenterDependsonWorkorder" : true,
"ledgerId" : 1,
"resortgroupId" : 1,
"resortgroupPriority" : 1,
"secondLedgerId" : 1
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.23.4. Gets a page with ledgers
GET /maxxton/v1/ledgers
Description
Gets page with ledgers.The records can be filtered based on ledger object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resorts. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/ledgers
Example HTTP response
Response 200
{
"content" : [ {
"description" : "string",
"ledgerId" : 1,
"ledgerNumber" : "string",
"name" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.24. Locks
Locks
5.24.1. Gets configured lock reasons
GET /maxxton/v1/locks/reasons
Description
Gets a page with all configured lock reasons. The records can be filtered based on the resourceLockReason object.It also supports pageable
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching lock reasons. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/locks/reasons
Example HTTP response
Response 200
{
"content" : [ {
"reasonId" : 1,
"translations" : [ {
"description" : "string",
"langauge" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.25. Memos
Informative text on different entities
5.25.1. Gets a page with memo categories
GET /maxxton/v1/memos/categories
Description
Gets a page with memo categories. The records can be filtered based on memo category object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching memo categories |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/memos/categories
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"memoCategoryId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26. Offer
Discounts or special offers on accommodations
5.26.1. Add addition of offers
POST /maxxton/v1/offers/{resourceId}/additions
Description
Add addition of offers by an addition resource id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Addition resource id of offer, which is an addition on a resource specified by resourceId in the request body. |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching addition. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/additions
Request body
{
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
}
Example HTTP response
Response 200
{
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
}
5.26.2. Add contract type of offers
POST /maxxton/v1/offers/{resourceId}/contracttypes
Description
When we add the contract type on offer, that offer will only bookable from that unit which have same contract type configuration.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id for which contract type will add for offers |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while adding contract type on offer |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/contracttypes
Request body
{
"contracttypeId" : 1,
"resourceId" : 1
}
Example HTTP response
Response 200
{
"contracttypeId" : 1,
"resourceId" : 1
}
5.26.3. Add rentability for offers
POST /maxxton/v1/offers/{resourceId}/rentability
Description
Rentability defines a specific period in which the offer is rentable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id for which rentability will be added for offers |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while adding rentability. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/rentability
Request body
{
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"dayMax" : 1,
"dayMin" : 1,
"daysOfWeek" : [ "string" ],
"isArrival" : true,
"isDeparture" : true,
"isTemporary" : 1,
"managerId" : 1,
"maxDeviationArrDepDate" : 1,
"maxTimeAfterBookDate" : 1,
"minDeviationArrDepDate" : 1,
"minTimeAfterBookDate" : 1
}
5.26.4. Create a new offer
POST /maxxton/v1/offers
Description
The endpoint can be used to reserve/book offer i.e special or product
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating offer |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers
Request body
{
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToPublish" : true,
"archivedFrom" : "01-01-2023",
"autovalidate" : true,
"code" : "string",
"customizableResource" : true,
"excludePriceCache" : true,
"lowestLevel" : true,
"offerExactPeriodOnly" : true,
"offerPolicy" : "string",
"offerPriority" : 1,
"offerType" : "string",
"parentId" : 1,
"path" : "string",
"poolWeightage" : 1,
"powerplaygroupId" : 1,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"secretOffer" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
}
Example HTTP response
Response 200
{
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToPublish" : true,
"archivedFrom" : "01-01-2023",
"autovalidate" : true,
"code" : "string",
"customizableResource" : true,
"excludePriceCache" : true,
"lowestLevel" : true,
"offerExactPeriodOnly" : true,
"offerPolicy" : "string",
"offerPriority" : 1,
"offerType" : "string",
"parentId" : 1,
"path" : "string",
"poolWeightage" : 1,
"powerplaygroupId" : 1,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"secretOffer" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
}
5.26.5. Create representations of offer
POST /maxxton/v1/offers/{resourceId}/representations
Description
Create representations of offer to a specific resource id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
resourceId of offer for which the representations will be create. |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating representations. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/representations
Request body
{
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
}
Example HTTP response
Response 200
{
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
}
5.26.6. Delete a contract type
DELETE /maxxton/v1/offers/{resourceId}/contracttypes/{contracttypeId}
Description
Delete a contract type of offer based on offer id and contract type id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id of offer |
integer (int64) |
Path |
contracttypeId |
contracttype id which want to delete |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
contract type is deleted without any error. |
No Content |
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/contracttypes/{contracttypeId}
5.26.7. Get Offer rates
GET /maxxton/v1/offers/{resourceId}/rates
Description
Gets a page with offer rates. The records can be filtered based on rate object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id for which Rates are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching offer rates. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/rates
Example HTTP response
Response 200
{
"content" : [ {
"applicableTo" : [ {
"accommodationKindId" : 1,
"resourceId" : 1,
"resourceType" : "string"
} ],
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"daysOfWeek" : [ "string" ],
"duration" : 1,
"maxDeviation" : 1,
"maxDuration" : 1,
"maxDurationMinutes" : 1,
"minDeviation" : 1,
"minDuration" : 1,
"minDurationMinutes" : 1,
"priority" : 1,
"qrvType" : "string",
"qrvValues" : [ {
"minQuantity" : 1,
"value" : 1
} ],
"quantifier" : "string",
"rateId" : 1,
"rateTypeIds" : [ "integer" ],
"rateTypes" : [ {
"rateTypeId" : 1
} ],
"remark" : "string",
"resourceId" : 1,
"resources" : [ {
"accommodationKindId" : 1,
"resourceId" : 1,
"resourceType" : "string"
} ],
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"usageDowList" : [ "string" ],
"usageDurationFrom" : 1,
"usageDurationTo" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023",
"value" : 1,
"valueType" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.8. Get a page with offers available.
GET /maxxton/v1/offers
Description
Gets a page with offers associated with resource id. The records can be filtered bassed on offer object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Specials |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers
Example HTTP response
Response 200
{
"content" : [ {
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToPublish" : true,
"archivedFrom" : "01-01-2023",
"autovalidate" : true,
"code" : "string",
"customizableResource" : true,
"excludePriceCache" : true,
"lowestLevel" : true,
"offerExactPeriodOnly" : true,
"offerPolicy" : "string",
"offerPriority" : 1,
"offerType" : "string",
"parentId" : 1,
"path" : "string",
"poolWeightage" : 1,
"powerplaygroupId" : 1,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"secretOffer" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.9. Get addition of offer
GET /maxxton/v1/offers/{resourceId}/additions
Description
Get addition of offer. The records can be filtered based on resource addition object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
ResourceId for which offer want to get additions |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching addtion. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/additions
Example HTTP response
Response 200
{
"content" : [ {
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.10. Get implies of offer
GET /maxxton/v1/offers/implies
Description
Gets a page with implies of offer. The records can be filtered based on implies object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching implies. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : 1,
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"countFromMin" : true,
"ignoreRentability" : true,
"implicationManagerId" : 1,
"implied" : [ {
"objectId" : 1,
"resourceId" : 1
} ],
"impliesId" : 1,
"implyOnce" : true,
"included" : true,
"onBill" : true,
"parent" : true,
"parentId" : 1,
"priority" : 1,
"quantityMax" : 1,
"quantityMin" : 1,
"removable" : true,
"required" : true,
"resourceId" : 1,
"resourceIds" : [ "integer" ],
"showOnAllInPriceBill" : true,
"showPrice" : true,
"stay" : true,
"subjectsMax" : 1,
"subjectsMin" : 1,
"supplierImpliesId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.11. Get implies of offer
GET /maxxton/v1/offers/{resourceId}/implies
Description
Implies are the mandatory resources which can be booked, the optional resources can be retrieved through the additions call.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
ResourceId of offer for which the implies needs to be fetched. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching implies. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : 1,
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"countFromMin" : true,
"ignoreRentability" : true,
"implicationManagerId" : 1,
"implied" : [ {
"objectId" : 1,
"resourceId" : 1
} ],
"impliesId" : 1,
"implyOnce" : true,
"included" : true,
"onBill" : true,
"parent" : true,
"parentId" : 1,
"priority" : 1,
"quantityMax" : 1,
"quantityMin" : 1,
"removable" : true,
"required" : true,
"resourceId" : 1,
"resourceIds" : [ "integer" ],
"showOnAllInPriceBill" : true,
"showPrice" : true,
"stay" : true,
"subjectsMax" : 1,
"subjectsMin" : 1,
"supplierImpliesId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.12. Get offer to a specific resource id
GET /maxxton/v1/offers/{resourceId}
Description
Get offer associated with a specific resouce id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id to fetched offer |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Offer |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}
Example HTTP response
Response 200
{
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToPublish" : true,
"archivedFrom" : "01-01-2023",
"autovalidate" : true,
"code" : "string",
"customizableResource" : true,
"excludePriceCache" : true,
"lowestLevel" : true,
"offerExactPeriodOnly" : true,
"offerPolicy" : "string",
"offerPriority" : 1,
"offerType" : "string",
"parentId" : 1,
"path" : "string",
"poolWeightage" : 1,
"powerplaygroupId" : 1,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"secretOffer" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
}
5.26.13. Get offers contracttype
GET /maxxton/v1/offers/{resourceId}/contracttypes
Description
Gets a page with contract types related to a particular resource id. The records can be filtered based on offer contract types.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
Resource id of offer which want to fetch contract types |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while getting contract types for offer |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/contracttypes
Example HTTP response
Response 200
{
"content" : [ {
"contracttypeId" : 1,
"resourceId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.14. Get representations of offer
GET /maxxton/v1/offers/{resourceId}/representations
Description
Get representations of offer by a specific resource id. The records can be filtered based on representation object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resourceId |
ResourceId of offer for which the representations needs to be fetched. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching representations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/representations
Example HTTP response
Response 200
{
"content" : [ {
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.15. Gets Offers additions
GET /maxxton/v1/offers/additions
Description
Gets a page with offers additions. The records can be filtered based on resource addition object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching offers additions. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/additions
Example HTTP response
Response 200
{
"content" : [ {
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.26.16. Insert the offer rate
POST /maxxton/v1/offers/{resourceId}/rates
Description
The offer rates can be inserted by a particular resource id and cashflow rules.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id for which Offer rates will insert |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while fetching Offer rates. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}/rates
Request body
{
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"cashflowruleId" : 1,
"daysOfWeek" : [ "string" ],
"duration" : 1,
"maxDeviation" : 1,
"maxDuration" : 1,
"maxUnit" : 1,
"minDeviation" : 1,
"minDuration" : 1,
"minUnit" : 1,
"priority" : 1,
"quantifier" : "string",
"rateLevelId" : 1,
"rateOptionId" : 1,
"rateTypeIds" : [ "integer" ],
"remark" : "string",
"repeatable" : 1,
"resourceId" : 1,
"status" : 1,
"stay" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"usageDowList" : [ "string" ],
"usageDurationFrom" : 1,
"usageDurationTo" : 1,
"usageUnitFrom" : 1,
"usageUnitTo" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023",
"value" : 1,
"valueType" : "string"
}
5.26.17. Update a offer
PUT /maxxton/v1/offers/{resourceId}
Description
The offer to a specific resource id can be updated.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
Resource id of offer which want to update |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating offer |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{resourceId}
Request body
{
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToPublish" : true,
"archivedFrom" : "01-01-2023",
"autovalidate" : true,
"code" : "string",
"customizableResource" : true,
"excludePriceCache" : true,
"lowestLevel" : true,
"offerExactPeriodOnly" : true,
"offerPolicy" : "string",
"offerPriority" : 1,
"offerType" : "string",
"parentId" : 1,
"path" : "string",
"poolWeightage" : 1,
"powerplaygroupId" : 1,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"secretOffer" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
}
Example HTTP response
Response 200
{
"allowMovingToMainBill" : true,
"allowPriceOverride" : true,
"allowToPublish" : true,
"archivedFrom" : "01-01-2023",
"autovalidate" : true,
"code" : "string",
"customizableResource" : true,
"excludePriceCache" : true,
"lowestLevel" : true,
"offerExactPeriodOnly" : true,
"offerPolicy" : "string",
"offerPriority" : 1,
"offerType" : "string",
"parentId" : 1,
"path" : "string",
"poolWeightage" : 1,
"powerplaygroupId" : 1,
"resortId" : 1,
"resourceId" : 1,
"searchCode" : "string",
"secretOffer" : true,
"showNilPriceOnBill" : true,
"source" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
}
5.26.18. Update addition of offers
PUT /maxxton/v1/offers/{additionResourceId}/additions/{additionId}
Description
Update addition details of a resource by addition resource id and addition id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
additionResourceId |
The resource on which the offer is applicable as an addition and needs to be modified. |
integer (int64) |
Body |
requestBody |
The resource on which the offer is applicable as an addition. |
|
Path |
additionId |
Addition id which is going to be updated |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching addtion. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/offers/{additionResourceId}/additions/{additionId}
Request body
{
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"i18n" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resortArticle" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
}
Example HTTP response
Response 200
{
"additionFast" : true,
"additionId" : 1,
"additionResourceId" : 1,
"addonType" : "string",
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"mandatoryResource" : true,
"maxQuantity" : 1,
"maxReservable" : 1,
"maxTotalQuantity" : 1,
"priceCompare" : true,
"resourceId" : 1,
"resourceMoment" : [ "string" ],
"supplierAdditionId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"type" : "string",
"unitId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
}
5.27. Operations
Operations
5.27.1. Get Images
GET /maxxton/v1/operations/{issueIncidentId}/images
Description
Images added during resolving the tasks .The records can be filtered based on Images object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
issueIncidentId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Image |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/operations/{issueIncidentId}/images
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageOrientation" : "string",
"imageType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.27.2. Gets periodical tasks
GET /maxxton/v1/operations/periodicalTasks
Description
All configured periodical tasks which can be used in operation management. The records can be filtered based on PeriodicalTask object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resortIds |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Periodical tasks |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/operations/periodicalTasks
Example HTTP response
Response 200
{
"content" : [ {
"areaId" : 1,
"areas" : [ {
"areaId" : 1,
"i18nArea" : [ {
"areaId" : 1,
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"translations" : [ {
"areaId" : 1,
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"comments" : "string",
"i18nArea" : [ {
"areaId" : 1,
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"i18nIssueCategory" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"i18nIssueItem" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"individualWorkorder" : true,
"issueCategories" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"issueItem" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"issueTaskConfigId" : 1,
"issueTaskSchedules" : [ {
"resortId" : 1,
"scheduleType" : "string",
"schedules" : [ {
"endDayOfWeek" : 1,
"endExecOnFinalDayOfMonth" : true,
"endMonthOfYear" : 1,
"endSpecificDayOfMonth" : 1,
"issueTaskScheduleId" : 1,
"numberOfDaysAfterLastExecDate" : 1,
"numberOfYearsAfterLastExecDate" : 1,
"startDayOfWeek" : 1,
"startExecOnFinalDayOfMonth" : true,
"startMonthOfYear" : 1,
"startSpecificDayOfMonth" : 1
} ]
} ],
"resortIds" : [ "integer" ],
"scheduleType" : "string",
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"workOrderTaskConfigurationResorts" : [ {
"resortId" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.27.3. Gets tasks
GET /maxxton/v1/operations/tasks
Description
Tasks created based on periodical tasks which can be executed on the resort. The records can be filtered based on tasks object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching tasks |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/operations/tasks
Example HTTP response
Response 200
{
"content" : [ {
"employeeId" : 1,
"expectedEndDate" : "01-01-2023",
"expectedStartDate" : "01-01-2023",
"imageManagerId" : 1,
"issueIncidentId" : 1,
"issueTaskConfigId" : 1,
"modifiedDate" : "01-01-2023T11:23:45Z",
"onHoldReason" : "string",
"parentId" : 1,
"priority" : 1,
"referenceNumber" : 1,
"reportedBy" : "string",
"reportedDate" : "01-01-2023T11:23:45Z",
"resortId" : 1,
"resourceId" : 1,
"status" : "string",
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"workTime" : 1,
"workTimeAddedDateTime" : "01-01-2023T11:23:45Z"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28. Owners
Someone who owns an accommodation
5.28.1. Authenticate a owner
POST /maxxton/v1/owners/login
Description
Authenticate a owner based on login credentials and return owner details if the owner credentials are authentic.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Login credentials of the owner to be authenticated. |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
401 |
Invalid credentials. |
No Content |
500 |
Error occurred while authenticating this customer |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/login
Request body
{
"login" : "string",
"password" : "string"
}
Example HTTP response
Response 200
{
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"birthPlace" : "string",
"company" : true,
"companyIdentificationNumber" : "string",
"companyName" : "string",
"dac7OwnerVerified" : true,
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"languageId" : 1,
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"owner" : true,
"ownerGroupId" : 1,
"ownerId" : 1,
"ownerPool" : "string",
"ownerType" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"sharedOwnerShips" : [ {
"ownerId" : 1,
"realOwnerId" : 1
} ],
"socialSecurityNumber" : "string",
"socialSecurityNumberIssuingCountryId" : 1,
"taxNumber" : "string",
"taxNumberIssuingCountryId" : 1,
"titleId" : 1
}
5.28.2. Create Ownership
POST /maxxton/v1/owners/{ownerId}/units
Description
Create a link between an existing unit and an existing owner using ownership.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
A ownership object to be added. |
|
Path |
ownerId |
ownerId of owner |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating ownership |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units
Request body
{
"endDate" : "01-01-2023",
"isReportToAuth" : true,
"origin" : "string",
"originId" : "string",
"ownershipId" : 1,
"startDate" : "01-01-2023",
"unitId" : 1
}
Example HTTP response
Response 200
{
"endDate" : "01-01-2023",
"isReportToAuth" : true,
"origin" : "string",
"originId" : "string",
"ownershipId" : 1,
"startDate" : "01-01-2023",
"unitId" : 1
}
5.28.3. Get owner’s reservation details
GET /maxxton/v1/owners/{ownerId}/reservations/details
Description
Get owner’s reservation details. the recored can be filter based on employeeId and contractType. It also supports pageable.
This endpoint contains reservedResources in the response which might increase in future, which in result may reduce the performance of the endpoint, so allowed maximum page size to 10 to keep this endpoint stable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
contractType |
ContractType to filter the owner’s reservation detail |
string |
Query |
employeeId |
Employee id to filter the owner reservation detail |
integer (int64) |
Path |
ownerId |
The id of owner whose accommodation reservations will be fetched in the response. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owner’s reservation detail |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/reservations/details
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDate" : "01-01-2023",
"categoryCode" : "string",
"customer" : {
"countryCode" : "string",
"customerId" : 1,
"firstName" : "string",
"lastName" : "string",
"mailAddressManagerId" : 1
},
"customerId" : 1,
"departureDate" : "01-01-2023",
"distributionChannelCode" : "string",
"distributionChannelId" : 1,
"duration" : 1,
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedArrivalTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureTime" : "01-01-2023T11:23:45Z",
"reservationCategoryId" : 1,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservationNumber" : "string",
"reservedResources" : [ {
"addonType" : "string",
"addons" : [ {
"addonType" : "string",
"code" : "string",
"parentReservedResourceId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"ownerId" : 1,
"rateTypeId" : 1,
"reservedResourceId" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"unitCode" : "string",
"unitId" : 1
} ],
"status" : 1,
"statusValue" : "string",
"subjects" : [ {
"maxAge" : 1,
"quantity" : 1,
"subjectId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.4. Get the generated hash and provides link
GET /maxxton/v1/owners/{ownerId}/files/{fileId}
Description
Get the generated hash for specific file which has information related to file
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
ownerId |
Owner id to fetch files associated with the owner |
integer (int64) |
Path |
fileId |
file id to fetch a specific file |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No document found for specific file id. |
No Content |
500 |
Error occured while generating hash |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/files/{fileId}
Example HTTP response
Response 200
{
"downloadLink" : "string"
}
5.28.5. Gets a page with owner groups
GET /maxxton/v1/owners/groups
Description
Gets a page of owner groups. The records can be filtered based on ownergroup object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owner groups |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/owners/groups
Example HTTP response
Response 200
{
"content" : [ {
"name" : "string",
"ownerGroupId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.6. Gets a page with owners SettlementEntries
GET /maxxton/v1/owners/settlements/{settlementId}/entries
Description
Gets a page of Settlements Entries, The records can be filtered based on Owner SettlementEntry object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
settlementId |
Settlement id to fetch entries |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors. |
|
500 |
Error occurred while fetching Settlements Entries |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/settlements/{settlementId}/entries
Example HTTP response
Response 200
{
"content" : [ {
"advancePercentage" : 1,
"baseCostCenterId" : 1,
"baseLedgerId" : 1,
"baseSecondLedgerId" : 1,
"basesumIncltax" : 1,
"beneficiary" : "string",
"blockedDays" : 1,
"commission" : 1,
"commissionCostCenterId" : 1,
"commissionLedgerId" : 1,
"commissionSecondLedgerId" : 1,
"contraId" : 1,
"contractId" : 1,
"contractRuleId" : 1,
"contracttypeId" : 1,
"currentDeductionBase" : 1,
"daysInDistribution" : 1,
"deductionBase" : 1,
"deductionBaseNow" : 1,
"deductionSettlementId" : 1,
"description" : "string",
"discount" : 1,
"distributionChannelCurrencyId" : 1,
"entryDate" : "01-01-2023T11:23:45Z",
"entryId" : 1,
"excludedDays" : 1,
"finalContractrule" : true,
"fiscalType" : "string",
"fiscalVat" : "string",
"invoiceId" : 1,
"invoicenumber" : "string",
"maxOwnerAmount" : 1,
"ownerAmount" : 1,
"ownerAmountDeduction" : 1,
"ownerAmountVatPercentage" : 1,
"ownerBillNumber" : "string",
"ownerCurrencyId" : 1,
"ownerId" : 1,
"pooldistributionId" : 1,
"previousCommission" : 1,
"previousOwnerAmount" : 1,
"realOwnerId" : 1,
"rentAmount" : 1,
"reservationId" : 1,
"reservedresourceId" : 1,
"resortId" : 1,
"resourceId" : 1,
"resourceRedirectionId" : 1,
"roundDifference" : 1,
"settlementId" : 1,
"settlementPercentage" : 1,
"status" : true,
"totalPrevVatOwnerAmounts" : 1,
"totalPreviousOwnerAmounts" : 1,
"type" : "string",
"unitId" : 1,
"vatCommission" : 1,
"vatDeductionBase" : 1,
"vatDeductionBaseNow" : 1,
"vatOwnerAmount" : 1,
"vatPercentageCommission" : 1,
"vatPercentageDeductionBase" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.7. Gets a page with owners Settlements
GET /maxxton/v1/owners/settlements
Description
Gets a page of Settlements, The records can be filtered based on Owner Settlement object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors. |
|
500 |
Error occurred while fetching Owner Settlements. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/settlements
Example HTTP response
Response 200
{
"content" : [ {
"adminOrganisationId" : 1,
"comments" : "string",
"createdAt" : "01-01-2023T11:23:45Z",
"createdByEmployeeId" : 1,
"invoicesReservationPaymentDepartureDate" : "01-01-2023",
"isPoolSettlement" : true,
"madePermanentAt" : "01-01-2023",
"madePermanentByEmployeeId" : 1,
"overridePercentageDepartureDate" : "01-01-2023",
"ownerMutationReportNumber" : 1,
"resortId" : 1,
"savePreviousBalance" : true,
"settleInvoicesUntilDate" : "01-01-2023",
"settleRedirectionUntilDate" : "01-01-2023",
"settleReservationPaymentDepartureDate" : "01-01-2023",
"settlementDate" : "01-01-2023T11:23:45Z",
"settlementId" : 1,
"settlementName" : "string",
"settlementNumber" : 1,
"settlementPercentage" : 1,
"status" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.8. Gets a page with owners.
GET /maxxton/v1/owners
Description
Gets a page with owners. The records can be filtered based on owner object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnFiscalType |
The fiscal types will be returned when the value is set to true |
boolean |
Query |
returnSharedOwnerShips |
The List of shared ownerIds will be returned when the value is set to true |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owners |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners
Example HTTP response
Response 200
{
"content" : [ {
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"birthPlace" : "string",
"company" : true,
"companyIdentificationNumber" : "string",
"companyName" : "string",
"dac7OwnerVerified" : true,
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"languageId" : 1,
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"owner" : true,
"ownerGroupId" : 1,
"ownerId" : 1,
"ownerPool" : "string",
"ownerType" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"sharedOwnerShips" : [ {
"ownerId" : 1,
"realOwnerId" : 1
} ],
"socialSecurityNumber" : "string",
"socialSecurityNumberIssuingCountryId" : 1,
"taxNumber" : "string",
"taxNumberIssuingCountryId" : 1,
"titleId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.9. Gets a page with ownerships
GET /maxxton/v1/owners/{ownerId}/units/{unitId}/ownerships
Description
Gets a page of ownerships, The records can be filtered based on ownership object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
Unit id to fetch ownerships of the unit |
integer (int64) |
Path |
ownerId |
Owner id to fetch ownership of the owner |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors. |
|
500 |
Error occurred while fetching ownerships. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units/{unitId}/ownerships
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"origin" : "string",
"originId" : "string",
"ownershipId" : 1,
"startDate" : "01-01-2023",
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.10. Gets accommodationtypes associated with the owner
GET /maxxton/v1/owners/{ownerId}/accommodationtypes
Description
Gets a page with accommodationtype associated with particular owner. The records can be filtered based on owner accommodation type object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
code |
Code of the accommodationType |
string |
Path |
ownerId |
Owner id to fetch accommodationtypes of the owner |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owners with accommodationtypes |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/accommodationtypes
Example HTTP response
Response 200
{
"content" : [ {
"accommodationAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"accotypeKindId" : 1,
"archivedFrom" : "01-01-2023",
"brand" : "string",
"code" : "string",
"dependsOnLedgerGroup" : true,
"hasObjects" : true,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"numberOfPersons" : 1,
"ownerId" : 1,
"parentId" : 1,
"path" : "string",
"priority" : 1,
"resortId" : 1,
"resourceId" : 1,
"supplierOrigin" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.11. Gets all files
GET /maxxton/v1/owners/{ownerId}/files
Description
Get a page with files associated with an owner.The records are filtered based on filebase object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
ownerId |
Owner id for which the files are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No owner or files found for given owner id. |
No Content |
500 |
Error occurred while fetching files |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/files
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"fileId" : 1,
"fileName" : "string",
"fileSize" : 1,
"fileType" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"uploadDate" : "01-01-2023",
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.12. Gets an owner.
GET /maxxton/v1/owners/{ownerId}
Description
Gets information associated with specific owner. The records can be filtered based on owner object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
ownerId |
An Id of owner to be fetched |
integer (int64) |
Query |
returnSharedOwnerShips |
The List of shared ownerIds will be returned when the value is set to true |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owner |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}
Example HTTP response
Response 200
{
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"birthPlace" : "string",
"company" : true,
"companyIdentificationNumber" : "string",
"companyName" : "string",
"dac7OwnerVerified" : true,
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"languageId" : 1,
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"owner" : true,
"ownerGroupId" : 1,
"ownerId" : 1,
"ownerPool" : "string",
"ownerType" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"sharedOwnerShips" : [ {
"ownerId" : 1,
"realOwnerId" : 1
} ],
"socialSecurityNumber" : "string",
"socialSecurityNumberIssuingCountryId" : 1,
"taxNumber" : "string",
"taxNumberIssuingCountryId" : 1,
"titleId" : 1
}
5.28.13. Gets history associated with owner
GET /maxxton/v1/owners/{ownerId}/communications
Description
Get a page with communication call done with a client associated with an owner on reservation basis.The records are filtered based on communication object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
ownerId |
Owner id for which the communication calls are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No owner or owner communication found for given owner id. |
No Content |
500 |
Error occurred while fetching owner communication calls |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/communications
Example HTTP response
Response 200
{
"content" : [ {
"attachments" : [ {
"endDate" : "01-01-2023T11:23:45Z",
"fileId" : 1,
"fileName" : "string",
"fileSize" : 1,
"fileType" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"uploadDate" : "01-01-2023T11:23:45Z",
"validFrom" : "01-01-2023T11:23:45Z",
"validTo" : "01-01-2023T11:23:45Z"
} ],
"customerCommunicationId" : 1,
"message" : "string",
"report" : {
"reportCode" : "string"
},
"reportCode" : "string",
"reportType" : "string",
"reportUrl" : [ {
"reportType" : "string"
} ],
"reportUrls" : [ {
"reportType" : "string"
} ],
"reservationId" : 1,
"sendDate" : "01-01-2023T11:23:45Z",
"senderEmail" : "string",
"sendingType" : "string",
"staticAttachments" : [ {
"endDate" : "01-01-2023T11:23:45Z",
"fileId" : 1,
"fileName" : "string",
"fileSize" : 1,
"fileType" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"uploadDate" : "01-01-2023T11:23:45Z",
"validFrom" : "01-01-2023T11:23:45Z",
"validTo" : "01-01-2023T11:23:45Z"
} ],
"subject" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.14. Gets owner with his units
GET /maxxton/v1/ownergroups/{ownerGroupId}/units
Description
Gets a page of units associated to the owner. The records can be filtered based on owner unit object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resourceId |
ResourceId of the accommodationType to which the unit is linked |
integer (int64) |
Query |
code |
Code of the unit |
string |
Path |
ownerGroupId |
OwnerGroup Id to fetch units of the owners |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owners with units |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/ownergroups/{ownerGroupId}/units
Example HTTP response
Response 200
{
"content" : [ {
"accommodationAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"archivedFrom" : "01-01-2023",
"brand" : "string",
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"endDate" : "01-01-2023",
"excludeQuestionnaireStats" : true,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"ownerGroupId" : 1,
"ownerId" : 1,
"path" : "string",
"resourceGroupId" : 1,
"resourceId" : 1,
"roomCode" : "string",
"startDate" : "01-01-2023",
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"unitId" : 1,
"vsi" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.15. Gets owner with his units
GET /maxxton/v1/owners/{ownerId}/units
Description
Gets a page of units associated to the owner. The records can be filtered based on owner unit object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resourceId |
ResourceId of the accommodationType to which the unit is linked |
integer (int64) |
Query |
code |
Code of the unit |
string |
Path |
ownerId |
Owner id to fetch units of the owner |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owners with units |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units
Example HTTP response
Response 200
{
"content" : [ {
"accommodationAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"archivedFrom" : "01-01-2023",
"brand" : "string",
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"endDate" : "01-01-2023",
"excludeQuestionnaireStats" : true,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"ownerGroupId" : 1,
"ownerId" : 1,
"path" : "string",
"resourceGroupId" : 1,
"resourceId" : 1,
"roomCode" : "string",
"startDate" : "01-01-2023",
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"unitId" : 1,
"vsi" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.16. Gets owners with their accommodationtype
GET /maxxton/v1/owners/accommodationtypes
Description
Gets a page with owners with their accommodationtype. The records can be filtered based on owner accommodation type object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
code |
Code of the accommodationType |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owners with accommodationtypes |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/accommodationtypes
Example HTTP response
Response 200
{
"content" : [ {
"accommodationAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"accotypeKindId" : 1,
"archivedFrom" : "01-01-2023",
"brand" : "string",
"code" : "string",
"dependsOnLedgerGroup" : true,
"hasObjects" : true,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"numberOfPersons" : 1,
"ownerId" : 1,
"parentId" : 1,
"path" : "string",
"priority" : 1,
"resortId" : 1,
"resourceId" : 1,
"supplierOrigin" : "string",
"translations" : [ {
"accotypeKind" : "string",
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"namePath" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.17. Gets owners with their units
GET /maxxton/v1/owners/units
Description
Gets a page with owners with their units. The records can be filtered based on owner unit object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resourceId |
ResourceId of the accommodationType to which the unit is linked |
integer (int64) |
Query |
code |
Code of the unit |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owners with units |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/units
Example HTTP response
Response 200
{
"content" : [ {
"accommodationAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"archivedFrom" : "01-01-2023",
"brand" : "string",
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"endDate" : "01-01-2023",
"excludeQuestionnaireStats" : true,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"ownerGroupId" : 1,
"ownerId" : 1,
"path" : "string",
"resourceGroupId" : 1,
"resourceId" : 1,
"roomCode" : "string",
"startDate" : "01-01-2023",
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"unitId" : 1,
"vsi" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.18. Gets reservation of a specified units for an owner
GET /maxxton/v1/owners/{ownerId}/units/{unitId}/reservations
Description
Gets a page of reservations associated to a specified units for an owner. It also supports pageable.
This endpoint contains reservedResources in the response which might increase in future, which in result may reduce the performance of the endpoint, so allowed maximum page size to 10 to keep this endpoint stable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
Unit id to fetch reservations of the unit |
integer (int64) |
Path |
ownerId |
Owner id to fetch units of the owner |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching owners with units |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units/{unitId}/reservations
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDate" : "01-01-2023",
"categoryCode" : "string",
"customer" : {
"countryCode" : "string",
"customerId" : 1,
"firstName" : "string",
"lastName" : "string",
"mailAddressManagerId" : 1
},
"customerId" : 1,
"departureDate" : "01-01-2023",
"distributionChannelCode" : "string",
"distributionChannelId" : 1,
"duration" : 1,
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedArrivalTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureTime" : "01-01-2023T11:23:45Z",
"reservationCategoryId" : 1,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservationNumber" : "string",
"reservedResources" : [ {
"addonType" : "string",
"addons" : [ {
"addonType" : "string",
"code" : "string",
"parentReservedResourceId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"ownerId" : 1,
"rateTypeId" : 1,
"reservedResourceId" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"unitCode" : "string",
"unitId" : 1
} ],
"status" : 1,
"statusValue" : "string",
"subjects" : [ {
"maxAge" : 1,
"quantity" : 1,
"subjectId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.28.19. Update owner
PUT /maxxton/v1/owners/{ownerId}
Description
Update owner of provided ownerId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
owner with field value that needs to be update |
|
Path |
ownerId |
ownerId of owner which needs to be update |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating owner. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}
Request body
{
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"company" : true,
"companyName" : "string",
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"ownerGroupId" : 1,
"ownerPool" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"titleId" : 1
}
Example HTTP response
Response 200
{
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"birthPlace" : "string",
"company" : true,
"companyIdentificationNumber" : "string",
"companyName" : "string",
"dac7OwnerVerified" : true,
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"languageId" : 1,
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"owner" : true,
"ownerGroupId" : 1,
"ownerId" : 1,
"ownerPool" : "string",
"ownerType" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"sharedOwnerShips" : [ {
"ownerId" : 1,
"realOwnerId" : 1
} ],
"socialSecurityNumber" : "string",
"socialSecurityNumberIssuingCountryId" : 1,
"taxNumber" : "string",
"taxNumberIssuingCountryId" : 1,
"titleId" : 1
}
5.28.20. Update ownership
PUT /maxxton/v1/owners/{ownerId}/units/{unitId}
Description
Update ownership of provided ownershipId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
ownership with field value that needs to be update |
|
Path |
unitId |
unitId of ownership |
integer (int64) |
Path |
ownerId |
ownerId of ownership |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating ownership. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/units/{unitId}
Request body
{
"endDate" : "01-01-2023",
"isReportToAuth" : true,
"origin" : "string",
"originId" : "string",
"ownershipId" : 1,
"startDate" : "01-01-2023",
"unitId" : 1
}
Example HTTP response
Response 200
{
"endDate" : "01-01-2023",
"isReportToAuth" : true,
"origin" : "string",
"originId" : "string",
"ownershipId" : 1,
"startDate" : "01-01-2023",
"unitId" : 1
}
5.28.21. create owner
POST /maxxton/v1/owners
Description
Adds a new Owner. The details are to be added in request body.
Note: The country field in mailAddress is not allowed while adding a owner.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating the owner |
No Content |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/owners
Request body
{
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"company" : true,
"companyName" : "string",
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"owner" : true,
"ownerGroupId" : 1,
"ownerPool" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"titleId" : 1
}
Example HTTP response
Response 200
{
"accountNr" : "string",
"alternateName" : "string",
"attentionOf" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"birthPlace" : "string",
"company" : true,
"companyIdentificationNumber" : "string",
"companyName" : "string",
"dac7OwnerVerified" : true,
"emailAllowed" : true,
"firstName" : "string",
"fiscalTypes" : [ {
"endDate" : "01-01-2023",
"fiscalType" : "string",
"fiscalVat" : "string",
"ownerFiscalTypeId" : 1,
"startDate" : "01-01-2023"
} ],
"ibanNumber" : "string",
"languageId" : 1,
"lastName" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"mailAllowed" : true,
"middle" : "string",
"origin" : "string",
"originId" : "string",
"owner" : true,
"ownerGroupId" : 1,
"ownerId" : 1,
"ownerPool" : "string",
"ownerType" : "string",
"questionnaireUnsubscribed" : true,
"sendMethodId" : 1,
"sex" : "string",
"sharedOwnerShips" : [ {
"ownerId" : 1,
"realOwnerId" : 1
} ],
"socialSecurityNumber" : "string",
"socialSecurityNumberIssuingCountryId" : 1,
"taxNumber" : "string",
"taxNumberIssuingCountryId" : 1,
"titleId" : 1
}
5.28.22. updates the customer credentials
PUT /maxxton/v1/owners/{ownerId}/credentials
Description
This endpoint can update the login and password of a owner in Maxxton. The /maxxton/v1/owners/login can be used to check if this login is correct and can be used to authenticate a user in an external system. There is no user session management available. The login and password can be changed in this call. The password can not be fetched from the API because of security reasons. In case the login field or password field is kept empty the existing value will be kept.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Login credentials of the owner to be updated. |
|
Path |
ownerId |
owner id to update the owner credentials |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while updating the owner credentials |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/owners/{ownerId}/credentials
Request body
{
"login" : "string",
"password" : "string"
}
5.29. Packages
Packages
5.29.1. Gets all packages items
GET /maxxton/v1/packages/items
Description
Gets a page of all packages items, records can be filtered based on fields on packages items object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching packages items |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/packages/items
Example HTTP response
Response 200
{
"content" : [ {
"duration" : 1,
"packageResourceId" : 1,
"parentId" : 1,
"quantity" : 1,
"resourceId" : 1,
"sequence" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"packageItemId" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.29.2. Gets all packages items by packageResourceId.
GET /maxxton/v1/packages/{packageResourceId}/items
Description
Gets a list of all packages items, records can be filtered based on fields on packages items object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
packageResourceId |
packageResourceId to fetch particular package |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< PackageItem |
500 |
Error occurred while fetching packages items |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/packages/{packageResourceId}/items
Example HTTP response
Response 200
[ {
"duration" : 1,
"packageResourceId" : 1,
"parentId" : 1,
"quantity" : 1,
"resourceId" : 1,
"sequence" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"packageItemId" : 1
} ]
} ]
5.30. Payment Term Set
Informations related to payment term sets.
5.30.1. Get a page of Payment term sets
GET /maxxton/v1/paymenttermsets
Description
Get all the payment term sets.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching these reservations |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/paymenttermsets
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"maxArrivalDeviation" : 1,
"maxStayLength" : 1,
"minArrivalDeviation" : 1,
"minStayLength" : 1,
"nonRefundable" : true,
"paymentTermSetId" : 1,
"paymentTermSetType" : "string",
"preBooking" : true,
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.31. PointsOfInterests
PointsOfInterests
5.31.1. Gets Points Of Interest
GET /maxxton/v1/pointofinterests
Description
All configured PointsOfInterest. The records can be filtered based on PointsOfInterest object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching PointOfInterests |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/pointofinterests
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"endDate" : "01-01-2023",
"endTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"pointsOfInterestCategoryId" : 1,
"pointsOfInterestId" : 1,
"price" : "string",
"priceAdult" : "string",
"priceChildren" : "string",
"priceValuePoint" : "string",
"priority" : 1,
"resortIds" : [ "integer" ],
"startDate" : "01-01-2023",
"startTime" : {
"hour" : 1,
"minute" : 1,
"nano" : 1,
"second" : 1
},
"translations" : [ {
"description" : "string",
"description2" : "string",
"headText" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"text" : "string"
} ],
"url" : "string",
"visibleFrom" : "01-01-2023",
"visibleTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.31.2. Gets Points OfInterests Categories
GET /maxxton/v1/pointofinterests/categories
Description
All configured PointOfInterestsCategories. The records can be filtered based on PointsOfInterestCategory object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching PointOfInterestsCategories |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/pointofinterests/categories
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"pointsOfInterestCategoryId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.32. PredefinedMemo
Informative text on different entities
5.32.1. Gets a page with predefined memo
GET /maxxton/v1/predefinedmemos
Description
Gets a page with predefined memo. The records can be filtered based on predefined memo object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching memo categories |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/predefinedmemos
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"content" : "string",
"memoCategoryId" : 1,
"preDefinedMemoId" : 1,
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"validFrom" : "01-01-2023T11:23:45Z",
"validTo" : "01-01-2023T11:23:45Z"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.33. Rate Types
A group of different prices of an accommodation type
5.33.1. Gets all Rate types
GET /maxxton/v1/ratetypes
Description
Gets a page with rate types.The records can be filtered based on rate type object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
distributionChannelCode |
distributionChannelCode code to filter rate types. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contract Types. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/ratetypes
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"currencyCode" : "string",
"currencyId" : 1,
"distributionChannels" : [ {
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"distributionChannelId" : 1,
"endDate" : "01-01-2023T11:23:45Z",
"id" : 1,
"startDate" : "01-01-2023T11:23:45Z"
} ],
"isDefault" : true,
"name" : "string",
"priority" : 1,
"rateTypeDchannel" : [ {
"bookdateFrom" : "01-01-2023T11:23:45Z",
"bookdateTo" : "01-01-2023T11:23:45Z",
"distributionChannelId" : 1,
"endDate" : "01-01-2023T11:23:45Z",
"id" : 1,
"startDate" : "01-01-2023T11:23:45Z"
} ],
"rateTypeId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.34. Region
Defines region on a map
5.34.1. Get a region
GET /maxxton/v1/regions/{regionId}
Description
Gets the details of region. The records can be filtered based on region object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
regionId |
An Id of region to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching region |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/regions/{regionId}
Example HTTP response
Response 200
{
"breadCrumbs" : "string",
"childIds" : [ "integer" ],
"code" : "string",
"geoShapePoints" : [ "array" ],
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"priority" : 1,
"regionId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
}
5.34.2. Gets regions
GET /maxxton/v1/regions
Description
Gets a page with regions. The records can be filtered based on region object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnGeoShapePoints |
The geoShapePoints will be returned when the value is set to true |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching regions |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/regions
Example HTTP response
Response 200
{
"content" : [ {
"breadCrumbs" : "string",
"childIds" : [ "integer" ],
"code" : "string",
"geoShapePoints" : [ "array" ],
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"priority" : 1,
"regionId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.35. Rentability
Possible arrival and departure days
5.35.1. Gets a page of Rentability Sets
GET /maxxton/v1/rentability/sets
Description
Gets a page with rentability sets. The records can be filtered based on rentabilityset object. It also supports a pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching rentability sets. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/rentability/sets
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"endDate" : "01-01-2023",
"preBooking" : true,
"rentabilityManagerId" : 1,
"rentabilitySetId" : 1,
"resortId" : 1,
"startDate" : "01-01-2023",
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.35.2. Gets a page of Rentability markers
GET /maxxton/v1/rentability/config
Description
Gets a page with rentability markers. Distribution channel ids and resource id is used to fetch the rentability markers. The records can be filtered based on rentability object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resourceId |
A resourceId to fetch rentability markers |
integer (int64) |
Query |
distributionChannelId |
A distributionChannelId to fetch rentability Markers |
integer (int64) |
Query |
resourceType |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching rentability markers. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/rentability/config
Example HTTP response
Response 200
{
"content" : [ {
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"distributionChannelIds" : [ "integer" ],
"gap" : 1,
"isTemporary" : 1,
"managerId" : 1,
"maxDeviationArrDepDate" : 1,
"maxTimeAfterBookDate" : 1,
"minDeviationArrDepDate" : 1,
"minTimeAfterBookDate" : 1,
"rentabilityId" : 1,
"rentabilityMarkers" : [ {
"dowMask" : 1,
"rentabilityMarkerId" : 1,
"timeMax" : 1,
"timeMin" : 1,
"type" : "string"
} ],
"resourceIds" : [ "integer" ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.35.3. Gets page with rentabilities
GET /maxxton/v1/rentability/stays
Description
Gets a page with stay summaries. Distibution channel id, resource id is used to fetch stay summaries. Max arrival is a date to specify the stay summaries. Maximum duration specifies a duration in minutes which represent day(s).It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
maxArrival |
A maxArrival date to fetch stay summaries |
string (date) |
Query |
resourceId |
A resourceId to fetch stay summaries |
integer (int64) |
Query |
distributionChannelId |
A distributionChannelId to fetch stay summaries |
integer (int64) |
Query |
maxDuration |
Max duration in days to limit records based on duration. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching stay summaries. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/rentability/stays
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDate" : "01-01-2023",
"duration" : 1,
"rentabilityManagerId" : 1,
"validFrom" : "01-01-2023T11:23:45Z",
"validTo" : "01-01-2023T11:23:45Z"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.36. Representation
Defines accommodation type configuration valid for a distribution channel
5.36.1. Add the distribution channel to a representation
POST /maxxton/v1/representations/{representationId}/distributionchannels
Description
The representation is the link between resource(accommodationtype) and distribution channel. One resource(accommodation type) can have multiple representations and one representation can be linked to multiple distribution channel Ids. One distribution channel can only be asses to one representation per resource.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
representationId |
representationId for which distribution channel will be added |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while linking the distribution channel to a representation. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}/distributionchannels
Request body
{
"channelId" : 1,
"code" : "string",
"distributionChannelId" : 1,
"name" : "string",
"path" : "string",
"representationId" : 1
}
5.36.2. Delete representation
DELETE /maxxton/v1/representations/{representationId}
Description
Delete representation of a provided representation id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
representationId |
id of the representation which needs to be deleted |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
representation is deleted without any error. |
No Content |
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}
5.36.3. Get distribution channels based on representation id
GET /maxxton/v1/representations/{representationId}/distributionchannels
Description
Gets a page with distribution channels based on representation id.The records can be filtered based on representation distribution channel object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
representationId |
representationId to fetch the distribution channels of representation |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching distribution channel. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}/distributionchannels
Example HTTP response
Response 200
{
"content" : [ {
"channelId" : 1,
"code" : "string",
"distributionChannelId" : 1,
"name" : "string",
"path" : "string",
"representationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.36.4. Get representation for specific representation id
GET /maxxton/v1/representations/{representationId}
Description
Gets a page with representation for specific representation id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
representationId |
representationId for which representation will be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching representations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}
Example HTTP response
Response 200
{
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
}
5.36.5. Get representations
GET /maxxton/v1/representations
Description
Get a page with representations. The records can be filtered based on representation object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching representations. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/representations
Example HTTP response
Response 200
{
"content" : [ {
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.36.6. Remove distribution channel link from representation
DELETE /maxxton/v1/representations/{representationId}/distributionchannels/{distributionChannelId}
Description
Remove distribution channel link from representation based on specific distribution channel id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
representationId |
id of the representation which needs to be deleted |
integer (int64) |
Body |
requestBody |
||
Path |
distributionChannelId |
id of the distribution channel which needs to be removed from representation |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
From representation distribution channel link is deleted without any error. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}/distributionchannels/{distributionChannelId}
Request body
{
"allotment" : 1,
"distributionChannelId" : 1,
"distributionChannelRepresentationId" : 1,
"distributionChannelRepresentationParentId" : 1,
"representationId" : 1
}
5.36.7. Update representation
PUT /maxxton/v1/representations/{representationId}
Description
Update representation of provided representationId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
representationId |
representationId of representation which needs to be update |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating representation. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/representations/{representationId}
Request body
{
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
}
Example HTTP response
Response 200
{
"bookable" : true,
"distributionChannelIds" : [ "integer" ],
"representationId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"i18nRepresentationId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"representationId" : 1,
"shortDescription" : "string"
} ],
"visible" : true
}
5.37. Resellers
Agent who are selling accommodation types
5.37.1. Gets a page holding ResellerStopSells.
GET /maxxton/v1/resellers/{resellerId}/stopsells
Description
Gets a page holding ResellerStopSells of a specific reseller id.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resellerId |
resellrId to fetch ResellerStopSell |
integer (int64) |
Query |
stopSellType |
enumerated value of type StopSellType to fetch ResellerStopSell(s) |
enum (BLOCKING,LOWERING,RESTRICTION) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resellers. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resellers/{resellerId}/stopsells
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"resellerId" : 1,
"resellerStopSellId" : 1,
"reservableValue" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"stopSellType" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.37.2. Gets a page holding Resellers
GET /maxxton/v1/resellers
Description
Get a page holding Resellers objects.The records can be filtered based on reseller object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resellers. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resellers
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"description" : "string",
"distributionChannelId" : 1,
"name" : "string",
"resellerId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.37.3. Gets a single Reseller by it’s Id.
GET /maxxton/v1/resellers/{resellerId}
Description
Gets a single Reseller by its Id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resellerId |
resellerId to fetch reseller |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reseller. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resellers/{resellerId}
Example HTTP response
Response 200
{
"code" : "string",
"description" : "string",
"distributionChannelId" : 1,
"name" : "string",
"resellerId" : 1
}
5.38. Reservability
Number of units available
5.38.1. Gets a Reservability by resource filter
GET /maxxton/v1/resourcereservability
Description
Gets a page of reservability resource. The records can be filtered based on resource reservability object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resourceId |
Resource id for which the result is valid |
string |
Query |
resourceType |
Resource type of the resourceid |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservability |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resourcereservability
Example HTTP response
Response 200
{
"content" : [ {
"allocatable" : 1,
"endDate" : "01-01-2023",
"modifiedDate" : "01-01-2023T11:23:45Z",
"reservabilityId" : 1,
"reservable" : 1,
"reserved" : 1,
"resourceId" : 1,
"resourceType" : "string",
"startDate" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.38.2. Gets free allotments for resource reservability.
GET /maxxton/v1/resourcereservability/allotment
Description
The above endpoint gets the free allotments for reservability of resources and the records can be filtered based on fields of ResourceReservabilityAllotment, the max period of start and endDate should not exceed more than 2 years.
There could be some overlapping period for same resourceId and distributionChannelId, so in such case free allotments for the overlapping dates should be merged and calculated based on start date and end date.and the total free allotments for a specific date can be calculated by considering all the records which are overlapping for the specific date.
Example: for a resource id : 12345 and distribution channel id : 67890, The allotment for the entire period of 7th sept 2016 to 14th sept 2016 is 3 but the allotment period is defined as free allotment for 7th sept - 14th sept is 2 and from 9th sept to 14th sept is 1 so the user has to merge these allotments which sums up to 3.
The above endpoint also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resourceId |
The identifier of the ResourceId to fetch resource reservability |
integer (int64) |
Query |
endDate |
The identifier of the EndDate to fetch resource reservability |
string (date) |
Query |
startDate |
The identifier of the StartDate to fetch resource reservability |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
401 |
Unauthorized access, Please check your access token. |
No Content |
500 |
Error occurred while fetching free allotments reservability |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resourcereservability/allotment
Example HTTP response
Response 200
{
"content" : [ {
"bookedAllotments" : 1,
"distributionChannelId" : 1,
"endDate" : "01-01-2023",
"freeAllotments" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"totalAllotments" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.38.3. Gets free allotments for unit reservability.
GET /maxxton/v1/unitreservability/allotment
Description
Get free allotments for reservability of units, records can be filtered based on fields of ReservedResourceUnitAllotment.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
distributionChannelId |
The identifier of the DistributionChannel to fetch unit reservability |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
401 |
Unauthorized access, Please check your access token. |
No Content |
500 |
Error occurred while fetching free allotments reservability |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/unitreservability/allotment
Example HTTP response
Response 200
{
"content" : [ {
"distributionChannelId" : 1,
"endDate" : "01-01-2023",
"freeAllotments" : 1,
"modifiedDate" : "01-01-2023T11:23:45Z",
"resourceId" : 1,
"startDate" : "01-01-2023",
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.38.4. Gets unit reservability periods.
GET /maxxton/v1/unitreservability/period
Description
Gets a list of unit reservability periods. Records can be filtered based on domain holding values for unit reservability search filter.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
endDate |
string (date) |
|
Query |
unitId |
< integer > array |
|
Query |
startDate |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservability |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/unitreservability/period
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"reservability" : "string",
"startDate" : "01-01-2023",
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.38.5. Gets unit reservability.
GET /maxxton/v1/unitreservability
Description
Get a list of unit reservability. The records can be filtered based on unit reservability search object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resourceId |
resourceId for filtering unitReservability |
integer (int64) |
Query |
unitId |
unitId for filtering unitReservability |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservability |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/unitreservability
Example HTTP response
Response 200
{
"content" : [ {
"allocatable" : 1,
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"modifiedDate" : "01-01-2023T11:23:45Z",
"reservabilityId" : 1,
"reservable" : 1,
"reserved" : 1,
"resourceId" : 1,
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39. Reservations
Customer booking of an accommodation
5.39.1. Add additions
POST /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Description
Addition is an optional resource which guest can opt and book it. This endpoint can be used to reserve/book addition with an existing reservation's reserved resource.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id to which additions will be added |
integer (int64) |
Path |
reservedResourceId |
ReservedResource id to which additions will be added |
integer (int64) |
Body |
requestBody |
< AdditionRequest |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while adding additions |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Request body
[ {
"endDate" : "01-01-2023",
"memo" : "string",
"name" : "string",
"price" : 1,
"quantity" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023"
} ]
5.39.2. Add custom fields
POST /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Description
Custom fields are part of the reservation that can be updated for a particular reservation. This endpoint can be used to added custom field to the reservation .
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id to which custom field will be added |
integer (int64) |
Path |
reservedResourceId |
ReservedResource id to which custom field will be added |
integer (int64) |
Body |
requestBody |
< CustomField |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while adding custom fields |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Request body
[ {
"booleanValue" : true,
"dateValue" : "01-01-2023",
"fieldId" : 1,
"numericValue" : 1,
"selectValues" : [ "string" ],
"textValue" : "string"
} ]
5.39.3. Add payment for reservation
POST /maxxton/v1/reservations/{reservationId}/payments
Description
Creates payment for a reservation for a specific reservationId. The payment details are to be added to the request body. The distribution channel in the authorization token should be same as the one in reservation for which the payment is being created. If the distribution channel is not present in the token, the reservation distribution channel will be used.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which the payment has to be added. |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
400 |
The distribution channel present in the authorization token does not match the distribution channel of the reservation. |
No Content |
500 |
Error occurred while adding payments for the reservation. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/payments
Request body
{
"amount" : 1,
"currencyCode" : "string",
"paymentMethodCode" : "string",
"remark" : "string"
}
Example HTTP response
Response 200
{
"amount" : 1,
"currencyCode" : "string",
"paymentMethodCode" : "string",
"remark" : "string"
}
5.39.4. Create emergency contact for reservation
POST /maxxton/v1/reservations/{reservationId}/emergencycontacts
Description
Creates emergency contact for a reservation for specific reservationId. The emergency contact details are to be added to the request body.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which emergency contact will be created for reservation |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating emergency contact. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/emergencycontacts
Request body
{
"emergencyContactId" : 1,
"firstName" : "string",
"lastName" : "string",
"middleName" : "string",
"phone" : "string",
"relationship" : "string",
"reservationId" : 1
}
Example HTTP response
Response 200
{
"emergencyContactId" : 1,
"firstName" : "string",
"lastName" : "string",
"middleName" : "string",
"phone" : "string",
"relationship" : "string",
"reservationId" : 1
}
5.39.5. Create memo for reservation
POST /maxxton/v1/reservations/{reservationId}/memos
Description
Creates memo for a reservation for specific reservationId. The memo details are to be added to the request body.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which memo will be created for reservation |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating memo. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/memos
Request body
{
"memoCategoryId" : 1,
"onCheckin" : true,
"onInvoice" : true,
"sensitive" : true,
"text" : "string"
}
Example HTTP response
Response 200
{
"content" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"employeeId" : 1,
"memoCategoryId" : 1,
"memoId" : 1,
"predefinedMemoId" : 1
}
5.39.6. Creates a new reservation
POST /maxxton/v1/reservations
Description
Creates a new reservation based on given criteria.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Reservation criteria based on given detail new reservation will create |
|
Header |
locale |
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc. |
string |
Query |
returnBill |
The customer bill will be returned when the value is set to true |
boolean |
Query |
returnInstalments |
The instalments will be returned when the value is set to true |
boolean |
Query |
skipAvailabilityIndexCheck |
This parameter will skip the check on availability based on the Elastic search availability index. This can be used if a reservation needs to be made when you can’t wait for the index to be updated. It’s recommended to not use this parameter in case you are not really sure what you are doing. By default, this check is always there because it’s giving better performance in case of no availability. When this parameter is true - unitId is mandatory in request. |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
408 |
Reservation creation timed out |
No Content |
500 |
Error occurred while creating reservation |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations
Request body
{
"accommodationTypes" : [ {
"additions" : [ {
"additionResourceId" : 1,
"endDate" : "01-01-2023",
"memo" : "string",
"quantity" : 1,
"startDate" : "01-01-2023"
} ],
"arrivalDate" : "01-01-2023",
"duration" : 1,
"offerCode" : "string",
"preferences" : [ {
"id" : 1,
"remark" : "string",
"type" : "string"
} ],
"rateTypeId" : 1,
"removeImplies" : [ "integer" ],
"resourceId" : 1,
"subjects" : {
"persons" : [ {
"age" : 1,
"quantity" : 1
} ],
"petsQuantity" : 1
},
"travelParties" : [ {
"birthDate" : "01-01-2023",
"firstName" : "string",
"identityCardNumber" : "string",
"identityNumber" : "string",
"identityType" : "string",
"lastName" : "string",
"middleName" : "string",
"sex" : "string"
} ],
"unitId" : 1,
"useLoyaltyFreeNights" : 1,
"useLoyaltyPoints" : 1,
"vehicles" : [ {
"remark" : "string",
"subjectId" : 1,
"vehicleRegistrationMark" : "string"
} ],
"voucherCode" : "string"
} ],
"categoryCode" : "string",
"customer" : {
"alternateName" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"emailAllowed" : true,
"firstName" : "string",
"language" : "string",
"lastName" : "string",
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"city" : "string",
"countryCode" : "string",
"district" : "string",
"email" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"questionnaireUnsubscribed" : true,
"sex" : "string",
"socialSecurityNumber" : "string",
"titleId" : 1
},
"customerId" : 1,
"distributionChannelCode" : "string",
"employee" : "string",
"externalBookingReference" : "string",
"paymentTermSetId" : 1,
"remark" : "string",
"sendMethodCode" : "string",
"statusValue" : "string"
}
Example HTTP response
Response 200
{
"agentBill" : [ {
"billLineType" : 1,
"description" : "string",
"endDate" : "01-01-2023",
"name" : "string",
"redeemedLoyaltyNights" : 1,
"redeemedLoyaltyPoints" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"vatRate" : 1
} ],
"arrivalDate" : "01-01-2023",
"currencyCode" : "string",
"customerBill" : [ {
"billLineType" : 1,
"description" : "string",
"endDate" : "01-01-2023",
"name" : "string",
"redeemedLoyaltyNights" : 1,
"redeemedLoyaltyPoints" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"vatRate" : 1
} ],
"customerId" : 1,
"departureDate" : "01-01-2023",
"externalBookingReference" : "string",
"infotexts" : [ {
"description" : "string"
} ],
"instalments" : [ {
"autopay" : true,
"due" : 1,
"dueDate" : "01-01-2023",
"issueDate" : "01-01-2023",
"payerType" : "string",
"status" : "string",
"taxValue" : 1,
"term" : "string",
"value" : 1
} ],
"paymentTermSetId" : 1,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservationInfoTexts" : [ {
"code" : "string",
"description" : "string",
"display" : true,
"infoTextId" : 1,
"name" : "string",
"reservations" : [ {
"display" : true,
"infoTextId" : 1,
"infoTextReservationId" : 1,
"reservedResourceId" : 1
} ],
"reservedResourceId" : 1
} ],
"reservationNumber" : "string",
"reservedResources" : [ {
"code" : "string",
"description" : "string",
"endDate" : "01-01-2023",
"hasPriceOverride" : true,
"impliesId" : 1,
"imply" : true,
"infotexts" : [ {
"description" : "string"
} ],
"name" : "string",
"offerType" : "string",
"parentId" : 1,
"price" : 1,
"quantity" : 1,
"removable" : true,
"reservedResourceId" : 1,
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"type" : "string",
"unitId" : 1
} ],
"resortId" : 1,
"status" : 1,
"statusValue" : "string"
}
5.39.7. Creates a reservation proposal
POST /maxxton/v1/reservations/proposals
Description
Creates a reservation proposal based on given criteria. The endpoint provides the availability for a particular property for particular duration. It also provides a virtual bill to the user which contains all the possible additions for a reservation, the currency code is displayed in which the bill will be calculated, customers arrival and departure date, customer bill, installments etc. We can specify the information that we want to view in response i.e there are different query parameters to filter the response. The additions displayed in reservation proposal are displayed on the basis of show moments. There are four show moments for additions i.e mobile, internet, my environment and newyse. The show moments is displayed in the reservation proposal only if the show moment is internet.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Query |
returnAdditions |
The applicable additions will be returned when the value is set to true |
boolean |
Query |
returnUnits |
The list of available unit will be returned when the value is set to true. |
boolean |
Header |
locale |
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc. |
string |
Query |
returnBill |
The customer bill will be returned when the value is set to true |
boolean |
Query |
returnInstalments |
The instalments of reservation will be returned when the value is set to true |
boolean |
Query |
returnPaymentOptions |
This parameter will provide all possible payment term sets available, including the instalments for the provided criteria. The payment term set id can be provided in the “paymenttermsetid“ in the request to use the payment option. In case no payment option is set, it will take the one with the highest priority. |
boolean |
Query |
skipAvailabilityIndexCheck |
This parameter will skip the check on availability based on the Elastic search availability index. This can be used if a reservation needs to be made when you can’t wait for the index to be updated. It’s recommended to not use this parameter in case you are not really sure what you are doing. By default, this check is always there because it’s giving better performance in case of no availability. When this parameter is true - unitId is mandatory in the request. |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation proposal |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/proposals
Request body
{
"accommodationTypes" : [ {
"additions" : [ {
"additionResourceId" : 1,
"endDate" : "string",
"quantity" : 1,
"startDate" : "string"
} ],
"arrivalDate" : "01-01-2023",
"duration" : 1,
"offerCode" : "string",
"preferences" : [ {
"id" : 1,
"remark" : "string",
"type" : "string"
} ],
"rateTypeId" : 1,
"removeImplies" : [ "integer" ],
"resourceId" : 1,
"subjects" : {
"persons" : [ {
"age" : 1,
"quantity" : 1
} ],
"petsQuantity" : 1
},
"unitId" : 1,
"useLoyaltyFreeNights" : 1,
"useLoyaltyPoints" : 1,
"voucherCode" : "string"
} ],
"categoryCode" : "string",
"customerId" : 1,
"distributionChannelCode" : "string",
"paymentTermSetId" : 1
}
Example HTTP response
Response 200
{
"additions" : [ {
"additionResourceId" : 1,
"addonType" : "string",
"code" : "string",
"currency" : "string",
"dayProductBookableDates" : [ "string" ],
"description" : "string",
"endDate" : "01-01-2023",
"maxQuantity" : 1,
"maxReservable" : 1,
"minQuantity" : 1,
"name" : "string",
"perSubject" : true,
"price" : 1,
"resortArticle" : true,
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"stockType" : "string",
"type" : "string"
} ],
"agentBill" : [ {
"billLineType" : 1,
"multiplier" : 1,
"name" : "string",
"quantity" : 1,
"redeemedLoyaltyNights" : 1,
"redeemedLoyaltyPoints" : 1,
"resourceId" : 1,
"total" : 1,
"value" : 1,
"vatRate" : 1
} ],
"arrivalDate" : "01-01-2023",
"currencyCode" : "string",
"customerBill" : [ {
"billLineType" : 1,
"multiplier" : 1,
"name" : "string",
"quantity" : 1,
"redeemedLoyaltyNights" : 1,
"redeemedLoyaltyPoints" : 1,
"resourceId" : 1,
"total" : 1,
"value" : 1,
"vatRate" : 1
} ],
"departureDate" : "01-01-2023",
"infotexts" : [ {
"description" : "string",
"display" : "string",
"name" : "string"
} ],
"instalments" : [ {
"autopay" : true,
"due" : 1,
"dueDate" : "01-01-2023",
"issueDate" : "01-01-2023",
"payerType" : "string",
"status" : "string",
"taxValue" : 1,
"term" : "string",
"value" : 1
} ],
"preBooking" : true,
"reservedResources" : [ {
"addOnMetricDescription" : "string",
"code" : "string",
"description" : "string",
"endDate" : "01-01-2023",
"hasPriceOverride" : true,
"impliesId" : 1,
"imply" : true,
"infotexts" : [ {
"description" : "string",
"display" : "string",
"name" : "string"
} ],
"internetAdditionalCost" : true,
"name" : "string",
"offerType" : "string",
"price" : 1,
"quantity" : 1,
"removable" : true,
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"type" : "string",
"unitId" : 1
} ],
"unitIds" : [ "integer" ]
}
5.39.8. Delete a specific travelparty, vehicle or equipment from the reservation.
DELETE /maxxton/v1/reservations/{reservationId}/subjects/{reservationSubjectId}
Description
Delete a specific travelparty, vehicle or equipment from the reservation.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationSubjectId |
Reservation subject id of the subject to be deleted. |
integer (int64) |
Path |
reservationId |
Reservation id for which the subjects are to be deleted |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
specific reservation subject is deleted without any error. |
No Content |
404 |
No reservation found for given reservation id. |
No Content |
500 |
Error occurred while deleting reservation subject |
No Content |
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects/{reservationSubjectId}
5.39.9. Delete reservedResource
DELETE /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
Description
Delete exiting reservedResource for the given reservationId and reservedResourceId as per the given criteria
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Id of the reservation which needs to be updated. |
integer (int64) |
Path |
reservedResourceId |
Id of the reservedresource which needs to be updated |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while updating reservedResource |
No Content |
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
5.39.10. Get Reservation Payment Link
GET /maxxton/v1/reservations/{reservationId}/paymentlink
Description
Generate a PSP(payment service provider) payment link to pay for the reservation. This will provide a url which can be used by the customer to make the payment from the hosted payment page of the psp. When the payment is succesful it will automatically be added to the reservation in the Maxxton system.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
acceptUrl |
URL where the customer should be redirected to in case of a successful payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct |
string |
Query |
exceptionUrl |
URL where the customer should be redirected to in case of a failed payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct |
string |
Header |
locale |
The name field in paymentPage generate along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc. |
string |
Query |
homeUrl |
Home Url of website. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct |
string |
Query |
storeCC |
When the value is set to true, the customer’s credit card details will be saved, and a reservation payment token will be generated for further payments |
boolean |
Query |
cancelUrl |
URL where the customer should be redirected to in case of a canceled payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct |
string |
Query |
payerType |
Payer type of payment |
enum (PAYING_CUSTOMER,AGENT,CUSTOMER) |
Path |
reservationId |
The reservation id defines the reservation the payment goes to. When a payment comes in from Ingenico the open amount of this reservation will be deducted with the amount paid at Ingenico. |
integer (int64) |
Query |
countryCode |
CountryCode(e.g. NL/FR) required to fetch the correct payment methods from Ingenico to be used with paymentMethods parameter. This countrycode is not impacting the actual language or locale of the Ingenico page |
string |
Query |
declineUrl |
URL where the customer should be redirected to in case of a declined payment. This parameter is only supported in legacy Ingenico and not supported in Ingenico Direct |
string |
Query |
price |
Amount to be paid, this can be the full reservation amount or part of it. |
number (double) |
Query |
paymentMethods |
Payment methods list which will be shown on payment page. Incase not provided all configured payment methods will be shown. To restrict the payment methods, take the paymentMethod field values from the following endpoint https://developers.maxxton.com/maxxton/v1/swagger/index.html#/Reservations/getReservationPaymentMethod Then, pass the paymentMethod obtained from this endpoint in the generatePaymentLink requestParam. |
< string > array |
Query |
returnUrl |
The returnUrl parameter specifies the URL to which a customer is redirected after completing a transaction on the Ingenico Direct payment page. This parameter is specific to Ingenico Direct and simplifies the redirection process by consolidating multiple URL parameters used in the legacy Ingenico platform into a single parameter. In the legacy platform, separate URLs (such as declineUrl, acceptUrl, cancelUrl, homeUrl, and exceptionUrl) are used based on the transaction result. These fields are replaced in Ingenico Direct to this single redirection URL(returnUrl). |
string |
Query |
currencyCode |
Code of currency in which payment will be charged |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating payment page link |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/paymentlink
Example HTTP response
Response 200
{
"url" : "string"
}
5.39.11. Get a Reservation details by reservation id
GET /maxxton/v1/reservations/{reservationId}/details
Description
Get a Reservation details by reservation id. Archived resources will also be returned in the response.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
The identifier of the reservation. |
integer (int64) |
Query |
returnEmergencyContacts |
The emergency contacts will be returned when the value is set to true |
boolean |
Query |
returnReservedResources |
The reserved resource will be returned when the value is set to true |
boolean |
Query |
returnFreeFields |
The free fields of reserved resource will be returned when the value is set to true |
boolean |
Query |
returnCustomerStatus |
The customer status will be returned when the value is set to true |
boolean |
Header |
locale |
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc. |
string |
Query |
returnBill |
The instalments will be returned when the value is set to true |
boolean |
Query |
returnSections |
List of constant strings to return only the selected sections in the response. The possible values are AGENTBILL, CUSTOMER, CUSTOMERBILL, CUSTOMERSTATUS, EMERGENCYCONTACTS, INFOTEXTS, INSTALMENTS, RESERVEDRESOURCES. 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. |
< string > array |
Query |
returnCustomer |
The customer will be returned when the value is set to true |
boolean |
Query |
returnInstalments |
The instalments will be returned when the value is set to true |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No reservation found for given reservation id. |
No Content |
500 |
Error occurred while fetching this reservation |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/details
Example HTTP response
Response 200
{
"agentBill" : [ {
"billLineType" : 1,
"endDate" : "01-01-2023",
"multiplier" : 1,
"name" : "string",
"quantity" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"value" : 1,
"vatRate" : 1
} ],
"arrivalDate" : "01-01-2023",
"cancelDate" : "01-01-2023",
"categoryCode" : "string",
"currencyCode" : "string",
"currencyId" : 1,
"customer" : {
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"lastName" : "string",
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"socialSecurityNumber" : "string",
"title" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"title" : "string"
} ]
}
},
"customerBill" : [ {
"billLineType" : 1,
"endDate" : "01-01-2023",
"multiplier" : 1,
"name" : "string",
"quantity" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"value" : 1,
"vatRate" : 1
} ],
"customerId" : 1,
"customerStatus" : {
"customerCluseters" : [ {
"clusterId" : 1,
"code" : "string",
"description" : "string",
"name" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"customerClusters" : [ {
"clusterId" : 1,
"code" : "string",
"description" : "string",
"name" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ]
},
"departureDate" : "01-01-2023",
"distributionChannelCode" : "string",
"distributionChannelId" : 1,
"emergencyContacts" : [ {
"emergencyContactId" : 1,
"firstName" : "string",
"lastName" : "string",
"middleName" : "string",
"phone" : "string",
"relationship" : "string",
"reservationId" : 1
} ],
"employeeId" : 1,
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedArrivalTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureTime" : "01-01-2023T11:23:45Z",
"externalBookingReference" : "string",
"infotexts" : [ {
"description" : "string"
} ],
"instalments" : [ {
"autopay" : true,
"due" : 1,
"dueDate" : "01-01-2023",
"issueDate" : "01-01-2023",
"payerType" : "string",
"status" : "string",
"taxValue" : 1,
"term" : "string",
"value" : 1
} ],
"modifiedDate" : "01-01-2023T11:23:45Z",
"parentId" : 1,
"payingCustomer" : {
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"lastName" : "string",
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"socialSecurityNumber" : "string",
"title" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"title" : "string"
} ]
}
},
"payingCustomerId" : 1,
"paymentTermSetId" : 1,
"previousPmsId" : 1,
"reservationCategoryId" : 1,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservationInfoTexts" : [ {
"code" : "string",
"description" : "string",
"display" : true,
"infoTextId" : 1,
"name" : "string",
"reservations" : [ {
"display" : true,
"infoTextId" : 1,
"infoTextReservationId" : 1,
"reservedResourceId" : 1
} ],
"reservedResourceId" : 1
} ],
"reservationKind" : "string",
"reservationNumber" : "string",
"reservedResources" : [ {
"amenities" : [ {
"amenityId" : 1,
"categories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"metricDetail" : {
"code" : "string",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"metricId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"parentAmenityId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string"
} ],
"cancellationPremium" : true,
"code" : "string",
"description" : "string",
"endDate" : "01-01-2023",
"freeFields" : [ {
"dataTypeName" : "string",
"fieldId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"value" : "string"
} ],
"impliesId" : 1,
"imply" : true,
"included" : true,
"infotexts" : [ {
"description" : "string"
} ],
"modifiedDate" : "01-01-2023T11:23:45Z",
"name" : "string",
"nightsRedeemed" : 1,
"offerType" : "string",
"parentId" : 1,
"pointsRedeemed" : 1,
"preferences" : [ {
"id" : 1,
"type" : "string"
} ],
"price" : 1,
"quantity" : 1,
"rateType" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"rateTypeId" : 1,
"removable" : true,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservedResourceId" : 1,
"resortArticle" : true,
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"status" : 1,
"subjects" : [ {
"maxAge" : 1,
"quantity" : 1,
"subjectId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string",
"unit" : {
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"unitId" : 1
},
"unitId" : 1
} ],
"resortId" : 1,
"sendMethodId" : 1,
"status" : 1,
"statusValue" : "string",
"supplierBookingReference" : "string",
"tncSigned" : true,
"tncSignedDate" : "01-01-2023",
"tncSigneeCustomerName" : "string",
"validationStatusId" : 1,
"voucher" : "string",
"vouchers" : [ {
"amount" : 1,
"blockReason" : "string",
"reservationId" : 1,
"status" : "string",
"voucher" : {
"blockReason" : "string",
"code" : "string",
"employeeId" : 1,
"employeeName" : "string",
"generationDate" : "01-01-2023",
"numberOfVouchers" : 1,
"originalReservationId" : 1,
"printCount" : 1,
"resourceCode" : "string",
"status" : "string",
"type" : "string",
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023",
"voucherCriteriaId" : 1,
"voucherId" : 1,
"voucherOriginalValue" : 1,
"voucherSetCashResourceId" : 1,
"voucherSetId" : 1,
"voucherSetName" : "string",
"voucherSetResourceCode" : "string",
"voucherTypeName" : "string",
"voucherValue" : 1
},
"voucherId" : 1,
"voucherRedemptionId" : 1
} ]
}
5.39.12. Get a list of preferences by reservation id
GET /maxxton/v1/reservations/{reservationId}/preferences
Description
Get a list of preferences by reservation id. The preferences are used to identify specific unit preference, to guarantee that the customer will stay in the unit he/she chose.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which the preferences are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< ReservedResourcePreference |
404 |
No reservation or preferences found for given reservation id. |
No Content |
500 |
Error occurred while fetching preferences |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/preferences
Example HTTP response
Response 200
[ {
"remark" : "string",
"reservationId" : 1,
"reservedResourceBase" : {
"actualEndDate" : "01-01-2023",
"actualStartDate" : "01-01-2023",
"cancellationPremium" : true,
"code" : "string",
"description" : "string",
"employeeId" : 1,
"endDate" : "01-01-2023",
"hasPriceOverride" : true,
"impliesId" : 1,
"imply" : true,
"implyOnce" : true,
"included" : true,
"modifiedDate" : "01-01-2023T11:23:45Z",
"name" : "string",
"offerType" : "string",
"onBill" : true,
"overrideEmployeeId" : 1,
"overrideValue" : 1,
"parentId" : 1,
"price" : 1,
"quantity" : 1,
"rateTypeId" : 1,
"removable" : true,
"representationId" : 1,
"resellerAddonCode" : "string",
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservedResourceId" : 1,
"resourceCode" : "string",
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"statusName" : "string",
"totalInternalPrice" : 1,
"turnOverValue" : 1,
"type" : "string",
"unitId" : 1,
"vatRate" : 1
},
"reservedResourceId" : 1,
"reservedResourcePreferenceId" : 1,
"type" : "string"
} ]
5.39.13. Get a page of Reservations
GET /maxxton/v1/reservations
Description
Get all the reservations for particular concern as per the access token and if dc is null then all the reservations of all the dcs are fetched in response.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
distributionChannelCode |
If DC is present in the access token then the reservations of that DC will be retrieved. If DC is null in access token then the DC entered in filter will be considered. If both DCs are null then all the reservations from all the dc will be fetched. |
string |
Query |
reservationIds |
< integer > array |
|
Query |
customeremail |
string |
|
Query |
resourceId |
integer (int64) |
|
Query |
accommodationtypecode |
string |
|
Query |
unitId |
The unitId for filtering the reservations |
integer (int64) |
Query |
customerName |
Filter reservations on customer name. Customer name should be provided in the format specified as: {first name} {middle name} {last name}. Ex: first name = x, middle name = y and last name = z, then the filter field will be passed as: customerName=x y z. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
204 |
No reservations found for given criteria. |
No Content |
500 |
Error occurred while fetching these reservations |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDate" : "01-01-2023",
"cancelDate" : "01-01-2023",
"categoryCode" : "string",
"categoryName" : "string",
"customerId" : 1,
"departureDate" : "01-01-2023",
"distributionChannelId" : 1,
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedArrivalTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureTime" : "01-01-2023T11:23:45Z",
"expireDate" : "01-01-2023T11:23:45Z",
"externalBookingReference" : "string",
"memoManagerId" : 1,
"modifiedDate" : "01-01-2023T11:23:45Z",
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"payingCustomerId" : 1,
"paymentTermSetId" : 1,
"printedDate" : "01-01-2023",
"resellerId" : 1,
"reservationCategoryId" : 1,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservationKind" : "string",
"reservationNumber" : "string",
"resortId" : 1,
"sendMethodId" : 1,
"status" : 1,
"statusValue" : "string",
"supplierVoucher" : "string",
"tncSigned" : true,
"tncSignedDate" : "01-01-2023",
"tncSigneeCustomerName" : "string",
"type" : "string",
"validationStatus" : 1,
"voucher" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.14. Get a page of preferences by reservation ids
GET /maxxton/v1/reservations/preferences
Description
Get a page of preferences by reservation ids. The preferences are used to identify specific unit preference, to guarantee that the customer will stay in the unit he/she chose.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
reservationIds |
Reservation ids for which the preferences are to be fetched |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching preferences |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/preferences
Example HTTP response
Response 200
{
"content" : [ {
"id" : 1,
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.15. Get a reservation infotexts by reservation id. Archived resources will also be returned in the response.
GET /maxxton/v1/reservations/{reservationId}/infotexts
Description
Get a reservation infotexts by reservation id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
The identifier of the reservation. |
integer (int64) |
Header |
locale |
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors. |
< InfotextResponse |
404 |
No reservation found for given reservation id. |
No Content |
500 |
Error occurred while fetching this reservation. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/infotexts
Example HTTP response
Response 200
[ {
"description" : "string",
"display" : true,
"name" : "string"
} ]
5.39.16. Get a reservation journal by reservation id.
GET /maxxton/v1/reservations/{reservationId}/journals
Description
Get a reservation Journal by reservation id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which journal is to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors. |
< JournalResponse |
404 |
No reservation found for given reservation id. |
No Content |
500 |
Error occurred while fetching this reservation. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/journals
Example HTTP response
Response 200
[ {
"accountName" : "string",
"comments" : "string",
"contractType" : "string",
"costCenter" : "string",
"creditVatExcluded" : 1,
"creditVatIncluded" : 1,
"customerId" : 1,
"debitVatExcluded" : 1,
"debitVatIncluded" : 1,
"distributionChannelCountryCode" : "string",
"distributionChannelId" : 1,
"ledgerNumber" : "string",
"mutationDate" : "01-01-2023T11:23:45Z",
"ownerName" : "string",
"referenceNumber" : 1,
"reportId" : 1,
"reportNumber" : 1,
"reservationId" : 1,
"reservationNumber" : "string",
"reservedResourceId" : 1,
"resortId" : 1,
"resourceCode" : "string",
"secondLedgerNumber" : "string",
"settlementNumber" : 1,
"statementDate" : "01-01-2023",
"statementNumber" : "string",
"type" : "string",
"workOrderId" : 1
} ]
5.39.17. Get a single Reservation by reservation id
GET /maxxton/v1/reservations/{reservationId}
Description
Get a single Reservation by reservation id. You can use other calls, like /content or /customers to gather more detailed information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
The identifier of the reservation. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No reservation found for given reservation id. |
No Content |
500 |
Error occurred while fetching this reservation |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}
Example HTTP response
Response 200
{
"arrivalDate" : "01-01-2023",
"cancelDate" : "01-01-2023",
"categoryCode" : "string",
"categoryName" : "string",
"customerId" : 1,
"departureDate" : "01-01-2023",
"distributionChannelId" : 1,
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedArrivalTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureTime" : "01-01-2023T11:23:45Z",
"expireDate" : "01-01-2023T11:23:45Z",
"externalBookingReference" : "string",
"memoManagerId" : 1,
"modifiedDate" : "01-01-2023T11:23:45Z",
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"payingCustomerId" : 1,
"paymentTermSetId" : 1,
"printedDate" : "01-01-2023",
"resellerId" : 1,
"reservationCategoryId" : 1,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservationKind" : "string",
"reservationNumber" : "string",
"resortId" : 1,
"sendMethodId" : 1,
"status" : 1,
"statusValue" : "string",
"supplierVoucher" : "string",
"tncSigned" : true,
"tncSignedDate" : "01-01-2023",
"tncSigneeCustomerName" : "string",
"type" : "string",
"validationStatus" : 1,
"voucher" : "string"
}
5.39.18. Get additions
GET /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Description
Get additions for given reservedResourceId and reservationId
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which application resource additions to be fetch |
integer (int64) |
Path |
reservedResourceId |
ReservedResource id for which application resource additions to be fetch |
integer (int64) |
Header |
locale |
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc. |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching additions |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/additions
Example HTTP response
Response 200
{
"content" : [ {
"addonType" : "string",
"allowPriceOverride" : true,
"code" : "string",
"completed" : true,
"description" : "string",
"endDate" : "01-01-2023",
"maxQuantity" : 1,
"minQuantity" : 1,
"name" : "string",
"price" : 1,
"resortArticle" : true,
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"supplierId" : 1,
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.19. Get reservation details
GET /maxxton/v1/reservations/details
Description
Get reservation details.
Maximum page size for this endpoint is 10.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
returnCustomerStatus |
The customer status will be returned when the value is set to true |
boolean |
Query |
reservedResourceStatusIds |
Filter reservations based on reserved resource status ids |
< integer > array |
Header |
locale |
The name field in bill and reservedResources along with the infoTexts will be translated according to the locale passed, example for possible values: en(English), nl(Dutch), fr(French) etc. |
string |
Query |
returnSections |
List of constant strings to return only the selected sections in the response. The possible values are AGENTBILL, CUSTOMER, CUSTOMERBILL, CUSTOMERSTATUS, EMERGENCYCONTACTS, INFOTEXTS, INSTALMENTS, RESERVEDRESOURCES. 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. |
< string > array |
Query |
accommodationKindIds |
Filter response based on accommodation kind ids. Its mandatory to pass either reservationIds or customerIds in request with accommodationKindIds. |
< integer > array |
Query |
reservedResourceType |
Filter reservations based on reserved resource type |
string |
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
reservationIds |
Filter reservations based on reservation ids |
< integer > array |
Query |
returnReservedResources |
The reserved resources will be returned when the value is set to true |
boolean |
Query |
reservationNumber |
The identifier of the reservation |
string |
Query |
returnFreeFields |
The free fields will be returned when the value is set to true |
boolean |
Query |
customerIds |
Filter reservations based on customer ids |
< integer > array |
Query |
distributionChannelId |
Filter reservations based on distribution channel id |
integer (int64) |
Query |
reservationCategoryIds |
Filter reservations based on reservation category ids |
< integer > array |
Query |
returnBill |
The reservation bill will be returned when the value is set to true |
boolean |
Query |
statusIds |
Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41) |
< integer > array |
Query |
returnCustomer |
The customer information will be returned when the value is set to true |
boolean |
Query |
returnInstalments |
The reservation instalments will be returned when the value is set to true |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching this reservation |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/details
Example HTTP response
Response 200
{
"content" : [ {
"agentBill" : [ {
"billLineType" : 1,
"endDate" : "01-01-2023",
"multiplier" : 1,
"name" : "string",
"quantity" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"value" : 1,
"vatRate" : 1
} ],
"arrivalDate" : "01-01-2023",
"cancelDate" : "01-01-2023",
"categoryCode" : "string",
"currencyCode" : "string",
"currencyId" : 1,
"customer" : {
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"lastName" : "string",
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ { } ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"socialSecurityNumber" : "string",
"title" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"title" : "string"
} ]
}
},
"customerBill" : [ {
"billLineType" : 1,
"endDate" : "01-01-2023",
"multiplier" : 1,
"name" : "string",
"quantity" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"value" : 1,
"vatRate" : 1
} ],
"customerId" : 1,
"customerStatus" : {
"customerCluseters" : [ {
"clusterId" : 1,
"code" : "string",
"description" : "string",
"name" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"customerClusters" : [ {
"clusterId" : 1,
"code" : "string",
"description" : "string",
"name" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ]
},
"departureDate" : "01-01-2023",
"distributionChannelCode" : "string",
"distributionChannelId" : 1,
"emergencyContacts" : [ {
"emergencyContactId" : 1,
"firstName" : "string",
"lastName" : "string",
"middleName" : "string",
"phone" : "string",
"relationship" : "string",
"reservationId" : 1
} ],
"employeeId" : 1,
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedArrivalTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureTime" : "01-01-2023T11:23:45Z",
"externalBookingReference" : "string",
"infotexts" : [ {
"description" : "string"
} ],
"instalments" : [ {
"autopay" : true,
"due" : 1,
"dueDate" : "01-01-2023",
"issueDate" : "01-01-2023",
"payerType" : "string",
"status" : "string",
"taxValue" : 1,
"term" : "string",
"value" : 1
} ],
"modifiedDate" : "01-01-2023T11:23:45Z",
"parentId" : 1,
"payingCustomer" : {
"alternateName" : "string",
"bicSwift" : "string",
"birthDate" : "01-01-2023",
"companyName" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"customerId" : 1,
"emailAllowed" : true,
"firstName" : "string",
"ibanNumber" : "string",
"language" : "string",
"lastName" : "string",
"mailAddress" : {
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"translations" : [ { } ]
},
"countryId" : 1,
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"workPhone" : "string",
"zipCode" : "string"
},
"mailAllowed" : true,
"middle" : "string",
"owner" : true,
"questionnaireUnsubscribed" : true,
"sex" : "string",
"socialSecurityNumber" : "string",
"title" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"title" : "string"
} ]
}
},
"payingCustomerId" : 1,
"paymentTermSetId" : 1,
"previousPmsId" : 1,
"reservationCategoryId" : 1,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservationInfoTexts" : [ {
"code" : "string",
"description" : "string",
"display" : true,
"infoTextId" : 1,
"name" : "string",
"reservations" : [ {
"display" : true,
"infoTextId" : 1,
"infoTextReservationId" : 1,
"reservedResourceId" : 1
} ],
"reservedResourceId" : 1
} ],
"reservationKind" : "string",
"reservationNumber" : "string",
"reservedResources" : [ {
"amenities" : [ {
"amenityId" : 1,
"categories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ { } ],
"isInternalUse" : true,
"translations" : [ { } ]
} ],
"endDate" : "01-01-2023",
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"parentAmenityId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string"
} ],
"cancellationPremium" : true,
"code" : "string",
"description" : "string",
"endDate" : "01-01-2023",
"freeFields" : [ {
"dataTypeName" : "string",
"fieldId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"value" : "string"
} ],
"impliesId" : 1,
"imply" : true,
"included" : true,
"infotexts" : [ {
"description" : "string"
} ],
"modifiedDate" : "01-01-2023T11:23:45Z",
"name" : "string",
"nightsRedeemed" : 1,
"offerType" : "string",
"parentId" : 1,
"pointsRedeemed" : 1,
"preferences" : [ {
"id" : 1,
"type" : "string"
} ],
"price" : 1,
"quantity" : 1,
"rateType" : {
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"rateTypeId" : 1,
"removable" : true,
"reservationDate" : "01-01-2023T11:23:45Z",
"reservedResourceId" : 1,
"resortArticle" : true,
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"status" : 1,
"subjects" : [ {
"maxAge" : 1,
"quantity" : 1,
"subjectId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"resourceId" : 1,
"shortDescription" : "string"
} ],
"type" : "string",
"unit" : {
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"unitId" : 1
},
"unitId" : 1
} ],
"resortId" : 1,
"sendMethodId" : 1,
"status" : 1,
"statusValue" : "string",
"supplierBookingReference" : "string",
"tncSigned" : true,
"tncSignedDate" : "01-01-2023",
"tncSigneeCustomerName" : "string",
"validationStatusId" : 1,
"voucher" : "string",
"vouchers" : [ {
"amount" : 1,
"blockReason" : "string",
"reservationId" : 1,
"status" : "string",
"voucher" : {
"blockReason" : "string",
"code" : "string",
"employeeId" : 1,
"employeeName" : "string",
"generationDate" : "01-01-2023",
"numberOfVouchers" : 1,
"originalReservationId" : 1,
"printCount" : 1,
"resourceCode" : "string",
"status" : "string",
"type" : "string",
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023",
"voucherCriteriaId" : 1,
"voucherId" : 1,
"voucherOriginalValue" : 1,
"voucherSetCashResourceId" : 1,
"voucherSetId" : 1,
"voucherSetName" : "string",
"voucherSetResourceCode" : "string",
"voucherTypeName" : "string",
"voucherValue" : 1
},
"voucherId" : 1,
"voucherRedemptionId" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.20. Get reservation doorlock
GET /maxxton/v1/reservations/{reservationId}/doorlocks
Description
Gets a reservation doorlocks.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Filter data for specific reservationId. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation door locks. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/doorlocks
Example HTTP response
Response 200
{
"arrivalDate" : "01-01-2023",
"departureDate" : "01-01-2023",
"doorLockCodes" : [ {
"code1" : "string",
"code1Active" : "string",
"code2" : "string",
"code2Active" : "string",
"earlyCheckInCode1" : "string",
"earlyCheckInCode2" : "string",
"reservedResourceId" : 1,
"unitId" : 1,
"validDateFrom" : "01-01-2023",
"validDateTo" : "01-01-2023"
} ],
"reservationId" : 1
}
5.39.21. Get reservation doorlocks
GET /maxxton/v1/reservations/doorlocks
Description
Gets a page of reservation doorlocks.
Maximum page size for this endpoint is 100
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
reservationId |
Filter data for specific reservationId. |
integer (int64) |
Query |
reservedResourceId |
Filter data for specific reservedResourceId. |
integer (int64) |
Query |
arrivalDateFrom |
arrival date range, from which the data will be fetched till arrivalDateTo. if only arrivalDateFrom is provided then data for only that day will be returned. |
string (date) |
Query |
unitId |
Filter the response for specific unitId. |
integer (int64) |
Query |
arrivalDateTo |
arrival date range, from which the data will be fetched till arrivalDateTo. if only arrivalDateFrom is provided then data for only that day will be returned. |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation door locks. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/doorlocks
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDate" : "01-01-2023",
"departureDate" : "01-01-2023",
"doorLockCodes" : [ {
"code1" : "string",
"code1Active" : "string",
"code2" : "string",
"code2Active" : "string",
"earlyCheckInCode1" : "string",
"earlyCheckInCode2" : "string",
"reservedResourceId" : 1,
"unitId" : 1,
"validDateFrom" : "01-01-2023",
"validDateTo" : "01-01-2023"
} ],
"reservationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.22. Get reservation payment term sets
GET /maxxton/v1/reservations/{reservationId}/paymenttermsets
Description
Gets a page of reservation payment term sets.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Filter data for specific reservationId. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching payment term sets. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/paymenttermsets
Example HTTP response
Response 200
{
"content" : [ {
"arrivalDateFrom" : "01-01-2023",
"arrivalDateTo" : "01-01-2023",
"maxArrivalDeviation" : 1,
"maxStayLength" : 1,
"minArrivalDeviation" : 1,
"minStayLength" : 1,
"nonRefundable" : true,
"paymentTermSetId" : 1,
"paymentTermSetType" : "string",
"preBooking" : true,
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.23. Get the amenities by reservation id
GET /maxxton/v1/reservations/{reservationId}/amenities
Description
Amenities of a reservation are the amenities that this customer has booked with preference and are guaranteed. For example 'non smoking' will mean that the unit in this booking will be a non smoking accommodation.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which amenities are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< ReservedResourceAmenity |
404 |
No reservation or amenities found for given reservation id. |
No Content |
500 |
Error occurred while fetching amenities |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/amenities
Example HTTP response
Response 200
[ {
"amenityId" : 1,
"extraId" : 1,
"reservedResourceId" : 1,
"type" : "string"
} ]
5.39.24. Get the page of reservation costs by reservation ids.
GET /maxxton/v1/reservations/bills/costs
Description
Get the page of reservation costs by reservation ids.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
reservationIds |
Reservation ids for which costs is to be fetched |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation costs |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/bills/costs
Example HTTP response
Response 200
{
"content" : [ {
"costs" : [ {
"costPrice" : {
"bookDateFrom" : "01-01-2023T11:23:45Z",
"bookDateTo" : "01-01-2023T11:23:45Z",
"costPriceId" : 1,
"costPriceSpecials" : [ {
"endDate" : "01-01-2023",
"resourceId" : 1,
"startDate" : "01-01-2023"
} ],
"currency" : {
"code" : "string",
"currencyCountry" : "string",
"currencyId" : 1,
"currencyLanguage" : "string",
"name" : "string",
"symbol" : "string"
},
"remark" : "string",
"resourceId" : 1,
"stayDateFrom" : "01-01-2023",
"stayDateTo" : "01-01-2023",
"usageUnit" : 1,
"usageUnitFrom" : 1,
"usageUnitTo" : 1,
"value" : 1
},
"costPriceType" : "string",
"endDate" : "01-01-2023",
"quantity" : 1,
"startDate" : "01-01-2023",
"subjectId" : 1
} ],
"reservationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.25. Get the page of reservation reminders.
GET /maxxton/v1/reservations/reminders
Description
Get the page of reservation reminders.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation reminders |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/reminders
Example HTTP response
Response 200
{
"content" : [ {
"dueAmount" : 1,
"paymentDate" : "01-01-2023T11:23:45Z",
"paymentTermSetId" : 1,
"printDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"sendDate" : "01-01-2023T11:23:45Z",
"status" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.26. Get the page of reservation snapshots by reservation id
GET /maxxton/v1/reservations/{reservationId}/bills/snapshots
Description
Get the page of reservation snapshots by reservation id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which snapshots is to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No reservation or reservation snapshots found for given reservation id. |
No Content |
500 |
Error occurred while fetching reservation snapshots |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/bills/snapshots
Example HTTP response
Response 200
{
"content" : [ {
"businessSnapshotId" : 1,
"businessSnapshotNumber" : "string",
"creationDate" : "01-01-2023",
"dueDate" : "01-01-2023",
"endDate" : "01-01-2023",
"issueDate" : "01-01-2023",
"open" : 1,
"paid" : 1,
"payerType" : "string",
"startDate" : "01-01-2023",
"validationStatus" : "string",
"value" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.27. Get the reservation bill by reservation id
GET /maxxton/v1/reservations/bills
Description
Get the page of reservation bill by reservation ids, this will give you a range of bill lines which build up the total bill. Each reservation can have three bills, for the customer, paying customer and the agent. The distinction can be made by filtering on the payertype.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
reservationIds |
Reservation ids for which bill is to be fetched |
< integer > array |
Query |
payerType |
payerType of the bill. Possible values: CUSTOMER or PAYING_CUSTOMER or AGENT |
string |
Query |
doFetchInternalBill |
true then fetch internal bill lines else don’t default value false |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation bill |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/bills
Example HTTP response
Response 200
{
"content" : [ {
"reservationBillLines" : [ {
"billLineType" : 1,
"cashflowRuleName" : "string",
"description" : "string",
"endDate" : "01-01-2023",
"multiplier" : 1,
"overrideValue" : 1,
"payerType" : "string",
"quantity" : 1,
"redeemedLoyaltyNights" : 1,
"redeemedLoyaltyPoints" : 1,
"replacesParentResource" : true,
"reservationBillId" : 1,
"reservationBillLineId" : 1,
"reservationId" : 1,
"reservedResourceId" : 1,
"resourceDescription" : "string",
"resourceId" : 1,
"resourceName" : "string",
"resourceType" : "string",
"resourceTypeSequenceNr" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"totalBottomSequenceNr" : 1,
"type" : "string",
"value" : 1,
"vatRate" : 1,
"virtualOverrideValue" : 1
} ],
"reservationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.28. Get the reservation bill by reservation id
GET /maxxton/v1/reservations/{reservationId}/bills
Description
Get the reservation bill by reservation id, this will give you a range of bill lines which build up the total bill. Each reservation can have three bills, for the customer, paying customer and the agent. The distinction can be made by filtering on the payertype.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
payerType |
payerType of the bill. Possible values: CUSTOMER or PAYING_CUSTOMER or AGENT |
string |
Path |
reservationId |
Reservation id for which bill is to be fetched |
integer (int64) |
Query |
doFetchInternalBill |
true then fetch internal bill lines else don’t default value false |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< ReservationBillLine |
404 |
No reservation or reservation bill found for given reservation id. |
No Content |
500 |
Error occurred while fetching reservation bill |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/bills
Example HTTP response
Response 200
[ {
"billLineType" : 1,
"cashflowRuleName" : "string",
"description" : "string",
"endDate" : "01-01-2023",
"multiplier" : 1,
"overrideValue" : 1,
"payerType" : "string",
"quantity" : 1,
"redeemedLoyaltyNights" : 1,
"redeemedLoyaltyPoints" : 1,
"replacesParentResource" : true,
"reservationBillId" : 1,
"reservationBillLineId" : 1,
"reservationId" : 1,
"reservedResourceId" : 1,
"resourceDescription" : "string",
"resourceId" : 1,
"resourceName" : "string",
"resourceType" : "string",
"resourceTypeSequenceNr" : 1,
"startDate" : "01-01-2023",
"total" : 1,
"totalBottomSequenceNr" : 1,
"type" : "string",
"value" : 1,
"vatRate" : 1,
"virtualOverrideValue" : 1
} ]
5.39.29. Gets a page of custom fields
GET /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Description
Custom fields are part of the reservation that can be updated for a particular reservation. This endpoint can be used to fetch a page of custom field of reservation .
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id of the reservation |
integer (int64) |
Path |
reservedResourceId |
ReservedResource id of the reservation |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching custom fields |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}/customfields
Example HTTP response
Response 200
{
"content" : [ {
"allowedValues" : [ "string" ],
"booleanValue" : true,
"dataType" : "string",
"dateValue" : "01-01-2023",
"fieldId" : 1,
"numericValue" : 1,
"selectValues" : [ "string" ],
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.30. Gets a page with credit card authorisations for a reservation.
GET /maxxton/v1/reservations/{reservationId}/creditcardauthorisations
Description
Gets a page with credit card authorisations for a reservation. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
reservationId |
Reservation id for which credit card authorisations will be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
When reservationId path parameter value is invalid/does not exist. |
No Content |
500 |
Error occurred while fetching reservation credit card authorisations |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/creditcardauthorisations
Example HTTP response
Response 200
{
"content" : [ {
"authorisationStatus" : "string",
"authorisedAmount" : 1,
"availableAmount" : 1,
"bankAccount" : {
"bankAccountName" : "string",
"code" : "string",
"currencyCode" : "string",
"name" : "string",
"paymentMethodDefinition" : {
"brandName" : "string",
"code" : "string",
"name" : "string"
}
},
"capturedAmount" : 1,
"creationDate" : "01-01-2023",
"creditCardAuthorisationId" : 1,
"payerType" : "string",
"paymentMethod" : {
"brandName" : "string",
"code" : "string",
"name" : "string"
},
"status" : "string",
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.31. Gets all source categories.
GET /maxxton/v1/reservations/sources/categories
Description
Gets a page of all source categories, records can be filtered based on fields on source object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors. |
|
500 |
Error occurred while fetching category. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/sources/categories
Example HTTP response
Response 200
{
"content" : [ {
"categoryId" : 1,
"parentId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.32. Gets all sources.
GET /maxxton/v1/reservations/sources
Description
Gets a page of all sources, records can be filtered based on fields on source object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors. |
|
500 |
Error occurred while fetching source. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/sources
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"endDate" : "01-01-2023T11:23:45Z",
"showOnInternet" : true,
"sourceCategoryId" : 1,
"sourceId" : 1,
"startDate" : "01-01-2023T11:23:45Z",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.33. Gets page of reservation categories
GET /maxxton/v1/reservations/categories
Description
Get reservation categories.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation categories |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/categories
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"endDate" : "string",
"markForOwnUse" : true,
"name" : "string",
"reservationCategory" : {
"code" : "string",
"endDate" : "string",
"markForOwnUse" : true,
"name" : "string",
"reservationCategory" : {
"code" : "string",
"endDate" : "string",
"markForOwnUse" : true,
"name" : "string",
"reservationCategory" : {
"code" : "string",
"endDate" : "string",
"markForOwnUse" : true,
"name" : "string",
"reservationCategory" : { },
"reservationCategoryId" : 1,
"translations" : [ { } ]
},
"reservationCategoryId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"reservationCategoryId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"reservationCategoryId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.34. Gets page of reservation terms and conditions
GET /maxxton/v1/reservations/{reservationId}/termsandconditions
Description
Get reservation terms and conditions. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
reservationId |
Reservation id for which term and conditions are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation terms and conditions |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/termsandconditions
Example HTTP response
Response 200
{
"content" : [ {
"contents" : "string",
"isDefault" : true,
"templateId" : 1,
"termAndConditionId" : 1,
"type" : "string",
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.35. Gets page of reservation’s payent methods
GET /maxxton/v1/reservations/{reservationId}/paymentmethods
Description
Get payment methods for reservation based on reservationId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
reservationId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching payment methods for the given reservation |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/paymentmethods
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"maxDaysBetweenBookAndArrivalDate" : 1,
"minDaysBeforeArrival" : 1,
"paymentMethod" : "string",
"paymentProvider" : "string",
"paymentType" : "string",
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.36. Gets page with memos
GET /maxxton/v1/reservations/memos
Description
Get memos for reservation ids specified by a list of reservationIds.The records can be filtered based on memo object. In order to filter creationDate the format of date passed should be: YYYY-MM-DDThh:mm:ss. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
reservationIds |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching memos for the given reservation |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/memos
Example HTTP response
Response 200
{
"content" : [ {
"memo" : [ {
"content" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"employeeId" : 1,
"memoCategoryId" : 1,
"memoId" : 1,
"predefinedMemoId" : 1
} ],
"reservationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.37. Gets page with memos
GET /maxxton/v1/reservations/{reservationId}/memos
Description
Get memos for a reservation specified by reservationId.The records can be filtered based on memo object. In order to filter creationDate the format of date passed should be: YYYY-MM-DDThh:mm:ss. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
reservationId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching memos for the given reservation |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/memos
Example HTTP response
Response 200
{
"content" : [ {
"content" : "string",
"creationDate" : "01-01-2023T11:23:45Z",
"employeeId" : 1,
"memoCategoryId" : 1,
"memoId" : 1,
"predefinedMemoId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.38. Gets the page of amenities by reservation ids
GET /maxxton/v1/reservations/amenities
Description
Amenities of a reservations are the amenities that the customer has booked with preference and are guaranteed. For example 'non smoking' will mean that the unit in this booking will be a non smoking accommodation.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
reservationIds |
Reservation ids for which amenities are to be fetched |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching amenities |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/amenities
Example HTTP response
Response 200
{
"content" : [ {
"amenities" : [ {
"amenityId" : 1,
"extraId" : 1,
"reservedResourceId" : 1,
"type" : "string"
} ],
"reservationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.39. Gets the page of instalments by reservation ids
GET /maxxton/v1/reservations/instalments
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
reservationIds |
Reservation ids for which instalments are to be fetched. Maximum allowed reservationIds per call is 20 |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching instalments |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/instalments
Example HTTP response
Response 200
{
"content" : [ {
"instalments" : [ {
"autopay" : true,
"due" : 1,
"dueDate" : "01-01-2023",
"issueDate" : "01-01-2023",
"payerType" : "string",
"status" : "string",
"taxValue" : 1,
"term" : "string",
"value" : 1
} ],
"reservationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.40. Gets the page of payment details for the specific reservationIds.
GET /maxxton/v1/reservations/payments
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
reservationIds |
Ids of the reservation for which payments has to be fethced. |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation payments. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/payments
Example HTTP response
Response 200
{
"content" : [ {
"payments" : [ {
"amount" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"ledgerId" : 1,
"payerType" : "string",
"paymentAccount" : "string",
"paymentDate" : "01-01-2023T11:23:45Z",
"paymentId" : 1,
"paymentNumber" : "string",
"paymentType" : "string",
"refunded" : true,
"remark" : "string",
"reservationId" : 1,
"statementDate" : "01-01-2023"
} ],
"reservationId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.41. Gets the page of reservation addition groups
POST /maxxton/v1/reservations/proposals/additiongroups
Description
This endpoint provides you with a page of valid additions for your request criteria including marketing groups and all details of the addition. This endpoint only provides the additions which are in a marketing group. If not they will not be returned. In the case of a nested marketing group structure, all groups are returned separately, in case the whole tree is required this can be created using the parentId.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching addition groups. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/proposals/additiongroups
Request body
{
"accommodationTypes" : [ {
"arrivalDate" : "01-01-2023",
"duration" : 1,
"rateTypeId" : 1,
"resourceId" : 1,
"subjects" : {
"persons" : [ {
"age" : 1,
"quantity" : 1
} ],
"petsQuantity" : 1
},
"unitId" : 1
} ],
"categoryCode" : "string",
"distributionChannelCode" : "string"
}
Example HTTP response
Response 200
{
"content" : [ {
"additions" : [ {
"additionResourceId" : 1,
"endDate" : "01-01-2023",
"memo" : "string",
"quantity" : 1,
"startDate" : "01-01-2023"
} ],
"code" : "string",
"groupId" : 1,
"parentId" : 1,
"priority" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.42. Gets the payment details for the specific reservationId.
GET /maxxton/v1/reservations/{reservationId}/payments
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Id of the reservation for which payments has to be fethced. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching reservation payments. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/payments
Example HTTP response
Response 200
{
"content" : [ {
"amount" : 1,
"currencyCode" : "string",
"currencyId" : 1,
"ledgerId" : 1,
"payerType" : "string",
"paymentAccount" : "string",
"paymentDate" : "01-01-2023T11:23:45Z",
"paymentId" : 1,
"paymentNumber" : "string",
"paymentType" : "string",
"refunded" : true,
"remark" : "string",
"reservationId" : 1,
"statementDate" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.43. Reservation subjects by reservation id
GET /maxxton/v1/reservations/{reservationId}/subjects
Description
The endpoints returns the number of subjects added in reservation.
1. Get a page of reservation subjects per reserved resource.
2. The vehicle list in reservation will be added to the first accommodation type reserved resource in the response list.
3. The response is by default sorted on the reserved resource id in ascending order.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
reservationId |
Reservation id for which the subjects are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No reservation or reservation Subjects found for given reservation id. |
No Content |
500 |
Error occurred while fetching reservation subjects |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects
Example HTTP response
Response 200
{
"content" : [ {
"equipments" : [ {
"remark" : "string",
"reservationSubjectId" : 1,
"reservedResourceId" : 1,
"value" : "string"
} ],
"quantity" : 1,
"reservedResourceId" : 1,
"subject" : {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
},
"subjectId" : 1,
"travelParties" : [ {
"arrivalDate" : "01-01-2023",
"birthDate" : "01-01-2023",
"city" : "string",
"companion" : true,
"countryId" : 1,
"departureDate" : "01-01-2023",
"email" : "string",
"firstName" : "string",
"gender" : "string",
"guest" : true,
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"identityCardNumber" : "string",
"identityCountryId" : 1,
"identityDateIssued" : "01-01-2023",
"identityNumber" : "string",
"identityType" : "string",
"lastName" : "string",
"middleName" : "string",
"personAlreadyLeft" : true,
"reservationSubjectId" : 1,
"sex" : "string",
"street" : "string",
"zipCode" : "string"
} ],
"vehicles" : [ {
"registrationMark" : "string",
"remark" : "string",
"reservationSubjectId" : 1,
"reservedResourceId" : 1,
"subjectId" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.44. Reservation subjects by reservation id
POST /maxxton/v1/reservations/{reservationId}/subjects
Description
Creates subjects for a reservation. You can add a list of either travel parties, vehicles, or equipments at a time using this endpoint.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which the subjects are to be fetched |
integer (int64) |
Body |
requestBody |
< ReservationSubjectRequest |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
400 |
You can add a list of either travel parties, vehicles, or equipments at a time using this endpoint. |
No Content |
404 |
No reservation found for given reservation id. |
No Content |
500 |
Error occurred while creating reservation subject |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects
Request body
[ {
"equipments" : [ {
"remark" : "string",
"reservedResourceId" : 1,
"value" : "string"
} ],
"reservedResourceId" : 1,
"subjectId" : 1,
"travelParties" : [ {
"arrivalDate" : "01-01-2023",
"birthDate" : "01-01-2023",
"city" : "string",
"companion" : true,
"countryId" : 1,
"departureDate" : "01-01-2023",
"email" : "string",
"firstName" : "string",
"gender" : "string",
"guest" : true,
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"identityCardNumber" : "string",
"identityCountryId" : 1,
"identityDateIssued" : "01-01-2023",
"identityNumber" : "string",
"identityType" : "string",
"lastName" : "string",
"middleName" : "string",
"personAlreadyLeft" : true,
"sex" : "string",
"street" : "string",
"zipCode" : "string"
} ],
"vehicles" : [ {
"registrationMark" : "string",
"remark" : "string",
"reservedResourceId" : 1,
"subjectId" : 1
} ]
} ]
5.39.45. Reservation subjects by reservation ids
GET /maxxton/v1/reservations/subjects
Description
The endpoints returns the page of subjects added in reservation.
1. Get a page of reservation subjects per reservationId.
2. The vehicle list in reservation will be added to the first accommodation type reserved resource in the response list.
3. The response is by default sorted on the reserved resource id in ascending order.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
reservationIds |
Reservation id for which the subjects are to be fetched |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reservation subjects |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/subjects
Example HTTP response
Response 200
{
"content" : [ {
"reservationId" : 1,
"reservedResourceSubjectQuantity" : [ {
"equipments" : [ {
"remark" : "string",
"reservationSubjectId" : 1,
"reservedResourceId" : 1,
"value" : "string"
} ],
"quantity" : 1,
"reservedResourceId" : 1,
"subject" : {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
},
"subjectId" : 1,
"travelParties" : [ {
"arrivalDate" : "01-01-2023",
"birthDate" : "01-01-2023",
"city" : "string",
"companion" : true,
"countryId" : 1,
"departureDate" : "01-01-2023",
"email" : "string",
"firstName" : "string",
"gender" : "string",
"guest" : true,
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"identityCardNumber" : "string",
"identityCountryId" : 1,
"identityDateIssued" : "01-01-2023",
"identityNumber" : "string",
"identityType" : "string",
"lastName" : "string",
"middleName" : "string",
"personAlreadyLeft" : true,
"reservationSubjectId" : 1,
"sex" : "string",
"street" : "string",
"zipCode" : "string"
} ],
"vehicles" : [ {
"registrationMark" : "string",
"remark" : "string",
"reservationSubjectId" : 1,
"reservedResourceId" : 1,
"subjectId" : 1
} ]
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.46. Reserved resources by reservation id
GET /maxxton/v1/reservations/{reservationId}/content
Description
Get the reserved resources by reservation id. ReservedResources are the content of a booking, everything you add to your booking as a resource, is a reservedresource. For example your accommodation is a reservedresource but also the mandatory or additional products. Together they form a tree structure which we call the reservation content. Archived resources will also be returned in the response.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
reservationId |
Reservation id for which reserved resources should be fetched |
integer (int64) |
Query |
fetchTurnover |
Parameter to identify if Turnover is to be fetched for each reserved resource. By default this is false. |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No reserved resources or reservation found for given reservation id. |
No Content |
500 |
Error occurred while fetching reserved resources |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/content
Example HTTP response
Response 200
{
"content" : [ {
"actualEndDate" : "01-01-2023",
"actualStartDate" : "01-01-2023",
"cancellationPremium" : true,
"code" : "string",
"description" : "string",
"employeeId" : 1,
"endDate" : "01-01-2023",
"hasPriceOverride" : true,
"impliesId" : 1,
"imply" : true,
"implyOnce" : true,
"included" : true,
"modifiedDate" : "01-01-2023T11:23:45Z",
"name" : "string",
"nightsRedeemed" : 1,
"offerType" : "string",
"onBill" : true,
"overrideEmployeeId" : 1,
"overrideValue" : 1,
"parentId" : 1,
"pointsRedeemed" : 1,
"price" : 1,
"quantity" : 1,
"rateTypeId" : 1,
"removable" : true,
"representationId" : 1,
"resellerAddonCode" : "string",
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservedResourceId" : 1,
"resourceCode" : "string",
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"statusName" : "string",
"totalInternalPrice" : 1,
"turnOverValue" : 1,
"type" : "string",
"unitId" : 1,
"vatRate" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.47. Reserved resources by reservation ids
GET /maxxton/v1/reservations/content
Description
Get the page of reserved resources by reservation ids. ReservedResources are the content of a booking, everything you add to your booking as a resource, is a reservedresource. For example your accommodation is a reservedresource but also the mandatory or additional products. Together they form a tree structure which we call the reservation content. Archived resources will also be returned in the response.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
reservationIds |
Reservation ids for which reserved resources should be fetched |
< integer > array |
Query |
fetchTurnover |
Parameter to identify if Turnover is to be fetched for each reserved resource. By default this is false. |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching reserved resources |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/content
Example HTTP response
Response 200
{
"content" : [ {
"reservationId" : 1,
"reservedResources" : [ {
"actualEndDate" : "01-01-2023",
"actualStartDate" : "01-01-2023",
"cancellationPremium" : true,
"code" : "string",
"description" : "string",
"employeeId" : 1,
"endDate" : "01-01-2023",
"hasPriceOverride" : true,
"impliesId" : 1,
"imply" : true,
"implyOnce" : true,
"included" : true,
"modifiedDate" : "01-01-2023T11:23:45Z",
"name" : "string",
"nightsRedeemed" : 1,
"offerType" : "string",
"onBill" : true,
"overrideEmployeeId" : 1,
"overrideValue" : 1,
"parentId" : 1,
"pointsRedeemed" : 1,
"price" : 1,
"quantity" : 1,
"rateTypeId" : 1,
"removable" : true,
"representationId" : 1,
"resellerAddonCode" : "string",
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservedResourceId" : 1,
"resourceCode" : "string",
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"statusName" : "string",
"totalInternalPrice" : 1,
"turnOverValue" : 1,
"type" : "string",
"unitId" : 1,
"vatRate" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.39.48. Update reservation
PUT /maxxton/v1/reservations/{reservationId}
Description
Update an existing reservation based on given details.
The user can change the status of the reservation as per the below status flow specified:
QUOTATION(-5) → CONFIRM(10), DECLINE(-10)
OPTIONAL(11) → CONFIRM(10), DECLINE(-10)
REQUEST(10)→DECLINE(-10), CONFIRM(12)
PROVISIONAL(12) → CANCEL(-12), DECLINE(-10)
DEFINITIVE(21)→CANCEL(-12), CHECKED_IN(31)
CHECKED_IN(31)→CHECKED_OUT(41).
The expectedArrivalDateTime and expectedDepartureDateTime should be passed in the below format:
'YYYY-MM-DDThh:mm:ss'
The above fields are mainly used by the receptionist of the resort, by maintenance department and housekeeping.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Id of the reservation which needs to be updated. |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating reservation |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}
Request body
{
"cancellationReason" : "string",
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"paymentTermSetId" : 1,
"statusValue" : "string"
}
Example HTTP response
Response 200
{
"expectedArrivalDateTime" : "01-01-2023T11:23:45Z",
"expectedDepartureDateTime" : "01-01-2023T11:23:45Z",
"infotexts" : [ {
"description" : "string"
} ],
"paymentTermSetId" : 1,
"reservationId" : 1,
"status" : "string",
"statusValue" : "string"
}
5.39.49. Update reservation subjects by reservation id
PUT /maxxton/v1/reservations/{reservationId}/subjects
Description
All the equipment, travelparties, and vehicles available in a reservation can be updated with this call.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Reservation id for which the subjects are to be updated |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
404 |
No reservation found for given reservation id. |
No Content |
500 |
Error occurred while updating reservation subject |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/subjects
Request body
{
"equipments" : [ {
"remark" : "string",
"reservationSubjectId" : 1,
"reservedResourceId" : 1,
"value" : "string"
} ],
"travelParties" : [ {
"arrivalDate" : "01-01-2023",
"birthDate" : "01-01-2023",
"city" : "string",
"companion" : true,
"countryId" : 1,
"departureDate" : "01-01-2023",
"email" : "string",
"firstName" : "string",
"gender" : "string",
"guest" : true,
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"identityCardNumber" : "string",
"identityCountryId" : 1,
"identityDateIssued" : "01-01-2023",
"identityNumber" : "string",
"identityType" : "string",
"lastName" : "string",
"middleName" : "string",
"personAlreadyLeft" : true,
"reservationSubjectId" : 1,
"sex" : "string",
"street" : "string",
"zipCode" : "string"
} ],
"vehicles" : [ {
"registrationMark" : "string",
"remark" : "string",
"reservationSubjectId" : 1,
"reservedResourceId" : 1,
"subjectId" : 1
} ]
}
5.39.50. Update reservedResource
PUT /maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
Description
Update exiting reservedResource for the given reservationId and reservedResourceId as per the given criteria
startDate/endDate and actualStartDate/actualEndDate date should be pass in following format : 'YYYY-MM-DD'. The start and end date depicts the dates of booking with financial implications and actualStartDate and actualEndDate shows when the availability and bookability of an accommodation. Please note that if a reservedResource of a reservation is an imply, then it cannot be updated.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
reservationId |
Id of the reservation which needs to be updated. |
integer (int64) |
Path |
reservedResourceId |
Id of the reservedresource which needs to be updated |
integer (int64) |
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while updating reservedResource |
No Content |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/reservations/{reservationId}/reservedresources/{reservedResourceId}
Request body
{
"actualEndDate" : "01-01-2023",
"actualStartDate" : "01-01-2023",
"endDate" : "01-01-2023",
"price" : 1,
"quantity" : 1,
"startDate" : "01-01-2023",
"unitId" : 1
}
Example HTTP response
Response 200
{
"actualEndDate" : "01-01-2023",
"actualStartDate" : "01-01-2023",
"cancellationPremium" : true,
"code" : "string",
"description" : "string",
"employeeId" : 1,
"endDate" : "01-01-2023",
"hasPriceOverride" : true,
"impliesId" : 1,
"imply" : true,
"implyOnce" : true,
"included" : true,
"modifiedDate" : "01-01-2023T11:23:45Z",
"name" : "string",
"offerType" : "string",
"onBill" : true,
"overrideEmployeeId" : 1,
"overrideValue" : 1,
"parentId" : 1,
"price" : 1,
"quantity" : 1,
"rateTypeId" : 1,
"removable" : true,
"representationId" : 1,
"resellerAddonCode" : "string",
"reservationDate" : "01-01-2023T11:23:45Z",
"reservationId" : 1,
"reservedResourceId" : 1,
"resourceCode" : "string",
"resourceId" : 1,
"shortDescription" : "string",
"startDate" : "01-01-2023",
"statusName" : "string",
"totalInternalPrice" : 1,
"turnOverValue" : 1,
"type" : "string",
"unitId" : 1,
"vatRate" : 1
}
5.40. Resorts
Group of accommodation types at the same location
5.40.1. Gets Resort Activities
GET /maxxton/v1/resorts/activities
Description
Gets a page with Resort Activities .It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resorts Activities |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/activities
Example HTTP response
Response 200
{
"content" : [ {
"activityCategoryId" : 1,
"code" : "string",
"priceAdult" : "string",
"priceChild" : "string",
"priceType" : "string",
"priceValuePoints" : "string",
"resortActivityId" : 1,
"ticketingType" : "string",
"translations" : [ {
"description" : "string",
"headText" : "string",
"languageId" : 1,
"text" : "string",
"title" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.2. Gets a List of Subjects associated with Resort
GET /maxxton/v1/resorts/{resortId}/subjects
Description
Provides the List of subjects for specific resort. The subjects correspond to the travelling party for ex. Adult, Youngster, Baby etc.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resortId |
resortId to fetch subjects |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< Subject |
500 |
Error occurred while fetching Subjects for Resort. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/subjects
Example HTTP response
Response 200
[ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
5.40.3. Gets a page holding resort objects
GET /maxxton/v1/resorts
Description
Gets a page holding resort objects.The records can be filtered based on resort object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
resortIds |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching resorts. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts
Example HTTP response
Response 200
{
"content" : [ {
"adminOrganisationId" : 1,
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"bookableLocation" : true,
"code" : "string",
"dynamicManagerId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"imageManagerId" : 1,
"inheritTc" : true,
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"previousPmsId" : "string",
"resArrivalDateFrom" : "01-01-2023",
"resortId" : 1,
"resortNumber" : 1,
"resortPriority" : 1,
"supplierId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"visitAddressManagerId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.4. Gets a page holding resort priorities objects
GET /maxxton/v1/resorts/priorities
Description
Gets a page holding resort priorities objects.The records can be filtered based on resort priorities object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts priorities found for given criteria. |
No Content |
500 |
Error occurred while fetching priorities. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/priorities
Example HTTP response
Response 200
{
"content" : [ {
"distributionChannelId" : 1,
"endDate" : "01-01-2023",
"priority" : 1,
"resortId" : 1,
"resortPriorityId" : 1,
"segmentId" : 1,
"startDate" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.5. Gets a page of resort amenity links
GET /maxxton/v1/resorts/amenitylinks
Description
Gets a page of all the amenity links, along with the applicable resortId. The records can be filtered based on resortamenity object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No amenity links found for given resort. |
No Content |
500 |
Error occurred while fetching amenity links. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"code" : "string",
"endDate" : "01-01-2023",
"numberValue" : 1,
"preferenceExtraId" : 1,
"resortId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.6. Gets a page of resort amenity links
GET /maxxton/v1/resorts/{resortId}/amenitylinks
Description
Gets a page with amenity links by resortId.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resortId |
resortId to fetch AmenityLink(s) |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching resorts. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"code" : "string",
"endDate" : "01-01-2023",
"numberValue" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.7. Gets a resort by its Id
GET /maxxton/v1/resorts/{resortId}
Description
Get’s a resort by its Id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resortId |
resortId to fetch resort |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resort found for given criteria. |
No Content |
500 |
Error occurred while fetching resort. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}
Example HTTP response
Response 200
{
"adminOrganisationId" : 1,
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"bookableLocation" : true,
"code" : "string",
"dynamicManagerId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"imageManagerId" : 1,
"inheritTc" : true,
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"previousPmsId" : "string",
"resArrivalDateFrom" : "01-01-2023",
"resortId" : 1,
"resortNumber" : 1,
"resortPriority" : 1,
"supplierId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"visitAddressManagerId" : 1
}
5.40.8. Gets a resort details by it’s Id
GET /maxxton/v1/resorts/{resortId}/details
Description
Gets a resort details by it’s Id.The data is being filtered based on start and end date
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
endDate |
Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Path |
resortId |
resortId to fetch resort details |
integer (int64) |
Query |
returnResortMap |
The unitMap will be returned when the value is set to true. |
boolean |
Query |
returnSections |
List of constant strings to return only the selected sections in the response. The possible values are AMENITYCATEGORYSETS, DYNAMICFIELDS, IMAGES, MAILADDRESS, RESORTMAP, 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. |
< string > array |
Query |
startDate |
Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resort details found for given criteria. |
No Content |
500 |
Error occurred while fetching resort details. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/details
Example HTTP response
Response 200
{
"adminOrganisationId" : 1,
"amenityCategorySets" : [ {
"categories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ { } ],
"thumbnailUrl" : "string",
"translations" : [ { } ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"managerId" : 1,
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"bookableLocation" : true,
"breadCrumb" : "string",
"code" : "string",
"dynamicFields" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"dynamicManagerId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"inheritTc" : true,
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"previousPmsId" : "string",
"regionId" : 1,
"resArrivalDateFrom" : "01-01-2023",
"resortId" : 1,
"resortMap" : {
"filename" : "string",
"imageId" : 1,
"imageUrl" : "string",
"unitCoordinates" : [ {
"getxValue" : 1,
"getyValue" : 1,
"unitId" : 1
} ]
},
"resortNumber" : 1,
"resortPriority" : 1,
"subjects" : [ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ],
"supplierId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"videos" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"visitAddressManagerId" : 1
}
5.40.9. Gets all resorts with their details
GET /maxxton/v1/resorts/details
Description
Gets a page of resorts along with their details. Maximum and default page size for this endpoint is 10.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
endDate |
Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Query |
resortIds |
List of resortIds to fetch the details |
< integer > array |
Query |
returnResortMap |
The unitMap will be returned when the value is set to true. |
boolean |
Query |
returnSections |
List of constant strings to return only the selected sections in the response. The possible values are AMENITYCATEGORYSETS, DYNAMICFIELDS, IMAGES, MAILADDRESS, RESORTMAP, 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. |
< string > array |
Query |
startDate |
Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resorts. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/details
Example HTTP response
Response 200
{
"content" : [ {
"adminOrganisationId" : 1,
"amenityCategorySets" : [ {
"categories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ { } ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : { },
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"bookableLocation" : true,
"breadCrumb" : "string",
"code" : "string",
"dynamicFields" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"dynamicManagerId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"inheritTc" : true,
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"previousPmsId" : "string",
"regionId" : 1,
"resArrivalDateFrom" : "01-01-2023",
"resortId" : 1,
"resortMap" : {
"filename" : "string",
"imageId" : 1,
"imageUrl" : "string",
"unitCoordinates" : [ {
"getxValue" : 1,
"getyValue" : 1,
"unitId" : 1
} ]
},
"resortNumber" : 1,
"resortPriority" : 1,
"subjects" : [ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ],
"supplierId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"videos" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"visitAddressManagerId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.10. Gets dynamic fields for a particular resort
GET /maxxton/v1/resorts/{resortId}/dynamicfields
Description
Gets a page with dynamic fields to a specific resort. The records can be filtered based on the DynamicField object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resortId |
Resort id for which dynamic fieilds are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resort dynamic fields. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/dynamicfields
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.11. Gets images for a particular resort
GET /maxxton/v1/resorts/{resortId}/images
Description
Gets a page with images to a specific resort. The records can be filtered based on the image object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
resortId |
Resort id for which images are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
Resort id for which images are to be fetched |
|
500 |
Error occurred while fetching resorts. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/images
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.12. Gets resort priorities by it’s resort Id
GET /maxxton/v1/resorts/{resortId}/priorities
Description
Gets resort priorities by resort Id
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resortId |
resortId to fetch resort’s priorities |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resort priorities found for given criteria. |
No Content |
500 |
Error occurred while fetching resort priorities. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/priorities
Example HTTP response
Response 200
{
"content" : [ {
"distributionChannelId" : 1,
"endDate" : "01-01-2023",
"priority" : 1,
"resortId" : 1,
"resortPriorityId" : 1,
"segmentId" : 1,
"startDate" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.40.13. Search available accommodationtypes of a resort based on provided criteria
POST /maxxton/v1/resorts/search
Description
The above endpoint is used to search through the availability of the whole inventory based on resorts. The endpoint will club the accommodation types with availability per resort and provide them as a nested list within the resort entity. The result can be filtered based on the provided request criteria. For example: arrival date, duration, resorts, amenities and subjects are possible filters. The result can contain filter options, filter options provide all possible filter possibilities based on the currently provided filter options. This provides you with all possible arrivals, departures, resorts and amenities as per the criteria passed in the request.
In case of prebooking, the accommdationtype prices are null.
The "dateMargin" request parameter will provide up to 4 alternative stays according to the number that is supplied in "dateMargin" in case there is no match with the requested criteria. It’s up to the client to choose which of these alternatives to use. In case there is an exact match with the requested stay dates only 1 available stay is provided in the result. In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay. See below diagram for an explanation on how the alternative stays work:
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Query |
defaultSelection |
nearest_arrival, cheapest_price [nearest_arrival - First available arrival(based on today’s date) if no arrival date is provided. cheapest_price - sort based on cheapest price] |
string |
Query |
segmentId |
if provided, it will fetch the resort priorities based on this segmentId.if not provided, but segments are used, it will use the priority configured on the location level instead and sort the resorts based on that |
integer (int64) |
Query |
sort |
if provided, it will sort the resort priorities in the given direction. if not provided, it will sort the resort priorities in ascending order. Possible : resort_priority_asc, resort_priority_desc. |
enum (RESORT_PRIORITY_ASC,RESORT_PRIORITY_DESC) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching resorts |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/search
Request body
{
"accommodationKindIds" : [ "integer" ],
"amenityIds" : [ "integer" ],
"arrivalDate" : "01-01-2023",
"dateMargin" : 1,
"dateMarginMethod" : "string",
"distributionChannelId" : 1,
"duration" : 1,
"filterOptions" : [ "string" ],
"includeAccommodationtypes" : true,
"includeFilterOptionCounts" : true,
"maxNrOfBathrooms" : 1,
"maxNrOfBedrooms" : 1,
"minNrOfBathrooms" : 1,
"minNrOfBedrooms" : 1,
"offerCode" : "string",
"offerId" : 1,
"petQuantity" : 1,
"redeemableLoyaltyPoints" : 1,
"regionId" : 1,
"resortIds" : [ "integer" ],
"subjects" : {
"persons" : [ {
"maxAge" : "string",
"quantity" : 1
} ]
}
}
Example HTTP response
Response 200
{
"filterOptionsResult" : {
"accommodationKinds" : [ "object" ],
"amenities" : [ "object" ],
"arrivals" : [ "string" ],
"departures" : [ "string" ]
},
"result" : {
"content" : [ {
"accommodationtypes" : [ {
"accommodationKindId" : 1,
"arrivalDate" : "01-01-2023",
"basePrice" : 1,
"basePriceInclusive" : 1,
"departureDate" : "01-01-2023",
"duration" : 1,
"freeLoyaltyDuration" : 1,
"loyaltyPrice" : 1,
"loyaltyPriceInclusive" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"offerCode" : "string",
"offerPrice" : 1,
"offerPriceInclusive" : 1,
"rateTypeId" : 1,
"referencePrice" : 1,
"referencePriceInclusive" : 1,
"requiredLoyaltyPoints" : 1,
"resourceId" : 1,
"totalCapacity" : 1
} ],
"resortId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
}
5.40.14. Update/insert resort dynamic field
PUT /maxxton/v1/resorts/{resortId}/dynamicfields/{fieldId}
Description
The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for resort, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the resort, then the text field will be modified
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
< DynamicFieldDataCriteria |
|
Path |
resortId |
resortId to fetch resort |
integer (int64) |
Path |
fieldId |
fieldId to fetch dynamic field |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while fetching updating/inserting the resort dynamic fields. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/dynamicfields/{fieldId}
Request body
[ {
"language" : "string",
"text" : "string"
} ]
5.40.15. Updates/creates amenitylink to the resort.
PUT /maxxton/v1/resorts/{resortId}/amenitylinks/{amenityId}
Description
The above endpoint updates the amenity link for that resort. If the amenityId is valid for resort, but not linked yet, then the link will be created.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
amenityId |
amenityId to update/create AmenityLink |
integer (int64) |
Body |
requestBody |
||
Path |
resortId |
resortId to update/create AmenityLink |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while updating/creating amenity links. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/amenitylinks/{amenityId}
Request body
{
"amenityId" : 1,
"endDate" : "01-01-2023",
"numberValue" : 1,
"startDate" : "01-01-2023",
"textValue" : "string"
}
5.40.16. creates a new resort
POST /maxxton/v1/resorts
Description
creates a new resort
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating resort. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts
Request body
{
"adminOrganisationId" : 1,
"code" : "string",
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"resortNumber" : 1,
"resortPriority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"name" : "string",
"shortDescription" : "string"
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
}
}
Example HTTP response
Response 200
{
"adminOrganisationId" : 1,
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"bookableLocation" : true,
"code" : "string",
"dynamicManagerId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"imageManagerId" : 1,
"inheritTc" : true,
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"previousPmsId" : "string",
"resArrivalDateFrom" : "01-01-2023",
"resortId" : 1,
"resortNumber" : 1,
"resortPriority" : 1,
"supplierId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"visitAddressManagerId" : 1
}
5.40.17. updates a existing resort
PUT /maxxton/v1/resorts/{resortId}
Description
updates a existing resort
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Path |
resortId |
resortId to update resort |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while creating resort. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}
Request body
{
"adminOrganisationId" : 1,
"code" : "string",
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"resortNumber" : 1,
"resortPriority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"name" : "string",
"shortDescription" : "string"
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
}
}
Example HTTP response
Response 200
{
"adminOrganisationId" : 1,
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"bookableLocation" : true,
"code" : "string",
"dynamicManagerId" : 1,
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"imageManagerId" : 1,
"inheritTc" : true,
"internalResortNumber" : "string",
"mailAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"mailAddressManagerId" : 1,
"origin" : "string",
"originId" : "string",
"parentId" : 1,
"previousPmsId" : "string",
"resArrivalDateFrom" : "01-01-2023",
"resortId" : 1,
"resortNumber" : 1,
"resortPriority" : 1,
"supplierId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string"
} ],
"visitAddress" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"visitAddressManagerId" : 1
}
5.40.18. updates a resortPriority for a given resortId
POST /maxxton/v1/resorts/{resortId}/priorities
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Path |
resortId |
Resort id for which priority needs to be updated. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
404 |
Resort not found |
No Content |
500 |
Error occurred while updating resort priorities. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/resorts/{resortId}/priorities
Request body
{
"distributionChannelId" : 1,
"endDate" : "01-01-2023",
"priority" : 1,
"resortId" : 1,
"resortPriorityId" : 1,
"segmentId" : 1,
"startDate" : "01-01-2023"
}
5.41. Room types
Defines type of room in an unit
5.41.1. Gets a page with room types
GET /maxxton/v1/roomtypes
Description
Gets a page with room types and its details.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching roomtypes. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/roomtypes
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.42. Rooms
Defines a room in an unit
5.42.1. Gets all amenity links
GET /maxxton/v1/rooms/amenitylinks
Description
Gets a page with all the amenity links.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Amenity links. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/rooms/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"code" : "string",
"endDate" : "01-01-2023",
"numberValue" : 1,
"preferenceExtraId" : 1,
"roomId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.42.2. Gets amenity links for a specific room
GET /maxxton/v1/rooms/{roomId}/amenitylinks
Description
Gets a page with amenity links for a particular room.It also supports pageable.It also supports pageable..
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
roomId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
404 |
No resorts found for given criteria. |
No Content |
500 |
Error occurred while fetching Amenity links. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/rooms/{roomId}/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"code" : "string",
"endDate" : "01-01-2023",
"numberValue" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.43. Send Methods
Send methods of reservation
5.43.1. Gets a send methods for reservations
GET /maxxton/v1/sendmethods
Description
Gets a page with send methods.The records can be filtered based on send method object.It also supports pageable.
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching send methods. |
No Content |
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/sendmethods
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"default" : true,
"extraCostResourceId" : 1,
"isDefault" : true,
"sendMethodId" : 1,
"translations" : [ {
"i18nSendMethodId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"sendMethodId" : 1
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.44. Subjects
Subjects for accommodation types
5.44.1. Gets subject categories
GET /maxxton/v1/subjects/categories
Description
Gets subject categories.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching subject categories. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/subjects/categories
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"maxAge" : 1,
"sort" : 1,
"subjectId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45. Units
Physical accommodation where customer stays
5.45.1. Adds a lock to the specific unit.
POST /maxxton/v1/units/{unitId}/locks
Description
Adds a lock to the specific unit, this makes the unit no longer bookable online. In case a lock already exists for part of the period the existing period is extended.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Path |
unitId |
id of the unit |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while creating unit lock. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/locks
Request body
{
"detailDescription" : "string",
"endDate" : "01-01-2023",
"reasonId" : 1,
"startDate" : "01-01-2023",
"type" : "string",
"unitId" : 1
}
5.45.2. Create Unit
POST /maxxton/v1/units
Description
Adds a new Unit. The details are to be added in request body.
Note: The country field in mailAddress is not allowed while adding a unit.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Responses
Code | Description | Schema |
---|---|---|
200 |
unit created without any error. |
|
500 |
Error occurred while creating unit. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units
Request body
{
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"code" : "string",
"groupPriority" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"rentableUnitId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ]
}
Example HTTP response
Response 200
{
"accommodationAddressManagerId" : 1,
"accommodationMemoManagerId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityManagerId" : 1,
"archivedFrom" : "01-01-2023",
"brandId" : 1,
"cadastralId" : "string",
"capacityManagerId" : 1,
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"concernId" : 1,
"contactManagerId" : 1,
"costCenterId" : 1,
"dynamicManagerId" : 1,
"eventManagerId" : 1,
"excludeQuestionnaireStats" : true,
"fileManagerId" : 1,
"genericMemoManagerId" : 1,
"groupPriority" : 1,
"imageManagerId" : 1,
"implicationManagerId" : 1,
"impliedObject" : true,
"inventoryManagerId" : 1,
"isSeasonalRuleExcluded" : true,
"ledgerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"path" : "string",
"questionnaireStatsManagerId" : 1,
"rentableUnitId" : 1,
"resourceGroupId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"roomCode" : "string",
"roomManagerId" : 1,
"secondLedgerId" : 1,
"setupDate" : "01-01-2023",
"showOnPlanningChart" : true,
"supervisorId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"type" : "string",
"unitId" : 1,
"virtual" : true,
"vsi" : 1
}
5.45.3. Create new amenity link
POST /maxxton/v1/units/{unitId}/amenitylinks
Description
Send an request to the endpoint. This will link the amenity to the unit from the request. After this, you will get the amenityLinkId and information in the response. To update other details for the amenity from the response and update it using the PUT maxxton/v1/units/{unitId}/amenitylink/{amenitylinkId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Path |
unitId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed without any error. |
|
500 |
Error occurred while creating new unit link with amenity. |
No Content |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks
Request body
{
"amenityId" : 1,
"endDate" : "01-01-2023",
"numberValue" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"visible" : true
}
Example HTTP response
Response 200
{
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"categories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"identifier" : "string",
"metric" : {
"code" : "string",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"metricId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
}
5.45.4. Delete amenity link
DELETE /maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
Description
Delete amenity link with a specific amenity id from a specific unit.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
unitId |
integer (int64) |
|
Path |
amenitylinkId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
amenityLink is deleted without any error. |
No Content |
500 |
Error occurred while deleting amenityLink. |
No Content |
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
5.45.5. Get rooms for a specific unitId
GET /maxxton/v1/units/{unitId}/rooms
Description
Provides the details of the rooms specific to a particular unit id. The records can be filtered based on rooms object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
Unit id for which rooms are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Rooms |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/rooms
Example HTTP response
Response 200
{
"content" : [ {
"amenities" : [ {
"amenityLinkId" : 1,
"numberValue" : 1,
"textValue" : "string"
} ],
"code" : "string",
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"roomId" : 1,
"roomManagerId" : 1,
"roomType" : {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.6. Get unit doorlock pincodes
GET /maxxton/v1/units/doorlocks/pincodes
Description
Gets a page of unit doorlock pincodes.
Maximum page size for this endpoint is 100. The records can be filtered based on unit doorlock Pincodes object. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
endDate |
If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate. If only the endDate is provided, pin codes will be returned from the currentDate until endDate, and the duration in between the currentDate and endDate should not be greater than one month. |
string (date) |
Query |
startDate |
If both startDate and endDate are provided, data will be fetched for the specified date range from startDate to endDate. If only the startDate is provided, pin codes will be returned from startDate until the next one month. |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching unit doorlock pincodes |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/doorlocks/pincodes
Example HTTP response
Response 200
{
"content" : [ {
"bluetoothLowEnergy" : true,
"codeLength" : 1,
"doorlockId" : 1,
"lockCode" : "string",
"pincodes" : [ {
"arrivalDate" : "01-01-2023",
"doorlockPincodeId" : 1,
"pincode1" : "string",
"pincode2" : "string",
"statusCode1" : true,
"statusCode2" : true
} ],
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.7. Get workorder for units
GET /maxxton/v1/units/workorders
Description
Get a page of workorders for units.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Workorders |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/workorders
Example HTTP response
Response 200
{
"content" : [ {
"areaName" : "string",
"assigneeEmployeeId" : 1,
"description" : "string",
"expectedStartDate" : "01-01-2023",
"issueCategoryName" : "string",
"item" : "string",
"materialSupplier" : "string",
"reporterEmployeeId" : 1,
"reservationId" : 1,
"status" : "string",
"totalLabourPrice" : 1,
"totalMaterialPrice" : 1,
"totalWorkTime" : 1,
"unitId" : 1,
"workOrderId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.8. Gets Amenity links for units
GET /maxxton/v1/units/amenitylinks
Description
Gets a page with amenity links associated with Units.The records can be filtered based on AmenityDetail object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
unitId |
A unitId to filter amenity links based for specific unit. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching amenity links for units. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"categories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"identifier" : "string",
"metric" : {
"code" : "string",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"metricId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"unitId" : 1,
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.9. Gets Units locks
GET /maxxton/v1/units/locks
Description
Gets a page with Units locks to all unit ids. The records can be filtered based on the lock object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching units locks. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/locks
Example HTTP response
Response 200
{
"content" : [ {
"accoCreatedLock" : 1,
"blockDate" : "01-01-2023",
"clientId" : 1,
"created" : "01-01-2023T11:23:45Z",
"createdOn" : "01-01-2023T11:23:45Z",
"detailDescription" : "string",
"endDate" : "01-01-2023",
"objectId" : 1,
"reasonId" : 1,
"resourceId" : 1,
"resourceLockId" : 1,
"resourceManagerId" : 1,
"startDate" : "01-01-2023",
"type" : "string",
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.10. Gets a single unit
GET /maxxton/v1/units/{unitId}
Description
Gets a single unit based on a specific unit id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
unitId |
Unit id of the unit |
integer (int64) |
Query |
returnWorkOrderUnits |
Work order type units are not returned by default. To get work order type units, this request parameter can be used |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}
Example HTTP response
Response 200
{
"accommodationAddressManagerId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"archivedFrom" : "01-01-2023",
"brandId" : 1,
"capacityManagerId" : 1,
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"doorLockTypes" : [ {
"doorlockTypeId" : 1,
"doorlocks" : [ {
"bluetoothLowEnergy" : true,
"doorLockCode" : "string"
} ],
"endDate" : "01-01-2023",
"lockType" : "string",
"startDate" : "01-01-2023"
} ],
"dynamicManagerId" : 1,
"energyLabelRegistrationNumber" : "string",
"excludeQuestionnaireStats" : true,
"imageManagerId" : 1,
"implicationManagerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"path" : "string",
"previousPmsId" : "string",
"rentableUnitId" : 1,
"resourceGroupId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"roomCode" : "string",
"roomManagerId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"type" : "string",
"unitId" : 1,
"vsi" : 1
}
5.45.11. Gets a unit with details.
GET /maxxton/v1/units/{unitId}/details
Description
Provides a unit with amenities, capacities, images, rooms and dynamic fields.The data is being filtered based on start and end date.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
endDate |
Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Path |
unitId |
Unit id of the unit |
integer (int64) |
Query |
distributionChannelId |
A distributionChannelId to fetch Unit |
integer (int64) |
Query |
returnSections |
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. |
< string > array |
Query |
startDate |
Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Query |
returnWorkOrderUnits |
Work order type units are not returned by default. To get work order type units, this request parameter can be used |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching the unit. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/details
Example HTTP response
Response 200
{
"accommodationAddressManagerId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityCategorySets" : [ {
"categories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ { } ],
"thumbnailUrl" : "string",
"translations" : [ { } ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"managerId" : 1,
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"metricDetail" : {
"code" : "string",
"i18n" : [ { } ],
"metricId" : 1,
"translations" : [ { } ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"archivedFrom" : "01-01-2023",
"brandId" : 1,
"capacities" : [ {
"capacity" : 1,
"capacityId" : 1,
"endDate" : "01-01-2023",
"managerId" : 1,
"startDate" : "01-01-2023",
"subject" : {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
},
"subjectId" : 1
} ],
"capacityManagerId" : 1,
"capacityRequirements" : [ {
"managerId" : 1,
"required" : 1,
"subject" : [ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
} ],
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"doorLockTypes" : [ {
"doorlockTypeId" : 1,
"doorlocks" : [ {
"bluetoothLowEnergy" : true,
"doorLockCode" : "string"
} ],
"endDate" : "01-01-2023",
"lockType" : "string",
"startDate" : "01-01-2023"
} ],
"dynamicFields" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"dynamicManagerId" : 1,
"energyLabelRegistrationNumber" : "string",
"excludeQuestionnaireStats" : true,
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"implicationManagerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"path" : "string",
"previousPmsId" : "string",
"rentableUnitId" : 1,
"resourceGroupId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"roomCode" : "string",
"roomManagerId" : 1,
"rooms" : [ {
"amenities" : [ {
"amenityLinkId" : 1,
"numberValue" : 1,
"textValue" : "string"
} ],
"code" : "string",
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"roomId" : 1,
"roomManagerId" : 1,
"roomType" : {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"type" : "string",
"unitId" : 1,
"videos" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ],
"vsi" : 1
}
5.45.12. Gets all units
GET /maxxton/v1/units
Description
Gets a page with units. The records can be filtered based on unit object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnWorkOrderUnits |
Work order type units are not returned by default. To get work order type units, this request parameter can be used |
boolean |
Query |
unitIds |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching units. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units
Example HTTP response
Response 200
{
"content" : [ {
"accommodationAddressManagerId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"archivedFrom" : "01-01-2023",
"brandId" : 1,
"capacityManagerId" : 1,
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"doorLockTypes" : [ {
"doorlockTypeId" : 1,
"doorlocks" : [ {
"bluetoothLowEnergy" : true,
"doorLockCode" : "string"
} ],
"endDate" : "01-01-2023",
"lockType" : "string",
"startDate" : "01-01-2023"
} ],
"dynamicManagerId" : 1,
"energyLabelRegistrationNumber" : "string",
"excludeQuestionnaireStats" : true,
"imageManagerId" : 1,
"implicationManagerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"path" : "string",
"previousPmsId" : "string",
"rentableUnitId" : 1,
"resourceGroupId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"roomCode" : "string",
"roomManagerId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"type" : "string",
"unitId" : 1,
"vsi" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.13. Gets all units with their details
GET /maxxton/v1/units/details
Description
Gets a page of units along with their details. Maximum and default page size for this endpoint is 10.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Query |
returnSections |
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. |
< string > array |
Query |
returnWorkOrderUnits |
Work order type units are not returned by default. To get work order type units, this request parameter can be used |
boolean |
Query |
unitIds |
List of unitIds to fetch the details |
< integer > array |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching units. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/details
Example HTTP response
Response 200
{
"content" : [ {
"accommodationAddressManagerId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityCategorySets" : [ {
"categories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ { } ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : { },
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"archivedFrom" : "01-01-2023",
"brandId" : 1,
"capacities" : [ {
"capacity" : 1,
"capacityId" : 1,
"endDate" : "01-01-2023",
"managerId" : 1,
"startDate" : "01-01-2023",
"subject" : {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
},
"subjectId" : 1
} ],
"capacityManagerId" : 1,
"capacityRequirements" : [ {
"managerId" : 1,
"required" : 1,
"subject" : [ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
} ],
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"doorLockTypes" : [ {
"doorlockTypeId" : 1,
"doorlocks" : [ {
"bluetoothLowEnergy" : true,
"doorLockCode" : "string"
} ],
"endDate" : "01-01-2023",
"lockType" : "string",
"startDate" : "01-01-2023"
} ],
"dynamicFields" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"dynamicManagerId" : 1,
"energyLabelRegistrationNumber" : "string",
"excludeQuestionnaireStats" : true,
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"implicationManagerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"path" : "string",
"previousPmsId" : "string",
"rentableUnitId" : 1,
"resourceGroupId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"roomCode" : "string",
"roomManagerId" : 1,
"rooms" : [ {
"amenities" : [ {
"amenityLinkId" : 1,
"numberValue" : 1,
"textValue" : "string"
} ],
"code" : "string",
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"roomId" : 1,
"roomManagerId" : 1,
"roomType" : {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"type" : "string",
"unitId" : 1,
"videos" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ],
"vsi" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.14. Gets allotments for Unit to a specific unit id.
GET /maxxton/v1/units/{unitId}/allotments
Description
Gets a page with all allotments for Unit to a specific unit id.The records can be filtered based on allotment object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
Unit id for which to fetch Allotments |
integer (int64) |
Query |
distributionChannelId |
DistributionChannel id for which to fetch Allotments |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching Allotments. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/allotments
Example HTTP response
Response 200
{
"content" : [ {
"allotmentId" : 1,
"amount" : 1,
"description" : "string",
"distributionChannelId" : 1,
"exceedLimit" : 1,
"expirePeriod" : 1,
"hasObjects" : true,
"isEnactive" : true,
"modified" : "01-01-2023",
"name" : "string",
"periods" : [ {
"endDate" : "01-01-2023",
"quantity" : 1,
"startDate" : "01-01-2023",
"unitIds" : [ "integer" ]
} ],
"resourceId" : 1,
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.15. Gets amenity links to a specific unit id.
GET /maxxton/v1/units/{unitId}/amenitylinks
Description
Gets a page with amenity links associated with Unit to a specific unit id.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
unitId |
unitId to fetch amenity links. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching amenity links for unit. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks
Example HTTP response
Response 200
{
"content" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"categories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"identifier" : "string",
"metric" : {
"code" : "string",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"metricId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"unitId" : 1,
"visible" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.16. Gets capacity list of the unit
GET /maxxton/v1/units/{unitId}/capacities
Description
Gets capacities associated with Unit, capacity specify the details about the number persons (Adult, Youngster, Baby etc.) or pets that can be accommodated in the unit. This endpoint provides capacities for a unit.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
unitId to fetch capacities |
integer (int64) |
Query |
returnWorkOrderUnits |
Work order type units or their capacities are not returned by default. To get work order type units, this request parameter can be used with true value |
boolean |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< Capacity |
500 |
Error occurred while fetching capacities for unit. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/capacities
Example HTTP response
Response 200
[ {
"capacity" : 1,
"capacityId" : 1,
"endDate" : "01-01-2023",
"managerId" : 1,
"name" : "string",
"startDate" : "01-01-2023",
"subjectId" : 1
} ]
5.45.17. Gets contracts to a particular unit id.
GET /maxxton/v1/units/{unitId}/contracts
Description
Gets a page with Contracts associated with Unit to a specific unit id. It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
unitId to fetch contracts. |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching contracts for unit. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/contracts
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"contractId" : 1,
"contractRenewalReminder" : "01-01-2023",
"contractTypeId" : 1,
"endDate" : "01-01-2023",
"name" : "string",
"origin" : "string",
"originId" : "string",
"ownerId" : 1,
"poolOwnerId" : 1,
"rentAssurance" : 1,
"resourceId" : 1,
"startDate" : "01-01-2023",
"targetAmount" : 1,
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.18. Gets dynamic fields for a particular unit
GET /maxxton/v1/units/{unitId}/dynamicfields
Description
Gets a page with dynamic fields to a specific unit. The records can be filtered based on the DynamicField object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
Unit id for which dynamic fieilds are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching unit dynamic fields. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/dynamicfields
Example HTTP response
Response 200
{
"content" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.19. Gets images for a particular unit
GET /maxxton/v1/units/{unitId}/images
Description
Gets a page with images to a specific uint. The records can be filtered based on the image object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
unit id for which images are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching unit images. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/images
Example HTTP response
Response 200
{
"content" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.20. Gets unit implies for a unit id.
GET /maxxton/v1/units/{unitId}/implies
Description
Gets a page with unit implies for a specific unit id. The records can be filtered based on implies object.It also supports pageable.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
unit id for which implies are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching unit implies. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/implies
Example HTTP response
Response 200
{
"content" : [ {
"addToParent" : 1,
"bookDateFrom" : "01-01-2023",
"bookDateTo" : "01-01-2023",
"countFromMin" : true,
"ignoreRentability" : true,
"implicationManagerId" : 1,
"implied" : [ {
"objectId" : 1,
"resourceId" : 1
} ],
"impliesId" : 1,
"implyOnce" : true,
"included" : true,
"onBill" : true,
"parent" : true,
"parentId" : 1,
"priority" : 1,
"quantityMax" : 1,
"quantityMin" : 1,
"removable" : true,
"required" : true,
"resourceId" : 1,
"resourceIds" : [ "integer" ],
"showOnAllInPriceBill" : true,
"showPrice" : true,
"stay" : true,
"subjectsMax" : 1,
"subjectsMin" : 1,
"supplierImpliesId" : 1,
"validFrom" : "01-01-2023",
"validTo" : "01-01-2023"
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.21. Gets unit locks to a specific unit id.
GET /maxxton/v1/units/{unitId}/locks
Description
Gets a page with Unit locks specific to a particular unit id. The records can be filtered based on locks object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Following fields can be used for filtering response. |
enum ( |
Path |
unitId |
Unit id for which locks are to be fetched |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while fetching unit locks. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/locks
Example HTTP response
Response 200
{
"content" : [ {
"accoCreatedLock" : 1,
"blockDate" : "01-01-2023",
"clientId" : 1,
"created" : "01-01-2023T11:23:45Z",
"createdOn" : "01-01-2023T11:23:45Z",
"detailDescription" : "string",
"endDate" : "01-01-2023",
"objectId" : 1,
"reasonId" : 1,
"resourceId" : 1,
"resourceLockId" : 1,
"resourceManagerId" : 1,
"startDate" : "01-01-2023",
"type" : "string",
"unitId" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
5.45.22. Gets units of resource
GET /maxxton/v1/units/{resourceId}/children
Description
Gets list of units of resource to a specific resource id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
resourceId |
resource id to fetch all units of resource |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
< UnitDetail |
500 |
Error occurred while fetching resource units. |
No Content |
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{resourceId}/children
Example HTTP response
Response 200
[ {
"accommodationAddressManagerId" : 1,
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"altContactPerson" : "string",
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"country" : {
"code" : "string",
"countryId" : 1,
"default" : true,
"defaultLanguageId" : 1,
"priority" : 1,
"shortName" : "string",
"translations" : [ {
"i18nCountryId" : 1,
"language" : "string",
"languageId" : 1,
"longName" : "string",
"name" : "string"
} ]
},
"countryId" : 1,
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"amenityCategorySets" : [ {
"categories" : [ {
"amenities" : [ {
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"i18n" : [ { } ],
"identifier" : "string",
"imageManagerId" : 1,
"images" : [ { } ],
"managerId" : 1,
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"amenityCategoryId" : 1,
"amenityGroups" : [ {
"amenities" : [ { } ],
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"code" : "string",
"endDate" : "01-01-2023",
"identifier" : "string",
"managerId" : 1,
"metric" : { },
"metricDetail" : { },
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ { } ],
"type" : "string",
"visible" : true
} ],
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"priority" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"code" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"archivedFrom" : "01-01-2023",
"brandId" : 1,
"capacities" : [ {
"capacity" : 1,
"capacityId" : 1,
"endDate" : "01-01-2023",
"managerId" : 1,
"startDate" : "01-01-2023",
"subject" : {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
},
"subjectId" : 1
} ],
"capacityManagerId" : 1,
"capacityRequirements" : [ {
"managerId" : 1,
"required" : 1,
"subject" : [ {
"controlAccess" : true,
"endDate" : "01-01-2023",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"includeInTotal" : true,
"maxAge" : 1,
"reportGroupSubjectId" : 1,
"subjectCategoryId" : 1,
"subjectId" : 1,
"subjectOrder" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"subjectId" : 1
} ],
"type" : "string"
} ]
} ],
"choosableOnInternet" : true,
"cleaningStatus" : "string",
"code" : "string",
"doorLockTypes" : [ {
"doorlockTypeId" : 1,
"doorlocks" : [ {
"bluetoothLowEnergy" : true,
"doorLockCode" : "string"
} ],
"endDate" : "01-01-2023",
"lockType" : "string",
"startDate" : "01-01-2023"
} ],
"dynamicFields" : [ {
"code" : "string",
"eventmanagerId" : 1,
"fieldId" : 1,
"translations" : [ {
"description" : "string",
"fieldId" : 1,
"i18nFieldId" : 1,
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"text" : "string"
} ],
"type" : "string"
} ],
"dynamicManagerId" : 1,
"energyLabelRegistrationNumber" : "string",
"excludeQuestionnaireStats" : true,
"imageManagerId" : 1,
"images" : [ {
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
} ],
"implicationManagerId" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"path" : "string",
"previousPmsId" : "string",
"rentableUnitId" : 1,
"resourceGroupId" : 1,
"resourceId" : 1,
"resourceManagerId" : 1,
"roomCode" : "string",
"roomManagerId" : 1,
"rooms" : [ {
"amenities" : [ {
"amenityLinkId" : 1,
"numberValue" : 1,
"textValue" : "string"
} ],
"code" : "string",
"lowestLevel" : true,
"name" : "string",
"parentId" : 1,
"roomId" : 1,
"roomManagerId" : 1,
"roomType" : {
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"roomTypeId" : 1,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ],
"type" : "string",
"unitId" : 1,
"videos" : [ {
"endDate" : "01-01-2023",
"hostType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageCode" : "string",
"mediaLanguageId" : 1,
"mediaType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"thumbnailUrl" : "string",
"url" : "string",
"videoId" : 1
} ],
"vsi" : 1
} ]
5.45.23. Removes lock for the provided unit Id.
DELETE /maxxton/v1/units/{unitId}/locks
Description
Removes lock for the provided unit Id. The lock is only released for the period specified in the start date and until the end date(included). In case this is within a bigger period two new locks are created to keep the rest of the locked period locked and only the specified period is released from the lock.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
endDate |
Lock end date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Path |
unitId |
id of the unit |
integer (int64) |
Query |
startDate |
Lock start date. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
Responses
Code | Description | Schema |
---|---|---|
204 |
lock for given unit is deleted without any error. |
No Content |
404 |
No Lock Found for given startDate and endDate |
No Content |
500 |
Error occurred while deleting unit lock. |
No Content |
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/locks
5.45.24. Search units based on provided criteria
POST /maxxton/v1/units/search
Description
The above endpoint is used to search through the availability of the whole inventory based on all unit ids, this can be filtered by providing request criteria. For example: arrival date, duration, resort, accommodation type, amenities and subjects are possible filters. The result can contain filter options, filter options provide all possible filter possibilities based on the currently provided filter options. This provides you with all possible arrivals, departures, resorts, units and amenities as per the criteria passed in the request. If "includeAllPrices" field is passed as true in the request, it will provide 10 records in the response, if it is provided as false, then only the first record is displayed in the response.
In case of prebooking, the prices returned would be null.
Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown.
The "dateMargin" request parameter will provide up to 4 alternative stays according to the number that is supplied in "dateMargin" in case there is no match with the requested criteria. It’s up to the client to choose which of these alternatives to use. In case there is an exact match with the requested stay dates only 1 available stay is provided in the result. See below diagram for an explanation on how the alternative stays work:
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
||
Query |
sort |
Sort parameter is used to sort the response in ascending or descending order on the basis of offer price. In order to sort the response in ascending order 'offer_price_asc' is used and to sort in descending order the value of sort that should be passed is 'offer_price_desc' |
string |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
400 |
|
No Content |
500 |
Error occurred while fetching accommodationTypes |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/search
Request body
{
"accommodationKindIds" : [ "integer" ],
"amenityIds" : [ "integer" ],
"arrivalDate" : "01-01-2023",
"dateMargin" : 1,
"dateMarginMethod" : "string",
"distributionChannelId" : 1,
"duration" : 1,
"filterOptions" : [ "string" ],
"includeAllPrices" : true,
"includeFilterOptionCounts" : true,
"maxNrOfBathrooms" : 1,
"maxNrOfBedrooms" : 1,
"minNrOfBathrooms" : 1,
"minNrOfBedrooms" : 1,
"offerCode" : "string",
"offerId" : 1,
"petQuantity" : 1,
"redeemableLoyaltyPoints" : 1,
"regionId" : 1,
"resortId" : 1,
"resourceIds" : [ "integer" ],
"subjects" : {
"persons" : [ {
"maxAge" : "string",
"quantity" : 1
} ]
},
"voucherCode" : "string"
}
Example HTTP response
Response 200
{
"filterOptionsResult" : {
"accommodationKinds" : [ "object" ],
"amenities" : [ "object" ],
"arrivals" : [ "string" ],
"departures" : [ "string" ],
"resorts" : [ "object" ]
},
"result" : {
"content" : [ {
"accommodationKindId" : 1,
"arrivalDate" : "01-01-2023",
"basePrice" : 1,
"basePriceInclusive" : 1,
"departureDate" : "01-01-2023",
"duration" : 1,
"freeLoyaltyDuration" : 1,
"loyaltyPrice" : 1,
"loyaltyPriceInclusive" : 1,
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"offerCode" : "string",
"offerName" : "string",
"offerPrice" : 1,
"offerPriceInclusive" : 1,
"priority" : 1,
"rateTypeId" : 1,
"requiredLoyaltyPoints" : 1,
"resortId" : 1,
"resourceId" : 1,
"totalCapacity" : 1,
"unitId" : 1,
"unitRating" : 1
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 1,
"numberOfElements" : 1,
"size" : 1,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 1,
"totalPages" : 1
}
}
5.45.25. Update/insert unit’s dynamic field
PUT /maxxton/v1/units/{unitId}/dynamicfields/{fieldId}
Description
The above endpoint updates the text field of dynamic fields for specific language. If the dynamic field is valid for unit, but not linked yet, then the link will be created. When a user is updating the dynamic field and if the link is already created with the unit, then the text field will be modified
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
< DynamicFieldDataCriteria |
|
Path |
unitId |
unitId to fetch unit |
integer (int64) |
Path |
fieldId |
fieldId to fetch dynamic field |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while fetching updating/inserting the unit dynamic fields. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/dynamicfields/{fieldId}
Request body
[ {
"language" : "string",
"text" : "string"
} ]
5.45.26. Updates a single unit
PUT /maxxton/v1/units/{unitId}
Description
Updates a single unit
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request body to update the unit |
|
Path |
unitId |
Unit id of the unit |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
204 |
The request is completed successfully without any errors |
No Content |
500 |
Error occurred while updating the unit. |
No Content |
Consumes
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}
Request body
{
"address" : {
"accuracy" : "string",
"address1" : "string",
"address2" : "string",
"address3" : "string",
"addressId" : 1,
"alternateContactPerson" : "string",
"boxNumber" : "string",
"city" : "string",
"dateBegin" : "01-01-2023",
"dateEnd" : "01-01-2023",
"district" : "string",
"email" : "string",
"exposeLocation" : true,
"fax" : "string",
"houseNumber" : "string",
"houseNumberSuffix" : "string",
"latitude" : 1,
"longitude" : 1,
"mobilePhone" : "string",
"mobilePhone2" : "string",
"municipality" : "string",
"poBox" : "string",
"poBoxCity" : "string",
"poBoxZipcode" : "string",
"privatePhone" : "string",
"stateId" : 1,
"workPhone" : "string",
"zipCode" : "string"
},
"cleaningStatus" : "string",
"code" : "string",
"nrOfBathrooms" : 1,
"nrOfBedrooms" : 1,
"origin" : "string",
"originId" : "string",
"rentableUnitId" : 1,
"resourceId" : 1,
"translations" : [ {
"description" : "string",
"description2" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string",
"shortDescription" : "string",
"unitId" : 1
} ]
}
5.45.27. Updates details of existing amenity link.
PUT /maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
Description
Updates details of existing amenity link.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
Request body to update the start and end date of the amenity link. |
|
Path |
unitId |
integer (int64) |
|
Path |
amenitylinkId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed without any error. |
|
500 |
Error occurred while creating new unit link with amenity. |
No Content |
Consumes
-
application/json
Produces
-
application/json
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/amenitylinks/{amenitylinkId}
Request body
{
"endDate" : "01-01-2023",
"startDate" : "01-01-2023"
}
Example HTTP response
Response 200
{
"amenityId" : 1,
"amenityLinkId" : 1,
"archivedFrom" : "01-01-2023",
"categories" : [ {
"amenityCategoryId" : 1,
"code" : "string",
"i18n" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"isInternalUse" : true,
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
} ],
"endDate" : "01-01-2023",
"identifier" : "string",
"metric" : {
"code" : "string",
"i18n" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"metricId" : 1,
"translations" : [ {
"language" : "string",
"languageId" : 1,
"name" : "string"
} ]
},
"numberValue" : 1,
"origin" : "string",
"parentAmenityId" : 1,
"preferenceExtraId" : 1,
"startDate" : "01-01-2023",
"textValue" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"type" : "string",
"visible" : true
}
5.45.28. Updates details of existing image.
PUT /maxxton/v1/units/{unitId}/images/{imageId}
Description
Updates details of existing image.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
imageId |
imageId id of the image to be updated |
integer (int64) |
Body |
requestBody |
||
Path |
unitId |
unitId id of the Unit |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
Image is updated without any error. |
|
500 |
Error occurred while updating image. |
No Content |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/images/{imageId}
Request body
{
"endDate" : "01-01-2023",
"imageOrientation" : "string",
"imageType" : "string",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"version" : 1
}
Example HTTP response
Response 200
{
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
}
5.45.29. Upload Image for a particular unit.
POST /maxxton/v1/units/{unitId}/images/upload
Description
Send an image as content-type:multipart to the endpoint. This will upload the image to the Maxxton CDN and link it to the unit from the request. After this, you will get the image Id and information in the response. To update other details for the image use the imageId from the response and update it using the PUT /units/{unitId}/images/{imageId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
requestBody |
object |
|
Path |
unitId |
integer (int64) |
Responses
Code | Description | Schema |
---|---|---|
200 |
The request is completed successfully without any errors |
|
500 |
Error occurred while uploading unit. |
No Content |
Consumes
-
application/json
Produces
-
/
Example HTTP request
Request path
/maxxton/v1/units/{unitId}/images/upload
Example HTTP response
Response 200
{
"endDate" : "01-01-2023",
"fileName" : "string",
"hostType" : "string",
"imageId" : 1,
"imageManagerId" : 1,
"imageManagerIds" : [ "integer" ],
"imageOrientation" : "string",
"imageType" : "string",
"isActive" : true,
"isUploaded" : true,
"isWebPresentation" : true,
"mediaLanguageId" : 1,
"mediaType" : "string",
"mimeType" : "string",
"modifiedDate" : "01-01-2023T11:23:45Z",
"sequenceNumber" : 1,
"startDate" : "01-01-2023",
"tags" : [ {
"name" : "string",
"tagId" : 1
} ],
"thumbnailUrl" : "string",
"translations" : [ {
"description" : "string",
"language" : "string",
"languageId" : 1,
"name" : "string"
} ],
"uploadDate" : "01-01-2023T11:23:45Z",
"url" : "string",
"version" : 1
}
6. Definitions
6.1. AccommodationKind
Name | Description | Schema |
---|---|---|
accommodationkindId |
unique id associated with each accommodationKind |
integer (int64) |
name |
name associated with each accommodationKind |
string |
isWorkOrderObject |
Write only (field is only accessible in the request body) |
boolean |
translations |
information of the accommodation kind which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nAccommodationKind |
code |
unique code associated with each accommodationKind |
string |
6.2. AccommodationKindDetail
Name | Description | Schema |
---|---|---|
accommodationkindId |
unique id associated with each accommodationKind |
integer (int64) |
code |
unique code associated with each accommodationKind |
string |
priority |
it defines acoommodation kind priority |
integer (int32) |
translations |
information of the accommodation kind which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nAccommodationKind |
excludeFromReporting |
It specifies if the accommodation types linked to the corresponding accommodation kind is excluded or not from the statistical/reporting data. |
boolean |
workOrderUnits |
boolean |
|
archivedFrom |
string (date) |
6.3. AccommodationType
Name | Description | Schema |
---|---|---|
resourceId |
unique id associated with each accommodationtype |
integer (int64) |
resourceManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
ledgerGroupId |
integer (int64) |
|
type |
type of the resource i.e ACCOMMODATIONTYPE |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
code |
unique code associated with each accommodationtype |
string |
resortId |
unique id associated with each resort to which the accommodationtype belong |
integer (int64) |
parentId |
if the accommodationtype is child to another accommodationtype then the id of the parent accommodationtype is displayed in response |
integer (int64) |
path |
the field denotes where the accommodationtype is located |
string |
hasObjects |
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. |
boolean |
dependsOnLedgerGroup |
if the accommodationtype ledger depends on a ledger group then the field is true else false |
boolean |
priority |
the sequence in which the accommodationtype will be visible to the user |
integer (int32) |
numberOfPersons |
total number of persons which an accommodationtype can accommodate |
integer (int32) |
nrOfBedrooms |
number of bedrooms that an accommodationtype possess |
number (double) |
nrOfBathrooms |
number of bathrooms that an accommodationtype can possess |
number (double) |
accotypeKindId |
unique id associated with each kind of accommodationtype |
integer (int64) |
supplierOrigin |
If the accommodationtype is consuming units from supplier then the name of the supplier is displayed deprecated |
string |
translations |
information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nResource |
accotypeAddressmanagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
cashflowManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
brandId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
Write only (field is only accessible in the request body) |
string |
shortDescription |
Write only (field is only accessible in the request body) |
string |
description |
Write only (field is only accessible in the request body) |
string |
realRentabilityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
address |
||
capacityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
amenityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
archivedFrom |
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) |
string (date) |
ledgerId |
integer (int64) |
|
brand |
label associated with the accommodationtype by which an accommodationtype can be sold out. It can vary from website to website for same accommodationtype. |
string |
origin |
string |
|
originId |
string |
|
powerplayGroupId |
integer (int64) |
|
groupId |
integer (int64) |
|
qualityLevelId |
integer (int64) |
|
previousPmsId |
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 |
string |
accotypeDoorlock |
Number cards/keys for accommodation |
integer (int64) |
accotypeBarrier |
Number of access cards for entry barrier at a location |
integer (int64) |
i18n |
Write only (field is only accessible in the request body) |
< I18nResource |
accommodationTypeKindCode |
unique code associated with each accommodationkind |
string |
6.4. AccommodationTypeAddon
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
resortId |
integer (int64) |
|
bookDateFrom |
string (date) |
|
bookDateTo |
string (date) |
|
translations |
< I18nAddon |
|
arrivalDateFrom |
string (date) |
|
arrivalDateTo |
string (date) |
|
prices |
< AddonPrice |
|
minQuantity |
Minimum quantity of the add-on that needs to be available in the reservation |
integer (int64) |
maxQuantity |
Maximum quantity of the add-on that needs to be available in the reservation |
integer (int64) |
6.5. AccommodationTypeAmenityLink
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated which tells the amenity is linked to a resource |
integer (int64) |
type |
type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
visible |
if the amenity linked should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
startDate |
date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
amenityId |
unique id associated with each amenity |
integer (int64) |
code |
unique code associated with each amenity |
string |
translations |
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. |
< I18nAmenity |
accommodationTypeId |
unique id associated with each accommodationtype |
integer (int64) |
6.6. AccommodationTypeCostPrice
Name | Description | Schema |
---|---|---|
costPriceId |
unique id associated with CostPrice |
integer (int64) |
resourceId |
unique code associated with resource |
integer (int64) |
arrivalDateFrom |
start of period within a period of the reservation(between and including arrival and departure date) |
string (date) |
arrivalDateTo |
end of period within a period of the reservation(between and including arrival and departure date) |
string (date) |
bookDateFrom |
the date from which cost price will be valid |
string (date-time) |
bookDateTo |
the date till which CostPrice will be valid |
string (date-time) |
duration |
specifies the duration for which cost price can be applied |
integer (int64) |
minDuration |
minimum number of days CostPrice will be valid |
integer (int64) |
maxDuration |
maximum number of days CostPrice will be valid |
integer (int64) |
value |
value of the CostPrice |
number (double) |
currencyId |
unique id associated with currency |
integer (int64) |
valueType |
value types of rate |
string |
usageDowList |
the days of the week on which CostPrices can be applied |
< string > array |
currencyCode |
unique code associated with currency |
string |
6.7. AccommodationTypeDetail
Name | Description | Schema |
---|---|---|
resourceId |
unique id associated with each accommodationtype |
integer (int64) |
code |
unique code associated with each accommodationtype |
string |
ledgerGroupId |
integer (int64) |
|
resortId |
unique id associated with each resort to which the accommodationtype belong |
integer (int64) |
brandId |
unique id associated with each brand |
integer (int64) |
priority |
the sequence in which the accommodationtype will be visible to the user |
integer (int32) |
nrOfBedrooms |
number of bedrooms that an accommodationtype possess |
number (double) |
nrOfBathrooms |
number of bathrooms that an accommodationtype can possess |
number (double) |
hasObjects |
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. |
boolean |
path |
the field denotes where the accommodationtype is located |
string |
checkinTime |
||
checkoutTime |
||
lateCheckoutTime |
||
earlyCheckinTime |
||
translations |
information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nResource |
dynamicFields |
user-defined and customized fields |
< DynamicField |
address |
||
images |
details of the images associated to the accommodationtype |
< Image |
videos |
details associated with videos related to the accommodationtype |
< Video |
amenityCategorySets |
group of amenity categories |
< AmenityCategorySetDetail |
capacities |
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 |
< CapacityDetail |
capacityRequirements |
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 |
< Requirement |
rooms |
different part of units in an accommodation are considered as rooms ex: bedrooms, living rooms etc |
< Room |
accommodationKind |
||
brand |
label associated with the accommodationtype by which an accommodationtype can be sold out. It can vary from website to website for same accommodationtype. |
string |
archivedFrom |
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) |
string (date) |
ledgerId |
integer (int64) |
|
parentId |
integer (int64) |
|
numberOfPersons |
integer (int32) |
|
accotypeKindId |
integer (int64) |
|
origin |
string |
|
originId |
string |
|
powerplayGroupId |
integer (int64) |
|
resourcegroupId |
Write only (field is only accessible in the request body) |
integer (int64) |
resourceGroup |
||
qualityLevelId |
integer (int64) |
|
previousPmsId |
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 |
string |
accotypeDoorlock |
Number cards/keys for accommodation |
integer (int64) |
accotypeBarrier |
Number of access cards for entry barrier at a location |
integer (int64) |
i18n |
Write only (field is only accessible in the request body) |
< I18nResource |
accommodationTypeKindCode |
unique code associated with each accommodationtypekind |
string |
6.8. AccommodationTypeImply
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
resortId |
integer (int64) |
|
bookDateFrom |
string (date) |
|
bookDateTo |
string (date) |
|
translations |
< I18nImply |
|
arrivalDateFrom |
string (date) |
|
arrivalDateTo |
string (date) |
|
required |
boolean |
|
prices |
< ImplyPrice |
|
stayDate |
Mandatory stay dates for the applicable rates |
< string > array |
minQuantity |
Minimum quantity of the mandatory add-on that needs to be available in the reservation |
integer (int64) |
maxQuantity |
Maximum quantity of the mandatory add-on that can be available in the reservation |
integer (int64) |
subjectsMin |
Linked mandatory add-on is applicable for specific subjects(specified in prices → subjectIds field) and/or should be added in the reservation only for a minimum subject quantity specified here. |
integer (int64) |
subjectsMax |
Linked mandatory add-on is applicable for specific subjects(specified in prices → subjectIds field) and/or should be added in the reservation only for a maximum subject quantity specified here. |
integer (int64) |
included |
Mandatory add-on can be marked as included/not included in bill. If marked as 'included in bill' then guests are not charged for the add-on separately |
boolean |
addToParent |
If the value is true, the price will be added to the accommodation type base price and will not be shown separately.In case the value is false the price will be shown separately on the bill and not be part of the accommodation type base price. |
boolean |
6.9. AccommodationTypePreference
Name | Description | Schema |
---|---|---|
resourceId |
Id of preference addon. |
integer (int64) |
resortId |
integer (int64) |
|
preferenceTypes |
List of preference type this addon applies to. Possible values: UNIT,ADJACENT,MISCELLANEOUS |
< string > array |
prices |
< PreferencePrice |
6.10. AccommodationTypePriority
Name | Description | Schema |
---|---|---|
accommodationtypePriorityId |
integer (int64) |
|
resourceId |
integer (int64) |
|
fiscalYear |
||
fiscalyearId |
Write only (field is only accessible in the request body) |
integer (int64) |
reservationFrom |
string (date) |
|
reservationTo |
string (date) |
|
useContractPriority |
boolean |
|
useVsi |
boolean |
|
useOccupation |
boolean |
|
useTargetAmount |
boolean |
|
usePlanboardFitting |
boolean |
|
useQuestionnaire |
boolean |
|
prioritySequence |
string |
6.11. AccommodationTypeRangeSearchFilterOption
Name | Description | Schema |
---|---|---|
arrivals |
unique items |
< string > array |
departures |
unique items |
< string > array |
qualityLevels |
quality level ids on which user can filter data unique items |
< integer > array |
6.12. AccommodationTypeRelease
Name | Description | Schema |
---|---|---|
releaseId |
integer (int64) |
|
maxArrivalDate |
string (date) |
|
minArrivalDate |
string (date) |
|
releasedDays |
integer (int64) |
|
status |
enum (CLOSED,OPEN_TEST,OPEN_OWNER,OPEN) |
|
resourceId |
integer (int64) |
|
createdDate |
string (date-time) |
|
modifiedDate |
string (date-time) |
6.13. AccommodationTypeSearchFilterOption
Name | Description | Schema |
---|---|---|
arrivals |
unique items |
< string > array |
departures |
unique items |
< string > array |
resorts |
If includeFilterOptionCounts is "true" in request body, then all the available resortIds and their respective counts as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the resortIds are displayed in response. unique items |
< object > array |
amenities |
If includeFilterOptionCounts is "true" in request body, then all the available amenities and their respective counts(No of accommodations in which that amenity is available) as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the amenityIds are displayed in response. unique items |
< object > array |
accommodationKinds |
accommodationkind ids on which user can filter data unique items |
< object > array |
qualityLevels |
quality level ids on which user can filter data unique items |
< integer > array |
6.14. Account
Name | Description | Schema |
---|---|---|
accountId |
integer (int64) |
|
name |
string |
|
currencyId |
integer (int64) |
|
currencyCode |
string |
|
bankAccount |
6.15. AccountCurrency
Name | Description | Schema |
---|---|---|
debitVatIncluded |
number |
|
debitVatExcluded |
number |
|
creditVatExcluded |
number |
|
getcreditVatIncluded |
number |
|
currencyId |
integer (int64) |
|
currencyCode |
string |
|
exchangeRate |
integer (int64) |
6.16. AddOn
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
code |
string |
|
resortId |
integer (int64) |
|
parentId |
integer (int64) |
|
path |
string |
|
cashflowManagerId |
integer (int64) |
|
allowPriceOverride |
boolean |
|
addonType |
string |
|
translations |
< I18nResource |
|
source |
string |
|
showNilPriceOnBill |
boolean |
|
powerplaygroupId |
integer (int64) |
|
allowMovingToMainBill |
boolean |
|
archivedFrom |
string (date) |
|
searchCode |
string |
|
excludePriceCache |
boolean |
|
specialPriority |
integer (int32) |
|
name |
Write only (field is only accessible in the request body) |
string |
shortDescription |
Write only (field is only accessible in the request body) |
string |
description |
Write only (field is only accessible in the request body) |
string |
autoValidateValue |
Write only (field is only accessible in the request body) |
integer (int32) |
type |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
|
resortArticle |
If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately. |
boolean |
stayArticle |
boolean |
|
reservationArticle |
boolean |
|
cashArticle |
boolean |
|
ownerArticle |
boolean |
|
invoiceArticle |
boolean |
|
perDay |
boolean |
|
customizable |
boolean |
|
stockType |
string |
|
withholdingArticle |
boolean |
|
warrant |
boolean |
|
correction |
boolean |
|
commission |
boolean |
|
vatCommission |
boolean |
|
cancelPremium |
boolean |
|
cancelCompensation |
boolean |
|
adjustment |
boolean |
|
repaymentVoucher |
boolean |
|
earlyCheckin |
boolean |
|
showDatesOnInternet |
boolean |
|
allowToAddInCiCo |
boolean |
|
tax |
boolean |
|
maxQuantity |
integer (int64) |
|
commissionVatIncluded |
boolean |
|
implicationManagerId |
integer (int64) |
|
ledgerId |
integer (int64) |
|
ledgerGroupId |
integer (int64) |
|
dependsOnLedgerGroup |
boolean |
|
dependencyMask |
enum (NONE,ARRIVAL,DEPARTURE,ARRIVAL_DEPARTURE) |
|
i18n |
Write only (field is only accessible in the request body) |
< I18nResource |
autoValidate |
boolean |
6.17. Addition
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
type |
enum (PRODUCTTYPE,RESOURCEACTIVITY,ACTIVITY,ACCOMMODATIONTYPE,EXTRA,SPECIAL,COMPOSITION) |
|
name |
string |
|
shortDescription |
string |
|
description |
string |
|
price |
number (double) |
|
minQuantity |
integer (int32) |
|
maxQuantity |
integer (int32) |
|
completed |
Write only (field is only accessible in the request body) |
boolean |
code |
Write only (field is only accessible in the request body) |
string |
supplierId |
Write only (field is only accessible in the request body) |
integer (int64) |
startDate |
string (date) |
|
endDate |
string (date) |
|
addonType |
string |
|
allowPriceOverride |
Write only (field is only accessible in the request body) |
boolean |
resortArticle |
If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately. |
boolean |
6.18. AdditionAccommodationType
Name | Description | Schema |
---|---|---|
arrivalDate |
string (date) |
|
duration |
integer (int32) |
|
rateTypeId |
integer (int64) |
|
resourceId |
integer (int64) |
|
unitId |
integer (int64) |
|
subjects |
6.19. AdditionRequest
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
quantity |
integer (int32) |
|
memo |
Maximum Length: 500 |
string |
name |
string |
|
price |
number (double) |
6.20. AddonPrice
Name | Description | Schema |
---|---|---|
price |
Single value rate and qrv resourcebase rate |
number (double) |
priceArrivalDateFrom |
string (date) |
|
priceArrivalDateTo |
string (date) |
|
perDay |
string |
|
duration |
Number of minutes in a day times the applicable duration of the rate, that is weekly or nightly or per booking or custom. |
integer (int32) |
daysOfWeek |
Denotes the days of week. Calculated as Sum of 2^N where N is 0 = Monday, 1 = Tuesday, … , 6 = Sunday |
< string > array |
minQuantity |
Deprecated. not part of addon price deprecated |
integer (int64) |
maxQuantity |
Deprecated. not part of addon price deprecated |
integer (int64) |
subjectIds |
deprecated |
< integer > array |
dependsOnOffer |
Flag to indicate if the price depend on offers |
boolean |
offerIds |
Offer ids of offers on which the addon price depends on |
< integer > array |
dependsOnAddon |
Flag to indicate if the price depend on addons |
boolean |
addonIds |
Addon ids of addons on which the addon price depends on |
< integer > array |
dependsOnAccommodationtypes |
Depends on accommodationtype provided in request |
boolean |
percentagePrice |
Show if the price is a flat value or a percentage |
boolean |
subjectPrices |
Subject based rates for groups of persons |
< SubjectPrice |
appliedPerSubject |
boolean |
6.21. Address
details of the visit address of the user
Name | Description | Schema |
---|---|---|
addressId |
unique id associated with each address Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
address1 |
the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address2 |
the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address3 |
the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
boxNumber |
number used as an address |
string |
houseNumberSuffix |
a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
zipCode |
zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBox |
numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxZipcode |
zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxCity |
city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
city |
city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
countryId |
unique id associated with each country |
integer (int64) |
municipality |
name of the general-purpose administrative subdivision |
string |
mobilePhone2 |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
latitude |
latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
longitude |
longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
email |
email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
stateId |
unique id associated with each state Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
mobilePhone |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
houseNumber |
house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
district |
district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
privatePhone |
the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
workPhone |
the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
exposeLocation |
if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false |
boolean |
dateEnd |
date when the accommodationtype/resort/unit is archived |
string (date) |
dateBegin |
date on which the accommodationtype/resort/unit was created |
string (date) |
fax |
fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateContactPerson |
name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
accuracy |
Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE |
enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE) |
country |
||
altContactPerson |
Write only (field is only accessible in the request body) |
string |
6.22. AddressUpdate
Name | Description | Schema |
---|---|---|
email |
string |
|
address1 |
string |
|
address2 |
string |
|
address3 |
string |
|
city |
string |
|
countryCode |
string |
|
district |
string |
|
houseNumber |
string |
|
houseNumberSuffix |
string |
|
mobilePhone |
string |
|
mobilePhone2 |
string |
|
poBox |
string |
|
poBoxCity |
string |
|
poBoxZipcode |
string |
|
privatePhone |
string |
|
workPhone |
string |
|
zipCode |
string |
|
stateId |
integer (int64) |
|
boxNumber |
string |
|
municipality |
string |
|
latitude |
number (double) |
|
longitude |
number (double) |
6.23. Address_Id
details of the address where the unit is located
Name | Description | Schema |
---|---|---|
addressId |
unique id associated with each address Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
address1 |
the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address2 |
the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address3 |
the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
boxNumber |
number used as an address |
string |
houseNumberSuffix |
a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
zipCode |
zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBox |
numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxZipcode |
zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxCity |
city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
city |
city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
countryId |
unique id associated with each country |
integer (int64) |
municipality |
name of the general-purpose administrative subdivision |
string |
mobilePhone2 |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
latitude |
latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
longitude |
longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
email |
email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
stateId |
unique id associated with each state Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
mobilePhone |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
houseNumber |
house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
district |
district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
privatePhone |
the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
workPhone |
the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
exposeLocation |
if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false |
boolean |
dateEnd |
date when the accommodationtype/resort/unit is archived |
string (date) |
dateBegin |
date on which the accommodationtype/resort/unit was created |
string (date) |
fax |
fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateContactPerson |
name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
accuracy |
Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE |
enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE) |
country |
||
altContactPerson |
Write only (field is only accessible in the request body) |
string |
6.24. AdminOrganisation
Name | Description | Schema |
---|---|---|
adminOrganisationId |
integer (int64) |
|
name |
string |
|
description |
string |
|
code |
string |
|
currencyId |
integer (int64) |
|
currencyCode |
string |
|
origin |
string |
|
originId |
string |
|
journalId |
integer (int64) |
6.25. AdminOrganisationCurrency
Name | Description | Schema |
---|---|---|
debitVatIncluded |
number |
|
debitVatExcluded |
number |
|
creditVatExcluded |
number |
|
creditVatIncluded |
number |
|
currencyId |
integer (int64) |
|
currencyCode |
string |
6.26. Allotment
Name | Description | Schema |
---|---|---|
allotmentId |
integer (int64) |
|
distributionChannelId |
integer (int64) |
|
resourceId |
integer (int64) |
|
name |
string |
|
description |
string |
|
type |
string |
|
exceedLimit |
integer (int64) |
|
expirePeriod |
integer (int64) |
|
hasObjects |
boolean |
|
amount |
integer (int64) |
|
modified |
string (date) |
|
isEnactive |
boolean |
|
periods |
< AllotmentPeriod |
6.27. AllotmentPeriod
Name | Description | Schema |
---|---|---|
unitIds |
unique items |
< integer > array |
startDate |
string (date) |
|
endDate |
string (date) |
|
quantity |
integer (int64) |
6.28. AllotmentRelease
Name | Description | Schema |
---|---|---|
allotmentReleaseId |
integer (int64) |
|
distributionChannelId |
integer (int64) |
|
name |
string |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
releasePeriod |
integer (int64) |
|
releaseDate |
string (date) |
|
performedDate |
string (date) |
|
resourceId |
integer (int64) |
|
resortId |
integer (int64) |
|
isEnactive |
boolean |
6.29. Amenity
Name | Description | Schema |
---|---|---|
amenityId |
integer (int64) |
|
type |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
|
metricDetail |
||
identifier |
string |
|
listMulti |
boolean |
|
numberMinimum |
integer (int64) |
|
numberMaximum |
integer (int64) |
|
percentageDiscountPriority |
integer (int64) |
|
source |
string |
|
standardCodeAmenityId |
integer (int64) |
|
linkedAmenityId |
integer (int64) |
|
parentAmenityId |
integer (int64) |
|
archivedFrom |
string (date) |
|
endDate |
Write only (field is only accessible in the request body) |
string (date) |
translations |
< I18nAmenity |
|
amenityCategoryIds |
Write only (field is only accessible in the request body) |
< integer > array |
categories |
< AmenityCategory |
|
metric |
||
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenity |
6.30. AmenityCategory
details related to group of amenities
Name | Description | Schema |
---|---|---|
amenityCategoryId |
Write only (field is only accessible in the request body) |
integer (int64) |
code |
unique code associated with each group of amenities |
string |
translations |
information of the group of amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nAmenityCategory |
isInternalUse |
Write only (field is only accessible in the request body) |
boolean |
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenityCategory |
6.31. AmenityCategorySetDetail
details related to group of amenity categories
Name | Description | Schema |
---|---|---|
code |
unique code associated with each amenity category group |
string |
translations |
information of the set of amenity categories available in the unit which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nAmenityCategory |
categories |
details related to group of amenities |
< CategoryDetail |
6.32. AmenityCategory_Basic
details related to group of amenities
Name | Description | Schema |
---|---|---|
amenityCategoryId |
Write only (field is only accessible in the request body) |
integer (int64) |
code |
unique code associated with each group of amenities |
string |
translations |
information of the group of amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nAmenityCategory_Basic |
isInternalUse |
Write only (field is only accessible in the request body) |
boolean |
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenityCategory_Basic |
6.33. AmenityDetail_Basic
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated with each amenity link |
integer (int64) |
amenityId |
unique id associated with each amenity |
integer (int64) |
endDate |
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) |
string (date) |
startDate |
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) |
string (date) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
visible |
if the amenity should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
origin |
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 (SELF,PARENT,CHILD) |
translations |
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. |
< I18nAmenity_Basic |
type |
type of the amenity. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
archivedFrom |
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) |
string (date) |
identifier |
value of the identifier associated with an amenity linked |
string |
metric |
||
parentAmenityId |
if the amenity has a parent then the id of the parent amenity is displayed in this field |
integer (int64) |
categories |
details related to group of amenities |
< AmenityCategory_Basic |
6.34. AmenityGroupLinkDetail
desirable or accessible properties that a customer can possess in the resource. The value that will be encountered is GROUP
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated, which tells the amenity is linked to a resource |
integer (int64) |
amenityId |
unique id associated with each amenity |
integer (int64) |
endDate |
date till which the amenity is accessible.Date format will be displayed and added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
startDate |
date from which the amenity can be accessed.Date format will be displayed and added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
visible |
if the amenity should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
origin |
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 (SELF,PARENT,CHILD) |
translations |
information of the amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nAmenity |
managerId |
Write only (field is only accessible in the request body) |
integer (int64) |
metricDetail |
||
type |
type of the amenity. Possible values can be : GROUP |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
parentAmenityId |
if the amenity has a parent then the id of the parent amenity is displayed in this field |
integer (int64) |
code |
unique code associated with each amenity |
string |
archivedFrom |
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) |
string (date) |
amenities |
desirable or accessible properties that a customer can possess in the resource.These are child amenities. Possible values encountered: Simple,Text, Number |
< AmenityLinkDetail |
metric |
||
identifier |
Write only (field is only accessible in the request body) |
string |
6.35. AmenityLink
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated which tells the amenity is linked to a resource |
integer (int64) |
type |
type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
visible |
if the amenity linked should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
startDate |
date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
amenityId |
unique id associated with each amenity |
integer (int64) |
code |
unique code associated with each amenity |
string |
translations |
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. |
< I18nAmenity |
6.36. AmenityLinkDetail
desirable or accessible properties that a customer can possess in the resource.These are child amenities. Possible values encountered: Simple,Text, Number
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated which tells the amenity is linked to a resource |
integer (int64) |
amenityId |
unique id associated with each amenity |
integer (int64) |
endDate |
date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
startDate |
date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
visible |
if the amenity should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
origin |
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 (SELF,PARENT,CHILD) |
managerId |
Write only (field is only accessible in the request body) |
integer (int64) |
metricDetail |
||
type |
type of the amenity. Possible values can be : SIMPLE, NUMBER, TEXT, LIST |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
parentAmenityId |
if the amenity has a parent then the id of the parent amenity is displayed in this field |
integer (int64) |
code |
unique code associated with each amenity |
string |
archivedFrom |
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) |
string (date) |
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
images |
< Image |
|
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenity |
identifier |
Write only (field is only accessible in the request body) |
string |
translations |
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. |
< I18nAmenity |
6.37. AmenityResponse
Name | Description | Schema |
---|---|---|
amenityId |
integer (int64) |
|
code |
string |
|
type |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
|
numberMinimum |
integer (int64) |
|
numberMaximum |
integer (int64) |
|
linkedAmenityId |
integer (int64) |
|
translations |
< I18nAmenity |
|
amenityCategoryIds |
< integer > array |
|
childAmenityIds |
< integer > array |
|
amenityStandardCode |
string |
|
origin |
string |
|
originId |
string |
6.38. AmenityTreeDetail
Name | Description | Schema |
---|---|---|
amenityCategorySetId |
integer (int64) |
|
code |
string |
|
priority |
integer (int64) |
|
translations |
< I18nAmenityCategory |
|
parentId |
Write only (field is only accessible in the request body) |
integer (int64) |
isInternalUse |
Write only (field is only accessible in the request body) |
boolean |
amenityCategories |
< CategoryDetail |
|
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenityCategory |
6.39. Area
Name | Description | Schema |
---|---|---|
areaId |
integer (int64) |
|
translations |
< I18nArea |
|
i18nArea |
Write only (field is only accessible in the request body) |
< I18nArea |
6.40. AuthorizationResponse
Name | Description | Schema |
---|---|---|
scope |
string |
|
details |
object |
|
jti |
string |
|
access_token |
string |
|
token_type |
string |
|
expires_in |
integer (int64) |
6.41. AvailabilityResult
Name | Description | Schema |
---|---|---|
resourceId |
The unique id of the accommodationtype |
integer (int64) |
resortId |
The unique id associated with the resort to which the accommodationtype belong |
integer (int64) |
accommodationKindId |
The accommodation Kind id associated with each accommodationtype |
integer (int64) |
arrivalDate |
The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
departureDate |
The date on which customer/guest will leave. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
offerCode |
Basis accommodationtype rent price without any additional costs or addons included |
string |
offerName |
The name of the offer |
string |
basePrice |
Basis accommodationtype rent price without any additional costs or addons included |
number (double) |
basePriceInclusive |
Basis accommodationtype rent price including mandatory additional costs configured as internet additional cost |
number (double) |
offerPrice |
The lowest offer price available for the particular stay without any additional costs or addons included |
number (double) |
offerPriceInclusive |
The lowest offer price available for the particular stay including mandatory additional costs configured as internet additional cost |
number (double) |
units |
List of unit ids associated currently available for the the accommodationtype. For the accommodationtype search this list is limited to 100 unit ids to avoid any performance impact. Incase a full list exceeding 100 unit ids is needed consider using the reservation proposal call or unit search |
< integer > array |
totalCapacity |
Total capacity accommodated in the accommodationtype |
integer (int32) |
rating |
Average rating guests have given for the accommodation through surveys |
number (double) |
referencePrice |
The highest accommodationtype rent price ever available for the particular stay(can be used as from price) |
number (double) |
referencePriceInclusive |
The highest accommodationtype rent price ever available for the particular stay(can be used as from price) including mandatory additional costs configured as internet additional cost |
number (double) |
duration |
The duration(number of nights) for which a user will stay at the accommodationtype |
integer (int32) |
rateTypeId |
The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type |
integer (int64) |
priority |
Write only (field is only accessible in the request body) |
integer (int32) |
nrOfBathrooms |
Number of bathrooms in the accommodationtype |
number (double) |
nrOfBedrooms |
Number of bedrooms in the accommodationtype |
integer (int32) |
loyaltyPrice |
Price including offers and loyalty |
number (double) |
loyaltyPriceInclusive |
Price including offers, loyalty and additional costs |
number (double) |
requiredLoyaltyPoints |
The required number of points for this loyalty price |
integer (int32) |
freeLoyaltyDuration |
The number of free nights for this number of loyalty points |
integer (int32) |
qualityLevelId |
integer (int64) |
6.42. BankAccount
the bank account associated with the credit card authorisation record.
Name | Description | Schema |
---|---|---|
bankAccountName |
Write only (field is only accessible in the request body) |
string |
code |
Write only (field is only accessible in the request body) |
string |
name |
the bank account name. |
string |
currencyCode |
the bank account currency code. |
string |
paymentMethodDefinition |
6.43. Brand
Name | Description | Schema |
---|---|---|
brandId |
unique id associated with each brand |
integer (int64) |
defaultBrand |
if the brand is the default one then the value of the field is true else false |
boolean |
name |
name of the brand |
string |
reservationCategoryId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.44. CalculatePriceRequest
Name | Description | Schema |
---|---|---|
distributionChannelId |
If the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown. |
integer (int64) |
reservationCategoryId |
Specifies the categoryId of the reservation |
integer (int64) |
arrivalDate |
The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
duration |
The number of days starting from the arrivalDate for which the price range search has been carried out and the duration should be passed in days ex: 7. |
integer (int32) |
rateTypeId |
Rate type id which will be used to fetch availability. If not provided, then the first rate type will be picked up from the rate types linked to distribution channel and ordered in ascending order of priority. |
integer (int64) |
offerCode |
Unique code associated with offer on the bases of which accommodationtype is to be filtered |
string |
subjects |
||
petQuantity |
Quantity of the pets for which search is to be made Write only (field is only accessible in the request body) |
integer (int32) |
redeemableLoyaltyPoints |
Loyalty points to be used for the price calculation of the accommmodationtype |
integer (int32) |
6.45. CalculatePriceResponse
Name | Description | Schema |
---|---|---|
basePrice |
Accommodation type price + mandatory costs |
number |
offerPrice |
The discount that is received through offer(s) |
number |
loyaltyDiscount |
The discount that is received through loyalty |
number |
totalPrice |
The total price including discounts (if no offer code is provided: cheapest option among open offers, otherwise price for requested offer code) |
number |
warrantTotalPrice |
Write only (field is only accessible in the request body) |
number |
6.46. Capacity
Name | Description | Schema |
---|---|---|
capacityId |
unique id associated with each capacity |
integer (int64) |
managerId |
Write only (field is only accessible in the request body) |
integer (int64) |
capacity |
number of subjects(people) who will come for stay |
integer (int32) |
subjectId |
unique id asociated with each subject |
integer (int64) |
startDate |
date from which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
name |
name of the subject |
string |
6.47. CapacityDetail
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
Name | Description | Schema |
---|---|---|
capacityId |
unique id associated with each capacity |
integer (int64) |
managerId |
Write only (field is only accessible in the request body) |
integer (int64) |
capacity |
The maximum number of subjects for which the accommodation can be booked |
integer (int32) |
subjectId |
unique id asociated with each subject |
integer (int64) |
startDate |
date from which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
subject |
6.48. CashAccount
Name | Description | Schema |
---|---|---|
accountId |
integer (int64) |
|
name |
string |
|
description |
string |
|
companyId |
integer (int64) |
|
accountType |
enum (NORMAL,UNASSIGNABLE,FREE,DEVIATION,CASH,RECEPTION,ROUNDOFF,CARD,INTERNET,DEBITCARD,FUND_DEBITCARD,ZEROBALANCE,CCARD_AUTHORIZATION,CHEQUE_INCOMING,CHEQUE_OUTGOING,TRANSFER_PAYMENTS,MISCELLANEOUS) |
6.49. CashClearance
Name | Description | Schema |
---|---|---|
cashClearanceId |
integer (int64) |
|
reportNumber |
integer (int64) |
|
creationDate |
string (date-time) |
|
companyId |
integer (int64) |
|
employeeId |
integer (int64) |
|
totalValueAmount |
number (double) |
|
totalCardAmount |
number (double) |
|
startBalanceNextDay |
number (double) |
|
tillAmountNextDay |
number (double) |
|
safeWithdrawalAmount |
number (double) |
|
safeDepositAmount |
number (double) |
|
receivedAmount |
number (double) |
|
totalMutationAmount |
number (double) |
|
cashDifference |
number (double) |
|
reasonCashDifference |
string |
|
currencyId |
integer (int64) |
6.50. CashFlowRuleResource
Name | Description | Schema |
---|---|---|
resourceType |
string |
|
accommodationKindId |
integer (int64) |
|
resourceId |
integer (int64) |
6.51. Cashflowrule
rate for resource to insert
Name | Description | Schema |
---|---|---|
value |
Actual rate value, price. |
number (double) |
remark |
Optional remark/comment about the specific rate |
string |
quantifier |
Possible values are: ABSOLUTE ( +/- an amount to the rate), OVERRIDE (override the rate), RELATIVE( +/- a percentage to the rate). |
string |
valueType |
Type of value, price. This can be "single" (base ) |
string |
priority |
Priority, the rate with the highest priority will be the preferred one |
integer (int64) |
bookdateFrom |
The reservation book date should be greater than equal to this date. |
string (date-time) |
bookdateTo |
The reservation book date should be less than equal to this date. |
string (date-time) |
resourceId |
The resource(accommodationtype, addon) the rate applies to. |
integer (int64) |
repeatable |
Defines if the rate be used again between the valid from and to period |
integer (int64) |
status |
integer (int64) |
|
rateLevelId |
Deprecated |
integer (int64) |
rateTypeIds |
Ratetypes the rate is linked to |
< integer > array |
rateOptionId |
The rate option which is linked to the rate type. A rate option defines if the price is per night or any other length of stay. If it’s not per night, the rate is depending on the minimum length of stay. When creating a rate, the correct rateOptionId is selected based on the provided values of rateTypeIds, minDuration, maxDuration, duration, usageDurationFrom, usageDurationTo. |
integer (int64) |
minDeviation |
Minimal number of days between book date and arrival date when the price will be valid. |
integer (int64) |
maxDeviation |
Maximum number of days between book date and arrival date when the price will be valid. |
integer (int64) |
translations |
< I18nRate |
|
validFrom |
The arrival date of reservation should be geater than or equal to this date. Write only (field is only accessible in the request body) |
string (date) |
validTo |
The arrival date of reservation should be less than or equal to this date. Write only (field is only accessible in the request body) |
string (date) |
daysOfWeek |
The day the rate is applicable/valid Write only (field is only accessible in the request body) |
< string > array |
duration |
Stay for which the cashflow rule Write only (field is only accessible in the request body) |
integer (int64) |
usageDurationFrom |
The usage of the unit should be greater than or equal to the this date. Write only (field is only accessible in the request body) |
integer (int64) |
usageDurationTo |
The usage of the unit should be less than or equal to the this date. Write only (field is only accessible in the request body) |
integer (int64) |
minDuration |
Minimal length of stay(number of nights) the price is valid for(only applies in case of nightly rates). Write only (field is only accessible in the request body) |
integer (int64) |
maxDuration |
Maximum length of stay(number of nights) the price is valid for(only applies in case of nightly rates). Write only (field is only accessible in the request body) |
integer (int64) |
cashflowruleId |
The id of the cashflow rule. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
arrivalDateFrom |
The arrival date of reservation should be geater than or equal to this date. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
string (date) |
arrivalDateTo |
The arrival date of reservation should be less than or equal to this date. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
string (date) |
usageDowList |
List of usageDow Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
< string > array |
stay |
Stay for which the cashflow rule Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
minUnit |
Number of units should be greater than or equal to this amount. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
maxUnit |
Number of units should be less than or equal to this amount. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
usageUnitFrom |
The usage of the unit should be greater than or equal to the this date. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
usageUnitTo |
The usage of the unit should be less than or equal to the this date. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
6.52. Category
Name | Description | Schema |
---|---|---|
amenityCategoryId |
integer (int64) |
|
code |
string |
|
priority |
integer (int64) |
|
translations |
< I18nAmenityCategory |
|
isInternalUse |
Write only (field is only accessible in the request body) |
boolean |
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenityCategory |
6.53. CategoryDetail
details related to group of amenities
Name | Description | Schema |
---|---|---|
code |
unique code associated with each amenity group |
string |
amenityCategoryId |
unique id associated with each amenity group |
integer (int64) |
priority |
priority of the amenity category |
integer (int64) |
amenities |
desirable or accessible properties that a customer can possess in the resource. Possible values encountered: SIMPLE, TEXT, NUMBER |
< AmenityLinkDetail |
amenityGroups |
desirable or accessible properties that a customer can possess in the resource. The value that will be encountered is GROUP |
< AmenityGroupLinkDetail |
translations |
information of the group of amenities available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nAmenityCategory |
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenityCategory |
6.54. CategorySet
Name | Description | Schema |
---|---|---|
amenityCategorySetId |
integer (int64) |
|
code |
string |
|
priority |
integer (int64) |
|
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
images |
< Image |
|
translations |
< I18nAmenityCategory |
|
parentId |
Write only (field is only accessible in the request body) |
integer (int64) |
amenityCategories |
< Category |
|
isInternalUse |
Write only (field is only accessible in the request body) |
boolean |
i18n |
Write only (field is only accessible in the request body) |
< I18nAmenityCategory |
6.55. Communication
Name | Description | Schema |
---|---|---|
customerCommunicationId |
integer (int64) |
|
sendDate |
string (date-time) |
|
sendingType |
string |
|
reservationId |
integer (int64) |
|
message |
string |
|
senderEmail |
string |
|
subject |
string |
|
attachments |
< Filebase |
|
reportUrls |
Write only (field is only accessible in the request body) |
< ReportUrl |
report |
||
staticAttachments |
Write only (field is only accessible in the request body) |
< Filebase |
reportUrl |
Write only (field is only accessible in the request body) |
< ReportUrl |
reportType |
enum (GENERAL,EMPLOYEE,CUSTOMER,AGENT,OWNER) |
|
reportCode |
string |
6.56. Company
Name | Description | Schema |
---|---|---|
companyId |
integer (int64) |
|
companyNumber |
string |
|
name |
string |
|
description |
string |
|
adminOrganisationId |
string |
|
currencyId |
integer (int64) |
6.57. Contract
Name | Description | Schema |
---|---|---|
contractId |
integer (int64) |
|
code |
string |
|
name |
string |
|
ownerId |
integer (int64) |
|
unitId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
targetAmount |
number (double) |
|
contractTypeId |
integer (int64) |
|
resourceId |
integer (int64) |
|
poolOwnerId |
integer (int64) |
|
origin |
string |
|
originId |
string |
|
rentAssurance |
number (double) |
|
contractRenewalReminder |
string (date) |
6.58. ContractRule
Name | Description | Schema |
---|---|---|
contractRuleId |
integer (int64) |
|
contractTypeId |
integer (int64) |
|
archivedFrom |
string (date) |
|
arrivalDateEnd |
string (date) |
|
arrivalDateStart |
string (date) |
|
baseSumIncludingTax |
boolean |
|
beneficiary |
string |
|
calculateAbsolutePerNight |
boolean |
|
calculationSource |
string |
|
commissionOnly |
boolean |
|
commissionInculdingTax |
boolean |
|
departureDateStart |
string (date-time) |
|
departureDateEnd |
string (date-time) |
|
introducerInOwnObject |
boolean |
|
ledgerId |
integer (int64) |
|
name |
string |
|
ownerSpecific |
boolean |
|
priority |
integer (int64) |
|
purchaseLedgerId |
integer (int64) |
|
purchaseSecondLedgerId |
integer (int64) |
|
reservationDateStart |
string (date) |
|
reservationDateEnd |
string (date) |
|
resourceType |
string |
|
resourceTypeSelected |
boolean |
|
resourceBeneficiary |
boolean |
|
resourceId |
integer (int64) |
|
secondLedgerId |
integer (int64) |
|
settlementOwnerId |
integer (int64) |
|
settlementOwnerResortId |
integer (int64) |
|
stayDateFrom |
string (date) |
|
stayDateTo |
string (date) |
|
substractDistributionChannelCommission |
boolean |
|
substractDistributionChannelIncludingTax |
boolean |
|
taxSumInCommission |
integer (int64) |
|
time |
integer (int64) |
|
type |
enum (ABSOLUTE,RELATIVE) |
|
unit |
enum (RESERVATION,SUBJECT,TIME) |
|
value |
integer (int64) |
|
vatForPrivateOwner |
boolean |
|
ownerVatRateExclude |
integer (int64) |
|
ledgerGroupId |
integer (int64) |
|
purchaseLedgerGroupId |
integer (int64) |
|
dependsOnLedgerGroup |
boolean |
|
validity |
||
owners |
Write only (field is only accessible in the request body) |
< Owner |
valueOnStayBasis |
boolean |
|
resort |
Write only (field is only accessible in the request body) |
< ContractRuleResort |
commissionTaxrate |
integer (int64) |
6.59. ContractRuleResort
Name | Description | Schema |
---|---|---|
contractRuleResortId |
integer (int64) |
|
resortId |
integer (int64) |
|
contractruleId |
integer (int64) |
6.60. ContractType
Name | Description | Schema |
---|---|---|
contractTypeId |
integer (int64) |
|
code |
string |
|
remark |
string |
|
settlementMethod |
string |
|
settlementPct |
integer (int64) |
|
redirectionMinAmount |
integer (int64) |
|
contractKind |
enum (EMPTY,OWNER_SPECIFIC,POOL,RENT_ASSURANCE,POOL_SHARE) |
|
priority |
integer (int64) |
|
round |
boolean |
|
ownUsageAllowed |
boolean |
|
archivedFrom |
string (date) |
|
resourceGroupId |
integer (int64) |
|
translations |
< I18nContractType |
|
nonRentable |
boolean |
|
i18n |
Write only (field is only accessible in the request body) |
< I18nContractType |
6.61. CostCenter
Name | Description | Schema |
---|---|---|
costCenterId |
integer (int64) |
|
name |
string |
|
description |
string |
|
costCenterNumber |
string |
6.62. CostPrice
Name | Description | Schema |
---|---|---|
costPriceId |
integer (int64) |
|
resourceId |
integer (int64) |
|
stayDateFrom |
string (date) |
|
stayDateTo |
string (date) |
|
bookDateFrom |
string (date-time) |
|
bookDateTo |
string (date-time) |
|
usageUnit |
integer (int64) |
|
usageUnitFrom |
integer (int64) |
|
usageUnitTo |
integer (int64) |
|
value |
number (double) |
|
currency |
||
remark |
string |
|
costPriceSpecials |
< CostPriceSpecial |
6.63. CostPriceSpecial
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
6.64. Country
details of the country in which the accommodationtype/resort/unit is situated
read only
Name | Description | Schema |
---|---|---|
countryId |
unique id associated with each country |
integer (int64) |
shortName |
Write only (field is only accessible in the request body) |
string |
priority |
integer (int32) |
|
defaultLanguageId |
Write only (field is only accessible in the request body) |
integer (int64) |
translations |
< I18NCountry |
|
default |
boolean |
|
code |
country code represents shortname of country, 2 letter code(ISO 3166). |
string |
6.65. Country_Id
details of the country in which the accommodationtype/resort/unit is situated
read only
Name | Description | Schema |
---|---|---|
countryId |
unique id associated with each country |
integer (int64) |
shortName |
Write only (field is only accessible in the request body) |
string |
priority |
integer (int32) |
|
defaultLanguageId |
Write only (field is only accessible in the request body) |
integer (int64) |
translations |
< I18NCountry_Id |
|
default |
boolean |
|
code |
country code represents shortname of country, 2 letter code(ISO 3166). |
string |
6.66. CreateAccommodationTypeRequest
Name | Description | Schema |
---|---|---|
accotypeKindId |
unique id associated with each kind of accommodationtype |
integer (int64) |
brandId |
unique id associated with each brand |
integer (int64) |
code |
unique code associated with each accommodationtype |
string |
nrOfBathrooms |
number of bathrooms that an accommodationtype can possess |
number (double) |
nrOfBedrooms |
number of bedrooms that an accommodationtype possess |
number (double) |
parentId |
if the accommodationtype is child to another accommodationtype |
string |
priority |
the sequence in which the accommodationtype will be visible to the user |
integer (int64) |
resortId |
unique id associated with each resort to which the accommodationtype belong |
integer (int64) |
translations |
information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nAccommodationType |
address |
||
origin |
Origin name of the resource Maximum Length: 10 |
string |
originId |
Origin Id of the resource |
string |
6.67. CreateAddressRequest
Name | Description | Schema |
---|---|---|
accuracy |
Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE |
enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE) |
address1 |
the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address2 |
the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address3 |
the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateContactPerson |
name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
boxNumber |
number used as an address |
string |
city |
city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
countryId |
unique id associated with each country |
integer (int64) |
dateEnd |
date when the accommodationtype/resort/unit is archived |
string (date) |
dateBegin |
date on which the accommodationtype/resort/unit was created |
string (date) |
district |
district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
email |
email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
exposeLocation |
if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false |
boolean |
fax |
fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
houseNumber |
house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
houseNumberSuffix |
a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
latitude |
latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
longitude |
longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
mobilePhone |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
mobilePhone2 |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
municipality |
name of the general-purpose administrative subdivision |
string |
poBox |
numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxZipcode |
zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxCity |
city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
privatePhone |
the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
stateId |
unique id associated with each state |
integer (int64) |
workPhone |
the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
zipCode |
zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
6.68. CreateAdminOrganisationRequest
Request Body for new adminorganisation
Name | Description | Schema |
---|---|---|
name |
Maximum Length: 50 |
string |
description |
Maximum Length: 4000 |
string |
code |
unique code of the admin organisation Maximum Length: 50 |
string |
currencyId |
currencyId of the admin organisation |
integer (int64) |
origin |
string |
|
originId |
string |
6.69. CreateAmenity
Name | Description | Schema |
---|---|---|
amenityCategoryIds |
< integer > array |
|
childAmenityIds |
< integer > array |
|
type |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
|
code |
string |
|
numberMinimum |
integer (int32) |
|
numberMaximum |
integer (int32) |
|
linkedAmenityId |
integer (int64) |
|
translations |
< CreateAmenityTranslation |
|
amenityStandardCode |
string |
|
origin |
string |
|
originId |
string |
6.70. CreateAmenityTranslation
Name | Description | Schema |
---|---|---|
language |
language in which the given information is stored |
string |
name |
name of the amenity |
string |
description |
description related to the amenity |
string |
6.71. CreateLockRequest
Name | Description | Schema |
---|---|---|
detailDescription |
string |
|
endDate |
string (date) |
|
unitId |
integer (int64) |
|
reasonId |
integer (int64) |
|
startDate |
string (date) |
|
type |
enum (FINAL,PHASING,TEMPORARY,PHASINGGROUP) |
6.72. CreateOwnerRequest
request body to create owner
Name | Description | Schema |
---|---|---|
accountNr |
string |
|
alternateName |
string |
|
attentionOf |
string |
|
bicSwift |
string |
|
birthDate |
string (date) |
|
company |
boolean |
|
companyName |
string |
|
emailAllowed |
boolean |
|
firstName |
string |
|
fiscalTypes |
< OwnerFiscalType |
|
ibanNumber |
string |
|
lastName |
string |
|
mailAddress |
||
mailAllowed |
boolean |
|
middle |
string |
|
sendMethodId |
integer (int64) |
|
sex |
string |
|
titleId |
integer (int64) |
|
origin |
string |
|
originId |
string |
|
ownerPool |
enum (OWNER,POOL,RENT_ASSURANCE_POOL,YEAR_ROUND_GUEST,BUSINESS,LOCATION,MAINTAINANCE_FUND,VENDOR,POOL_CONSUMPTION,POOL_SHARE) |
|
ownerGroupId |
integer (int64) |
|
questionnaireUnsubscribed |
boolean |
|
owner |
boolean |
6.73. CreateRepresentationRequest
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
visible |
boolean |
|
bookable |
boolean |
|
distributionChannelIds |
< integer > array |
|
translations |
< I18nRepresentation |
6.74. CreateReservationEquipment
Name | Description | Schema |
---|---|---|
value |
string |
|
remark |
string |
|
reservedResourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.75. CreateReservationPersonSubject
Name | Description | Schema |
---|---|---|
firstName |
string |
|
middleName |
string |
|
lastName |
string |
|
birthDate |
string (date) |
|
sex |
string |
|
email |
string |
|
street |
string |
|
houseNumber |
string |
|
houseNumberSuffix |
string |
|
zipCode |
string |
|
city |
string |
|
countryId |
integer (int64) |
|
guest |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
boolean |
companion |
boolean |
|
personAlreadyLeft |
boolean |
|
arrivalDate |
string (date) |
|
departureDate |
string (date) |
|
identityCardNumber |
Identity card number of travel party member Maximum Length: 50 |
string |
identityType |
enum (PASSPORT,IDENTITY_CARD,DRIVERS_LICENCE) |
|
identityNumber |
string |
|
identityCountryId |
integer (int64) |
|
identityDateIssued |
string (date) |
|
gender |
Write only (field is only accessible in the request body) |
string |
6.76. CreateReservationVehicleSubject
Name | Description | Schema |
---|---|---|
remark |
string |
|
registrationMark |
Maximum Length: 15 |
string |
subjectId |
Write only (field is only accessible in the request body) |
integer (int64) |
reservedResourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.77. CreateResortRequest
Request body to create a new resort.
Name | Description | Schema |
---|---|---|
adminOrganisationId |
integer (int64) |
|
code |
string |
|
internalResortNumber |
string |
|
origin |
string |
|
originId |
string |
|
parentId |
integer (int64) |
|
resortNumber |
integer (int64) |
|
resortPriority |
integer (int64) |
|
visitAddress |
||
mailAddress |
||
translations |
< CreateResortTranslation |
6.78. CreateResortTranslation
Name | Description | Schema |
---|---|---|
language |
code of the language in which the above information is stored |
string |
name |
name of the resort |
string |
description |
description related to the resort |
string |
shortDescription |
short description related to the resort |
string |
6.79. CreateUnitAmenitylinkRequest_Basic
Name | Description | Schema |
---|---|---|
amenityId |
Unique id associated with each amenity |
integer (int64) |
startDate |
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) |
string (date) |
endDate |
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) |
string (date) |
numberValue |
If the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
If the amenity is of type text then the value provided to the amenity is displayed here |
string |
visible |
If the amenity should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
The id associated to the extra |
integer (int64) |
6.80. CreateUnitRequest
Name | Description | Schema |
---|---|---|
resourceId |
accommodationtype the unit applies to |
integer (int64) |
address |
||
code |
unique code of the unit |
string |
nrOfBathrooms |
number (double) |
|
nrOfBedrooms |
integer (int32) |
|
translations |
< I18nUnit |
|
origin |
system the unit is created in |
string |
originId |
identifier from the origin system |
string |
rentableUnitId |
integer (int64) |
|
groupPriority |
integer (int32) |
6.81. CreditCardAuthorisation
Name | Description | Schema |
---|---|---|
creditCardAuthorisationId |
unique id associated with each credit card authorisation |
integer (int64) |
status |
Write only (field is only accessible in the request body) |
enum (OPEN,CLOSED,CANCEL,PARTIAL) |
type |
the type of the authorisation. |
enum (DEBITCARD,RESERVATION) |
authorisedAmount |
the total amount that is authorised on a reservation. |
number (double) |
availableAmount |
the amount remaining and is not captured yet from authorised amount. |
number (double) |
creationDate |
the date on which the authorisation is created. |
string (date) |
capturedAmount |
the amount captured till now from the authorised amount. |
number (double) |
payerType |
the payer who paid the authorised amount. |
enum (CUSTOMER,PAYING_CUSTOMER,AGENT) |
bankAccount |
||
authorisationStatus |
enum (OPEN,CLOSED,CANCEL,PARTIAL) |
|
paymentMethod |
6.82. Currency
Name | Description | Schema |
---|---|---|
currencyId |
integer (int64) |
|
code |
string |
|
name |
string |
|
symbol |
string |
|
currencyLanguage |
string |
|
currencyCountry |
string |
6.83. CustomField
Custom field for reservation
Name | Description | Schema |
---|---|---|
fieldId |
integer (int64) |
|
textValue |
Applicable only when custom field is of type text |
string |
booleanValue |
Applicable only when custom field is of type boolean |
boolean |
dateValue |
Applicable only when custom field is of type date |
string (date) |
numericValue |
Applicable only when custom field is of type numeric |
number |
selectValues |
Applicable only when custom field is of type selection incl. or selection excl. |
< string > array |
6.84. Customer
Name | Description | Schema |
---|---|---|
customerId |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
customerGroupId |
integer (int64) |
|
titleId |
integer (int64) |
|
firstName |
first name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
middle |
middle name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
lastName |
last name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateName |
alternate name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
mailAddress |
||
emailAllowed |
boolean |
|
mailAllowed |
boolean |
|
phoneCallAllowed |
This field indicates if the customer has given us permission to contact them via phone call. |
boolean |
textMsgAllowed |
This field indicates if we can send text messages to the customer. |
boolean |
signatureDate |
string (date) |
|
socialSecurityNumber |
social security number of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
sex |
gender of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
languageId |
integer (int64) |
|
language |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
string |
ibanNumber |
ibanNumber of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
bicSwift |
string |
|
birthDate |
birth date of customer and this is a restricted field. If you don’t have access to this field, then 1800-01-01 will be returned as value. |
string (date) |
companyName |
company name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
login |
Login id for the customer. Login field should be same as the email field in the customer address entity. |
string |
previousPmsId |
integer (int64) |
|
creationDate |
string (date-time) |
|
owner |
boolean |
|
questionnaireUnsubscribed |
boolean |
6.85. CustomerBill
The bill of agent or tour operator or any third party who made the reservation on behalf of the customer.
Name | Description | Schema |
---|---|---|
resourceId |
The unique id of resource for which the bill is generated. |
integer (int64) |
name |
The name of resource for which the bill is generated. |
string |
endDate |
The date till which the bill is generated for resource as part of the reservation. |
string (date) |
startDate |
The date from which the bill is start as part of the reservation. |
string (date) |
billLineType |
Possible bill-line type can be encountered : |
integer (int32) |
description |
Description of the resource for which the bill is generated. Write only (field is only accessible in the request body) |
string |
total |
Total amount of the bill. |
number (double) |
vatRate |
Value of the applied configured vat-rate for the resource. |
number (double) |
redeemedLoyaltyPoints |
Number of points needed to get this discount |
integer (int32) |
redeemedLoyaltyNights |
Number of nights given free by the resource |
integer (int32) |
6.86. CustomerCluster
Name | Description | Schema |
---|---|---|
clusterId |
integer (int64) |
|
name |
deprecated |
string |
code |
string |
|
description |
string |
|
translations |
< I18nCrmCluster |
6.87. CustomerCredential
Name | Description | Schema |
---|---|---|
login |
string |
|
password |
string |
6.88. CustomerLogin
Name | Description | Schema |
---|---|---|
customerId |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
customerGroupId |
integer (int64) |
|
titleId |
integer (int64) |
|
firstName |
first name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
middle |
middle name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
lastName |
last name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateName |
alternate name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
mailAddress |
||
emailAllowed |
boolean |
|
mailAllowed |
boolean |
|
phoneCallAllowed |
This field indicates if the customer has given us permission to contact them via phone call. |
boolean |
textMsgAllowed |
This field indicates if we can send text messages to the customer. |
boolean |
signatureDate |
string (date) |
|
socialSecurityNumber |
social security number of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
sex |
gender of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
languageId |
integer (int64) |
|
language |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
string |
ibanNumber |
ibanNumber of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
bicSwift |
string |
|
birthDate |
birth date of customer and this is a restricted field. If you don’t have access to this field, then 1800-01-01 will be returned as value. |
string (date) |
companyName |
company name of customer and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
login |
Login id for the customer. Login field should be same as the email field in the customer address entity. |
string |
previousPmsId |
integer (int64) |
|
creationDate |
string (date-time) |
|
passwordModifiedDate |
Password Modification Date of Customer Credentials |
string (date-time) |
owner |
boolean |
|
questionnaireUnsubscribed |
boolean |
6.89. CustomerLoyaltyBalance
Name | Description | Schema |
---|---|---|
customerId |
integer (int64) |
|
activePoints |
sum of all points that are redeemable for this customer |
integer (int32) |
spentPoints |
sum of all points already spent (redeemed) by this customer |
integer (int32) |
pendingPoints |
sum of all points which will become active in the future (where the activationDate is in the future) for this customer |
integer (int32) |
expiredPoints |
sum of all points that have already been expired for this customer (expiration date in the past) |
integer (int32) |
transactions |
< Transaction |
6.90. CustomerPhoneCall
Name | Description | Schema |
---|---|---|
customerPhoneCallId |
integer (int64) |
|
type |
enum (INCOMING,OUTGOING) |
|
customerId |
integer (int64) |
|
employeeId |
integer (int64) |
|
startTime |
string (date-time) |
|
endTime |
string (date-time) |
|
phoneNumber |
string |
|
memoCategoryId |
integer (int64) |
|
note |
string |
|
resortId |
integer (int64) |
6.91. CustomerStatus
Name | Description | Schema |
---|---|---|
customerId |
integer (int64) |
|
customerClusters |
< CustomerCluster |
6.92. CustomerTitle
Name | Description | Schema |
---|---|---|
titleId |
unique id associated with each title linked to the customer |
integer (int64) |
code |
unique code associated with each customer title |
string |
priority |
sequence in which the title will be displayed to the user. |
integer (int32) |
translations |
information of the customer title which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nCustomerTitle |
6.93. CustomerUpdate
Name | Description | Schema |
---|---|---|
firstName |
string |
|
middle |
string |
|
lastName |
string |
|
alternateName |
string |
|
birthDate |
string (date) |
|
emailAllowed |
boolean |
|
mailAllowed |
boolean |
|
textMsgAllowed |
boolean |
|
phoneCallAllowed |
boolean |
|
ibanNumber |
string |
|
bicSwift |
string |
|
language |
string |
|
sex |
string |
|
titleId |
integer (int64) |
|
mailAddress |
6.94. DCPaymentMethod
Name | Description | Schema |
---|---|---|
distributionChannelCode |
unique id associated with distributionChannel. |
string |
paymentMethods |
list of payment methods of distributionChannel. |
< PaymentMethod |
6.95. DistributionChannelCurrency
Name | Description | Schema |
---|---|---|
debitVatIncluded |
number |
|
debitVatExcluded |
number |
|
creditVatExcluded |
number |
|
creditVatIncluded |
number |
|
currencyId |
integer (int64) |
|
currencyCode |
string |
|
exchangeRate |
integer (int64) |
6.96. DistributionChannelRepresentation
Distribution channel representation that needs to be updated
Name | Description | Schema |
---|---|---|
distributionChannelRepresentationId |
integer (int64) |
|
distributionChannelId |
integer (int64) |
|
representationId |
integer (int64) |
|
allotment |
integer (int64) |
|
distributionChannelRepresentationParentId |
integer (int64) |
6.97. DistributionChannel_Id
Name | Description | Schema |
---|---|---|
distributionChannelId |
unique id associated with the distributionChannel. |
integer (int64) |
code |
unique code associated with the distributionChannel. |
string |
name |
name associated with the distributionChannel. |
string |
representationSetParentId |
if the representation set is a child of another representation set then the id of the parent is displayed in representationSetParentId. |
integer (int64) |
allotmentOnly |
if distrubition channel is created for allotments then true will be displayed, otherwise false will be displayed in allotmentOnly. deprecated |
boolean |
activeStartDate |
the date from which distributionChannel can be used.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
activeEndDate |
the date till which distributionChannel can be used.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
type |
type of the distributionChannel.Possible values that can be encountered are:DIRECT,RESELLER,TOUROPERATOR |
string |
inheritedType |
Write only (field is only accessible in the request body) |
string |
parentId |
if the distributionChannel is child of another distributionChannel then distributionChannelId of parent distributionChannel will be displayed in parentId. |
integer (int64) |
resellerId |
id of the reseller associated with distributionChannel. |
integer (int64) |
showAgentBill |
the amount which is paid by the agent will be displayed in showAgentBill. |
integer (int32) |
brandId |
unique id associated with brand. |
integer (int64) |
currencyId |
id associated with Currency. |
integer (int64) |
brand |
label associated with the distributionChannel. |
string |
archivedFrom |
date from which the distributionChannel was archived. The distributionChannels will not be displayed if the distributionChannel is archived.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
mailAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
mailAddress |
||
invoiceaddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
invoiceAddress |
||
customerRequiredFieldsSetId |
Write only (field is only accessible in the request body) |
integer (int64) |
allotmentSetting |
it returns the allotment setting options. |
enum (FREESALE,ALLOTMENT_ONLY,FREESALE_AND_ALLOTMENT) |
communicationPermission |
Communication permission is a level which can be set on a distribution channel. It displays the agreement the client has with the distributionchannel and if it’s allowed to contact the customer of the reservations made by the respective distributionchannel. There are different levels which can be assigned and the levels are as follows : (1) full_permission, (2) partial_permission, (3) no_permission, (4) special_permission |
string |
currencyCode |
unique code associated with the currency. |
string |
6.98. DocumentBase
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
fileId |
integer (int64) |
|
name |
string |
|
fileName |
string |
|
fileSize |
integer (int64) |
|
fileType |
string |
|
uploadDate |
string (date) |
|
language |
string |
|
endDate |
string (date) |
|
shortDescription |
string |
|
validFrom |
string (date) |
|
validTo |
string (date) |
6.99. DocumentUrl
Name | Description | Schema |
---|---|---|
downloadLink |
string |
6.100. DoorLock
Name | Description | Schema |
---|---|---|
doorLockCode |
string |
|
bluetoothLowEnergy |
boolean |
6.101. DoorLockType
SAFLOKCARD (key cards) or KOOLECONTROLS (doorlock pincodes). for normal key the doorLockTypes list will be empty.
Name | Description | Schema |
---|---|---|
doorlockTypeId |
integer (int64) |
|
lockType |
enum (SAFLOKCARD,KOOLECONTROLS) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
doorlocks |
< DoorLock |
6.102. DoorLockType_Id
SAFLOKCARD (key cards) or KOOLECONTROLS (doorlock pincodes). for normal key the doorLockTypes list will be empty.
Name | Description | Schema |
---|---|---|
doorlockTypeId |
integer (int64) |
|
lockType |
enum (SAFLOKCARD,KOOLECONTROLS) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
doorlocks |
< DoorLock_Id |
6.103. DoorLock_Id
Name | Description | Schema |
---|---|---|
doorLockCode |
string |
|
bluetoothLowEnergy |
boolean |
6.104. DoorlockCode
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
unitId |
integer (int64) |
|
validDateFrom |
string (date) |
|
validDateTo |
string (date) |
|
code1 |
string |
|
code2 |
string |
|
code1Active |
string |
|
code2Active |
string |
|
earlyCheckInCode1 |
string |
|
earlyCheckInCode2 |
string |
6.105. DoorlockPincodesContainer
Name | Description | Schema |
---|---|---|
doorlockId |
integer (int64) |
|
unitId |
integer (int64) |
|
lockCode |
string |
|
codeLength |
integer (int32) |
|
bluetoothLowEnergy |
boolean |
|
pincodes |
< Pincode |
6.106. DynamicField
Name | Description | Schema |
---|---|---|
fieldId |
unique id associated with each dynamic field |
integer (int64) |
code |
unique id associated with each dynamic field |
string |
type |
type of the accommodationtype configured in dynamic field ex: house, bungalow etc |
string |
eventmanagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
translations |
information of the dynamic fields of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nDynamicField |
6.107. DynamicFieldDataCriteria
Name | Description | Schema |
---|---|---|
language |
string |
|
text |
string |
6.108. EmergencyContact
Emergency contact for reservation which contain the memo detail
Name | Description | Schema |
---|---|---|
emergencyContactId |
integer (int64) |
|
reservationId |
integer (int64) |
|
firstName |
string |
|
middleName |
string |
|
lastName |
string |
|
phone |
string |
|
relationship |
enum (PARENTS,CHILDREN_NOT_LIVING_AT_HOME,CHILDREN_LIVING_AT_HOME,FAMILY,FRIENDS,NEIGHBOURS) |
6.109. Employee
Name | Description | Schema |
---|---|---|
employeeId |
integer (int64) |
|
firstName |
string |
|
lastName |
string |
|
middleName |
string |
|
empEmailId |
string |
|
clientGroupId |
integer (int64) |
|
employeeGroup |
6.110. EmployeeCreateRequest
Name | Description | Schema |
---|---|---|
employeeGroupId |
integer (int64) |
|
clientType |
enum (EMPLOYEE,MAXXTON,APPLICATION,EXTERNAL) |
|
sex |
enum (M,F,U) |
|
type |
enum (I,T,P) |
|
locale |
enum (en_US,en_GB,nl_NL,de_DE,fr_FR) |
|
privacyAccessLevel |
enum (GDPR_1,GDPR_2,GDPR_3) |
|
privacyDbAccessLevel |
enum (GDPR_1,GDPR_2,GDPR_3) |
|
reservationcategoryCode |
string |
|
distributionchannelCode |
string |
|
firstName |
string |
|
lastName |
string |
|
middleName |
string |
|
email |
string |
|
login |
string |
|
onDuty |
string (date) |
|
offDuty |
string (date) |
|
cashAccountIds |
< integer > array |
|
permissionGroupIds |
< integer > array |
|
resortIds |
< integer > array |
|
adminorganisationIds |
< integer > array |
|
sectorIds |
< integer > array |
|
unifiedInboxIds |
< integer > array |
6.111. EmployeeGroup
Name | Description | Schema |
---|---|---|
employeeGroupId |
integer (int64) |
|
code |
string |
|
description |
string |
|
name |
string |
6.112. EmployeeResponse
Name | Description | Schema |
---|---|---|
employeeId |
integer (int64) |
|
distributionchannelId |
integer (int64) |
|
firstName |
string |
|
lastName |
string |
|
groupId |
integer (int64) |
|
login |
string |
|
middleName |
string |
|
reservationcategoryId |
integer (int64) |
|
sex |
string |
|
type |
string |
|
empEmailId |
string |
|
onDuty |
string (date) |
|
offDuty |
string (date) |
|
privacyAccessLevel |
enum (GDPR_1,GDPR_2,GDPR_3) |
|
privacyDbAccessLevel |
enum (GDPR_1,GDPR_2,GDPR_3) |
|
locale |
string |
|
clientType |
enum (EMPLOYEE,MAXXTON,APPLICATION,EXTERNAL) |
|
cashAccountIds |
< integer > array |
|
resortIds |
< integer > array |
|
adminorganisationIds |
< integer > array |
|
permissionGroupIds |
< integer > array |
|
sectorIds |
< integer > array |
|
unifiedInboxIds |
< integer > array |
6.113. EmployeeUpdateRequest
Name | Description | Schema |
---|---|---|
employeeGroupId |
integer (int64) |
|
sex |
enum (M,F,U) |
|
locale |
enum (en_US,en_GB,nl_NL,de_DE,fr_FR) |
|
type |
enum (I,T,P) |
|
privacyAccessLevel |
enum (GDPR_1,GDPR_2,GDPR_3) |
|
privacyDbAccessLevel |
enum (GDPR_1,GDPR_2,GDPR_3) |
|
reservationcategoryCode |
string |
|
distributionchannelCode |
string |
|
firstName |
string |
|
lastName |
string |
|
middleName |
string |
|
email |
string |
|
login |
string |
|
onDuty |
string (date) |
|
offDuty |
string (date) |
|
cashAccountIds |
< integer > array |
|
resortIds |
< integer > array |
|
adminorganisationIds |
< integer > array |
|
permissionGroupIds |
< integer > array |
|
sectorIds |
< integer > array |
|
unifiedInboxIds |
< integer > array |
6.114. ErrorCode
Name | Description | Schema |
---|---|---|
errorCode |
string |
|
message |
string |
|
httpStatus |
enum (100 CONTINUE,101 SWITCHING_PROTOCOLS,102 PROCESSING,103 CHECKPOINT,200 OK,201 CREATED,202 ACCEPTED,203 NON_AUTHORITATIVE_INFORMATION,204 NO_CONTENT,205 RESET_CONTENT,206 PARTIAL_CONTENT,207 MULTI_STATUS,208 ALREADY_REPORTED,226 IM_USED,300 MULTIPLE_CHOICES,301 MOVED_PERMANENTLY,302 FOUND,302 MOVED_TEMPORARILY,303 SEE_OTHER,304 NOT_MODIFIED,305 USE_PROXY,307 TEMPORARY_REDIRECT,308 PERMANENT_REDIRECT,400 BAD_REQUEST,401 UNAUTHORIZED,402 PAYMENT_REQUIRED,403 FORBIDDEN,404 NOT_FOUND,405 METHOD_NOT_ALLOWED,406 NOT_ACCEPTABLE,407 PROXY_AUTHENTICATION_REQUIRED,408 REQUEST_TIMEOUT,409 CONFLICT,410 GONE,411 LENGTH_REQUIRED,412 PRECONDITION_FAILED,413 PAYLOAD_TOO_LARGE,413 REQUEST_ENTITY_TOO_LARGE,414 URI_TOO_LONG,414 REQUEST_URI_TOO_LONG,415 UNSUPPORTED_MEDIA_TYPE,416 REQUESTED_RANGE_NOT_SATISFIABLE,417 EXPECTATION_FAILED,418 I_AM_A_TEAPOT,419 INSUFFICIENT_SPACE_ON_RESOURCE,420 METHOD_FAILURE,421 DESTINATION_LOCKED,422 UNPROCESSABLE_ENTITY,423 LOCKED,424 FAILED_DEPENDENCY,425 TOO_EARLY,426 UPGRADE_REQUIRED,428 PRECONDITION_REQUIRED,429 TOO_MANY_REQUESTS,431 REQUEST_HEADER_FIELDS_TOO_LARGE,451 UNAVAILABLE_FOR_LEGAL_REASONS,500 INTERNAL_SERVER_ERROR,501 NOT_IMPLEMENTED,502 BAD_GATEWAY,503 SERVICE_UNAVAILABLE,504 GATEWAY_TIMEOUT,505 HTTP_VERSION_NOT_SUPPORTED,506 VARIANT_ALSO_NEGOTIATES,507 INSUFFICIENT_STORAGE,508 LOOP_DETECTED,509 BANDWIDTH_LIMIT_EXCEEDED,510 NOT_EXTENDED,511 NETWORK_AUTHENTICATION_REQUIRED) |
|
applicationException |
boolean |
6.115. Event
Name | Description | Schema |
---|---|---|
eventId |
unique id associated with each event |
integer (int64) |
entityId |
the id of the entity that changed |
integer (int64) |
entityType |
the entity that was changed which led to the generation of this event. entityId is the id of this entity |
string |
entityAction |
type of change whether the entity was updated, created, deleted or merged(in the case when a customer data is merged to a new customer id). The possible values are INSERT, UPDATE, DELETE, MERGE |
string |
eventTimestamp |
the time at which this event occured |
string (date-time) |
type |
type of event |
string |
oldEntityId |
in case of a merge type of event, like in the case of customer, this will return the old entity id |
integer (int64) |
6.116. Facility
Name | Description | Schema |
---|---|---|
facilityId |
unique id associated with each facility |
integer (int64) |
code |
code of the facility |
string |
internalUse |
if the facility is for internal use |
boolean |
resortId |
resort id of the facility |
integer (int64) |
priority |
priority of the facility |
integer (int32) |
translations |
information of the facility which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nFacility |
openingTimes |
< FacilityOpeningTime |
6.117. FacilityOpeningTime
Name | Description | Schema |
---|---|---|
openingTimeId |
integer (int64) |
|
managerId |
Write only (field is only accessible in the request body) |
integer (int64) |
day |
Write only (field is only accessible in the request body) |
string (date) |
startTime |
string (date-time) |
|
endTime |
string (date-time) |
|
openingComment |
string |
|
published |
boolean |
|
translations |
< I18nFacilityOpeningTime |
|
date |
string (date) |
6.118. Fields
Name | Description | Schema |
---|---|---|
fieldId |
integer (int64) |
|
dataTypeName |
string |
|
type |
string |
|
value |
string |
|
i18n |
Write only (field is only accessible in the request body) |
< I18nFields |
translations |
< I18nFields |
6.119. Filebase
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
fileId |
integer (int64) |
|
name |
string |
|
fileName |
string |
|
fileSize |
integer (int64) |
|
fileType |
string |
|
uploadDate |
string (date-time) |
|
language |
string |
|
endDate |
string (date-time) |
|
shortDescription |
string |
|
validFrom |
string (date-time) |
|
validTo |
string (date-time) |
6.120. FilterOption
Name | Description | Schema |
---|---|---|
arrivals |
unique items |
< string > array |
departures |
unique items |
< string > array |
resorts |
If includeFilterOptionCounts is "true" in request body, then all the available resortIds and their respective counts as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the resortIds are displayed in response. unique items |
< object > array |
amenities |
If includeFilterOptionCounts is "true" in request body, then all the available amenities and their respective counts(No of accommodations in which that amenity is available) as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the amenityIds are displayed in response. unique items |
< object > array |
accommodationKinds |
accommodationkind ids on which user can filter data unique items |
< object > array |
6.121. FinancialTransactionJournalsReport
Name | Description | Schema |
---|---|---|
status |
string |
|
description |
string |
|
journalType |
string |
|
journalNumber |
string |
|
journalPeriodNumber |
string |
|
statementNumber |
string |
|
statementDate |
string (date) |
|
ledgerNumber |
string |
|
costCenter |
string |
|
costUnit |
string |
|
secondLedgerNumber |
string |
|
debitVatIncluded |
Write only (field is only accessible in the request body) |
number |
creditVatIncluded |
Write only (field is only accessible in the request body) |
number |
debitVatExcluded |
Write only (field is only accessible in the request body) |
number |
creditVatExcluded |
Write only (field is only accessible in the request body) |
number |
debitVatIncludedAccCurr |
Write only (field is only accessible in the request body) |
number |
creditVatIncludedAccCurr |
Write only (field is only accessible in the request body) |
number |
debitVatExcludedAccCurr |
Write only (field is only accessible in the request body) |
number |
creditVatExcludedAccCurr |
Write only (field is only accessible in the request body) |
number |
accountCurrencyId |
Write only (field is only accessible in the request body) |
integer (int64) |
exchangeValue |
Write only (field is only accessible in the request body) |
integer (int64) |
accountId |
integer (int64) |
|
accountCurrencyCode |
Write only (field is only accessible in the request body) |
string |
adminCurrencyCode |
Write only (field is only accessible in the request body) |
string |
adminCurrencyId |
Write only (field is only accessible in the request body) |
integer (int64) |
adminOrganistationCurrency |
||
accountCurrency |
||
statementHeader |
boolean |
|
financialTransactionReportJournalId |
integer (int64) |
|
adminOrganisationId |
integer (int64) |
|
financialTransactionReportId |
integer (int64) |
6.122. FinancialTransactionReport
Name | Description | Schema |
---|---|---|
financialTransactionReportId |
integer (int64) |
|
reportNumber |
integer (int64) |
|
creationDate |
string (date-time) |
|
status |
string |
|
adminOrganisationId |
integer (int64) |
6.123. FiscalYearResponse
Name | Description | Schema |
---|---|---|
arrivalLimit |
string (date) |
|
departureLimit |
string (date) |
|
financiallyClosed |
boolean |
|
fiscalYear |
integer (int32) |
|
fiscalYearId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.124. GeoLocation
Name | Description | Schema |
---|---|---|
latitude |
number (double) |
|
longitude |
number (double) |
6.125. Group
Name | Description | Schema |
---|---|---|
groupId |
integer (int64) |
|
code |
string |
|
type |
enum (CONTRACT_TYPE,PHASING,ACCOMMODATION_TYPE,RESORT,EXCLUDE_RESOURCE,POWERPLAY,DISTRIBUTION_CHANNEL,MARKETING,REPORTING_CONTRACT_TYPE,DEBITCARD_PRODUCT,BILL,PURPOSE,DUTIES,DISTRIBUTION_CHANNEL_SETTLEMENT,DISTRIBUTION_CHANNEL_SELECTION,INTERNET_ADDITIONAL_COST) |
|
parentId |
integer (int64) |
|
priority |
integer (int64) |
|
resortId |
integer (int64) |
|
translations |
< I18nGroup |
|
linkedIds |
< integer > array |
6.126. Housekeeping
Name | Description | Schema |
---|---|---|
resortId |
integer (int64) |
|
resourceId |
integer (int64) |
|
unitId |
integer (int64) |
|
executionDate |
string (date) |
|
executionMoment |
enum (ARRIVAL,DEPARTURE,CHANGEOVER,STAY,RESCHEDULE,MANUAL) |
|
sector |
||
tasks |
< Task |
6.127. HousekeepingTask
Name | Description | Schema |
---|---|---|
taskId |
integer (int64) |
|
code |
string |
|
translations |
< I18nHousekeepingTask |
6.128. I18NCountry
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
i18nCountryId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the country |
string |
language |
code of the language in which the above information is stored |
string |
longName |
Write only (field is only accessible in the request body) |
string |
6.129. I18NCountry_Id
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
i18nCountryId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the country |
string |
language |
code of the language in which the above information is stored |
string |
longName |
Write only (field is only accessible in the request body) |
string |
6.130. I18NRegion
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
description |
string |
|
name |
string |
|
shortDescription |
string |
|
language |
string |
6.131. I18nAccommodationKind
information of the accommodation kind which depends on a language and is translatable by the user. Multiple entries for different languages can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
i18nAccommodationkindId |
integer (int64) |
|
accommodationkindId |
integer (int64) |
|
name |
string |
|
description |
string |
6.132. I18nAccommodationType
information of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.
Name | Description | Schema |
---|---|---|
description |
description related to the accommodation type |
string |
description2 |
alternate description related to the accommodation type |
string |
language |
code of the language in which the given information is stored |
string |
name |
name of the accommodation type |
string |
shortDescription |
short description related to the accommodation type |
string |
6.133. I18nAddition
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the given information is stored |
string |
name |
name of the resource |
string |
shortDescription |
short description related to the resource |
string |
description |
description related to the resource |
string |
description2 |
alternate description related to the resource |
string |
6.134. I18nAddon
Name | Description | Schema |
---|---|---|
name |
string |
|
language |
string |
|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
resourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.135. I18nAmenity
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
language in which the given information is stored |
string |
name |
name of the amenity |
string |
description |
description related to the amenity |
string |
6.136. I18nAmenityCategory
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the amenity category |
string |
language |
language in which the given information is stored |
string |
description |
description of the amenity category |
string |
6.137. I18nAmenityCategory_Basic
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the amenity category |
string |
language |
language in which the given information is stored |
string |
description |
description of the amenity category |
string |
6.138. I18nAmenity_Basic
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.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
language in which the given information is stored |
string |
name |
name of the amenity |
string |
description |
description related to the amenity |
string |
6.139. I18nArea
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
areaId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
|
description2 |
string |
6.140. I18nContractType
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
contractTypeId |
integer (int64) |
|
language |
string |
|
name |
string |
6.141. I18nCrmCluster
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
6.142. I18nCustomerTitle
information of the customer title which depends on a language and is translatable by the user. Multiple entries for different languages can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
title |
title associated with the customer |
string |
language |
code of the language in which the above information is stored |
string |
6.143. I18nDynamicField
information of the dynamic fields of the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
i18nFieldId |
Write only (field is only accessible in the request body) |
integer (int64) |
fieldId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the specific accommodation type in dynamic field in the translated language |
string |
language |
code of the language in which the above information is stored |
string |
shortDescription |
short description of the related accommodationtype in dynamic field |
string |
description |
detailed description of the related accommodationtype in dynamic field |
string |
text |
text configured for specific accommodationtype in dynamic field |
string |
6.144. I18nFacility
information of the facility which depends on a language and is translatable by the user. Multiple entries for different languages can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
string |
|
description |
string |
|
language |
string |
|
shortDescription |
string |
6.145. I18nFacilityOpeningTime
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
openingComment |
Write only (field is only accessible in the request body) |
string |
6.146. I18nFields
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the given information is stored |
string |
name |
name of the resource |
string |
description |
description related to the resource |
string |
6.147. I18nGroup
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
string |
|
description |
string |
|
shortDescription |
string |
|
language |
string |
6.148. I18nHousekeepingTask
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
6.149. I18nImage
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the image |
string |
description |
description associated with the image in translated language |
string |
language |
code of the language in which the translation information is shown |
string |
6.150. I18nImply
Name | Description | Schema |
---|---|---|
name |
string |
|
language |
string |
|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.151. I18nIssueCategory
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
6.152. I18nIssueItem
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
6.153. I18nLedgerGroup
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
description |
string |
|
name |
string |
|
language |
string |
6.154. I18nMemoCategory
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
string |
|
description |
string |
|
language |
string |
6.155. I18nMetric
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the metric |
string |
language |
language in which the above information is stored |
string |
6.156. I18nMetric_Basic
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the metric |
string |
language |
language in which the above information is stored |
string |
6.157. I18nPackageItem
information of the packages available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
packageItemId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the packages |
string |
language |
language in which the given information is stored |
string |
6.158. I18nPaymentMethod
information of the payment methods which depends on a language and is translatable by the user. Multiple entries for different language can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the payment method |
string |
language |
code of the language in which the translation information is shown |
string |
6.159. I18nPaymentTermSet
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
string |
|
description |
string |
|
language |
string |
6.160. I18nPeriodicalTask
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
|
description2 |
string |
6.161. I18nPointsOfInterest
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
headText |
string |
|
text |
string |
|
description |
string |
|
description2 |
string |
6.162. I18nPointsOfInterestCategory
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
|
shortDescription |
string |
6.163. I18nPredefinedMemo
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
string |
|
description |
string |
|
language |
string |
6.164. I18nQualityLevel
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
6.165. I18nRate
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
6.166. I18nRateType
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
string |
|
language |
string |
6.167. I18nRentabilitySet
information of the rentability which depends on a language and is translatable by the user. Multiple entries for different languages can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the above information is stored |
string |
name |
name of the rentability set |
string |
6.168. I18nRepresentation
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
i18nRepresentationId |
Write only (field is only accessible in the request body) |
integer (int64) |
representationId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
string |
|
language |
string |
|
shortDescription |
string |
|
description |
string |
|
description2 |
string |
6.169. I18nReservationCategory
information of the reservationCategory which depends on a language and is translatable by the user. Multiple entries for different languages can exists.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which reservationCategory information is stored. |
string |
name |
name of the country. |
string |
description |
desciption of the reservationCategory. |
string |
6.170. I18nResort
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the above information is stored |
string |
name |
name of the resort |
string |
description |
description related to the resort |
string |
shortDescription |
short description related to the resort |
string |
6.171. I18nResortActivity
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
title |
string |
|
headText |
string |
|
text |
string |
|
description |
string |
6.172. I18nResource
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the given information is stored |
string |
name |
name of the resource |
string |
shortDescription |
short description related to the resource |
string |
description |
description related to the resource |
string |
description2 |
alternate description related to the resource |
string |
resourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
namePath |
name of the path of an accommodationtype |
string |
accotypeKind |
field under description which depicts the kind of accommodationtype |
string |
6.173. I18nResourceGroup
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
shortDescription |
string |
|
description |
string |
|
description2 |
string |
6.174. I18nResourceLockReason
Name | Description | Schema |
---|---|---|
languageId |
integer (int64) |
|
langauge |
string |
|
name |
string |
|
description |
string |
6.175. I18nRoom
information of the rooms accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the given information is stored |
string |
name |
name of the room |
string |
description |
description associated with the room |
string |
6.176. I18nRoomType
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the given information is stored |
string |
name |
name of the room type |
string |
description |
description associated with the room type |
string |
6.177. I18nSendMethod
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
i18nSendMethodId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
sendMethodId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.178. I18nSource
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
6.179. I18nSubject
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
name of the subject |
string |
shortDescription |
short description associated with the subject |
string |
subjectId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the translation information is shown |
string |
6.180. I18nTask
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
|
description2 |
string |
6.181. I18nUnit
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
|
description2 |
string |
|
shortDescription |
string |
|
unitId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.182. I18nUnit_Id
information of the unit which depends on a language and is translatable by the user. Multiple entries for different language can exist.
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
|
description2 |
string |
|
shortDescription |
string |
|
unitId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.183. IcalUrl
Name | Description | Schema |
---|---|---|
downloadLink |
string |
6.184. Image
Name | Description | Schema |
---|---|---|
fileName |
name of the file uploaded |
string |
imageId |
unique id associated with each image |
integer (int64) |
startDate |
date from which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
endDate |
date till which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
mimeType |
type of the image. Possible values that can be encountered are:IMAGE_JPG, IMAGE_JPEG, IMAGE_GIF, IMAGE_PNG, IMAGE_SVG, IMAGE_ICO, IMAGE_TIFF, UNKNOWN |
enum (IMAGE_JPG,IMAGE_JPEG,IMAGE_GIF,IMAGE_PNG,IMAGE_SVG,IMAGE_ICO,IMAGE_TIFF,UNKNOWN) |
version |
version of the image |
integer (int64) |
url |
url of the image |
string |
urls |
different urls related to the image based on the size |
object |
uploadDate |
date when the image was uploaded. The format of the date will be YYYY-MM-DDThh:mm:ss |
string (date-time) |
imageType |
type of image ex: if the image depicts the exterior of the accommodationtype/unit/resort then it gives 'EXTERIOR', if the image denotes the interior of the accommodationtype/unit/resort the value of this field is 'INTERIOR' |
enum (LOGO,FLOORPLAN,ROADMAP,INTERIOR,EXTERIOR,MUGSHOT,PICTURE,MAP,IMPRESSION,UNKNOWN,LOCATION_MAP,HEADER,VIDEO360,ICON,OPERATIONS,STATUSICON) |
imageOrientation |
orientation of the image i.e horizontal, vertical etc |
string |
modifiedDate |
date when the image was last modified. The format of the date will be YYYY-MM-DDThh:mm:ss. |
string (date-time) |
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
mediaType |
Write only (field is only accessible in the request body) |
enum (IMAGE,VIDEO,VIDEO360) |
isUploaded |
Write only (field is only accessible in the request body) |
boolean |
hostType |
Write only (field is only accessible in the request body) |
enum (YOUTUBE,VIDEO23,CLOUDINARY,EXTERNAL,MATTERPORT) |
isActive |
Write only (field is only accessible in the request body) |
boolean |
isWebPresentation |
Write only (field is only accessible in the request body) |
boolean |
mediaLanguageId |
Write only (field is only accessible in the request body) |
integer (int64) |
thumbnailUrl |
Write only (field is only accessible in the request body) |
string |
sequenceNumber |
sequence in which the image will be visible to the user |
integer (int32) |
imageManagerIds |
Write only (field is only accessible in the request body) |
< integer > array |
translations |
information of the images which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nImage |
tags |
details related to the tags attached to the image |
< Tag |
6.185. Images
Name | Description | Schema |
---|---|---|
fileName |
string |
|
imageId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
mimeType |
enum (IMAGE_JPG,IMAGE_JPEG,IMAGE_GIF,IMAGE_PNG,IMAGE_SVG,IMAGE_ICO,IMAGE_TIFF,UNKNOWN) |
|
version |
integer (int64) |
|
url |
string |
|
urls |
object |
|
uploadDate |
string (date-time) |
|
imageType |
enum (LOGO,FLOORPLAN,ROADMAP,INTERIOR,EXTERIOR,MUGSHOT,PICTURE,MAP,IMPRESSION,UNKNOWN,LOCATION_MAP,HEADER,VIDEO360,ICON,OPERATIONS,STATUSICON) |
|
imageOrientation |
string |
|
modifiedDate |
string (date-time) |
|
imageManagerId |
integer (int64) |
|
sequenceNumber |
integer (int32) |
|
translations |
< I18nImage |
|
tags |
< Tag |
6.186. Implied
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
objectId |
integer (int64) |
6.187. Implies
Name | Description | Schema |
---|---|---|
impliesId |
integer (int64) |
|
addToParent |
integer (int64) |
|
bookDateFrom |
string (date) |
|
bookDateTo |
string (date) |
|
countFromMin |
boolean |
|
ignoreRentability |
boolean |
|
implicationManagerId |
integer (int64) |
|
implyOnce |
boolean |
|
included |
boolean |
|
onBill |
boolean |
|
parentId |
integer (int64) |
|
priority |
integer (int32) |
|
quantityMax |
integer (int64) |
|
quantityMin |
integer (int64) |
|
removable |
boolean |
|
required |
boolean |
|
showOnAllInPriceBill |
boolean |
|
showPrice |
boolean |
|
subjectsMax |
integer (int64) |
|
subjectsMin |
integer (int64) |
|
supplierImpliesId |
integer (int64) |
|
validFrom |
string (date) |
|
validTo |
string (date) |
|
implied |
< Implied |
|
resourceIds |
< integer > array |
|
resourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
stay |
boolean |
|
parent |
boolean |
6.188. ImplyPrice
Name | Description | Schema |
---|---|---|
price |
This field returns a price for a single mandatory add-on which is not subject based. In case of a subject based add-on see the subjectPrices array. In case of a subject based price this price value will be 0. |
number (double) |
priceArrivalDateFrom |
string (date) |
|
priceArrivalDateTo |
string (date) |
|
perDay |
string |
|
duration |
Number of minutes in a day times the applicable duration of the rate, that is weekly or nightly or per booking or custom. |
integer (int32) |
daysOfWeek |
Denotes the days of week. Calculated as Sum of 2^N where N is 0 = Monday, 1 = Tuesday, … , 6 = Sunday |
< string > array |
minQuantity |
Deprecated. not part of imply price deprecated |
integer (int64) |
maxQuantity |
Deprecated. not part of imply price deprecated |
integer (int64) |
minNights |
Minimum number of nights. Applicable only when rates are varying with the number of days booked. |
integer (int32) |
maxNights |
Maximum number of nights. Applicable only when rates are varying with the number of days booked. |
integer (int32) |
included |
Deprecated. not part of imply price deprecated |
boolean |
subjectIds |
Set of subjectId’s for which prices are configured deprecated |
< integer > array |
subjectPrices |
If a subjectprices entry is available the regular price field is not used and will return 0. |
< SubjectPrice |
dependsOnOffer |
Flag to indicate if the price depend on offers |
boolean |
offerIds |
Offer ids of offers on which the imply price depends on |
< integer > array |
dependsOnAddon |
Flag to indicate if the price depend on addons |
boolean |
addonIds |
Addon ids of addons on which the imply price depends on |
< integer > array |
dependsOnAccommodationtypes |
Depends on accommodationtype provided in request |
boolean |
percentagePrice |
Show if the price is a flat value or a percentage |
boolean |
appliedPerSubject |
boolean |
6.189. InfoText
Name | Description | Schema |
---|---|---|
infoTextId |
integer (int64) |
|
code |
string |
|
name |
string |
|
description |
string |
|
reservations |
< ReservationLink |
|
display |
boolean |
|
reservedResourceId |
integer (int64) |
6.190. InfoTextItem
represent the any information that is related to the accommodationtype.
Name | Description | Schema |
---|---|---|
name |
name of the configured infotext. |
string |
display |
shows that infotext will be shown while creating reservation or not based on the configured conditions. |
string |
description |
this field contains the brief information, for which this infotext is configured. |
string |
6.191. Infotext
Name | Description | Schema |
---|---|---|
description |
Description associated with the infotext. |
string |
6.192. InfotextResponse
Name | Description | Schema |
---|---|---|
name |
string |
|
description |
string |
|
display |
boolean |
6.193. Instalment
as per the payment terms configuration , installments are generated for the entire bill.
Name | Description | Schema |
---|---|---|
term |
name of the configured payment terms. |
string |
value |
the value which is considered in installment as per the configuration of payment-terms according to the total amount. |
number (double) |
payerType |
represent the type of payer, who will pay for the reservation like agent or customer etc. |
string |
dueDate |
the date on which the installment amount need to be pay. |
string (date) |
status |
this field define the status of installment. Possible status are : |
string |
issueDate |
the date from which the installment is issued. |
string (date) |
taxValue |
this field shows the tax amount applied on bill. |
number (double) |
due |
this field shows the remaining amount, which needs to be paid. |
number (double) |
autopay |
This field is used for automatically charging the instalment due amount on stored credit card. |
boolean |
6.194. IssueCategory
Name | Description | Schema |
---|---|---|
translations |
< I18nIssueCategory |
6.195. IssueItem
Name | Description | Schema |
---|---|---|
translations |
< I18nIssueItem |
6.196. IssueTaskSchedule
Name | Description | Schema |
---|---|---|
resortId |
integer (int64) |
|
scheduleType |
enum (WEEKLY,MONTHLY,YEARLY,X_DAYS,X_YEARS) |
|
schedules |
< Schedule |
6.197. JournalResponse
Name | Description | Schema |
---|---|---|
reportId |
integer (int64) |
|
type |
enum (MUTATION_REPORT,REVENUE_DISTRIBUTION,OWNER_MUTATION_REPORT,PURCHASE_DISTRIBUTION,AR_AP_POSITION_OVERVIEW,AR_AP_REVALUATION_OVERVIEW) |
|
reservationId |
integer (int64) |
|
reportNumber |
integer (int64) |
|
mutationDate |
string (date-time) |
|
resortId |
integer (int64) |
|
reservationNumber |
string |
|
resourceCode |
string |
|
ledgerNumber |
string |
|
costCenter |
string |
|
debitVatIncluded |
number |
|
creditVatIncluded |
number |
|
debitVatExcluded |
number |
|
creditVatExcluded |
number |
|
secondLedgerNumber |
string |
|
ownerName |
string |
|
accountName |
string |
|
statementNumber |
string |
|
statementDate |
string (date) |
|
comments |
string |
|
settlementNumber |
integer (int64) |
|
contractType |
string |
|
customerId |
integer (int64) |
|
distributionChannelId |
integer (int64) |
|
distributionChannelCountryCode |
string |
|
workOrderId |
integer (int64) |
|
referenceNumber |
integer (int64) |
|
reservedResourceId |
integer (int64) |
6.198. Language
Name | Description | Schema |
---|---|---|
languageId |
string |
|
shortName |
string |
|
defaultLanguage |
boolean |
6.199. Ledger
Name | Description | Schema |
---|---|---|
ledgerId |
Unique id associated with each ledger. |
integer (int64) |
description |
Description of the ledger. |
string |
ledgerNumber |
Ledger number associated with each ledger. |
string |
name |
Name of the ledger. |
string |
6.200. LedgerGroup
Name | Description | Schema |
---|---|---|
ledgerGroupId |
integer (int64) |
|
code |
string |
|
translations |
< I18nLedgerGroup |
|
resortsGroups |
< ResortGroup |
6.201. LocalTime
Name | Description | Schema |
---|---|---|
hour |
integer (int32) |
|
minute |
integer (int32) |
|
second |
integer (int32) |
|
nano |
integer (int32) |
6.202. Lock
Name | Description | Schema |
---|---|---|
resourceLockId |
integer (int64) |
|
resourceManagerId |
integer (int64) |
|
reasonId |
integer (int64) |
|
detailDescription |
string |
|
clientId |
integer (int64) |
|
accoCreatedLock |
integer (int64) |
|
blockDate |
string (date) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
type |
string |
|
created |
string (date-time) |
|
objectId |
deprecated |
integer (int64) |
unitId |
integer (int64) |
|
resourceId |
integer (int64) |
|
createdOn |
Write only (field is only accessible in the request body) |
string (date-time) |
6.203. MailAddress
Name | Description | Schema |
---|---|---|
zipCode |
zip code of the place where the accommodationtype/resort/unit/customer is located |
string |
poBoxZipcode |
zip code of the post office box |
string |
houseNumberSuffix |
a letter that might come after an address number |
string |
address1 |
the field is expected to have street number, name |
string |
address2 |
the field refers to apartment, floor, etc |
string |
address3 |
the field expects other details related to the location |
string |
poBoxCity |
city where the post office box exist |
string |
city |
zip code of the post office box |
string |
mobilePhone2 |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
latitude |
latitude in which the accommodationtype/resort/unit lies |
number (double) |
houseNumber |
house number associated to the accommodationtype/resort/unit |
string |
boxNumber |
number used as an address |
string |
municipality |
name of the general-purpose administrative subdivision |
string |
exposeLocation |
if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false |
boolean |
poBox |
numbered box in a post office where letters for an organization or person can be called for |
string |
mobilePhone |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
district |
district in which the accommodationtype/resort/unit is situated |
string |
privatePhone |
the private contact number of the owner |
string |
workPhone |
the contact number which the owner uses at work |
string |
email |
email of the contact person of the accommodationtype/resort/unit |
string |
longitude |
longitude in which the accommodationtype/resort/unit lies |
number (double) |
countryId |
Write only (field is only accessible in the request body) |
integer (int64) |
country |
||
fax |
fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateContactPerson |
name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
6.204. MailAddress_Id
the address to which payment details needs to send.
Name | Description | Schema |
---|---|---|
zipCode |
zip code of the place where the accommodationtype/resort/unit/customer is located |
string |
poBoxZipcode |
zip code of the post office box |
string |
houseNumberSuffix |
a letter that might come after an address number |
string |
address1 |
the field is expected to have street number, name |
string |
address2 |
the field refers to apartment, floor, etc |
string |
address3 |
the field expects other details related to the location |
string |
poBoxCity |
city where the post office box exist |
string |
city |
zip code of the post office box |
string |
mobilePhone2 |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
latitude |
latitude in which the accommodationtype/resort/unit lies |
number (double) |
houseNumber |
house number associated to the accommodationtype/resort/unit |
string |
boxNumber |
number used as an address |
string |
municipality |
name of the general-purpose administrative subdivision |
string |
exposeLocation |
if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false |
boolean |
poBox |
numbered box in a post office where letters for an organization or person can be called for |
string |
mobilePhone |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
district |
district in which the accommodationtype/resort/unit is situated |
string |
privatePhone |
the private contact number of the owner |
string |
workPhone |
the contact number which the owner uses at work |
string |
email |
email of the contact person of the accommodationtype/resort/unit |
string |
longitude |
longitude in which the accommodationtype/resort/unit lies |
number (double) |
countryId |
Write only (field is only accessible in the request body) |
integer (int64) |
country |
||
fax |
fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateContactPerson |
name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
6.205. MaxxtonException
Name | Description | Schema | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cause |
|
object |
|||||||||||||||
stackTrace |
< object > array |
||||||||||||||||
errorCode |
|||||||||||||||||
fields |
object |
||||||||||||||||
internalFields |
object |
||||||||||||||||
messageWithoutFields |
string |
||||||||||||||||
message |
string |
||||||||||||||||
is1xxInformational |
boolean |
||||||||||||||||
is2xxSuccessful |
boolean |
||||||||||||||||
is3xxRedirection |
boolean |
||||||||||||||||
is4xxClientError |
boolean |
||||||||||||||||
is5xxServerError |
boolean |
||||||||||||||||
localizedMessage |
string |
||||||||||||||||
suppressed |
< object > array |
6.206. Memo
Name | Description | Schema |
---|---|---|
memoId |
integer (int64) |
|
memoCategoryId |
integer (int64) |
|
employeeId |
integer (int64) |
|
content |
string |
|
creationDate |
string (date-time) |
|
predefinedMemoId |
integer (int64) |
6.207. MemoCategory
Name | Description | Schema |
---|---|---|
memoCategoryId |
integer (int64) |
|
code |
string |
|
translations |
< I18nMemoCategory |
6.208. MemoRequest
Memo for reservation which contain the memo detail
Name | Description | Schema |
---|---|---|
text |
string |
|
memoCategoryId |
integer (int64) |
|
sensitive |
boolean |
|
onCheckin |
boolean |
|
onInvoice |
boolean |
6.209. MemoResponse
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
memo |
< Memo |
6.210. Metric
Name | Description | Schema |
---|---|---|
metricId |
unique id associated with each metric |
integer (int64) |
code |
unique code associated with each metric |
string |
translations |
information of the metrics which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nMetric |
i18n |
Write only (field is only accessible in the request body) |
< I18nMetric |
6.211. Metric_Basic
details of metric
Name | Description | Schema |
---|---|---|
metricId |
unique id associated with each metric |
integer (int64) |
code |
unique code associated with each metric |
string |
translations |
information of the metrics which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nMetric_Basic |
i18n |
Write only (field is only accessible in the request body) |
< I18nMetric_Basic |
6.212. Offer
A offer to be added
Name | Description | Schema |
---|---|---|
resourceId |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
code |
string |
|
resortId |
integer (int64) |
|
parentId |
integer (int64) |
|
path |
string |
|
lowestLevel |
boolean |
|
allowPriceOverride |
boolean |
|
translations |
< I18nResource |
|
source |
string |
|
showNilPriceOnBill |
boolean |
|
powerplaygroupId |
integer (int64) |
|
allowMovingToMainBill |
boolean |
|
archivedFrom |
string (date) |
|
offerExactPeriodOnly |
boolean |
|
offerType |
string |
|
offerPolicy |
string |
|
secretOffer |
boolean |
|
searchCode |
string |
|
excludePriceCache |
boolean |
|
offerPriority |
integer (int32) |
|
allowToPublish |
boolean |
|
type |
string |
|
poolWeightage |
integer (int32) |
|
customizableResource |
boolean |
|
autovalidate |
boolean |
6.213. OfferContractType
Contract type of Offers
Name | Description | Schema |
---|---|---|
contracttypeId |
integer (int64) |
|
resourceId |
integer (int64) |
6.214. OfferPrice
Name | Description | Schema |
---|---|---|
offerCode |
string |
|
offerPrice |
number (double) |
|
offerPriceInclusive |
number (double) |
|
minAge |
integer (int32) |
|
offerPolicy |
string |
|
maxAge |
integer (int32) |
|
offerId |
integer (int64) |
|
minCapacity |
integer (int32) |
6.215. OperationTask
Name | Description | Schema |
---|---|---|
issueIncidentId |
integer (int64) |
|
resortId |
integer (int64) |
|
translations |
< I18nTask |
|
reportedBy |
string |
|
onHoldReason |
string |
|
workTime |
integer (int32) |
|
priority |
integer (int32) |
|
status |
enum (DECLINED,ERROR_IN_INVOICE,MAY_BE_DECLINED,BLANK,NEW,ASSIGNED,ON_HOLD,CLOSED,READY_FOR_INVOICE,BILLED,NOT_TO_BE_BILLED,ADMIN_ON_HOLD,ON_HOLD_QUOTE,INTERNAL,UNDEFINED) |
|
employeeId |
integer (int64) |
|
reportedDate |
string (date-time) |
|
workTimeAddedDateTime |
string (date-time) |
|
type |
enum (ISSUE_INCIDENT,CHECKIN_CHECKOUT,TASK) |
|
issueTaskConfigId |
integer (int64) |
|
expectedStartDate |
string (date) |
|
expectedEndDate |
string (date) |
|
resourceId |
integer (int64) |
|
modifiedDate |
string (date-time) |
|
parentId |
integer (int64) |
|
referenceNumber |
integer (int64) |
|
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.216. Owner
Name | Description | Schema |
---|---|---|
ownerId |
integer (int64) |
|
accountNr |
string |
|
firstName |
string |
|
lastName |
string |
|
middle |
string |
|
alternateName |
string |
|
attentionOf |
string |
|
birthDate |
string (date) |
|
languageId |
integer (int64) |
|
mailAllowed |
boolean |
|
sendMethodId |
integer (int64) |
|
sex |
string |
|
origin |
string |
|
originId |
string |
|
socialSecurityNumber |
string |
|
company |
deprecated |
boolean |
emailAllowed |
boolean |
|
titleId |
integer (int64) |
|
ibanNumber |
string |
|
bicSwift |
string |
|
companyName |
string |
|
ownerGroupId |
integer (int64) |
|
mailAddress |
||
mailAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
fiscalTypes |
< OwnerFiscalType |
|
sharedOwnerShips |
< SharedOwnerShip |
|
ownerPool |
enum (OWNER,POOL,RENT_ASSURANCE_POOL,YEAR_ROUND_GUEST,BUSINESS,LOCATION,MAINTAINANCE_FUND,VENDOR,POOL_CONSUMPTION,POOL_SHARE) |
|
birthPlace |
string |
|
companyIdentificationNumber |
string |
|
socialSecurityNumberIssuingCountryId |
integer (int64) |
|
taxNumberIssuingCountryId |
integer (int64) |
|
taxNumber |
string |
|
ownerType |
string |
|
dac7OwnerVerified |
boolean |
|
owner |
boolean |
|
questionnaireUnsubscribed |
boolean |
6.217. OwnerAccommodationType
Name | Description | Schema |
---|---|---|
ownerId |
integer (int64) |
|
resourceId |
integer (int64) |
|
type |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
|
code |
string |
|
resortId |
integer (int64) |
|
parentId |
integer (int64) |
|
path |
string |
|
hasObjects |
boolean |
|
dependsOnLedgerGroup |
boolean |
|
priority |
integer (int32) |
|
numberOfPersons |
integer (int32) |
|
nrOfBedrooms |
number (double) |
|
nrOfBathrooms |
number (double) |
|
accotypeKindId |
integer (int64) |
|
supplierOrigin |
string |
|
translations |
< I18nResource |
|
archivedFrom |
string (date) |
|
accommodationAddress |
||
brand |
string |
6.218. OwnerFinancialTransaction
Name | Description | Schema |
---|---|---|
ownerFinancialTransactionReportId |
integer (int64) |
|
reportNumber |
integer (int64) |
|
creationDate |
string (date-time) |
|
bookDate |
string (date) |
|
status |
string |
6.219. OwnerFinancialTransactionJournalsDetails
Name | Description | Schema |
---|---|---|
ownerFinancialTransactionReportId |
integer (int64) |
|
settlementId |
integer (int64) |
|
settlementEntryId |
integer (int64) |
|
ledgerId |
integer (int64) |
|
ledgerNumber |
string |
|
ledgerName |
string |
|
costCenterId |
integer (int64) |
|
costCenterNumber |
string |
|
costCenterName |
string |
|
costUnitId |
integer (int64) |
|
costUnitNumber |
string |
|
costUnitName |
string |
|
secondLedgerId |
integer (int64) |
|
secondLedgerNumber |
string |
|
secondLedgerName |
string |
|
debitVatIncluded |
number (double) |
|
creditVatIncluded |
number (double) |
|
debitVatExcluded |
number (double) |
|
creditVatExcluded |
number (double) |
|
ownerCurrencyId |
integer (int64) |
6.220. OwnerFinancialTransactionJournalsReport
Name | Description | Schema |
---|---|---|
status |
string |
|
description |
string |
|
journalType |
string |
|
journalNumber |
string |
|
journalPeriodNumber |
integer (int64) |
|
statementNumber |
string |
|
statementDate |
string (date) |
|
ledgerNumber |
string |
|
costCenter |
string |
|
costUnit |
string |
|
secondLedgerNumber |
string |
|
debitVatIncluded |
Write only (field is only accessible in the request body) |
number |
creditVatIncluded |
Write only (field is only accessible in the request body) |
number |
debitVatExcluded |
Write only (field is only accessible in the request body) |
number |
creditVatExcluded |
Write only (field is only accessible in the request body) |
number |
debitVatIncludedInAdminOrganisationCurrency |
Write only (field is only accessible in the request body) |
number |
creditVatIncludedInAdminOrganisationCurrency |
Write only (field is only accessible in the request body) |
number |
debitVatExcludedInAdminOrganisationCurrency |
Write only (field is only accessible in the request body) |
number |
creditVatExcludedInAdminOrganisationCurrency |
Write only (field is only accessible in the request body) |
number |
ownerCurrencyId |
integer (int64) |
|
ownerCrrencyCode |
Write only (field is only accessible in the request body) |
string |
exchangeValue |
Write only (field is only accessible in the request body) |
integer (int64) |
accountId |
integer (int64) |
|
adminOrganisationCurrencyId |
Write only (field is only accessible in the request body) |
integer (int64) |
adminOrganisationCurrencyCode |
Write only (field is only accessible in the request body) |
string |
adminOrganisationCurrency |
||
ownerCurrency |
6.221. OwnerFiscalType
Name | Description | Schema |
---|---|---|
ownerFiscalTypeId |
integer (int64) |
|
fiscalType |
enum (PRIVATE_OWNER,DOMESTIC_VAT_COMPANY,FOREIGN_VAT_COMPANY) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
fiscalVat |
string |
6.222. OwnerGroup
Name | Description | Schema |
---|---|---|
ownerGroupId |
integer (int64) |
|
name |
string |
6.223. OwnerReservationCustomer
details related to the customer for which the reservation has been created.
Name | Description | Schema |
---|---|---|
customerId |
Write only (field is only accessible in the request body) |
integer (int64) |
mailAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
firstName |
it specifies the first name of customer/guest. |
string |
lastName |
it specifies the last name of customer/guest. |
string |
countryCode |
unique id represent the country, from where the customer belong. |
string |
6.224. OwnerReservedResource
the list of resources which are booked as part of the reservation.
Name | Description | Schema |
---|---|---|
reservedResourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
resourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
rateTypeId |
Write only (field is only accessible in the request body) |
integer (int64) |
startDate |
Write only (field is only accessible in the request body) |
string (date) |
endDate |
Write only (field is only accessible in the request body) |
string (date) |
ownerId |
the unique id represents the the owner of unit. |
integer (int64) |
unitCode |
the unique code associated unit. |
string |
unitId |
the unique id of unit. |
integer (int64) |
addonType |
Write only (field is only accessible in the request body) |
enum (PRODUCTTYPE,RESOURCEACTIVITY,ACTIVITY,ACCOMMODATIONTYPE,EXTRA,SPECIAL,COMPOSITION) |
addons |
field specifies the addon list applied on the reservation. |
< OwnerReservedResourceAddon |
6.225. OwnerReservedResourceAddon
field specifies the addon list applied on the reservation.
Name | Description | Schema |
---|---|---|
resourceId |
unique id associated with the addon. |
integer (int64) |
code |
unique code of addon linked to the resource which booked in the reservation. |
string |
parentReservedResourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
translations |
information of the addon which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< ReservedResourceTranslation |
addonType |
it specifies the type of the addon. Possible addon types are BREAKFAST, CLEANING, CASH_ADDONS, DEPOSIT, CUSTOM_ADDONS etc. |
string |
6.226. OwnerSettlement
Name | Description | Schema |
---|---|---|
ownerMutationReportNumber |
integer (int64) |
|
settlementId |
integer (int64) |
|
savePreviousBalance |
boolean |
|
createdAt |
string (date-time) |
|
isPoolSettlement |
boolean |
|
adminOrganisationId |
integer (int64) |
|
madePermanentAt |
string (date) |
|
comments |
string |
|
settleInvoicesUntilDate |
string (date) |
|
resortId |
integer (int64) |
|
overridePercentageDepartureDate |
string (date) |
|
settleRedirectionUntilDate |
string (date) |
|
madePermanentByEmployeeId |
integer (int64) |
|
settlementDate |
string (date-time) |
|
settlementNumber |
integer (int64) |
|
settlementPercentage |
integer (int64) |
|
settleReservationPaymentDepartureDate |
string (date) |
|
settlementName |
string |
|
createdByEmployeeId |
integer (int64) |
|
invoicesReservationPaymentDepartureDate |
string (date) |
|
status |
boolean |
6.227. OwnerSettlementEntry
Name | Description | Schema |
---|---|---|
baseLedgerId |
integer (int64) |
|
commissionSecondLedgerId |
integer (int64) |
|
resourceId |
integer (int64) |
|
reservedresourceId |
integer (int64) |
|
vatDeductionBase |
number (double) |
|
resourceRedirectionId |
integer (int64) |
|
discount |
number (double) |
|
vatDeductionBaseNow |
number (double) |
|
ownerId |
integer (int64) |
|
type |
string |
|
fiscalVat |
string |
|
entryId |
integer (int64) |
|
ownerAmountVatPercentage |
integer (int64) |
|
maxOwnerAmount |
number (double) |
|
reservationId |
integer (int64) |
|
totalPreviousOwnerAmounts |
number (double) |
|
baseSecondLedgerId |
integer (int64) |
|
rentAmount |
number (double) |
|
ownerBillNumber |
string |
|
commissionCostCenterId |
integer (int64) |
|
commissionLedgerId |
integer (int64) |
|
contractRuleId |
integer (int64) |
|
blockedDays |
integer (int64) |
|
previousCommission |
number (double) |
|
invoicenumber |
string |
|
advancePercentage |
integer (int64) |
|
excludedDays |
integer (int64) |
|
entryDate |
string (date-time) |
|
realOwnerId |
integer (int64) |
|
roundDifference |
number (double) |
|
settlementPercentage |
integer (int64) |
|
vatCommission |
number (double) |
|
baseCostCenterId |
integer (int64) |
|
beneficiary |
string |
|
fiscalType |
string |
|
previousOwnerAmount |
number (double) |
|
ownerAmountDeduction |
number (double) |
|
totalPrevVatOwnerAmounts |
number (double) |
|
ownerCurrencyId |
integer (int64) |
|
description |
string |
|
vatPercentageDeductionBase |
integer (int64) |
|
settlementId |
integer (int64) |
|
basesumIncltax |
integer (int64) |
|
commission |
number (double) |
|
ownerAmount |
number (double) |
|
unitId |
integer (int64) |
|
contracttypeId |
integer (int64) |
|
pooldistributionId |
integer (int64) |
|
deductionBase |
number (double) |
|
resortId |
integer (int64) |
|
contraId |
integer (int64) |
|
currentDeductionBase |
number (double) |
|
deductionSettlementId |
integer (int64) |
|
vatPercentageCommission |
integer (int64) |
|
distributionChannelCurrencyId |
integer (int64) |
|
deductionBaseNow |
number (double) |
|
contractId |
integer (int64) |
|
vatOwnerAmount |
number (double) |
|
finalContractrule |
boolean |
|
daysInDistribution |
integer (int64) |
|
invoiceId |
integer (int64) |
|
status |
boolean |
6.228. OwnerUnit
Name | Description | Schema |
---|---|---|
ownerId |
integer (int64) |
|
unitId |
integer (int64) |
|
brand |
string |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
ownerGroupId |
integer (int64) |
|
resourceGroupId |
integer (int64) |
|
resourceId |
integer (int64) |
|
code |
string |
|
nrOfBathrooms |
number (double) |
|
path |
string |
|
excludeQuestionnaireStats |
boolean |
|
choosableOnInternet |
boolean |
|
cleaningStatus |
enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP) |
|
roomCode |
string |
|
nrOfBedrooms |
integer (int64) |
|
archivedFrom |
string (date) |
|
translations |
< I18nUnit |
|
accommodationAddress |
||
vsi |
integer (int64) |
|
origin |
string |
|
originId |
string |
6.229. OwnerUnitReservation
Name | Description | Schema |
---|---|---|
reservationId |
unique id of the reservation. |
integer (int64) |
distributionChannelId |
Write only (field is only accessible in the request body) |
integer (int64) |
distributionChannelCode |
unique code associated with distribution channel. |
string |
reservationCategoryId |
Write only (field is only accessible in the request body) |
integer (int64) |
categoryCode |
unique code associated with reservation category. |
string |
arrivalDate |
the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
departureDate |
unique code represent the currency in which the reservation payment is done. |
string (date) |
duration |
Write only (field is only accessible in the request body) |
integer (int64) |
reservationDate |
date on which the reservation is created. |
string (date-time) |
reservationNumber |
represent the unique number of the reservation. |
string |
status |
this field holds the status, in which reservation is created. Possible values for reservation status : DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41) |
integer (int32) |
expectedArrivalDateTime |
the date and time on which the customer is expected to arrive. |
string (date-time) |
expectedDepartureDateTime |
the date and time on which the customer departure is expected. |
string (date-time) |
customerId |
Write only (field is only accessible in the request body) |
integer (int64) |
customer |
||
reservedResources |
the list of resources which are booked as part of the reservation. |
< OwnerReservedResource |
subjects |
details related to the subjects(people) and the number of subjects who will come for stay to the unit in reservation period. |
< ReservedResourceSubject |
expectedArrivalTime |
Write only (field is only accessible in the request body) |
string (date-time) |
expectedDepartureTime |
Write only (field is only accessible in the request body) |
string (date-time) |
statusValue |
enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT) |
6.230. Ownership
Name | Description | Schema |
---|---|---|
ownershipId |
integer (int64) |
|
unitId |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
startDate |
string (date) |
|
endDate |
string (date) |
|
origin |
string |
|
originId |
string |
|
isReportToAuth |
boolean |
6.231. OwnershipResponse
Name | Description | Schema |
---|---|---|
ownershipId |
integer (int64) |
|
unitId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
origin |
string |
|
originId |
string |
6.232. PackageItem
Name | Description | Schema |
---|---|---|
packageResourceId |
package resource Id associated with the package. |
integer (int64) |
parentId |
parent id associated with the package. |
integer (int64) |
resourceId |
resource id associated with the package. |
integer (int64) |
sequence |
sequence associated with the package. |
integer (int64) |
duration |
duration of the package. |
integer (int32) |
quantity |
quantity of the package. |
integer (int32) |
translations |
information of the packages available in the resource which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nPackageItem |
6.233. PageAccommodationKindDetail
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationKindDetail |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.234. PageAccommodationType
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationType |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.235. PageAccommodationTypeAddon
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationTypeAddon |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.236. PageAccommodationTypeAmenityLink
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationTypeAmenityLink |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.237. PageAccommodationTypeCostPrice
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationTypeCostPrice |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.238. PageAccommodationTypeDetail
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationTypeDetail |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.239. PageAccommodationTypeImply
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationTypeImply |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.240. PageAccommodationTypePriority
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationTypePriority |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.241. PageAccommodationTypeRelease
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AccommodationTypeRelease |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.242. PageAccount
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Account |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.243. PageAddOn
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AddOn |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.244. PageAddition
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Addition |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.245. PageAdminOrganisation
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AdminOrganisation |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.246. PageAllotment
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Allotment |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.247. PageAllotmentRelease
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AllotmentRelease |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.248. PageAmenity
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Amenity |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.249. PageAmenityLink
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AmenityLink |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.250. PageAmenityTreeDetail
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AmenityTreeDetail |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.251. PageAvailabilityResult
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< AvailabilityResult |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.252. PageBrand
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Brand |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.253. PageCashAccount
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< CashAccount |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.254. PageCashClearance
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< CashClearance |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.255. PageCategorySet
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< CategorySet |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.256. PageCommunication
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Communication |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.257. PageCompany
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Company |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.258. PageContract
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Contract |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.259. PageContractRule
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ContractRule |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.260. PageContractType
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ContractType |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.261. PageCreditCardAuthorisation
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< CreditCardAuthorisation |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.262. PageCurrency
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Currency |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.263. PageCustomer
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Customer |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.264. PageCustomerPhoneCall
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< CustomerPhoneCall |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.265. PageCustomerStatus
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< CustomerStatus |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.266. PageDCPaymentMethod
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< DCPaymentMethod |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.267. PageDistributionChannel_Id
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< DistributionChannel_Id |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.268. PageDocumentBase
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< DocumentBase |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.269. PageDoorlockPincodesContainer
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< DoorlockPincodesContainer |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.270. PageDynamicField
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< DynamicField |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.271. PageEmployee
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Employee |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.272. PageEvent
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Event |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.273. PageFacility
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Facility |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.274. PageFinancialTransactionJournalsReport
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< FinancialTransactionJournalsReport |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.275. PageFinancialTransactionReport
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< FinancialTransactionReport |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.276. PageGroup
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Group |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.277. PageHousekeeping
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Housekeeping |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.278. PageHousekeepingTask
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< HousekeepingTask |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.279. PageImage
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Image |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.280. PageImages
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Images |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.281. PageImplies
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Implies |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.282. PageLedger
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Ledger |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.283. PageLedgerGroup
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< LedgerGroup |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.284. PageLock
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Lock |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.285. PageMemo
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Memo |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.286. PageMemoCategory
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< MemoCategory |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.287. PageMemoResponse
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< MemoResponse |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.288. PageOffer
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Offer |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.289. PageOfferContractType
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OfferContractType |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.290. PageOperationTask
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OperationTask |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.291. PageOwner
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Owner |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.292. PageOwnerAccommodationType
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerAccommodationType |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.293. PageOwnerFinancialTransaction
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerFinancialTransaction |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.294. PageOwnerFinancialTransactionJournalsDetails
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerFinancialTransactionJournalsDetails |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.295. PageOwnerFinancialTransactionJournalsReport
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerFinancialTransactionJournalsReport |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.296. PageOwnerGroup
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerGroup |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.297. PageOwnerSettlement
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerSettlement |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.298. PageOwnerSettlementEntry
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerSettlementEntry |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.299. PageOwnerUnit
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerUnit |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.300. PageOwnerUnitReservation
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnerUnitReservation |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.301. PageOwnershipResponse
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< OwnershipResponse |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.302. PagePackageItem
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< PackageItem |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.303. PagePaymentMethod
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< PaymentMethod |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.304. PagePaymentTermSet
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< PaymentTermSet |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.305. PagePeriodicalTask
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< PeriodicalTask |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.306. PagePointsOfInterest
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< PointsOfInterest |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.307. PagePointsOfInterestCategory
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< PointsOfInterestCategory |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.308. PagePredefinedMemo
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< PredefinedMemo |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.309. PageQualityLevel
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< QualityLevel |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.310. PageRangeAvailabilityResult
list of filtered result as per the given criterias provided by the user
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RangeAvailabilityResult |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.311. PageRate
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Rate |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.312. PageRateResource
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RateResource |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.313. PageRateType
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RateType |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.314. PageRegion
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Region |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.315. PageRentability
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Rentability |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.316. PageRentabilitySet
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RentabilitySet |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.317. PageRepresentation
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Representation |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.318. PageRepresentationDistributionChannel
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RepresentationDistributionChannel |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.319. PageReseller
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Reseller |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.320. PageResellerStopSell
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResellerStopSell |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.321. PageReservation
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Reservation |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.322. PageReservationAdditionResponse
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationAdditionResponse |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.323. PageReservationAmenity
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationAmenity |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.324. PageReservationBill
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationBill |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.325. PageReservationCategory
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationCategory |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.326. PageReservationCostPrice
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationCostPrice |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.327. PageReservationCustomFieldResponse
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationCustomFieldResponse |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.328. PageReservationDetailResponse
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationDetailResponse |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.329. PageReservationDoorlock
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationDoorlock |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.330. PageReservationInstalmentResponse
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationInstalmentResponse |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.331. PageReservationPayment
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationPayment |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.332. PageReservationPaymentContainer
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationPaymentContainer |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.333. PageReservationPreference
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationPreference |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.334. PageReservationReminder
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationReminder |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.335. PageReservationReservedResourceSubject
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationReservedResourceSubject |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.336. PageReservationSnapshot
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationSnapshot |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.337. PageReservationTermAndCondition
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservationTermAndCondition |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.338. PageReservedResourceOfReservation
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservedResourceOfReservation |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.339. PageReservedResourcePerReservation
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservedResourcePerReservation |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.340. PageReservedResourceSubjectQuantity
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservedResourceSubjectQuantity |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.341. PageReservedResourceUnitAllotment
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ReservedResourceUnitAllotment |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.342. PageResort
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Resort |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.343. PageResortActivity
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResortActivity |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.344. PageResortAmenityLink
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResortAmenityLink |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.345. PageResortDC
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResortDC |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.346. PageResortDetailWithUnitMap
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResortDetailWithUnitMap |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.347. PageResortPriority
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResortPriority |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.348. PageResortSearchList
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResortSearchList |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.349. PageResourceAddition
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResourceAddition |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.350. PageResourceBudget
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResourceBudget |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.351. PageResourceLockReason
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResourceLockReason |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.352. PageResourceReservability
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResourceReservability |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.353. PageResourceReservabilityAllotment
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ResourceReservabilityAllotment |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.354. PageRevenueDistribution
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RevenueDistribution |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.355. PageRevenueDistributionJournal
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RevenueDistributionJournal |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.356. PageRoom
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Room |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.357. PageRoomAmenityLink
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RoomAmenityLink |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.358. PageRoomType
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< RoomType |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.359. PageSearchInfoTextResponse
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< SearchInfoTextResponse |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.360. PageSendMethod
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< SendMethod |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.361. PageShowMoment
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< ShowMoment |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.362. PageSource
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Source |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.363. PageSourceCategory
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< SourceCategory |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.364. PageState
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< State |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.365. PageStaySummary
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< StaySummary |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.366. PageSubjectCategory
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< SubjectCategory |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.367. PageTargetAmount
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< TargetAmount |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.368. PageTemporaryResourceAddition
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< TemporaryResourceAddition |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.369. PageTransaction
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Transaction |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.370. PageUnitAmenityLink
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< UnitAmenityLink |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.371. PageUnitAvailabilityResult
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< UnitAvailabilityResult |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.372. PageUnitDetail
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< UnitDetail |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.373. PageUnitDetail_Id
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< UnitDetail_Id |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.374. PageUnitReservability
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< UnitReservability |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.375. PageUnitReservabilityPeriod
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< UnitReservabilityPeriod |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.376. PageVideo
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Video |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.377. PageWorkorder
Name | Description | Schema |
---|---|---|
totalPages |
integer (int32) |
|
totalElements |
integer (int64) |
|
number |
integer (int32) |
|
size |
integer (int32) |
|
numberOfElements |
integer (int32) |
|
content |
< Workorder |
|
sort |
||
first |
boolean |
|
last |
boolean |
|
empty |
boolean |
6.378. Pageable
Name | Description | Schema |
---|---|---|
page |
Minimum: 0 |
integer (int32) |
size |
Minimum: 1 |
integer (int32) |
sort |
< string > array |
6.379. PageableObject
Name | Description | Schema |
---|---|---|
paged |
boolean |
|
unpaged |
boolean |
|
pageNumber |
integer (int32) |
|
pageSize |
integer (int32) |
|
offset |
integer (int64) |
|
sort |
6.380. PageableObject_Id
Name | Description | Schema |
---|---|---|
paged |
boolean |
|
unpaged |
boolean |
|
pageNumber |
integer (int32) |
|
pageSize |
integer (int32) |
|
offset |
integer (int64) |
|
sort |
6.381. PaymentLink
Name | Description | Schema |
---|---|---|
url |
string |
6.382. PaymentMethod
Name | Description | Schema |
---|---|---|
paymentMethod |
name of the payment method. |
string |
code |
unique code associated with the payment method. |
string |
paymentType |
type of the payment method. |
string |
paymentProvider |
service provider of the payment method. |
string |
minDaysBeforeArrival |
payment method is applicable on or before x days of arrival date. |
integer (int32) |
maxDaysBetweenBookAndArrivalDate |
payment method is applicable when difference between reservation book date and arrival date is less than or equal to max days specified with this field value. |
integer (int64) |
translations |
information of the payment methods which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nPaymentMethod |
6.383. PaymentMethodDefinition
the payment method of the credit card used for authorisation.
Name | Description | Schema |
---|---|---|
brandName |
Write only (field is only accessible in the request body) |
string |
code |
the payment method code. |
string |
name |
the payment method name. |
string |
6.384. PaymentTermSet
Name | Description | Schema |
---|---|---|
paymentTermSetId |
integer (int64) |
|
priority |
integer (int32) |
|
minArrivalDeviation |
integer (int32) |
|
maxArrivalDeviation |
integer (int32) |
|
validFrom |
string (date) |
|
validTo |
string (date) |
|
arrivalDateFrom |
string (date) |
|
arrivalDateTo |
string (date) |
|
minStayLength |
integer (int32) |
|
maxStayLength |
integer (int32) |
|
paymentTermSetType |
enum (GENERAL,ENERGY) |
|
nonRefundable |
boolean |
|
preBooking |
boolean |
|
translations |
< I18nPaymentTermSet |
6.385. PeriodicalTask
Name | Description | Schema |
---|---|---|
issueTaskConfigId |
integer (int64) |
|
code |
string |
|
comments |
string |
|
resortIds |
< integer > array |
|
scheduleType |
enum (WEEKLY,MONTHLY,YEARLY,X_DAYS,X_YEARS) |
|
individualWorkorder |
boolean |
|
issueCategories |
||
i18nIssueCategory |
Write only (field is only accessible in the request body) |
< I18nIssueCategory |
issueItem |
||
i18nIssueItem |
Write only (field is only accessible in the request body) |
< I18nIssueItem |
translations |
< I18nPeriodicalTask |
|
areas |
< Area |
|
areaId |
Write only (field is only accessible in the request body) |
integer (int64) |
i18nArea |
Write only (field is only accessible in the request body) |
< I18nArea |
workOrderTaskConfigurationResorts |
Write only (field is only accessible in the request body) |
< WorkOrderTaskConfigurationResort |
issueTaskSchedules |
< IssueTaskSchedule |
6.386. Person
the details of the person accommodated in an accommodationtype
Name | Description | Schema |
---|---|---|
persons |
list of details of person on which search is to be applied on |
< PersonDetail |
6.387. PersonDetail
list of details of person on which search is to be applied on
Name | Description | Schema |
---|---|---|
maxAge |
Max age of the subject for which search is to be made. In the case of the oldest subject without a maxAge configured the value 'null' can be provided instead of the actual max Age. |
string |
quantity |
quantity of the subject for which search is to be made |
integer (int32) |
6.388. Persons
details related to the persons for whom the accommodationtype is booked in reservation.
Name | Description | Schema |
---|---|---|
age |
Age of the person or maxAge of the subject. In the case of the oldest subject without a maxAge configured, the value 'null' can be provided instead of the actual age. |
integer (int32) |
quantity |
specify the no. of persons are for which the accommodation is booked. |
integer (int32) |
6.389. Pincode
Name | Description | Schema |
---|---|---|
doorlockPincodeId |
integer (int64) |
|
pincode1 |
string |
|
pincode2 |
string |
|
arrivalDate |
string (date) |
|
statusCode1 |
boolean |
|
statusCode2 |
boolean |
6.390. PointsOfInterest
Name | Description | Schema |
---|---|---|
pointsOfInterestId |
integer (int64) |
|
code |
string |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
visibleFrom |
string (date) |
|
visibleTo |
string (date) |
|
pointsOfInterestCategoryId |
integer (int64) |
|
url |
string |
|
resortIds |
< integer > array |
|
priority |
integer (int32) |
|
price |
string |
|
startTime |
||
endTime |
||
priceChildren |
string |
|
priceAdult |
string |
|
priceValuePoint |
string |
|
translations |
< I18nPointsOfInterest |
6.391. PointsOfInterestCategory
Name | Description | Schema |
---|---|---|
pointsOfInterestCategoryId |
integer (int64) |
|
code |
string |
|
translations |
< I18nPointsOfInterestCategory |
6.392. PredefinedMemo
Name | Description | Schema |
---|---|---|
preDefinedMemoId |
integer (int64) |
|
memoCategoryId |
integer (int64) |
|
code |
string |
|
priority |
integer (int64) |
|
validFrom |
string (date-time) |
|
validTo |
string (date-time) |
|
content |
string |
|
translations |
< I18nPredefinedMemo |
6.393. Preference
a preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit.
Name | Description | Schema |
---|---|---|
id |
it specifies the id of the amenity or unit based on the type field value is amenity or unit respectively. |
integer (int64) |
type |
it specifies the type of preference : AMENITY, UNIT or ADJACENT. |
enum (UNIT,AMENITY,ADJACENT) |
remark |
Remark to be added with the ADJACENT type preferences. |
string |
6.394. PreferencePrice
Name | Description | Schema |
---|---|---|
price |
This field returns single value rate and qrv resourcebase rate. In case of a subject based preference add-on see the subjectPrices array. In case of a subject based price this price value will be 0. |
number (double) |
priceArrivalDateFrom |
string (date) |
|
priceArrivalDateTo |
string (date) |
|
priceBookDateFrom |
string (date-time) |
|
priceBookDateTo |
string (date-time) |
|
subjectIds |
Set of subjectId’s for which prices are configured unique items |
< integer > array |
subjectPrices |
subject based rates for groups of persons. If a subjectprices entry is available the regular price field will not be used and will return 0. |
< SubjectPrice |
appliedPerSubject |
boolean |
6.395. PriceEnginePersons
List of details of person on which search is to be applied on
Name | Description | Schema |
---|---|---|
maxAge |
Max age of the subject for which search is to be made. In the case of the oldest subject without a maxAge configured the value 'null' can be provided instead of the actual max Age. |
integer (int64) |
quantity |
Quantity of the subject for which search is to be made |
integer (int32) |
6.396. PriceEngineSubject
The details of the person accommodated in an accommodationtype
Name | Description | Schema |
---|---|---|
persons |
List of details of person on which search is to be applied on |
< PriceEnginePersons |
6.397. PriceRangeSearchRequest
Name | Description | Schema |
---|---|---|
distributionChannelId |
if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown. |
integer (int64) |
arrivalDateFrom |
the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
numberOfDaysInResult |
the number of days starting from the arrivalDate for which the price range search has been carried out and the numberOfDaysInResult should be passed in days ex: 7. Maximum set limit is 30 days. |
integer (int32) |
offerCode |
unique code associated with offer on the bases of which accommodationtype is to be filtered |
string |
offerId |
unique id associated with offer on the bases of which accommodationtype is to be filtered |
integer (int64) |
subjects |
||
resortIds |
list of resort ids passed to fetch accommodationtypes which belong to the provided resorts unique items |
< integer > array |
resourceIds |
The accommodationtype ids which user wants to apply search on and this field accepts only single resource Id. unique items |
< integer > array |
petQuantity |
the number of pets accommodated in the accommodationtype |
integer (int32) |
amenityIds |
list of amenity ids which are linked to the accommodationtype unique items |
< integer > array |
accommodationKindIds |
list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched unique items |
< integer > array |
filterOptions |
filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals' and 'departures'.If a user is passing these filter options then all the possible departures and arrivals available for the requested criteria are displayed in response. |
< string > array |
preBooking |
an option to return prebooking prices along with normal prices. By default the value of preBooking is false, if not specified in the request. To enable preBooking support, set the value as true in the request. |
boolean |
voucherCode |
unique code associated with voucher on the bases of which accommodationtype is to be filtered |
string |
unitId |
unitId passed to fetch accommodationtypes which belong to the provided unitId |
integer (int64) |
rateTypeId |
Rate type id which will be used to fetch availability. If not provided, then the first rate type will be picked up from the rate types linked to distribution channel and ordered in ascending order of priority. |
integer (int64) |
redeemableLoyaltyPoints |
Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter. |
integer (int32) |
qualityLevelIds |
unique items |
< integer > array |
6.398. QrvValue
this field should be used in relation with valueType field when it’s value is QRV
Name | Description | Schema |
---|---|---|
minQuantity |
integer (int64) |
|
value |
number (double) |
6.399. QualityLevel
Name | Description | Schema |
---|---|---|
qualityLevelId |
integer (int64) |
|
code |
string |
|
archivedFrom |
string (date) |
|
priority |
integer (int32) |
|
translations |
< I18nQualityLevel |
6.400. RangeAvailabilityResult
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
basePrice |
number (double) |
|
basePriceInclusive |
number (double) |
|
referencePrice |
number (double) |
|
referencePriceInclusive |
number (double) |
|
offerPrice |
number (double) |
|
offerPriceInclusive |
number (double) |
|
offerCode |
string |
|
offerName |
string |
|
offerPolicy |
string |
|
arrivalDate |
string (date) |
|
departureDate |
string (date) |
|
arrivalDowMask |
string |
|
duration |
integer (int32) |
|
accommodationKindId |
integer (int64) |
|
resourceCode |
string |
|
resortId |
integer (int64) |
|
maxCapacity |
integer (int32) |
|
maxPetCapacity |
integer (int32) |
|
rateTypeId |
The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type |
integer (int64) |
preBooking |
Defines if the stay has a preBooking price |
boolean |
loyaltyPrice |
Price including offers and loyalty |
number (double) |
loyaltyPriceInclusive |
Price including offers, loyalty and additional costs |
number (double) |
requiredLoyaltyPoints |
The required number of points for this loyalty price |
integer (int32) |
freeLoyaltyDuration |
The number of free nights for this number of loyalty points |
integer (int32) |
qualityLevelId |
integer (int64) |
6.401. Rate
Name | Description | Schema |
---|---|---|
rateId |
Ratetype the rate is linked to |
integer (int64) |
value |
Actual rate value, price. |
number (double) |
remark |
Optional remark/comment about the specific rate |
string |
quantifier |
Possible values are: ABSOLUTE ( +/- an amount to the rate), OVERRIDE (override the rate), RELATIVE( +/- a percentage to the rate). |
string |
valueType |
Type of value, price. This can be "single" (base ) /price "qrv" (price depending on another resource or subject) |
string |
qrvType |
this field should be used in relation with valueType field when it’s value is QRV |
enum (EQUAL,RESOURCE,SUBJECT,AMENITY) |
duration |
Usage_unit, which length of stay the price is valid for |
integer (int64) |
minDuration |
Minimal length of stay(number of nights) the price is valid for(only applies in case of nightly rates). |
integer (int64) |
maxDuration |
Maximum length of stay(number of nights) the price is valid for(only applies in case of nightly rates). |
integer (int64) |
priority |
Priority, the rate with the highest priority will be the preferred one |
integer (int64) |
bookdateFrom |
The reservation book date should be greater than equal to this date. |
string (date-time) |
bookdateTo |
The reservation book date should be less than equal to this date. |
string (date-time) |
usageDurationFrom |
Defines the minium part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2. |
integer (int64) |
usageDurationTo |
Defines the maximum part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2. |
integer (int64) |
daysOfWeek |
The day the rate is applicable/valid |
< string > array |
rateTypes |
Write only (field is only accessible in the request body) |
< RateTypeForRate |
validFrom |
Valid from arrivaldate. the arrival date needs to be greater than equal to validFrom date |
string (date) |
validTo |
Valid till arrivaldate. The arrivaldate needs to less than the provided date. |
string (date) |
resourceId |
The resource(accommodationtype, addon) the rate applies to |
integer (int64) |
maxDeviation |
Maximum number of days between book date and arrival date when the price will be valid. |
integer (int64) |
minDeviation |
Minimal number of days between book date and arrival date when the price will be valid. |
integer (int64) |
rateTypeIds |
Ratetypes the rate is linked to |
< integer > array |
translations |
< I18nRate |
|
qrvValues |
this field should be used in relation with valueType field when it’s value is QRV |
< QrvValue |
usageDowList |
Write only (field is only accessible in the request body) |
< string > array |
minDurationMinutes |
integer (int64) |
|
maxDurationMinutes |
integer (int64) |
6.402. RateResource
Name | Description | Schema |
---|---|---|
rateId |
Ratetype the rate is linked to |
integer (int64) |
value |
Actual rate value, price. |
number (double) |
remark |
Optional remark/comment about the specific rate |
string |
quantifier |
Possible values are: ABSOLUTE ( +/- an amount to the rate), OVERRIDE (override the rate), RELATIVE( +/- a percentage to the rate). |
string |
valueType |
Type of value, price. This can be "single" (base ) /price "qrv" (price depending on another resource or subject) |
string |
qrvType |
this field should be used in relation with valueType field when it’s value is QRV |
enum (EQUAL,RESOURCE,SUBJECT,AMENITY) |
duration |
Usage_unit, which length of stay the price is valid for |
integer (int64) |
minDuration |
Minimal length of stay(number of nights) the price is valid for(only applies in case of nightly rates). |
integer (int64) |
maxDuration |
Maximum length of stay(number of nights) the price is valid for(only applies in case of nightly rates). |
integer (int64) |
priority |
Priority, the rate with the highest priority will be the preferred one |
integer (int64) |
bookdateFrom |
The reservation book date should be greater than equal to this date. |
string (date-time) |
bookdateTo |
The reservation book date should be less than equal to this date. |
string (date-time) |
usageDurationFrom |
Defines the minium part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2. |
integer (int64) |
usageDurationTo |
Defines the maximum part of the duration where the rate applies to. For example the first 2 days of the stay can have another rate and this specific rate is only valid for the days after the first 2. |
integer (int64) |
daysOfWeek |
The day the rate is applicable/valid |
< string > array |
rateTypes |
Write only (field is only accessible in the request body) |
< RateTypeForRate |
validFrom |
Valid from arrivaldate. the arrival date needs to be greater than equal to validFrom date |
string (date) |
validTo |
Valid till arrivaldate. The arrivaldate needs to less than the provided date. |
string (date) |
resourceId |
The resource(accommodationtype, addon) the rate applies to |
integer (int64) |
maxDeviation |
Maximum number of days between book date and arrival date when the price will be valid. |
integer (int64) |
minDeviation |
Minimal number of days between book date and arrival date when the price will be valid. |
integer (int64) |
rateTypeIds |
Ratetypes the rate is linked to |
< integer > array |
translations |
< I18nRate |
|
qrvValues |
this field should be used in relation with valueType field when it’s value is QRV |
< QrvValue |
applicableTo |
< CashFlowRuleResource |
|
resources |
Write only (field is only accessible in the request body) |
< CashFlowRuleResource |
usageDowList |
Write only (field is only accessible in the request body) |
< string > array |
minDurationMinutes |
integer (int64) |
|
maxDurationMinutes |
integer (int64) |
6.403. RateType
Name | Description | Schema |
---|---|---|
rateTypeId |
integer (int64) |
|
code |
string |
|
priority |
integer (int64) |
|
isDefault |
boolean |
|
translations |
< I18nRateType |
|
rateTypeDchannel |
Write only (field is only accessible in the request body) |
< RateTypeDchannel |
name |
string |
|
currencyId |
integer (int64) |
|
currencyCode |
string |
|
distributionChannels |
< RateTypeDchannel |
6.404. RateTypeDchannel
Name | Description | Schema |
---|---|---|
distributionChannelId |
Write only (field is only accessible in the request body) |
integer (int64) |
bookdateFrom |
string (date-time) |
|
bookdateTo |
string (date-time) |
|
startDate |
string (date-time) |
|
endDate |
string (date-time) |
|
id |
integer (int64) |
6.405. RateTypeForRate
Name | Description | Schema |
---|---|---|
rateTypeId |
integer (int64) |
6.406. Region
Name | Description | Schema |
---|---|---|
regionId |
integer (int64) |
|
code |
string |
|
name |
Write only (field is only accessible in the request body) |
string |
parentId |
integer (int64) |
|
priority |
integer (int64) |
|
lowestLevel |
boolean |
|
geoShapePoints |
< array > array |
|
translations |
< I18NRegion |
|
childIds |
< integer > array |
|
breadCrumbs |
string |
|
i18n |
Write only (field is only accessible in the request body) |
< I18NRegion |
6.407. Rentability
Name | Description | Schema |
---|---|---|
rentabilityId |
integer (int64) |
|
managerId |
integer (int64) |
|
dateBegin |
string (date) |
|
dateEnd |
string (date) |
|
minDeviationArrDepDate |
integer (int64) |
|
maxDeviationArrDepDate |
integer (int64) |
|
isTemporary |
integer (int64) |
|
bookDateFrom |
string (date-time) |
|
bookDateTo |
string (date-time) |
|
maxTimeAfterBookDate |
integer (int64) |
|
minTimeAfterBookDate |
integer (int64) |
|
gap |
integer (int64) |
|
distributionChannelIds |
< integer > array |
|
resourceIds |
< integer > array |
|
rentabilityMarkers |
< RentabilityMarkerDetail |
6.408. RentabilityDetail
Rentability for accommodation which contain the rentability configuration detail
Name | Description | Schema |
---|---|---|
managerId |
integer (int64) |
|
dateBegin |
The date from when the rentability is valid |
string (date) |
dateEnd |
he date till when the rentability is valid |
string (date) |
bookdateFrom |
string (date-time) |
|
bookdateTo |
string (date-time) |
|
minDeviationArrDepDate |
The minimum difference (in days) between the booking date and arrival date |
integer (int64) |
maxDeviationArrDepDate |
The maximum difference (in days) between the booking date and arrival date |
integer (int64) |
isTemporary |
integer (int64) |
|
maxTimeAfterBookDate |
integer (int64) |
|
minTimeAfterBookDate |
integer (int64) |
|
isArrival |
boolean |
|
isDeparture |
boolean |
|
dayMin |
integer (int64) |
|
dayMax |
integer (int64) |
|
daysOfWeek |
The days on which the rentability is valid |
< string > array |
6.409. RentabilityMarkerDetail
Name | Description | Schema |
---|---|---|
rentabilityMarkerId |
integer (int64) |
|
type |
string |
|
timeMin |
This property is in the form of minutes that denotes number of days the rentability marker applies. |
integer (int64) |
dowMask |
This property is a bitmask in the form of a number that denotes which weekdays the rentability marker applies. The value of Monday(1), Tuesday(2), Wednesday(4), Thursday(8), Friday(16), Saturday(32), and Sunday(64) are represented by the numbers 1,2,4,8,16,32,64. For example, a dowMask value of 17 means Monday and Friday are applicable. This can be calculated by summing the separate values(16+1=17). |
integer (int64) |
timeMax |
integer (int64) |
6.410. RentabilitySet
Name | Description | Schema |
---|---|---|
rentabilitySetId |
integer (int64) |
|
resortId |
integer (int64) |
|
rentabilityManagerId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
code |
string |
|
preBooking |
boolean |
|
translations |
information of the rentability which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nRentabilitySet |
6.411. Report
Name | Description | Schema |
---|---|---|
reportCode |
string |
6.412. ReportUrl
Name | Description | Schema |
---|---|---|
reportType |
enum (GENERAL,EMPLOYEE,CUSTOMER,AGENT,OWNER) |
6.413. Representation
Name | Description | Schema |
---|---|---|
representationId |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
resourceId |
integer (int64) |
|
visible |
boolean |
|
bookable |
boolean |
|
distributionChannelIds |
< integer > array |
|
translations |
< I18nRepresentation |
6.414. RepresentationDistributionChannel
Distribution channels detail which is to be added to a representation
Name | Description | Schema |
---|---|---|
distributionChannelId |
integer (int64) |
|
name |
string |
|
code |
string |
|
path |
string |
|
representationId |
integer (int64) |
|
channelId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.415. Requirement
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
Name | Description | Schema |
---|---|---|
managerId |
Write only (field is only accessible in the request body) |
integer (int64) |
required |
The minimum number of subjects which are mandatory to book the accommodation/unit |
integer (int32) |
subject |
details related to the subject |
< Subject |
6.416. Reseller
Name | Description | Schema |
---|---|---|
resellerId |
integer (int64) |
|
code |
string |
|
description |
string |
|
distributionChannelId |
integer (int64) |
|
name |
string |
6.417. ResellerStopSell
Name | Description | Schema |
---|---|---|
resellerStopSellId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
resellerId |
integer (int64) |
|
reservableValue |
integer (int32) |
|
resourceId |
integer (int64) |
|
stopSellType |
enum (BLOCKING,LOWERING,RESTRICTION) |
6.418. Reservation
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
categoryName |
string |
|
categoryCode |
string |
|
arrivalDate |
string (date) |
|
customerId |
integer (int64) |
|
departureDate |
string (date) |
|
distributionChannelId |
integer (int64) |
|
modifiedDate |
string (date-time) |
|
reservationCategoryId |
integer (int64) |
|
reservationDate |
string (date-time) |
|
reservationNumber |
string |
|
resortId |
integer (int64) |
|
status |
Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41) |
integer (int32) |
supplierVoucher |
If a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier booking reference number will be available in this field. |
string |
tncSigned |
boolean |
|
tncSignedDate |
string (date) |
|
tncSigneeCustomerName |
string |
|
type |
Possible values for reservation type |
string |
expectedArrivalDateTime |
string (date-time) |
|
expectedDepartureDateTime |
string (date-time) |
|
validationStatus |
PARK 111(-101) |
integer (int64) |
voucher |
It’s an external booking reference number of the system, from where the reservation was made. |
string |
parentId |
integer (int64) |
|
cancelDate |
string (date) |
|
originId |
string |
|
origin |
string |
|
expireDate |
string (date-time) |
|
printedDate |
string (date) |
|
resellerId |
integer (int64) |
|
statusValue |
enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT) |
|
sendMethodId |
integer (int64) |
|
memoManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
paymentTermSetId |
integer (int64) |
|
reservationKind |
Possible values for reservation kind ACCOMMODATION_RESERVATION("acco"), ADDON_RESERVATION("addon"), GROUP_RESERVATION("group") |
enum (ACCOMMODATION_RESERVATION,ADDON_RESERVATION,GROUP_RESERVATION) |
payingCustomerId |
integer (int64) |
|
externalBookingReference |
string |
|
expectedArrivalTime |
Write only (field is only accessible in the request body) |
string (date-time) |
expectedDepartureTime |
Write only (field is only accessible in the request body) |
string (date-time) |
6.419. ReservationAccommodationType
it contains the details of the accommodationtype for which the reservation is made.
Name | Description | Schema |
---|---|---|
resourceId |
unique id associated with each accommodationtype. |
integer (int64) |
unitId |
unique id associated with each unit. |
integer (int64) |
arrivalDate |
the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
duration |
the duration for which a user wants to make a reservation and the duration should be passed in days ex: 7. |
integer (int32) |
offerCode |
it is a discount code which can be applied in a reservation. |
string |
useLoyaltyPoints |
Loyalty points to be used for the reservation |
integer (int32) |
useLoyaltyFreeNights |
Nights to redeem on saved loyalty points |
integer (int32) |
additions |
the product and extras which a user wants to book in a reservation. |
< ReservationAddition |
preferences |
a preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit. |
< Preference |
subjects |
||
travelParties |
The list of travel parties staying |
< ReservationTravelPartyCriteria |
vehicles |
The list of vehicles with the booking |
< ReservationVehicleCriteria |
rateTypeId |
unique id of the rate types, for which the cashflow is applicable. |
integer (int64) |
removeImplies |
list of impliesId which want to be removed. |
< integer > array |
voucherCode |
Voucher code which can be applied to a reservation. This code is case sensitive. Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown. |
string |
6.420. ReservationAddition
the product and extras which a user wants to book in a reservation.
Name | Description | Schema |
---|---|---|
additionResourceId |
unique id represent the addition linked to the resource. |
integer (int64) |
startDate |
the date from which the addition is accessed in the accommodationtype. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
endDate |
the date till which the addition can be accessed in the accommodationtype. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
quantity |
this field specify the no. of additions which are applied to accommodationtype. Minimum: 1 |
integer (int32) |
memo |
memo for the addition Maximum Length: 500 |
string |
6.421. ReservationAdditionCriteria
request body to fetch reservation addition groups.
Name | Description | Schema |
---|---|---|
accommodationTypes |
< AdditionAccommodationType |
|
categoryCode |
string |
|
distributionChannelCode |
string |
6.422. ReservationAdditionResponse
Name | Description | Schema |
---|---|---|
code |
string |
|
groupId |
integer (int64) |
|
additions |
< ReservationAddition |
|
parentId |
integer (int64) |
|
priority |
integer (int64) |
|
translations |
< I18nResourceGroup |
6.423. ReservationAddress
it specify the address information of customer.
Name | Description | Schema |
---|---|---|
zipCode |
zip code of the place from where the customer belong. |
string |
poBoxZipcode |
zip code of the post office box. |
string |
houseNumberSuffix |
a letter that might come after an address number. Max allowed length: 25 characters. |
string |
address1 |
the field is expected to have street number, name |
string |
address2 |
the field refers to apartment, floor and allows a maximum length of 100 characters |
string |
address3 |
the field expects other details related to the location and allows a maximum length of 100 characters. |
string |
poBoxCity |
it specify the city, where post office box exist and allows a maximum length of 100 characters. |
string |
city |
it represent the city of customer/guest and allows a maximum length of 100 characters. |
string |
mobilePhone2 |
alternative mobilephone number through which the customer/guest in the accommodationtype can be contacted and allows a maximum length of 25 characters. |
string |
latitude |
specify the latitude of customer’s/guest’s home location. |
number (double) |
longitude |
specify the longitude of customer’s/guest’s home location. |
number (double) |
stateId |
unique id represents the state of the customer’s home is located. |
integer (int64) |
houseNumber |
it is the house number of customer. Max allowed length: 10 characters. |
string |
countryCode |
unique id represent the country, from where the customer belong. |
string |
poBox |
numbered box in a post office where letters for an organization or person can be called for and allows a maximum length of 20 characters. |
string |
mobilePhone |
mobilephone number through which the customer/guest coming for stay in the accommodationtype can be contacted and allows a maximum length of 25 characters. |
string |
district |
district name in which the customer city is located and allows a maximum length of 100 characters. |
string |
privatePhone |
the private contact number of the customer and allows a maximum length of 25 characters. |
string |
workPhone |
the contact number at work by which the customer can be reached and allows a maximum length of 25 characters. |
string |
email |
email of the customer/guest. |
string |
6.424. ReservationAmenity
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
amenities |
< ReservedResourceAmenity |
6.425. ReservationBill
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
reservationBillLines |
< ReservationBillLine |
6.426. ReservationBillLine
Name | Description | Schema |
---|---|---|
reservationBillId |
integer (int64) |
|
reservationId |
integer (int64) |
|
cashflowRuleName |
string |
|
resourceName |
string |
|
description |
string |
|
quantity |
integer (int32) |
|
multiplier |
integer (int32) |
|
value |
number (double) |
|
total |
number (double) |
|
billLineType |
RESERVED_RESOURCE(10) |
integer (int32) |
totalBottomSequenceNr |
integer (int32) |
|
reservedResourceId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
payerType |
enum (CUSTOMER,PAYING_CUSTOMER,AGENT) |
|
virtualOverrideValue |
number (double) |
|
resourceId |
integer (int64) |
|
reservationBillLineId |
integer (int64) |
|
resourceType |
string |
|
resourceDescription |
string |
|
type |
string |
|
vatRate |
number (double) |
|
redeemedLoyaltyPoints |
Number of points needed to get this discount |
integer (int32) |
redeemedLoyaltyNights |
Number of nights given free by the resource |
integer (int32) |
resourceTypeSequenceNr |
integer (int64) |
|
overrideValue |
number (double) |
|
replacesParentResource |
Boolean field which indicates if the bill line resource will replace the parent resource or not . |
boolean |
6.427. ReservationBillResponse
Name | Description | Schema |
---|---|---|
resourceId |
integer (int64) |
|
name |
string |
|
endDate |
string (date) |
|
vatRate |
number (double) |
|
billLineType |
integer (int32) |
|
quantity |
integer (int32) |
|
multiplier |
integer (int32) |
|
value |
number (double) |
|
total |
number (double) |
|
startDate |
string (date) |
6.428. ReservationCategory
Name | Description | Schema |
---|---|---|
reservationCategoryId |
unique id associated with the reservationCategory. |
integer (int64) |
name |
name associated with the reservationCategory. |
string |
code |
unique code associated with the reservationCategory. |
string |
endDate |
the date till which reservationCategory is available. |
string |
markForOwnUse |
the reservation category is reserved for owners own use. |
boolean |
translations |
information of the reservationCategory which depends on a language and is translatable by the user. Multiple entries for different languages can exists. |
< I18nReservationCategory |
reservationCategory |
6.429. ReservationCostPrice
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
costs |
< ResourceCostPrice |
6.430. ReservationCriteria
Name | Description | Schema |
---|---|---|
distributionChannelCode |
unique code associated with distribution channel. |
string |
categoryCode |
unique code associated with reservation category. |
string |
accommodationTypes |
it contains the details of the accommodationtype for which the reservation is made. |
< ReservationAccommodationType |
remark |
if guest wants to specify some feedback to the resort, then the feedback given by the customer is displayed. |
string |
externalBookingReference |
if the tour operator wants to store their reservation reference number, then it is displayed under this field. |
string |
employee |
This is not changing the employee who created the reservation, as this is still the employee linked to the API key. This field will set the initials in the reservation. |
string |
sendMethodCode |
this field specifies how the guest can be communicated to i.e via email or post |
string |
statusValue |
this field hold the status, in which reservation will create. We create reservation with OPTIONAL or QUOTATION status. |
enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT) |
customerId |
unique id associated with the customer. In case a reservation for an existing/logged in customer is created this field can be used. The customer Id is provided when the customer login using POST /maxxton/v1/customers/login. |
integer (int64) |
customer |
||
paymentTermSetId |
integer (int64) |
6.431. ReservationCustomFieldResponse
Name | Description | Schema |
---|---|---|
fieldId |
integer (int64) |
|
dataType |
enum (MEMO,TEXT,NUMERIC,SELECTION_INCL,SELECTION_EXCL,DATE,BOOLEAN) |
|
allowedValues |
< string > array |
|
textValue |
Applicable only when custom field is of type text |
string |
booleanValue |
Applicable only when custom field is of type boolean |
boolean |
dateValue |
Applicable only when custom field is of type date |
string (date) |
numericValue |
Applicable only when custom field is of type numeric |
number |
selectValues |
Applicable only when custom field is of type selection incl. or selection excl. |
< string > array |
translations |
< I18nFields |
6.432. ReservationCustomer
details related to the customer. This entity will create a new customer, in case the customer needs to login use customerId field instead.
Name | Description | Schema |
---|---|---|
firstName |
it specifies the first name of customer/guest and allows a maximum length of 50 characters. |
string |
lastName |
it specifies the last name of customer/guest and allows a maximum length of 100 characters. |
string |
middle |
it specifies the middle name of customer/guest and allows a maximum length of 20 characters.. |
string |
socialSecurityNumber |
the social security number associated with the customer and allows a maximum length of 15 characters. |
string |
titleId |
unique id associated with each title linked to the customer. This id can be fetched using GET /maxxton/v1/titles |
integer (int64) |
sex |
specify the gender of customer/guest. |
enum (M,F,U) |
language |
code of language in which the given information is stored. This language is the shortcode of the language and can be fetched using GET /maxxton/v1/languages. This language is also the language used for all communication with the customer. |
string |
mailAddress |
||
alternateName |
it specifies the alternate name of customer/guest and allows a maximum length of 100 characters. |
string |
emailAllowed |
it specifies the permission for email communication with customer. |
boolean |
birthDate |
it specifies the birth date of customer. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string (date) |
mailAllowed |
it specifies the permission for postal communication with customer. |
boolean |
companyName |
it specifies the company name of customer/guest and allows a maximum length of 100 characters. |
string |
questionnaireUnsubscribed |
boolean |
6.433. ReservationCustomerResponse
Name | Description | Schema |
---|---|---|
customerId |
integer (int64) |
|
firstName |
string |
|
lastName |
string |
|
middle |
string |
|
socialSecurityNumber |
string |
|
title |
||
sex |
string |
|
language |
string |
|
ibanNumber |
string |
|
bicSwift |
string |
|
mailAddress |
||
alternateName |
string |
|
emailAllowed |
boolean |
|
birthDate |
string (date) |
|
questionnaireUnsubscribed |
boolean |
|
mailAllowed |
boolean |
|
owner |
boolean |
|
companyName |
string |
|
creationDate |
string (date-time) |
6.434. ReservationCustomerStatus
Name | Description | Schema |
---|---|---|
customerClusters |
< CustomerCluster |
|
customerCluseters |
Write only (field is only accessible in the request body) |
< CustomerCluster |
6.435. ReservationCustomerTitle
Name | Description | Schema |
---|---|---|
translations |
< I18nCustomerTitle |
6.436. ReservationDetailCountry
details of the country in which the accommodationtype/resort/unit is situated
Name | Description | Schema |
---|---|---|
countryId |
country id of the mail address. |
integer (int64) |
code |
country code represents shortname of country, 2 letter code(ISO 3166). |
string |
translations |
information of the country which depends on a language and is translatable by the user. Multiple entries for different languages can exists. |
< I18NCountry |
default |
if the country is the default one then this field is true else false. |
boolean |
6.437. ReservationDetailCountry_Id
details of the country in which the accommodationtype/resort/unit is situated
Name | Description | Schema |
---|---|---|
countryId |
country id of the mail address. |
integer (int64) |
code |
country code represents shortname of country, 2 letter code(ISO 3166). |
string |
translations |
information of the country which depends on a language and is translatable by the user. Multiple entries for different languages can exists. |
< I18NCountry_Id |
default |
if the country is the default one then this field is true else false. |
boolean |
6.438. ReservationDetailResponse
Name | Description | Schema |
---|---|---|
resortId |
integer (int64) |
|
externalBookingReference |
string |
|
distributionChannelId |
integer (int64) |
|
distributionChannelCode |
string |
|
reservationCategoryId |
integer (int64) |
|
categoryCode |
string |
|
reservationDate |
string (date-time) |
|
parentId |
integer (int64) |
|
arrivalDate |
string (date) |
|
reservationId |
integer (int64) |
|
reservationNumber |
string |
|
tncSignedDate |
string (date) |
|
tncSigned |
boolean |
|
tncSigneeCustomerName |
string |
|
cancelDate |
string (date) |
|
customerId |
Write only (field is only accessible in the request body) |
integer (int64) |
payingCustomerId |
Write only (field is only accessible in the request body) |
integer (int64) |
customer |
||
payingCustomer |
||
modifiedDate |
string (date-time) |
|
supplierBookingReference |
string |
|
departureDate |
string (date) |
|
status |
integer (int32) |
|
reservedResources |
< ReservedResourceResponse |
|
infotexts |
< ReservationInfotext |
|
customerBill |
< ReservationBillResponse |
|
agentBill |
< ReservationBillResponse |
|
instalments |
< Instalment |
|
emergencyContacts |
< EmergencyContact |
|
expectedArrivalDateTime |
string (date-time) |
|
expectedDepartureDateTime |
string (date-time) |
|
validationStatusId |
integer (int64) |
|
statusValue |
enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT) |
|
sendMethodId |
integer (int64) |
|
employeeId |
integer (int64) |
|
currencyId |
integer (int64) |
|
currencyCode |
string |
|
previousPmsId |
integer (int64) |
|
paymentTermSetId |
integer (int64) |
|
voucher |
string |
|
vouchers |
List of Special Vouchers redeemed for reservation. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
< VoucherRedemption |
reservationKind |
Possible values for reservation kind ACCOMMODATION_RESERVATION("acco"), ADDON_RESERVATION("addon"), GROUP_RESERVATION("group") |
enum (ACCOMMODATION_RESERVATION,ADDON_RESERVATION,GROUP_RESERVATION) |
expectedArrivalTime |
Write only (field is only accessible in the request body) |
string (date-time) |
expectedDepartureTime |
Write only (field is only accessible in the request body) |
string (date-time) |
reservationInfoTexts |
Write only (field is only accessible in the request body) |
< InfoText |
customerStatus |
6.439. ReservationDoorlock
Name | Description | Schema |
---|---|---|
arrivalDate |
string (date) |
|
departureDate |
string (date) |
|
reservationId |
integer (int64) |
|
doorLockCodes |
< DoorlockCode |
6.440. ReservationEquipment
Name | Description | Schema |
---|---|---|
value |
string |
|
remark |
string |
|
reservationSubjectId |
integer (int64) |
|
reservedResourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.441. ReservationInfotext
Represent any information that is related to resources for example extra, product, special and accommodationtype etc.
Name | Description | Schema |
---|---|---|
description |
description associated with the infotext. |
string |
6.442. ReservationInstalmentResponse
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
instalments |
< Instalment |
6.443. ReservationLink
Name | Description | Schema |
---|---|---|
infoTextReservationId |
integer (int64) |
|
reservedResourceId |
integer (int64) |
|
infoTextId |
integer (int64) |
|
display |
boolean |
6.444. ReservationPayment
Name | Description | Schema |
---|---|---|
paymentId |
unique id associated with the payments. |
integer (int64) |
reservationId |
unique id associated with the reservation. |
integer (int64) |
currencyId |
the currency of the bank account. |
integer (int64) |
currencyCode |
the currency code of the bank account. |
string |
amount |
the amount of the payment in the currency of the bank account. |
number |
paymentDate |
the date when the payemnt has been done. |
string (date-time) |
statementDate |
the date when the statement is created. |
string (date) |
paymentAccount |
the name of the bank with which payment has been done. |
string |
payerType |
the type of the payer. |
string |
paymentType |
type pf payment. |
string |
refunded |
indicates that this payment is a refund of another payment. |
boolean |
remark |
remark for the payments. |
string |
ledgerId |
ledgers in which payments are added. |
integer (int64) |
paymentNumber |
the payment number associated with the payments. |
string |
6.445. ReservationPaymentContainer
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
payments |
< ReservationPayment |
6.446. ReservationPaymentRequest
Payment to be added for reservation.
Name | Description | Schema |
---|---|---|
paymentMethodCode |
string |
|
amount |
number (double) |
|
currencyCode |
string |
|
remark |
string |
6.447. ReservationPersonSubject
Name | Description | Schema |
---|---|---|
reservationSubjectId |
integer (int64) |
|
firstName |
string |
|
middleName |
string |
|
lastName |
string |
|
birthDate |
string (date) |
|
sex |
string |
|
email |
string |
|
street |
string |
|
houseNumber |
string |
|
houseNumberSuffix |
string |
|
zipCode |
string |
|
city |
string |
|
countryId |
integer (int64) |
|
guest |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
boolean |
companion |
boolean |
|
personAlreadyLeft |
boolean |
|
arrivalDate |
string (date) |
|
departureDate |
string (date) |
|
identityCardNumber |
Identity card number of travel party member Maximum Length: 50 |
string |
identityType |
enum (PASSPORT,IDENTITY_CARD,DRIVERS_LICENCE) |
|
identityNumber |
string |
|
identityCountryId |
integer (int64) |
|
identityDateIssued |
string (date) |
|
gender |
Write only (field is only accessible in the request body) |
string |
6.448. ReservationPreference
Name | Description | Schema |
---|---|---|
id |
integer (int64) |
|
type |
string |
6.449. ReservationProposal
Name | Description | Schema |
---|---|---|
currencyCode |
unique code represent the currency in which the reservation payment is done. |
string |
arrivalDate |
the date on which customer/guest will arrive. |
string (date) |
departureDate |
the date on which customer/guest will leave the accommodation. |
string (date) |
customerBill |
the bill of the customer for which the reservation is created. |
< ReservationProposalCustomerBill |
agentBill |
the bill of agent or tour opertor or any third party who made the reservation on behalf of customer. |
< ReservationProposalCustomerBill |
instalments |
as per the payment terms configuration , installments are generated for the entire bill. |
< Instalment |
reservedResources |
the list of resources, which are booked as part of the reservation. |
< ReservedResourceItem |
additions |
addition contains all the possible product and extra that can be booked for that accommodationtype in a reservation. |
< ResourceAdditionItem |
infotexts |
represent the any information that is related to the accommodationtype. |
< InfoTextItem |
preBooking |
this field shows whether if it’s a pre-booking or not |
boolean |
unitIds |
the list of available units for the selected accommodationtype. |
< integer > array |
6.450. ReservationProposalAccommodationType
it contains the details of the accommodationtype for which the reservation is made.
Name | Description | Schema |
---|---|---|
resourceId |
Unique id associated with each accommodationtype. |
integer (int64) |
unitId |
Unique id associated with each unit. |
integer (int64) |
arrivalDate |
The date on which the customer/guest will arrive. The date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
duration |
The Duration for which a user wants to make a reservation and the duration should be passed in days ex: 7. |
integer (int32) |
offerCode |
Discount code which can be applied to a reservation. This code is case sensitive. |
string |
additions |
The product and extras which a user wants to book in a reservation. |
< ReservationProposalAddition |
preferences |
A preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit. |
< ReservationProposalPreference |
subjects |
||
rateTypeId |
Unique id of the rate types for which the cashflow is applicable. |
integer (int64) |
removeImplies |
List of impliesId which want to be removed. |
< integer > array |
voucherCode |
Voucher code which can be applied to a reservation. This code is case sensitive. Either voucherCode or offerCode should be provided in the request, and not both. In case both are provided then an error is thrown. |
string |
useLoyaltyPoints |
Loyalty points to be used for the reservation |
integer (int32) |
useLoyaltyFreeNights |
Nights to redeem on saved loyalty points |
integer (int32) |
6.451. ReservationProposalAddition
The product and extras which a user wants to book in a reservation.
Name | Description | Schema |
---|---|---|
additionResourceId |
unique id associated with addition linked to resource. |
integer (int64) |
startDate |
the date from which the addition is accessed in the accommodation. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string |
endDate |
the date till which the addition can be accessed in the accommodationtype. Date should be added using ISO 8601 standard(yyyy-MM-dd). |
string |
quantity |
this field specify the no. of additions which are applied in accommodationtype. Minimum: 1 |
integer (int32) |
6.452. ReservationProposalCustomerBill
the bill of agent or tour opertor or any third party who made the reservation on behalf of customer.
Name | Description | Schema |
---|---|---|
resourceId |
the unique id of resource for which the bill is generated. |
integer (int64) |
name |
the name of resource for which the bill is generated. |
string |
vatRate |
value of the applied configured vat-rate for the resource. |
number (double) |
billLineType |
possible bill-line type can be encountered : |
integer (int32) |
value |
price of the resource for which the bill is generated |
number (double) |
quantity |
integer (int32) |
|
multiplier |
integer (int32) |
|
total |
total amount of the bill |
number (double) |
redeemedLoyaltyPoints |
Number of points needed to get this discount |
integer (int32) |
redeemedLoyaltyNights |
Number of nights given free by the resource |
integer (int32) |
6.453. ReservationProposalPreference
A preference can be specified as an amenity or unit preference ex: guest prefers unit where smoking is allowed or guest prefers to stay in a specific unit.
Name | Description | Schema |
---|---|---|
id |
Specifies the id of the amenity or unit based on the type field value is amenity or unit respectively. |
integer (int64) |
type |
Specifies the type of preference : AMENITY, UNIT or ADJACENT. |
string |
remark |
Remark to be added with the ADJACENT type preferences. |
string |
6.454. ReservationProposalRequest
A reservation proposal object to be added
Name | Description | Schema |
---|---|---|
distributionChannelCode |
unique code of distribution-channel. |
string |
categoryCode |
unique code of reservation-category. |
string |
customerId |
integer (int64) |
|
accommodationTypes |
it contains the details of the accommodationtype for which the reservation is made. |
< ReservationProposalAccommodationType |
paymentTermSetId |
integer (int64) |
6.455. ReservationProposalSubjectCriteria
Specifies the quantity per subject ex: quantity of Adult, children identified based on the age.
Name | Description | Schema |
---|---|---|
persons |
Details related to the persons for whom the accommodationtype is booked in reservation proposal. |
< Persons |
petsQuantity |
Shows the pet’s quantity for which the accommodationtype is booked in reservation proposal. |
integer (int32) |
6.456. ReservationReminder
Name | Description | Schema |
---|---|---|
dueAmount |
number (double) |
|
status |
enum (OPEN,CLOSED,DORMENT) |
|
sendDate |
string (date-time) |
|
paymentDate |
string (date-time) |
|
printDate |
string (date-time) |
|
reservationId |
integer (int64) |
|
paymentTermSetId |
integer (int64) |
6.457. ReservationReservedResource
The list of resources which are booked as part of the reservation.
Name | Description | Schema |
---|---|---|
type |
The type of the resource, which is reserved as part of the reservation. |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
resourceId |
Unique id of the resource, which is reserved as part of the reservation. |
integer (int64) |
reservedResourceId |
Unique id represent the reserved resource in the reservation. |
integer (int64) |
parentId |
If the reserved resource is child of any other reserved resource then, the id of the parent reserved resource will be displayed. |
integer (int64) |
name |
Tame of the resource booked in the reservation. |
string |
startDate |
The date from which the resource is booked as part of the reservation. |
string (date) |
endDate |
The date till which the resource is booked as part of the reservation. |
string (date) |
price |
The cost of the resource in reservation. |
number (double) |
quantity |
Represent quantity of resources booked in the reservation. |
integer (int32) |
shortDescription |
Short description associated with reserved resource. |
string |
description |
Description associated with the reserved resource. |
string |
unitId |
The unique id, represent the unit booked in the reservation. |
integer (int64) |
hasPriceOverride |
This field shows whether the resource price can be overridden or not. |
boolean |
removable |
This field shows whether the resource can be removed or not. |
boolean |
infotexts |
Represent any information that is related to resources for example extra, product, special and accommodationtype etc. |
< ReservationInfotext |
impliesId |
Write only (field is only accessible in the request body) |
integer (int64) |
offerType |
It is the type of offer which is applicable in the reservation for e.g It can be a GENERAL_SPECIAL, STRUCTURAL_SPECIAL, FOLLOWUP_SPECIAL, CASHIN_SPECIAL, VOUCHER_SPECIAL |
enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE) |
code |
The code represents the resource which is booked as part of the reservation. |
string |
imply |
If any product or extra is a mandatory addition on a accommodationtype then the imply field will be true for that reserved resource or else it will be false. |
boolean |
6.458. ReservationReservedResourceSubject
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
reservedResourceSubjectQuantity |
< ReservedResourceSubjectQuantity |
6.459. ReservationResponse
Name | Description | Schema |
---|---|---|
reservationId |
Unique id of newly created reservation. |
integer (int64) |
reservationNumber |
Represent the unique number of newly created reservation. |
string |
arrivalDate |
The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
currencyCode |
Unique code represent the currency in which the reservation payment is done. |
string |
departureDate |
The date on which customer/guest will leave the accommodation. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
reservationDate |
Date on which the reservation is created. |
string (date-time) |
statusValue |
This field holds the status, in which reservation is created. Possible status can be: OPTIONAL, QUOTATION, PROVISIONAL, REQUEST |
enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT) |
resortId |
The unique id represents the resort in which the accommodationtype is located. |
integer (int64) |
externalBookingReference |
It represents the tour operator’s reservation reference number. |
string |
customerId |
The unique id represents the the customer/guest who requested for the reservation. |
integer (int64) |
customerBill |
The bill of the customer for which the reservation is created. |
< CustomerBill |
agentBill |
The bill of agent or tour operator or any third party who made the reservation on behalf of the customer. |
< CustomerBill |
reservedResources |
The list of resources which are booked as part of the reservation. |
< ReservationReservedResource |
infotexts |
Represent the any information that is related to the accommodationtype. |
< InfoText |
instalments |
As per the payment terms configuration , installments are generated for the entire bill. |
< Instalment |
status |
Possible values for reservation status DELETED(-99), DEFINITIVE_CANCELLED(-13), CANCELLED(-12), EXPIRED(-11), DECLINED(-10), QUOTATION(-5), INITIAL(0 ), REQUEST(10), OPTIONAL(11), PROVISIONAL(12), DEFINITIVE(21), CHECKED_IN(31), CHECKED_OUT(41) |
integer (int32) |
paymentTermSetId |
integer (int64) |
|
reservationInfoTexts |
Write only (field is only accessible in the request body) |
< InfoText |
6.460. ReservationSnapshot
Name | Description | Schema |
---|---|---|
businessSnapshotId |
integer (int64) |
|
businessSnapshotNumber |
string |
|
creationDate |
string (date) |
|
value |
number |
|
paid |
number |
|
open |
number |
|
validationStatus |
enum (NEVER_TO_BE_SENT,UNVALIDATED,VALID,SENT) |
|
payerType |
enum (CUSTOMER,PAYING_CUSTOMER,AGENT) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
issueDate |
string (date) |
|
dueDate |
string (date) |
6.461. ReservationSubjectCriteria
it specifies the quantity per subject ex: quantity of Adult, children identified based on the age.
Name | Description | Schema |
---|---|---|
persons |
details related to the persons for whom the accommodationtype is booked in reservation. |
< Persons |
petsQuantity |
it shows the pet’s quantity for which the accommodationtype is booked in reservation. |
integer (int32) |
6.462. ReservationSubjectRequest
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
subjectId |
integer (int64) |
|
travelParties |
< CreateReservationPersonSubject |
|
vehicles |
< CreateReservationVehicleSubject |
|
equipments |
< CreateReservationEquipment |
6.463. ReservationTermAndCondition
Name | Description | Schema |
---|---|---|
termAndConditionId |
unique id associated with each termAndCondition |
integer (int64) |
validFrom |
date from which that termAndCondition will be applicable |
string (date) |
validTo |
date to which that termAndCondition will be applicable |
string (date) |
contents |
actual term and conditions will be displayed in contents |
string |
type |
type of the termAndCondition |
string |
isDefault |
if the termAndCondition is default one then true will be displayed else false will be displayed in isDefault |
boolean |
templateId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.464. ReservationTravelPartyCriteria
The list of travel parties staying
Name | Description | Schema |
---|---|---|
firstName |
First name if the travel party. |
string |
middleName |
Middle name of the travel party. |
string |
lastName |
Last name of the travel party. |
string |
birthDate |
BirthDate of the travel party. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
sex |
Gender of the travel party. |
enum (f,m,u,F,M,U) |
identityCardNumber |
Identity card number of travel party member Maximum Length: 50 |
string |
identityType |
enum (PASSPORT,IDENTITY_CARD,DRIVERS_LICENCE) |
|
identityNumber |
string |
6.465. ReservationUpdateRequest
Request body to specify the modifications needed for a reservation.
Name | Description | Schema |
---|---|---|
statusValue |
reservation status can be change from existing status to the provided status. Possible reservation status that can be provided, are : CANCEL(-12), DECLINE(-10), CHECKED_IN(31), CONFIRM(33), CHECKED_OUT(41). |
enum (CANCEL,DECLINE,QUOTATION,INITIAL,PRE_BOOKING,REQUEST,OPTIONAL,PROVISIONAL,DEFINITIVE,CHECKED_IN,CONFIRM,CHECKED_OUT) |
expectedArrivalDateTime |
the date and time on which the customer is expected to arrive. |
string (date-time) |
expectedDepartureDateTime |
the date and time on which the customer departure is expected. |
string (date-time) |
cancellationReason |
The reason why the reservation is being cancelled or declined. This field is only used when the status is set and updated to CANCEL or DECLINE. Maximum Length: 4000 |
string |
paymentTermSetId |
integer (int64) |
6.466. ReservationUpdateResponse
Name | Description | Schema |
---|---|---|
reservationId |
unique id associated with reservation. |
integer (int64) |
statusValue |
the reservation status after update process. Possible status values can be: DELETED, CANCELLED, DECLINED, PROVISIONAL, DEFINITIVE |
enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT) |
expectedArrivalDateTime |
the date and time on which the customer is expected to arrive. |
string (date-time) |
expectedDepartureDateTime |
the date and time on which the customer departure is expected. |
string (date-time) |
paymentTermSetId |
id of the payment term set selected for the reservation. |
integer (int64) |
infotexts |
< InfoText |
|
status |
Write only (field is only accessible in the request body) |
enum (PROVISIONAL,DELETED,DEF_CANCELLED,CANCELLED,EXPIRED,DECLINED,QUOTATION,CHOICE,BASKET,INITIAL,SIGNED,PRE_BOOKING,REQUEST,OPTIONAL,DEFINITIVE,CHECKED_IN,CHECKED_OUT) |
6.467. ReservationVehicleCriteria
The list of vehicles with the booking
Name | Description | Schema |
---|---|---|
subjectId |
Subject id applicable to the vehicle. |
integer (int64) |
vehicleRegistrationMark |
Registration mark of the vehicle. Maximum Length: 15 |
string |
remark |
Remark relating to the vehicle. |
string |
6.468. ReservationVehicleSubject
Name | Description | Schema |
---|---|---|
remark |
string |
|
registrationMark |
Maximum Length: 15 |
string |
subjectId |
Write only (field is only accessible in the request body) |
integer (int64) |
reservationSubjectId |
integer (int64) |
|
reservedResourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.469. ReservedAmenityDetail
Name | Description | Schema |
---|---|---|
amenityId |
integer (int64) |
|
endDate |
string (date) |
|
type |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
|
metricDetail |
||
parentAmenityId |
integer (int64) |
|
translations |
< I18nAmenity |
|
categories |
< AmenityCategory |
6.470. ReservedI18nUnit
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
string |
|
name |
string |
|
description |
string |
|
shortDescription |
string |
6.471. ReservedRateType
Name | Description | Schema |
---|---|---|
translations |
< I18nRateType |
6.472. ReservedResource
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
reservationId |
integer (int64) |
|
resourceId |
integer (int64) |
|
unitId |
integer (int64) |
|
rateTypeId |
integer (int64) |
|
overrideEmployeeId |
integer (int64) |
|
overrideValue |
number (double) |
|
quantity |
integer (int64) |
|
type |
string |
|
offerType |
enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE) |
|
vatRate |
number (double) |
|
statusName |
string |
|
name |
string |
|
code |
string |
|
resourceCode |
string |
|
shortDescription |
string |
|
description |
string |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
cancellationPremium |
boolean |
|
reservationDate |
string (date-time) |
|
onBill |
boolean |
|
price |
number (double) |
|
hasPriceOverride |
boolean |
|
totalInternalPrice |
number (double) |
|
employeeId |
integer (int64) |
|
removable |
boolean |
|
modifiedDate |
string (date-time) |
|
implyOnce |
boolean |
|
included |
boolean |
|
turnOverValue |
number (double) |
|
representationId |
integer (int64) |
|
parentId |
integer (int64) |
|
impliesId |
integer (int64) |
|
resellerAddonCode |
string |
|
actualStartDate |
string (date) |
|
actualEndDate |
string (date) |
|
imply |
boolean |
6.473. ReservedResourceAmenity
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
amenityId |
integer (int64) |
|
type |
string |
|
extraId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.474. ReservedResourceItem
the list of resources, which are booked as part of the reservation.
Name | Description | Schema |
---|---|---|
resourceId |
unique id of the resource, which is reserved as part of the reservation proposal. |
integer (int64) |
offerType |
it is the type of offer which is applicable in the reservation proposal for e.g It can be a GENERAL_SPECIAL, STRUCTURAL_SPECIAL, FOLLOWUP_SPECIAL, CASHIN_SPECIAL, VOUCHER_SPECIAL |
enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE) |
code |
unique code associated with reserved resource. |
string |
type |
the type of the resource, which is reserved as part of the reservation proposal. |
string |
infotexts |
represent any information that is related to resources for example extra, product, special and accommodationtype etc. |
< InfoTextItem |
name |
name of the resource, booked in the reservation proposal. |
string |
shortDescription |
short description related to the reserved resource. |
string |
description |
description related to the reserved resource. |
string |
startDate |
the date from which the resource is booked as part of the reservation proposal. |
string (date) |
endDate |
the date till which the resource is booked as part of the reservation proposal. |
string (date) |
price |
the cost of the resource in reservation proposal. |
number (double) |
quantity |
represents quantity of resources, booked in the reservation proposal. |
integer (int32) |
unitId |
unique id associated with the unit booked in the reservation proposal. |
integer (int64) |
hasPriceOverride |
this field shows whether the resource price can be overridden or not. |
boolean |
removable |
this field shows whether the resource can be removed or not. |
boolean |
imply |
if any product or extra is a mandatory addition on an accommodation type then the imply field will be true for that reserved resource or else it will be false. |
boolean |
impliesId |
unique id associated with each implies. |
integer (int64) |
internetAdditionalCost |
this field is used to mark items that should be included in the total value shown to a guest or not. |
boolean |
addOnMetricDescription |
this field we use to add a textual description of the metric/unit of the addon. This means that this should contain a description that the add on price is per person, per stay or per night etc. |
string |
6.475. ReservedResourceOfReservation
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
reservationId |
integer (int64) |
|
resourceId |
integer (int64) |
|
unitId |
integer (int64) |
|
rateTypeId |
integer (int64) |
|
overrideEmployeeId |
integer (int64) |
|
overrideValue |
number (double) |
|
quantity |
integer (int64) |
|
type |
string |
|
offerType |
enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE) |
|
vatRate |
number (double) |
|
statusName |
string |
|
name |
string |
|
code |
string |
|
resourceCode |
string |
|
shortDescription |
string |
|
description |
string |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
cancellationPremium |
boolean |
|
reservationDate |
string (date-time) |
|
onBill |
boolean |
|
price |
number (double) |
|
hasPriceOverride |
boolean |
|
totalInternalPrice |
number (double) |
|
employeeId |
integer (int64) |
|
removable |
boolean |
|
modifiedDate |
string (date-time) |
|
implyOnce |
boolean |
|
included |
boolean |
|
turnOverValue |
number (double) |
|
representationId |
integer (int64) |
|
parentId |
integer (int64) |
|
impliesId |
integer (int64) |
|
resellerAddonCode |
string |
|
actualStartDate |
string (date) |
|
actualEndDate |
string (date) |
|
pointsRedeemed |
integer (int32) |
|
nightsRedeemed |
integer (int32) |
|
imply |
boolean |
6.476. ReservedResourcePerReservation
Name | Description | Schema |
---|---|---|
reservationId |
integer (int64) |
|
reservedResources |
< ReservedResourceOfReservation |
6.477. ReservedResourcePreference
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
remark |
string |
|
type |
enum (MISCELLANEOUS,OBJECT,ADJACENT) |
|
reservedResourcePreferenceId |
Write only (field is only accessible in the request body) |
integer (int64) |
reservationId |
Write only (field is only accessible in the request body) |
integer (int64) |
reservedResourceBase |
6.478. ReservedResourceResponse
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
parentId |
integer (int64) |
|
resourceId |
integer (int64) |
|
rateTypeId |
integer (int64) |
|
rateType |
||
endDate |
string (date) |
|
description |
string |
|
type |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
|
reservationDate |
string (date-time) |
|
price |
number (double) |
|
offerType |
enum (GENERAL_SPECIAL,STRUCTURAL_SPECIAL,FOLLOWUP_SPECIAL,CASHIN_SPECIAL,VOUCHER_SPECIAL,LAST_MINUTE) |
|
unitId |
Write only (field is only accessible in the request body) |
integer (int64) |
unit |
||
translations |
< ReservedResourceTranslation |
|
quantity |
integer (int32) |
|
cancellationPremium |
boolean |
|
shortDescription |
string |
|
removable |
boolean |
|
imply |
boolean |
|
name |
string |
|
modifiedDate |
string (date-time) |
|
startDate |
string (date) |
|
status |
integer (int32) |
|
code |
string |
|
included |
boolean |
|
impliesId |
integer (int64) |
|
freeFields |
< Fields |
|
infotexts |
< ReservationInfotext |
|
subjects |
< ReservedResourceSubject |
|
preferences |
< ReservationPreference |
|
amenities |
< ReservedAmenityDetail |
|
resortArticle |
boolean |
|
pointsRedeemed |
integer (int32) |
|
nightsRedeemed |
integer (int32) |
6.479. ReservedResourceSubject
Name | Description | Schema |
---|---|---|
subjectId |
integer (int64) |
|
quantity |
specify the no. of persons are for which the accommodation is booked. |
integer (int32) |
type |
specify the the type of subject like PET, PERSON, VEHICLE, OTHER. |
enum (PET,CATEGORY,PERSON,VEHICLE,OTHER,EQUIPMENT) |
maxAge |
specify the the max age of subject. |
integer (int32) |
translations |
information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nSubject |
6.480. ReservedResourceSubjectQuantity
Name | Description | Schema |
---|---|---|
reservedResourceId |
integer (int64) |
|
subjectId |
integer (int64) |
|
quantity |
integer (int32) |
|
subject |
||
travelParties |
< ReservationPersonSubject |
|
vehicles |
< ReservationVehicleSubject |
|
equipments |
< ReservationEquipment |
6.481. ReservedResourceTranslation
Name | Description | Schema |
---|---|---|
languageId |
Write only (field is only accessible in the request body) |
integer (int64) |
resourceId |
Write only (field is only accessible in the request body) |
integer (int64) |
language |
code of the language in which the given information is stored |
string |
name |
name of the addon |
string |
shortDescription |
short description related to the addon |
string |
description |
description related to the addon |
string |
6.482. ReservedResourceUnitAllotment
Name | Description | Schema |
---|---|---|
startDate |
string (date) |
|
endDate |
string (date) |
|
modifiedDate |
string (date-time) |
|
freeAllotments |
integer (int64) |
|
resourceId |
integer (int64) |
|
distributionChannelId |
integer (int64) |
|
unitId |
integer (int64) |
6.483. ReservedResourceUpdate
Request body to specify the modifications needed for a reservation.
Name | Description | Schema |
---|---|---|
startDate |
string (date) |
|
endDate |
string (date) |
|
actualStartDate |
string (date) |
|
actualEndDate |
string (date) |
|
unitId |
integer (int64) |
|
quantity |
integer (int64) |
|
price |
number (double) |
6.484. ReservedUnit
Name | Description | Schema |
---|---|---|
unitId |
integer (int64) |
|
translations |
< ReservedI18nUnit |
6.485. Resort
Name | Description | Schema |
---|---|---|
resortPriority |
priority set to the resort in which it will be visible to the user |
integer (int64) |
resortNumber |
number associated with each resort |
integer (int32) |
resArrivalDateFrom |
date on which the user can arrive |
string (date) |
internalResortNumber |
automatic generated resort number from where the reservation number will start |
string |
code |
unique code associated with each resort |
string |
resortId |
unique id associated with each resort |
integer (int64) |
parentId |
if resort is a child of another resort then the id of the parent resort is displayed |
integer (int64) |
archivedFrom |
date from which the resort was archived. The resorts will not be displayed if the resort is archived. Thus for all resorts which are being displayed the value will be null |
string (date) |
supplierId |
unique id associated with the supplier deprecated |
integer (int64) |
translations |
information of the resorts which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nResort |
visitAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
mailAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
inheritTc |
Write only (field is only accessible in the request body) |
boolean |
dynamicManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
mailAddress |
||
visitAddress |
||
amenityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
adminOrganisationId |
id of the admin organisation to which resort is linked. |
integer (int64) |
origin |
string |
|
originId |
string |
|
bookableLocation |
to show if location contains actual accommodation types and not just used for defining hierarchy |
boolean |
previousPmsId |
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 |
string |
i18n |
Write only (field is only accessible in the request body) |
< I18nResort |
6.486. ResortActivity
Name | Description | Schema |
---|---|---|
resortActivityId |
integer (int64) |
|
code |
string |
|
activityCategoryId |
integer (int64) |
|
priceAdult |
string |
|
priceChild |
string |
|
priceValuePoints |
string |
|
priceType |
enum (FREE,PAID) |
|
ticketingType |
enum (TICKETS,NO_TICKETS,TICKET_PER_GROUP,TICKET_PER_SUBJECT) |
|
translations |
< I18nResortActivity |
6.487. ResortAmenityLink
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated which tells the amenity is linked to a resource |
integer (int64) |
type |
type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
visible |
if the amenity linked should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
startDate |
date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
amenityId |
unique id associated with each amenity |
integer (int64) |
code |
unique code associated with each amenity |
string |
translations |
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. |
< I18nAmenity |
resortId |
unique id associated with each resort |
integer (int64) |
6.488. ResortDC
Name | Description | Schema |
---|---|---|
code |
unique code associated with each resort |
string |
resortId |
unique id associated with each resort |
integer (int64) |
parentId |
if resort is a child of another resort then the id of the parent resort is displayed |
integer (int64) |
archivedFrom |
date from which the resort was archived. The resorts will not be displayed if the resort is archived. Thus for all resorts which are being displayed the value will be null |
string (date) |
translations |
information of the resorts which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nResort |
i18n |
Write only (field is only accessible in the request body) |
< I18nResort |
6.489. ResortDetailWithUnitMap
Name | Description | Schema |
---|---|---|
resortPriority |
priority set to the resort in which it will be visible to the user |
integer (int64) |
resortNumber |
number associated with each resort |
integer (int32) |
resArrivalDateFrom |
date on which the user can arrive |
string (date) |
internalResortNumber |
automatic generated resort number from where the reservation number will start |
string |
code |
unique code associated with each resort |
string |
resortId |
unique id associated with each resort |
integer (int64) |
parentId |
if resort is a child of another resort then the id of the parent resort is displayed |
integer (int64) |
archivedFrom |
date from which the resort was archived. The resorts will not be displayed if the resort is archived. Thus for all resorts which are being displayed the value will be null |
string (date) |
supplierId |
unique id associated with the supplier deprecated |
integer (int64) |
translations |
information of the resorts which depends on a language and is translatable by the user. Multiple entries for different languages can exist. |
< I18nResort |
visitAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
mailAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
inheritTc |
Write only (field is only accessible in the request body) |
boolean |
dynamicManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
mailAddress |
||
visitAddress |
||
amenityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
adminOrganisationId |
id of the admin organisation to which resort is linked. |
integer (int64) |
origin |
string |
|
originId |
string |
|
bookableLocation |
to show if location contains actual accommodation types and not just used for defining hierarchy |
boolean |
previousPmsId |
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 |
string |
amenityCategorySets |
details related to the group of amenity categories |
< AmenityCategorySetDetail |
subjects |
details related to the subject(people) coming for stay |
< Subject |
dynamicFields |
user-defined and customized fields |
< DynamicField |
images |
details of the images associated to the resort |
< Image |
videos |
details associated with videos related to the accommodationtype |
< Video |
regionId |
Region of the resort. This is the id of the lowest level region where the resort is in. |
integer (int64) |
breadCrumb |
BreadCrumb of all regions the resort lies in. This is calculated based on the long and latitude set on the resort 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. |
string |
resortMap |
||
i18n |
Write only (field is only accessible in the request body) |
< I18nResort |
6.490. ResortGroup
Name | Description | Schema |
---|---|---|
resortgroupId |
integer (int64) |
|
ledgerId |
integer (int64) |
|
secondLedgerId |
integer (int64) |
|
costCenterId |
integer (int64) |
|
costCenterDependsResort |
boolean |
|
resortgroupPriority |
integer (int64) |
|
costcenterDependsonWorkorder |
boolean |
|
costUnitId |
integer (int64) |
|
costcenterDependsonResortRc |
boolean |
|
costCenter |
6.491. ResortMap
Resort map detail of the resort
Name | Description | Schema |
---|---|---|
imageId |
Image id of the resort map |
integer (int64) |
filename |
File name of the resort map |
string |
imageUrl |
Url of the image |
string |
unitCoordinates |
Coordinates of the unit |
< UnitMap |
6.492. ResortPriority
Name | Description | Schema |
---|---|---|
resortPriorityId |
unique id associated with each resort priority set Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
resortId |
Resort id associated with each resort |
integer (int64) |
distributionChannelId |
Distribution channel id associated with each resort |
integer (int64) |
startDate |
Start date of the period for which the priority has been applied. The date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
End date of the period for which the priority has been applied. The date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
priority |
Priority associated with each resort priority set |
integer (int64) |
segmentId |
Segment id associated with each resort priority set |
integer (int64) |
6.493. ResortSearchFilterOption
Name | Description | Schema |
---|---|---|
arrivals |
unique items |
< string > array |
departures |
unique items |
< string > array |
amenities |
If includeFilterOptionCounts is "true" in request body, then all the available amenities and their respective counts(No of accommodations in which that amenity is available) as per the requested search criteria are displayed in response. Else If includeFilterOptionCounts is "false", then only the amenityIds are displayed in response. unique items |
< object > array |
accommodationKinds |
accommodationkind ids on which user can filter data unique items |
< object > array |
6.494. ResortSearchList
Name | Description | Schema |
---|---|---|
resortId |
unique id associated with the resort to which the accommodationtype belong |
integer (int64) |
accommodationtypes |
< ResortSearchResult |
6.495. ResortSearchRequest
Name | Description | Schema |
---|---|---|
distributionChannelId |
if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown. |
integer (int64) |
arrivalDate |
the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
duration |
the duration for which a user will stay at the accommodationtype and the duration should be passed in days ex: 7. |
integer (int32) |
filterOptions |
filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals', 'departures', 'resorts', 'accommodationKinds' and 'amenities'.If a user is passing these filter options then all the possible amenities , departures and arrivals available for the requested criteria are displayed in response. |
< string > array |
offerCode |
unique code associated with offer on the bases of which accommodationtype is to be filtered |
string |
offerId |
integer (int64) |
|
subjects |
||
resortIds |
list of resort ids passed to fetch accommodationtypes which belong to the provided resorts unique items |
< integer > array |
petQuantity |
the number of pets accommodated in the accommodationtype |
integer (int32) |
amenityIds |
list of amenity ids which are linked to the accommodationtype unique items |
< integer > array |
accommodationKindIds |
list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched unique items |
< integer > array |
includeFilterOptionCounts |
an option to return the counts of the different filteroptions |
boolean |
regionId |
region id passed to fetch resorts which belong to the provided region |
integer (int64) |
includeAccommodationtypes |
an option to return the accommodationtypes in the response or not |
boolean |
dateMargin |
date margin to search other possible stays (arrival dates and durations) when the requested stay is not available. |
integer (int32) |
dateMarginMethod |
This parameter can be used together with the dateMargin parameter and will define how the alternatives are provided. The possible options are ARRIVAL_DATE which creates alternatives based on different arrival and departure dates but keeps the same duration. DURATION gives alternatives with a longer or shorter period. ARRIVAL_DATE_AND_DURATION which gives alternatives with different arrival and departure dates and also shorter or longer durations. In case this parameter is not used it will use the default value: ARRIVAL_DATE_AND_DURATION. DURATION_AND_ARRIVAL: |
enum (ARRIVAL_DATE,DURATION,ARRIVAL_DATE_AND_DURATION,DURATION_AND_ARRIVAL) |
minNrOfBathrooms |
integer (int32) |
|
maxNrOfBathrooms |
integer (int32) |
|
minNrOfBedrooms |
integer (int32) |
|
maxNrOfBedrooms |
integer (int32) |
|
redeemableLoyaltyPoints |
Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter. |
integer (int32) |
6.496. ResortSearchResponse
Name | Description | Schema |
---|---|---|
result |
||
filterOptionsResult |
6.497. ResortSearchResult
Name | Description | Schema |
---|---|---|
resourceId |
The unique id of the accommodationtype |
integer (int64) |
accommodationKindId |
Accommodation Kind id associated with each accommodationtype |
integer (int64) |
arrivalDate |
The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
departureDate |
The date on which customer/guest will leave. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
offerCode |
Unique searchcodes associated with the offers which are applicable to the accommodationtype |
string |
basePrice |
Basis accommodationtype rent price without any additional costs or addons included |
number (double) |
basePriceInclusive |
Basis accommodationtype rent price including mandatory additional costs configured as internet additional cost |
number (double) |
offerPrice |
The lowest offer price available for the particular stay without any additional costs or addons included |
number (double) |
offerPriceInclusive |
The lowest offer price available for the particular stay including mandatory additional costs configured as internet additional cost |
number (double) |
totalCapacity |
Total capacity accommodated in the accommodationtype |
integer (int32) |
referencePrice |
The highest accommodationtype rent price ever available for the particular stay(can be used as from price) |
number (double) |
referencePriceInclusive |
The highest accommodationtype rent price ever available for the particular stay(can be used as from price) including mandatory additional costs configured as internet additional cost |
number (double) |
duration |
The duration(number of nights) for which a user will stay at the accommodationtype |
integer (int32) |
rateTypeId |
The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type |
integer (int64) |
nrOfBathrooms |
Number of bathrooms in the accommodationtype |
number (double) |
nrOfBedrooms |
Number of bedrooms in the accommodationtype |
integer (int32) |
loyaltyPrice |
Price including offers and loyalty |
number (double) |
loyaltyPriceInclusive |
Price including offers, loyalty and additional costs |
number (double) |
requiredLoyaltyPoints |
The required number of points for this loyalty price |
integer (int32) |
freeLoyaltyDuration |
The number of free nights for this number of loyalty points |
integer (int32) |
6.498. ResourceAddition
Name | Description | Schema |
---|---|---|
additionId |
unique id associated with each addition |
integer (int64) |
additionResourceId |
integer (int64) |
|
additionFast |
if the checkbox of additionfast is selected in the system then the value for the field is true else false |
boolean |
mandatoryResource |
if the addition is mandatory for the customer then the value for the field is true else false |
boolean |
maxQuantity |
the maximum number of additions that a guest can reserve in all the reservations he makes |
integer (int64) |
maxReservable |
the maximum number of additions that a guest can reserve in a reservation |
integer (int64) |
maxTotalQuantity |
integer (int64) |
|
unitId |
unique id associated with the unit for which the additions can be reserved |
integer (int64) |
priceCompare |
if there is more than one cashflowrule is available for an addition and guest can compare the rates available then the value for the field is true else false |
boolean |
resourceId |
unique id associated with the accommodationtype for which the addition is valid |
integer (int64) |
supplierAdditionId |
if a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier’s addition id will be available in this field. |
integer (int64) |
validFrom |
date from which the addition will be applicable for reservation. The format of the date will be in ISO 8601 standard(yyyy-MM-dd) |
string (date) |
validTo |
date till which the addition is valid. The format of the date will be in ISO 8601 standard(yyyy-MM-dd) |
string (date) |
resourceMoment |
it is the show moment of the resource |
< string > array |
type |
It is the type of the resource. The possible values can be: RESOURCEACTIVITY, ACCOMMODATIONTYPE, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
resortArticle |
If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
boolean |
translations |
information of the additions which depends on a language and is translatable by the user. Multiple entries for different language can exist. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
< I18nAddition |
addonType |
It is the type of the addon. |
string |
i18n |
Write only (field is only accessible in the request body) |
< I18nAddition |
6.499. ResourceAdditionItem
addition contains all the possible product and extra that can be booked for that accommodationtype in a reservation.
Name | Description | Schema |
---|---|---|
additionResourceId |
unique id associated with the addition linked to the resource. |
integer (int64) |
resourceId |
unique id associated with the accommodationtype for which addition is applicable. |
integer (int64) |
name |
name of the addition. |
string |
price |
the cost of the addition which can be charged on reservation for corresponding addition. |
number (double) |
code |
unique code of addition linked to the resource. |
string |
type |
type of addition linked to the resource. |
string |
description |
description related to the addition linked to the resource. |
string |
shortDescription |
short description related to the addition linked to the resource. |
string |
currency |
unique code associated with each currency. |
string |
maxQuantity |
the maximum quantity which can be reserved in a single reservation. |
integer (int32) |
minQuantity |
the minimum quantity which can be reserved in a single reservation. |
integer (int32) |
maxReservable |
the Maximum number of additions that can be reserved in a reservation. |
integer (int32) |
startDate |
the date from which the addition can be booked in the reservation. |
string (date) |
endDate |
the date till which the addition can be booked in the reservation. |
string (date) |
resortArticle |
If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately. |
boolean |
addonType |
addonType of the addition linked to the resource. |
string |
stockType |
stockType of the addition linked to the resource. |
string |
perSubject |
In case the field is true, the add-on price and quantity is per person. This means for each subject this add-on is added. |
boolean |
dayProductBookableDates |
dayProductBookableDates contains all the possible book dates for a DAY product. This will be returned as null in case a product is from another type than DAY . |
< string > array |
6.500. ResourceAdditionRequest
Name | Description | Schema |
---|---|---|
additionId |
unique id associated with each addition |
integer (int64) |
additionResourceId |
Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
integer (int64) |
additionFast |
if the checkbox of additionfast is selected in the system then the value for the field is true else false |
boolean |
mandatoryResource |
if the addition is mandatory for the customer then the value for the field is true else false |
boolean |
maxQuantity |
the maximum number of additions that a guest can reserve in all the reservations he makes |
integer (int64) |
maxReservable |
the maximum number of additions that a guest can reserve in a reservation |
integer (int64) |
maxTotalQuantity |
integer (int64) |
|
unitId |
unique id associated with the unit for which the additions can be reserved |
integer (int64) |
priceCompare |
if there is more than one cashflowrule is available for an addition and guest can compare the rates available then the value for the field is true else false |
boolean |
resourceId |
unique id associated with the accommodationtype for which the addition is valid |
integer (int64) |
supplierAdditionId |
if a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier’s addition id will be available in this field. |
integer (int64) |
validFrom |
date from which the addition will be applicable for reservation. The format of the date will be in ISO 8601 standard(yyyy-MM-dd) |
string (date) |
validTo |
date till which the addition is valid. The format of the date will be in ISO 8601 standard(yyyy-MM-dd) |
string (date) |
bookDateFrom |
string (date-time) |
|
bookDateTo |
string (date-time) |
|
resourceMoment |
it is the show moment of the resource |
< string > array |
type |
It is the type of the resource. The possible values can be: RESOURCEACTIVITY, ACCOMMODATIONTYPE, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
translations |
information of the additions which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nAddition |
addonType |
It is the type of the addon. |
string |
6.501. ResourceAvailability
Name | Description | Schema |
---|---|---|
accommodationKindId |
integer (int64) |
|
arrivalDate |
string (date) |
|
departureDate |
string (date) |
|
duration |
integer (int32) |
|
prices |
< ResourceAvailablePrice |
|
resortId |
integer (int64) |
|
resortCode |
string |
|
resourceId |
integer (int64) |
|
maxCapacity |
integer (int32) |
|
petCapacity |
The pet capacity field defines how many pets are allowed in the type. In case only a selection of the units below this type have pets allowed, it will show 0 when all these units where pets are allowed are sold out. If there are units available that allow pets it will show how many pets are allowed. |
integer (int32) |
units |
< integer > array |
6.502. ResourceAvailabilityResponse
Name | Description | Schema |
---|---|---|
result |
||
filterOptionsResult |
6.503. ResourceAvailablePrice
Name | Description | Schema |
---|---|---|
basePrice |
number (double) |
|
basePriceInclusive |
number (double) |
|
referencePrice |
number (double) |
|
referencePriceInclusive |
number (double) |
|
rateTypeId |
integer (int64) |
|
offer |
||
calculationDate |
string (date-time) |
6.504. ResourceBudget
Name | Description | Schema |
---|---|---|
budgetId |
integer (int64) |
|
resourceId |
integer (int64) |
|
originalBudget |
number (double) |
|
modifiedBudget |
number (double) |
|
budgetDate |
string (date) |
6.505. ResourceBudgetRequest
Name | Description | Schema |
---|---|---|
turnoverBudget |
number (double) |
|
budgetDate |
string (date) |
6.506. ResourceCostPrice
Name | Description | Schema |
---|---|---|
quantity |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
subjectId |
integer (int64) |
|
costPrice |
||
costPriceType |
string |
6.507. ResourceGroup
Name | Description | Schema |
---|---|---|
groupId |
integer (int64) |
|
code |
string |
|
translations |
< I18nGroup |
6.508. ResourceLockReason
Name | Description | Schema |
---|---|---|
reasonId |
integer (int64) |
|
translations |
< I18nResourceLockReason |
6.509. ResourceRangeAvailabilityResponse
Name | Description | Schema |
---|---|---|
results |
||
filterOptionsResult |
6.510. ResourceReservability
Name | Description | Schema |
---|---|---|
reservabilityId |
Unique key for reservability row |
integer (int64) |
resourceId |
Resource id for which the result is valid |
integer (int64) |
resourceType |
Resource type of the resourceid |
string |
startDate |
First date these results are valid for |
string (date) |
endDate |
Last date these results are valid for (based on departure, so new results will be valid from same date) |
string (date) |
allocatable |
Number of available units (including free allotments, free sales and excluding unit level reservations) |
integer (int64) |
reservable |
Number of available units (including free allotments, free sales and excluding accommodationtype level reservations and accommodationtype level allotment bookings) |
integer (int64) |
reserved |
Number of booked units (including booked allotment, booked free sales and locks) |
integer (int64) |
modifiedDate |
Last date the reservability has been change |
string (date-time) |
6.511. ResourceReservabilityAllotment
Name | Description | Schema |
---|---|---|
startDate |
string (date) |
|
endDate |
string (date) |
|
freeAllotments |
integer (int64) |
|
totalAllotments |
integer (int64) |
|
bookedAllotments |
integer (int64) |
|
resourceId |
integer (int64) |
|
distributionChannelId |
integer (int64) |
6.512. RevenueDistribution
Name | Description | Schema |
---|---|---|
revenueDistributionId |
integer (int64) |
|
revenueDistributionNumber |
integer (int64) |
|
creationDate |
string (date-time) |
|
adminOrganisationId |
integer (int64) |
|
status |
string |
|
bookDate |
string (date-time) |
6.513. RevenueDistributionJournal
Name | Description | Schema |
---|---|---|
description |
string |
|
journalType |
string |
|
journalNumber |
string |
|
journalPeriodNumber |
integer (int64) |
|
ledgerNumber |
string |
|
costCenter |
string |
|
costUnit |
string |
|
secondLedgerNumber |
string |
|
debitVatIncludedDistributionChannelCurrency |
Write only (field is only accessible in the request body) |
number |
creditVatIncludedDistributionChannelCurrency |
Write only (field is only accessible in the request body) |
number |
debitVatExcludedDistributionChannelCurrency |
Write only (field is only accessible in the request body) |
number |
creditVatExcludedDistributionChannelCurrency |
Write only (field is only accessible in the request body) |
number |
debitVatIncluded |
Write only (field is only accessible in the request body) |
number |
creditVatIncluded |
Write only (field is only accessible in the request body) |
number |
debitVatExcluded |
Write only (field is only accessible in the request body) |
number |
creditVatExcluded |
Write only (field is only accessible in the request body) |
number |
exchangeValue |
Write only (field is only accessible in the request body) |
integer (int64) |
distributionChannelCurrencyCode |
Write only (field is only accessible in the request body) |
string |
distributionChannelCurrencyId |
Write only (field is only accessible in the request body) |
integer (int64) |
adminCurrencyCode |
Write only (field is only accessible in the request body) |
string |
adminCurrencyId |
Write only (field is only accessible in the request body) |
integer (int64) |
adminOrganistationCurrency |
||
distributionchannelCurrency |
||
adminOrganisationId |
integer (int64) |
|
revenueDistributionId |
integer (int64) |
|
revenueDistributionJournalId |
integer (int64) |
6.514. Room
Name | Description | Schema |
---|---|---|
roomId |
unique id associated with each room |
integer (int64) |
code |
unique code associated with each room |
string |
parentId |
if the room is the child of another room then the id the parent is displayed |
integer (int64) |
roomManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
roomTypeId |
Write only (field is only accessible in the request body) |
integer (int64) |
name |
Write only (field is only accessible in the request body) |
string |
lowestLevel |
if the room does not have any further child associated to it then the field is true else false |
boolean |
translations |
information of the rooms accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nRoom |
roomType |
||
amenities |
amenities associated with the room |
< RoomAmenityLinkDetail |
6.515. RoomAmenityLink
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated which tells the amenity is linked to a resource |
integer (int64) |
type |
type of the amenity linked. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
visible |
if the amenity linked should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
startDate |
date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
amenityId |
unique id associated with each amenity |
integer (int64) |
code |
unique code associated with each amenity |
string |
translations |
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. |
< I18nAmenity |
roomId |
unique id associated with each room |
integer (int64) |
6.516. RoomAmenityLinkDetail
amenities associated with the room
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique link id associated with the amenity linked to the room |
integer (int64) |
numberValue |
if the type of amenity is number then the value of the amenity is displayed in this field |
integer (int64) |
textValue |
if the type of amenity is text then the value of the amenity is displayed in this field |
string |
6.517. RoomType
details of the roomtype
Name | Description | Schema |
---|---|---|
roomTypeId |
unique id associated with each roomtype |
integer (int64) |
code |
unique id associated with each roomtype |
string |
translations |
information of the roomtype accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nRoomType |
i18n |
Write only (field is only accessible in the request body) |
< I18nRoomType |
6.518. Schedule
Name | Description | Schema |
---|---|---|
issueTaskScheduleId |
integer (int64) |
|
numberOfDaysAfterLastExecDate |
integer (int64) |
|
numberOfYearsAfterLastExecDate |
integer (int64) |
|
startSpecificDayOfMonth |
integer (int32) |
|
endSpecificDayOfMonth |
integer (int32) |
|
startMonthOfYear |
integer (int32) |
|
endMonthOfYear |
integer (int32) |
|
startExecOnFinalDayOfMonth |
boolean |
|
endExecOnFinalDayOfMonth |
boolean |
|
startDayOfWeek |
integer (int32) |
|
endDayOfWeek |
integer (int32) |
6.519. SearchInfoTextRequest
Name | Description | Schema |
---|---|---|
distributionChannelId |
integer (int64) |
|
reservationCategoryId |
integer (int64) |
|
resourceId |
integer (int64) |
|
showMomentId |
integer (int64) |
|
resortId |
integer (int64) |
|
arrivalDate |
string (date) |
|
departureDate |
string (date) |
|
infotextCategoryId |
integer (int64) |
|
unitIds |
< integer > array |
|
offerIds |
< integer > array |
|
addonIds |
< integer > array |
|
amenityIds |
< integer > array |
|
subjectIds |
< integer > array |
6.520. SearchInfoTextResponse
Name | Description | Schema |
---|---|---|
infoTextId |
integer (int64) |
|
name |
string |
|
content |
string |
6.521. SearchRequestFilter
Name | Description | Schema |
---|---|---|
distributionChannelId |
if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown. |
integer (int64) |
arrivalDate |
the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
duration |
the duration for which a user will stay at the accommodationtype and the duration should be passed in days ex: 7. |
integer (int32) |
filterOptions |
filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals', 'departures', 'resorts', 'accommodationKinds' and 'amenities'.If a user is passing these filter options then all the possible amenities , departures , resorts and arrivals available for the requested criteria are displayed in response. |
< string > array |
includeAllPrices |
If includeAllPrices field is passed as true in the request, it will provide 10 records in the response this is only possible for one specific resourceId, if it is provided as false, then only the first record is displayed in the response. |
boolean |
offerCode |
unique code associated with offer on the bases of which accommodationtype is to be filtered |
string |
offerId |
integer (int64) |
|
subjects |
||
resortIds |
list of resort ids passed to fetch accommodationtypes which belong to the provided resorts unique items |
< integer > array |
resourceIds |
list of accommodationtype ids which user wants to apply search on unique items |
< integer > array |
petQuantity |
the number of pets accommodated in the accommodationtype |
integer (int32) |
amenityIds |
list of amenity ids which are linked to the accommodationtype unique items |
< integer > array |
accommodationKindIds |
list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched unique items |
< integer > array |
includeFilterOptionCounts |
an option to return the counts of the different filteroptions |
boolean |
regionId |
region id passed to fetch accommodation types which belong to the provided region |
integer (int64) |
dateMargin |
date margin to search other possible stays (arrival dates and durations) when the requested stay is not available. |
integer (int32) |
dateMarginMethod |
This parameter can be used together with the dateMargin parameter and will define how the alternatives are provided. The possible options are ARRIVAL_DATE which creates alternatives based on different arrival and departure dates but keeps the same duration. DURATION gives alternatives with a longer or shorter period. ARRIVAL_DATE_AND_DURATION which gives alternatives with different arrival and departure dates and also shorter or longer durations. In case this parameter is not used it will use the default value: ARRIVAL_DATE_AND_DURATION |
enum (ARRIVAL_DATE,DURATION,ARRIVAL_DATE_AND_DURATION,DURATION_AND_ARRIVAL) |
voucherCode |
string |
|
minNrOfBathrooms |
integer (int32) |
|
maxNrOfBathrooms |
integer (int32) |
|
minNrOfBedrooms |
integer (int32) |
|
maxNrOfBedrooms |
integer (int32) |
|
redeemableLoyaltyPoints |
Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter. |
integer (int32) |
qualityLevelIds |
unique items |
< integer > array |
6.522. Sector
Name | Description | Schema |
---|---|---|
sectorId |
integer (int64) |
|
name |
string |
6.523. SendMethod
Name | Description | Schema |
---|---|---|
sendMethodId |
integer (int64) |
|
code |
string |
|
extraCostResourceId |
integer (int64) |
|
type |
enum (MAIL,EMAIL,FAX) |
|
isDefault |
Write only (field is only accessible in the request body) |
boolean |
translations |
< I18nSendMethod |
|
default |
boolean |
6.524. SharedOwnerShip
Name | Description | Schema |
---|---|---|
realOwnerId |
integer (int64) |
|
ownerId |
integer (int64) |
6.525. ShowMoment
Name | Description | Schema |
---|---|---|
momentId |
integer (int64) |
|
name |
enum (ON_CHECK_IN,ON_CHECK_OUT,ON_ASSIGNING_RESERVATION_NUMBER,ON_ASSIGNING_OTHER_STATUS,ON_STORING_SELECTED_RESOURCES_IN_RESERVATION,SHOW_BEFORE_OPENING_SCREEN,SHOW_AFTER_OPENING_SCREEN,ON_SEARCHING_RESOURCES,CHANGING_HOUSE_KEEPING_STATUS,GENERATING_BANK_FILE_FOR_RESERVATION,DEFINITIVE_CANCEL,GENERATING_REMINDER,CHANGING_REMINDER_STATUS,CHANGING_VALIDATION_STATUS,ON_STORING_SELECTED_RESOURCE_IN_BASKET,ON_RESERVATION_WITHOUT_DISPLAYING) |
|
description |
string |
6.526. SortObject
Name | Description | Schema |
---|---|---|
sorted |
boolean |
|
empty |
boolean |
|
unsorted |
boolean |
6.527. SortObject_Id
Name | Description | Schema |
---|---|---|
sorted |
boolean |
|
empty |
boolean |
|
unsorted |
boolean |
6.528. Source
Name | Description | Schema |
---|---|---|
sourceId |
integer (int64) |
|
startDate |
string (date-time) |
|
endDate |
string (date-time) |
|
code |
string |
|
showOnInternet |
boolean |
|
sourceCategoryId |
integer (int64) |
|
translations |
< I18nSource |
6.529. SourceCategory
Name | Description | Schema |
---|---|---|
categoryId |
integer (int64) |
|
translations |
< I18nSource |
|
parentId |
integer (int64) |
6.530. State
Name | Description | Schema |
---|---|---|
stateId |
integer (int64) |
|
code |
string |
|
countryId |
integer (int64) |
|
name |
string |
|
description |
string |
6.531. StaySummary
Name | Description | Schema |
---|---|---|
arrivalDate |
string (date) |
|
duration |
integer (int64) |
|
validFrom |
string (date-time) |
|
validTo |
string (date-time) |
|
rentabilityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
6.532. Subject
details related to the subject
Name | Description | Schema |
---|---|---|
subjectId |
unique id associated with each subject |
integer (int64) |
type |
type of the subject who will come for stay. Possible values that can be encountered are: PET, CATEGORY, PERSON, VEHICLE, OTHER |
enum (PET,CATEGORY,PERSON,VEHICLE,OTHER,EQUIPMENT) |
maxAge |
maximum age of the subject who is allowed under the given type |
integer (int32) |
controlAccess |
if the checkbox is checked in the system then the value is true else false. The default value for this is true |
boolean |
endDate |
date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
includeInTotal |
if the cost related to the subject is already included in the bill, then this value is true else false |
boolean |
subjectOrder |
order in which the subject is configured |
integer (int32) |
reportGroupSubjectId |
Write only (field is only accessible in the request body) |
integer (int32) |
subjectCategoryId |
The subject category id is the same across all resorts and will map the subjects over the resorts even though that the max Age can be different. This can be used to add an icon or styling based on the subject or equipment without making rules based on resort-specific subject data. |
integer (int64) |
translations |
information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nSubject |
i18n |
Write only (field is only accessible in the request body) |
< I18nSubject |
6.533. SubjectCategory
Name | Description | Schema |
---|---|---|
subjectId |
unique id associated with each subject |
integer (int64) |
maxAge |
maximum age of the subject who is allowed under the given type |
integer (int32) |
sort |
sort of the subject who is allowed under the given type |
integer (int32) |
endDate |
date till which the subject will be available for reservation. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
translations |
information of the subjects accommodated in the accommodationtype which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nSubject |
i18n |
Write only (field is only accessible in the request body) |
< I18nSubject |
6.534. SubjectPrice
subject based rates for groups of persons. If a subjectprices entry is available the regular price field will not be used and will return 0.
Name | Description | Schema |
---|---|---|
minQuantity |
Minimum number of subjects where the price does apply to |
integer (int32) |
price |
The price per person which applies to the minimum number of subject. The different prices need to be combined. For example if there is a price for minimum quantity 1 which is 20 and minimum quantity 2 which is 10. When there are 3 subjects the total price will be 20 + 10 + 10 = 40.If a subjectprices entry is available the regular price field is not used and will return 0. |
number (double) |
subjectIds |
The list of subject for which this subject price applies to. |
< integer > array |
6.535. Tag
Name | Description | Schema |
---|---|---|
tagId |
unique id associated with each tag |
integer (int64) |
name |
name of the tag |
string |
6.536. TargetAmount
Name | Description | Schema |
---|---|---|
resourceTargetAmountId |
integer (int64) |
|
resourceId |
integer (int64) |
|
fiscalYear |
||
fiscalyearId |
Write only (field is only accessible in the request body) |
integer (int64) |
contractTypeId |
integer (int64) |
|
targetAmount |
integer (int64) |
|
rentAssuranceBase |
integer (int64) |
|
accommodationtypePriorityId |
integer (int64) |
|
maxMaintenanceFund |
number (double) |
|
maxFundPerInvReservation |
number (double) |
|
ownerId |
integer (int64) |
|
maxFundPerInvForMaterial |
number (double) |
|
maxFundPerInvForWorktime |
number (double) |
|
maxFundPerWorkorder |
number (double) |
6.537. Task
Name | Description | Schema |
---|---|---|
planningId |
integer (int64) |
|
assignee |
string |
|
status |
enum (ASSIGNED,DONE,CANCELLED,RESCHEDULE,INPROGRESS,UNASSIGNED,DELETED) |
|
duration |
integer (int64) |
|
remark |
string |
|
taskId |
integer (int64) |
|
employeeId |
integer (int64) |
6.538. TemporaryResourceAddition
An addition(product/extra) that can be added on an offer.
Note: The translations are not allowed while adding an addtion on offer.
Name | Description | Schema |
---|---|---|
additionId |
unique id associated with each addition |
integer (int64) |
additionResourceId |
integer (int64) |
|
additionFast |
if the checkbox of additionfast is selected in the system then the value for the field is true else false |
boolean |
mandatoryResource |
if the addition is mandatory for the customer then the value for the field is true else false |
boolean |
maxQuantity |
the maximum number of additions that a guest can reserve in all the reservations he makes |
integer (int64) |
maxReservable |
the maximum number of additions that a guest can reserve in a reservation |
integer (int64) |
maxTotalQuantity |
integer (int64) |
|
unitId |
unique id associated with the unit for which the additions can be reserved |
integer (int64) |
priceCompare |
if there is more than one cashflowrule is available for an addition and guest can compare the rates available then the value for the field is true else false |
boolean |
resourceId |
unique id associated with the accommodationtype for which the addition is valid |
integer (int64) |
supplierAdditionId |
if a resort is linked to a supplier system, then creating a booking on this resort will also create a reservation in supplier system and the supplier’s addition id will be available in this field. |
integer (int64) |
validFrom |
date from which the addition will be applicable for reservation. The format of the date will be in ISO 8601 standard(yyyy-MM-dd) |
string (date) |
validTo |
date till which the addition is valid. The format of the date will be in ISO 8601 standard(yyyy-MM-dd) |
string (date) |
resourceMoment |
it is the show moment of the resource |
< string > array |
type |
It is the type of the resource. The possible values can be: RESOURCEACTIVITY, ACCOMMODATIONTYPE, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION |
enum (ACCOMMODATIONTYPE,RESOURCEACTIVITY,ACTIVITY,PRODUCTTYPE,EXTRA,SPECIAL,COMPOSITION) |
resortArticle |
If true, the add-on should be paid upon arrival at the resort. The price is not included in the total price of the bill but listed separately. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
boolean |
translations |
information of the additions which depends on a language and is translatable by the user. Multiple entries for different language can exist. Read only (field is only visible in the response body, the value cannot be updated or added using this field) |
< I18nAddition |
addonType |
It is the type of the addon. |
string |
bookDateFrom |
date from which the addition is bookable. The format of the date will be in ISO 8601 standard(yyyy-MM-ddThh:mm:sssZ) |
string (date-time) |
bookDateTo |
date till which the addition is bookable. The format of the date will be in ISO 8601 standard(yyyy-MM-ddThh:mm:sssZ) |
string (date-time) |
i18n |
Write only (field is only accessible in the request body) |
< I18nAddition |
6.539. Transaction
Name | Description | Schema |
---|---|---|
transactionId |
integer (int64) |
|
transactionType |
enum (CHECKOUT,REGISTRATION,RESERVATION,EXPIRATION,MANUAL,EXTERNAL,REGISTRATION_DUPLICATE) |
|
transactionDate |
string (date-time) |
|
activationDate |
string (date) |
|
expirationDate |
string (date) |
|
reservationId |
integer (int64) |
|
originalPoints |
integer (int32) |
|
remainingPoints |
integer (int32) |
|
remark |
string |
|
employeeId |
integer (int64) |
|
customerId |
integer (int64) |
|
reservedResourceId |
integer (int64) |
6.540. Unit
Name | Description | Schema |
---|---|---|
unitId |
integer (int64) |
|
accommodationAddressManagerId |
integer (int64) |
|
accommodationMemoManagerId |
integer (int64) |
|
archivedFrom |
string (date) |
|
resourceId |
integer (int64) |
|
brandId |
integer (int64) |
|
capacityManagerId |
integer (int64) |
|
choosableOnInternet |
boolean |
|
code |
string |
|
concernId |
integer (int64) |
|
costCenterId |
integer (int64) |
|
dynamicManagerId |
integer (int64) |
|
eventManagerId |
integer (int64) |
|
excludeQuestionnaireStats |
boolean |
|
fileManagerId |
integer (int64) |
|
genericMemoManagerId |
integer (int64) |
|
groupPriority |
integer (int32) |
|
imageManagerId |
integer (int64) |
|
implicationManagerId |
integer (int64) |
|
inventoryManagerId |
integer (int64) |
|
ledgerId |
integer (int64) |
|
nrOfBathrooms |
number (double) |
|
nrOfBedrooms |
integer (int32) |
|
originId |
string |
|
path |
string |
|
amenityManagerId |
integer (int64) |
|
questionnaireStatsManagerId |
integer (int64) |
|
rentableUnitId |
integer (int64) |
|
resourceGroupId |
integer (int64) |
|
resourceManagerId |
integer (int64) |
|
roomCode |
string |
|
secondLedgerId |
integer (int64) |
|
cleaningStatus |
enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP) |
|
supervisorId |
integer (int64) |
|
type |
string |
|
virtual |
boolean |
|
vsi |
integer (int64) |
|
roomManagerId |
integer (int64) |
|
contactManagerId |
integer (int64) |
|
setupDate |
string (date) |
|
isSeasonalRuleExcluded |
boolean |
|
cadastralId |
string |
|
showOnPlanningChart |
boolean |
|
translations |
< I18nUnit |
|
origin |
string |
|
address |
||
impliedObject |
boolean |
6.541. UnitAmenityLink
Name | Description | Schema |
---|---|---|
amenityLinkId |
unique id associated with each amenity link |
integer (int64) |
amenityId |
unique id associated with each amenity |
integer (int64) |
endDate |
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) |
string (date) |
startDate |
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) |
string (date) |
numberValue |
if the amenity is of type number then the value provided to the amenity is displayed here |
number (double) |
textValue |
if the amenity is of type text then the value provided to the amenity is displayed here |
string |
visible |
if the amenity should be visible to the user then this field is true else false |
boolean |
preferenceExtraId |
the id associated to the extra |
integer (int64) |
origin |
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 (SELF,PARENT,CHILD) |
translations |
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. |
< I18nAmenity |
type |
type of the amenity. Possible values can be : SIMPLE, NUMBER, TEXT, LIST,GROUP |
enum (SIMPLE,NUMBER,TEXT,LIST,GROUP) |
unitId |
unique id associated with each unit |
integer (int64) |
archivedFrom |
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) |
string (date) |
identifier |
value of the identifier associated with an amenity linked |
string |
metric |
||
parentAmenityId |
if the amenity has a parent then the id of the parent amenity is displayed in this field |
integer (int64) |
categories |
details related to group of amenities |
< AmenityCategory |
6.542. UnitAvailabilityResponse
Name | Description | Schema |
---|---|---|
result |
||
filterOptionsResult |
6.543. UnitAvailabilityResult
Name | Description | Schema |
---|---|---|
resourceId |
The unique id of the accommodationtype |
integer (int64) |
resortId |
The unique id associated with the resort to which the accommodationtype belong |
integer (int64) |
accommodationKindId |
The accommodation Kind id associated with each accommodationtype |
integer (int64) |
arrivalDate |
The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
departureDate |
The date on which customer/guest will leave. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
offerCode |
The unique code associated with the offer |
string |
offerName |
The name of the offer |
string |
basePrice |
Basic unit rent price without any additional costs or addons included |
number (double) |
basePriceInclusive |
Basis unit rent price including mandatory additional costs configured as internet additional cost |
number (double) |
offerPrice |
The lowest offer price available for the particular stay without any additional costs or addons included |
number (double) |
offerPriceInclusive |
The lowest offer price available for the particular stay including mandatory additional costs configured as internet additional cost |
number (double) |
unitId |
the unique identifier of the unit where the available stay and price applies to |
integer (int64) |
totalCapacity |
Total capacity accommodated in the unit |
integer (int32) |
unitRating |
Average rating guests have given for the unit through surveys |
number (double) |
duration |
The duration(number of nights) for which a guest will stay at the unit |
integer (int32) |
rateTypeId |
The id of the rate type(price group) for which the price is applicable, this can be provided in the reservation call to select the specific rate type |
integer (int64) |
priority |
Write only (field is only accessible in the request body) |
integer (int32) |
nrOfBathrooms |
Number of bathrooms in the unit |
number (double) |
nrOfBedrooms |
Number of bedrooms in the unit |
integer (int32) |
loyaltyPrice |
Price including offers and loyalty |
number (double) |
loyaltyPriceInclusive |
Price including offers, loyalty and additional costs |
number (double) |
requiredLoyaltyPoints |
The required number of points for this loyalty price |
integer (int32) |
freeLoyaltyDuration |
The number of free nights for this number of loyalty points |
integer (int32) |
6.544. UnitDetail
Name | Description | Schema |
---|---|---|
unitId |
unique id associated with each unit |
integer (int64) |
type |
Write only (field is only accessible in the request body) |
string |
resourceId |
unique id associated with the accommodationtype to which the unit belong |
integer (int64) |
code |
unique code associated with each unit |
string |
nrOfBathrooms |
total number of bathrooms that a unit possess |
number (double) |
path |
the field denotes where the unit is located |
string |
excludeQuestionnaireStats |
if the questionnaire is to be excluded then the checkbox is selected in the system and the value is true else false |
boolean |
choosableOnInternet |
if this is selected then the unit will be available in the dropdownbox on internet, then the value is true else |
boolean |
resourceGroupId |
unique id associated with the group of accommodationtype to which the unit belongs |
integer (int64) |
cleaningStatus |
status of clean is defined i.e |
enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP) |
roomCode |
unique code associated with each room which lies in the unit |
string |
nrOfBedrooms |
total number of bedrooms in the unit |
integer (int64) |
archivedFrom |
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 |
string (date) |
vsi |
vsi value of unit |
integer (int64) |
implicationManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
roomManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
capacityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
dynamicManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
brandId |
Write only (field is only accessible in the request body) |
integer (int64) |
resourceManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
accommodationAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
address |
||
translations |
information of the unit which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nUnit |
capacities |
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 |
< CapacityDetail |
capacityRequirements |
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 |
< Requirement |
rooms |
different part of units are considered as rooms ex: bedrooms, living rooms etc |
< Room |
images |
details of the images associated to the accommodationtype |
< Image |
videos |
details associated with videos related to the accommodationtype |
< Video |
dynamicFields |
user-defined and customized fields |
< DynamicField |
amenityCategorySets |
details related to group of amenity categories |
< AmenityCategorySetDetail |
origin |
string |
|
originId |
string |
|
doorLockTypes |
SAFLOKCARD (key cards) or KOOLECONTROLS (doorlock pincodes). for normal key the doorLockTypes list will be empty. |
< DoorLockType |
energyLabelRegistrationNumber |
Energy Label RegistrationNumber associated with each unit |
string |
previousPmsId |
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 |
string |
rentableUnitId |
integer (int64) |
6.545. UnitDetail_Id
Name | Description | Schema |
---|---|---|
unitId |
unique id associated with each unit |
integer (int64) |
type |
Write only (field is only accessible in the request body) |
string |
resourceId |
unique id associated with the accommodationtype to which the unit belong |
integer (int64) |
code |
unique code associated with each unit |
string |
nrOfBathrooms |
total number of bathrooms that a unit possess |
number (double) |
path |
the field denotes where the unit is located |
string |
excludeQuestionnaireStats |
if the questionnaire is to be excluded then the checkbox is selected in the system and the value is true else false |
boolean |
choosableOnInternet |
if this is selected then the unit will be available in the dropdownbox on internet, then the value is true else |
boolean |
resourceGroupId |
unique id associated with the group of accommodationtype to which the unit belongs |
integer (int64) |
cleaningStatus |
status of clean is defined i.e |
enum (CLEAN,TO_BE_CLEANED,IN_PROGRESS,CHECKED,POSTPONED,OCCUPIED_CLEAN,TOUCH_UP) |
roomCode |
unique code associated with each room which lies in the unit |
string |
nrOfBedrooms |
total number of bedrooms in the unit |
integer (int64) |
archivedFrom |
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 |
string (date) |
vsi |
vsi value of unit |
integer (int64) |
implicationManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
roomManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
imageManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
capacityManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
dynamicManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
brandId |
Write only (field is only accessible in the request body) |
integer (int64) |
resourceManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
accommodationAddressManagerId |
Write only (field is only accessible in the request body) |
integer (int64) |
address |
||
translations |
information of the unit which depends on a language and is translatable by the user. Multiple entries for different language can exist. |
< I18nUnit_Id |
origin |
string |
|
originId |
string |
|
doorLockTypes |
SAFLOKCARD (key cards) or KOOLECONTROLS (doorlock pincodes). for normal key the doorLockTypes list will be empty. |
< DoorLockType_Id |
energyLabelRegistrationNumber |
Energy Label RegistrationNumber associated with each unit |
string |
previousPmsId |
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 |
string |
rentableUnitId |
integer (int64) |
6.546. UnitMap
Coordinates of the unit
Name | Description | Schema |
---|---|---|
unitId |
integer (int64) |
|
getxValue |
integer (int32) |
|
getyValue |
integer (int32) |
6.547. UnitReservability
Name | Description | Schema |
---|---|---|
reservabilityId |
Unique key for reservability row |
integer (int64) |
resourceId |
Resource id for which the result is valid |
integer (int64) |
unitId |
Unit id for which the result is valid |
integer (int64) |
arrivalDateFrom |
First date these results are valid for |
string (date) |
arrivalDateTo |
Last date these results are valid for (based on departure, so new results will be valid from same date) |
string (date) |
allocatable |
Number of available units (including free allotments, free sales and excluding unit level reservations) |
integer (int64) |
reservable |
Number of available units (including free allotments, free sales and excluding accommodationtype level reservations and accommodationtype level allotment bookings) |
integer (int64) |
reserved |
Number of booked units ( including booked allotment, booked free sales and locks) |
integer (int64) |
modifiedDate |
Last date the reservability has been change |
string (date-time) |
6.548. UnitReservabilityPeriod
Name | Description | Schema |
---|---|---|
unitId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
reservability |
string |
6.549. UnitSearchRequestFilter
Name | Description | Schema |
---|---|---|
distributionChannelId |
if the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown. |
integer (int64) |
arrivalDate |
the date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
duration |
the duration for which a user will stay at the accommodationtype and the duration should be passed in days ex: 7. |
integer (int32) |
filterOptions |
filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals', 'departures', 'resorts', 'accommodationKinds' and 'amenities'.If a user is passing these filter options then all the possible amenities , departures , resorts and arrivals available for the requested criteria are displayed in response. |
< string > array |
includeAllPrices |
if the user passed this field as true then 10 records will be shown in response else only one element is shown in response |
boolean |
offerCode |
unique code associated with offer on the bases of which accommodationtype is to be filtered |
string |
offerId |
integer (int64) |
|
subjects |
||
resortId |
resort id passed to fetch units which belong to the provided resorts |
integer (int64) |
resourceIds |
list of accommodationtype ids which user wants to apply search on unique items |
< integer > array |
petQuantity |
the number of pets accommodated in the accommodationtype |
integer (int32) |
amenityIds |
list of amenity ids which are linked to the accommodationtype unique items |
< integer > array |
accommodationKindIds |
list of accommodation kind ids corresponding to which the accommodationtypes are to be fetched unique items |
< integer > array |
includeFilterOptionCounts |
an option to return the counts of the different filteroptions |
boolean |
regionId |
region id passed to fetch accommodation types which belong to the provided region |
integer (int64) |
dateMargin |
date margin to search other possible stays (arrival dates and durations) when the requested stay is not available. |
integer (int32) |
dateMarginMethod |
This parameter can be used together with the dateMargin parameter and will define how the alternatives are provided. The possible options are ARRIVAL_DATE which creates alternatives based on different arrival and departure dates but keeps the same duration. DURATION gives alternatives with a longer or shorter period. ARRIVAL_DATE_AND_DURATION which gives alternatives with different arrival and departure dates and also shorter or longer durations. In case this parameter is not used it will use the default value: ARRIVAL_DATE_AND_DURATION |
enum (ARRIVAL_DATE,DURATION,ARRIVAL_DATE_AND_DURATION,DURATION_AND_ARRIVAL) |
voucherCode |
string |
|
minNrOfBathrooms |
integer (int32) |
|
maxNrOfBathrooms |
integer (int32) |
|
minNrOfBedrooms |
integer (int32) |
|
maxNrOfBedrooms |
integer (int32) |
|
redeemableLoyaltyPoints |
Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter. |
integer (int32) |
6.550. UpdateAccommodationTypeRequest
Name | Description | Schema |
---|---|---|
checkinTime |
||
checkoutTime |
||
earlyCheckinTime |
||
nrOfBedrooms |
number (double) |
|
nrOfBathrooms |
number (double) |
|
translations |
< I18nAddition |
|
accotypeKindId |
integer (int64) |
|
address |
||
brandId |
integer (int64) |
|
code |
string |
|
parentId |
integer (int64) |
|
priority |
integer (int64) |
|
resortId |
integer (int64) |
|
origin |
string |
|
originId |
string |
6.551. UpdateAddressRequest
Name | Description | Schema |
---|---|---|
addressId |
integer (int64) |
|
accuracy |
Accuracy is the location-type which stores additional data about the specified location based on latitude and longitude ex: ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER, APPROXIMATE |
enum (ROOFTOP,RANGE_INTERPOLATED,GEOMETRIC_CENTER,APPROXIMATE) |
address1 |
the field is expected to have street number, name and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address2 |
the field refers to apartment, floor, etc and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
address3 |
the field expects other details related to the location and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
alternateContactPerson |
name of the person who can be contacted when the contact person can not be reached out and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
boxNumber |
number used as an address |
string |
city |
city where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
dateEnd |
date when the accommodationtype/resort/unit is archived |
string (date) |
dateBegin |
date on which the accommodationtype/resort/unit was created |
string (date) |
district |
district in which the accommodationtype/resort/unit is situated and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
email |
email of the contact person of the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
exposeLocation |
if the location of the accommodationtype/resort/unit is to be exposed to the user then this field is true else false |
boolean |
fax |
fax number which can be used to contact to the fax machine and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
houseNumber |
house number associated to the accommodationtype/resort/unit and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
houseNumberSuffix |
a letter that might come after an address number and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
latitude |
latitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
longitude |
longitude in which the accommodationtype/resort/unit lies and this is a restricted field. If you don’t have access to this field, then 0 will be returned as value. |
number (double) |
mobilePhone |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
mobilePhone2 |
mobilephone number through which the person in the accommodationtype/resort/unit can be contacted |
string |
municipality |
name of the general-purpose administrative subdivision |
string |
poBox |
numbered box in a post office where letters for an organization or person can be called for and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxZipcode |
zip code of the post office box and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
poBoxCity |
city where the post office box exist and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
privatePhone |
the private contact number of the owner and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
stateId |
unique id associated with each state |
integer (int64) |
workPhone |
the contact number which the owner uses at work and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
zipCode |
zip code of the place where the accommodationtype/resort/unit/customer is located and this is a restricted field. If you don’t have access to this field, then ** will be returned as value. |
string |
6.552. UpdateAdminOrganisationRequest
Name | Description | Schema |
---|---|---|
code |
unique code of the admin organisation Maximum Length: 50 |
string |
currencyId |
currencyId of the admin organisation |
integer (int64) |
description |
Maximum Length: 4000 |
string |
name |
Maximum Length: 50 |
string |
origin |
Origin name of the Admin Organisation |
string |
originId |
Origin Id of the Admin Organisation |
string |
6.553. UpdateAmenityLinkRequest
Request body to update or create a amenity link
Name | Description | Schema |
---|---|---|
amenityId |
unique id associated with each amenity |
integer (int64) |
endDate |
date till which the amenity is accessible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
startDate |
date from which the amenity can be accessed.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
textValue |
if the amenity is of type text then the value provided to the amenity should be passed here |
string |
numberValue |
if the amenity is of type number then the value provided to the amenity should be passed here |
number (double) |
6.554. UpdateContractRequest
Name | Description | Schema |
---|---|---|
contractId |
integer (int64) |
|
code |
string |
|
name |
string |
|
ownerId |
integer (int64) |
|
unitId |
integer (int64) |
|
startDate |
string (date) |
|
endDate |
string (date) |
|
targetAmount |
number (double) |
|
contractTypeId |
integer (int64) |
|
resourceId |
integer (int64) |
|
poolOwnerId |
integer (int64) |
|
origin |
string |
|
originId |
string |
|
rentAssurance |
number (double) |
6.555. UpdateFinancialReportRequest
Name | Description | Schema |
---|---|---|
status |
string |
6.556. UpdateImageRequest
Name | Description | Schema |
---|---|---|
startDate |
string (date) |
|
endDate |
string (date) |
|
imageOrientation |
string |
|
imageType |
enum (LOGO,FLOORPLAN,ROADMAP,INTERIOR,EXTERIOR,MUGSHOT,PICTURE,MAP,IMPRESSION,UNKNOWN,LOCATION_MAP,HEADER,VIDEO360,ICON,OPERATIONS,STATUSICON) |
|
sequenceNumber |
integer (int64) |
|
tags |
< Tag |
|
translations |
< I18nImage |
|
version |
integer (int64) |
6.557. UpdateOwnerFinancialTransactionRequest
Name | Description | Schema |
---|---|---|
status |
string |
6.558. UpdateOwnerRequest
Name | Description | Schema |
---|---|---|
accountNr |
string |
|
alternateName |
string |
|
attentionOf |
string |
|
bicSwift |
string |
|
birthDate |
string (date) |
|
company |
boolean |
|
companyName |
string |
|
emailAllowed |
boolean |
|
firstName |
string |
|
fiscalTypes |
< OwnerFiscalType |
|
ibanNumber |
string |
|
lastName |
string |
|
mailAddress |
||
mailAllowed |
boolean |
|
middle |
string |
|
sendMethodId |
integer (int64) |
|
sex |
string |
|
titleId |
integer (int64) |
|
origin |
string |
|
originId |
string |
|
ownerGroupId |
integer (int64) |
|
ownerPool |
enum (OWNER,POOL,RENT_ASSURANCE_POOL,YEAR_ROUND_GUEST,BUSINESS,LOCATION,MAINTAINANCE_FUND,VENDOR,POOL_CONSUMPTION,POOL_SHARE) |
|
questionnaireUnsubscribed |
boolean |
6.559. UpdateReservationSubjectRequest
A subject object to be added on reserved resource of a reservation
Name | Description | Schema |
---|---|---|
travelParties |
< ReservationPersonSubject |
|
vehicles |
< ReservationVehicleSubject |
|
equipments |
< ReservationEquipment |
6.560. UpdateResortRequest
Request body to update the resort.
Name | Description | Schema |
---|---|---|
adminOrganisationId |
integer (int64) |
|
code |
string |
|
internalResortNumber |
string |
|
origin |
string |
|
originId |
string |
|
parentId |
integer (int64) |
|
resortNumber |
integer (int64) |
|
resortPriority |
integer (int64) |
|
visitAddress |
||
mailAddress |
||
translations |
< CreateResortTranslation |
6.561. UpdateRevenueDistributionRequest
Name | Description | Schema |
---|---|---|
status |
string |
6.562. UpdateUnitAmenitylinkRequest
Name | Description | Schema |
---|---|---|
startDate |
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) |
string (date) |
endDate |
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) |
string (date) |
6.563. UpdateUnitRequest
Name | Description | Schema |
---|---|---|
cleaningStatus |
string |
|
translations |
< I18nUnit |
|
address |
||
code |
unique code of the unit |
string |
nrOfBathrooms |
number (double) |
|
nrOfBedrooms |
integer (int32) |
|
resourceId |
accommodationtype the unit applies to |
integer (int64) |
originId |
identifier from the origin system |
string |
origin |
system the unit is created in |
string |
rentableUnitId |
integer (int64) |
6.564. Validity
Name | Description | Schema |
---|---|---|
reservationCategoryIds |
< integer > array |
|
distributionChannelIds |
< integer > array |
|
ownerIds |
< integer > array |
|
resortIds |
< integer > array |
|
reservationDateFrom |
string (date) |
|
reservationDateTo |
string (date) |
|
arrivalDateFrom |
string (date) |
|
arrivalDateTo |
string (date) |
|
departureDateFrom |
string (date) |
|
departureDateTo |
string (date) |
|
stayDateFrom |
string (date) |
|
stayDateTo |
string (date) |
6.565. Video
details associated with videos related to the accommodationtype
Name | Description | Schema |
---|---|---|
videoId |
unique id associated with each video |
integer (int64) |
startDate |
date from which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
endDate |
date till which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd) |
string (date) |
url |
url of the video |
string |
isUploaded |
if the isActive field is enabled in the system then the value of this field is true else false |
boolean |
mediaType |
the type of the media will be displayed i.e VIDEO |
enum (IMAGE,VIDEO,VIDEO360) |
hostType |
host type of the video |
enum (YOUTUBE,VIDEO23,CLOUDINARY,EXTERNAL,MATTERPORT) |
isActive |
if the field is enabled in the system then it depicts true else false |
boolean |
isWebPresentation |
the field is true if the video uploaded is a web presentation else false |
boolean |
mediaLanguageId |
Write only (field is only accessible in the request body) |
integer (int64) |
mediaLanguageCode |
code of language in which the video is uploaded |
string |
thumbnailUrl |
url of the video thumbnail |
string |
sequenceNumber |
the sequence in which the video will be visible to the user |
integer (int32) |
6.566. Voucher
Name | Description | Schema |
---|---|---|
voucherId |
integer (int64) |
|
type |
enum (DISCOUNT,CASH,COMPENSATION) |
|
code |
string |
|
status |
enum (NOT_USED,USED,BLOCKED,PARTIALLY_USED) |
|
originalReservationId |
integer (int64) |
|
voucherOriginalValue |
number |
|
voucherValue |
number |
|
voucherSetId |
integer (int64) |
|
validFrom |
string (date) |
|
validTo |
string (date) |
|
employeeId |
integer (int64) |
|
employeeName |
string |
|
generationDate |
string (date) |
|
voucherCriteriaId |
integer (int64) |
|
voucherTypeName |
string |
|
voucherSetName |
string |
|
voucherSetResourceCode |
string |
|
voucherSetCashResourceId |
integer (int64) |
|
resourceCode |
string |
|
printCount |
integer (int32) |
|
numberOfVouchers |
integer (int32) |
|
blockReason |
string |
6.567. VoucherRedemption
List of Special Vouchers redeemed for reservation.
Name | Description | Schema |
---|---|---|
voucherRedemptionId |
integer (int64) |
|
voucherId |
integer (int64) |
|
reservationId |
integer (int64) |
|
status |
enum (NOT_USED,USED,BLOCKED,PARTIALLY_USED) |
|
amount |
number |
|
blockReason |
string |
|
voucher |
6.568. WorkOrderTaskConfigurationResort
Name | Description | Schema |
---|---|---|
resortId |
integer (int64) |
6.569. Workorder
Name | Description | Schema |
---|---|---|
unitId |
integer (int64) |
|
workOrderId |
integer (int64) |
|
status |
enum (DECLINED,ERROR_IN_INVOICE,MAY_BE_DECLINED,BLANK,NEW,ASSIGNED,ON_HOLD,CLOSED,READY_FOR_INVOICE,BILLED,NOT_TO_BE_BILLED,ADMIN_ON_HOLD,ON_HOLD_QUOTE,INTERNAL,UNDEFINED) |
|
item |
string |
|
description |
string |
|
assigneeEmployeeId |
integer (int64) |
|
reporterEmployeeId |
integer (int64) |
|
expectedStartDate |
string (date) |
|
reservationId |
integer (int64) |
|
areaName |
string |
|
totalWorkTime |
integer (int32) |
|
totalLabourPrice |
number (double) |
|
totalMaterialPrice |
number (double) |
|
materialSupplier |
string |
|
issueCategoryName |
string |