Maxxton

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 : support@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

  • Allotment : Guaranteed availability for a specific distribution channel

  • Amenity : Features or facilities available on a resort or an accommodation type

  • Authentication : Authorization Controller

  • Brands : Different labels used for marketing of an accommodation type

  • Contract Types : Type of agreement between the owner and the resort

  • 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

  • Download files : Document Controller

  • Events : Events occurred in the system due to modifications of the entities

  • Groups : Grouping different kind of entities

  • Languages : Available languages in the system

  • Memos : Informative text on different entities

  • Offer : Discounts or special offers on accommodations

  • Owners : Someone who owns an accommodation

  • Rate Types : A group of different prices of an accommodation type

  • Regions : 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

  • 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 as part of API credentials.

  • Please contact support@maxxton.com to request API credentials.

  • 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.

Requests per day Requests per month

0

Free

per
day
month * based on a 30 day month

1.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 1. Please contact Maxxton if concurrent calls are requested.

  • The number of requests is not limited and will be charged based on actual usage.

  • Costs for the API zip functionality are to agree on. Please contact Maxxton for more information and to enable this.

  • Costs for the API accommodationtype and accommodationtype arrival range search are to agree on. Please contact Maxxton for more information and to enable this.

  • Costs only apply to the new Maxxton REST API.

  • The number of requests only applies to the production API.

  • The acceptance API can be freely used

  • 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.

1.6.2. Fair Use Policy

On our API we do not have a fixed restriction. However a Fair Use Policy applies to the usage of the API.

Normal usage is permitted. Excessive usage is not permitted. Excessive usage means, usage which has 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

SELECT * FROM person WHERE name=bob or (in case of string value) WHERE name LIKE %bob%

Strict Equals

::

?filter=name::bob

SELECT * FROM person WHERE name=bob or (in case of string value) WHERE name LIKE bob

Not Equals

!:

?filter=name!:bob

SELECT * FROM person WHERE name!=bob or SELECT * FROM person WHERE name<>bob or (in case of string value) WHERE name NOT LIKE %bob%

Greater Than

>

?filter=age>30

SELECT * FROM person WHERE age>30

Greater Than Equals

>:

?filter=age>:30

SELECT * FROM person WHERE age>=30

Less Than

<

?filter=age<30

SELECT * FROM person WHERE age<30

Less Than Equals

<:

?filter=age <: 30

SELECT * FROM person WHERE age⇐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

SELECT * FROM person WHERE name=Bob OR age=30

Creating a single filter or chain multiple(AND)

&

?filter=name:Bob&filter=age:30

SELECT * FROM person WHERE name=Bob AND age=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
OR
locale=en_US

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
OR
x-show-archived=false

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

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. Resources

3.1. Accommodation Types

A group of similar units

3.1.1. 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

brand
optional

brand to filter records based on brand.

string

Query

countryCode
optional

Country code to filter accommodation types.

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
type:String,
code:String,
resortId:0,
parentId:0,
path:String,
hasObjects:true,
dependsOnLedgerGroup:true,
priority:0,
numberOfPersons:0,
nrOfBedrooms:0.0,
nrOfBathrooms:0.0,
accotypeKindId:0,
supplierOrigin:String,
archivedFrom:String(date),
brand:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching AccommodationTypes.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes
Example HTTP response
Response 200
{
  "accommodationTypeKindCode" : "string",
  "accotypeKindId" : 0,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "archivedFrom" : "string",
  "brand" : "string",
  "code" : "string",
  "dependsOnLedgerGroup" : true,
  "hasObjects" : true,
  "nrOfBathrooms" : 0.0,
  "nrOfBedrooms" : 0.0,
  "numberOfPersons" : 0,
  "parentId" : 0,
  "path" : "string",
  "priority" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "supplierOrigin" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.1.2. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionResourceId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Query

type
optional

type to filter records based on the type on the resource addition

enum (ACCOMMODATIONTYPE, RESOURCEACTIVITY, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/additions
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.1.3. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityLinkId:0,
type:String,
visible:true,
preferenceExtraId:0,
numberValue:0,
textValue:String,
startDate:String(date),
endDate:String(date),
amenityId:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Amenity links.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/amenitylinks
Example HTTP response
Response 200
{
  "amenityId" : 0,
  "amenityLinkId" : 0,
  "endDate" : "string",
  "numberValue" : 0,
  "preferenceExtraId" : 0,
  "startDate" : "string",
  "textValue" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ],
  "type" : "string",
  "visible" : true
}

3.1.4. 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.

Parameters
Type Name Description Schema

Body

filter
required

filter

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching accommodationTypes

No Content

Consumes
  • application/json

Produces
  • */*

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/arrivalrangesearch
Request body
{
  "accommodationKindIds" : [ 0 ],
  "amenityIds" : [ 0 ],
  "arrivalDateFrom" : "string",
  "distributionChannelId" : 0,
  "filterOptions" : [ "string" ],
  "numberOfDaysInResult" : 0,
  "offerCode" : "string",
  "petQuantity" : 0,
  "resortIds" : [ 0 ],
  "resourceIds" : [ 0 ],
  "subjects" : {
    "persons" : [ {
      "maxAge" : "string",
      "quantity" : 0
    } ]
  }
}
Example HTTP response
Response 200
{
  "filterOptionsResult" : {
    "arrivals" : [ null ],
    "departures" : [ null ]
  },
  "results" : {
    "content" : [ {
      "accommodationKindId" : 0,
      "amenities" : [ 0 ],
      "arrivalDate" : "string",
      "arrivalDowMask" : "string",
      "basePrice" : 0.0,
      "basePriceInclusive" : 0.0,
      "departureDate" : "string",
      "duration" : 0,
      "maxCapacity" : 0,
      "maxPetCapacity" : 0,
      "offerCode" : "string",
      "offerName" : "string",
      "offerPolicy" : "string",
      "offerPrice" : 0.0,
      "offerPriceInclusive" : 0.0,
      "rateTypeId" : 0,
      "referencePrice" : 0.0,
      "referencePriceInclusive" : 0.0,
      "resortId" : 0,
      "resourceCode" : "string",
      "resourceId" : 0,
      "unitIds" : [ 0 ],
      "unitNames" : [ "string" ]
    } ],
    "first" : true,
    "last" : true,
    "number" : 0,
    "numberOfElements" : 0,
    "size" : 0,
    "sort" : {
      "sorted" : true,
      "unsorted" : true
    },
    "totalElements" : 0,
    "totalPages" : 0
  }
}

3.1.5. Gets accommodation Type Detail

GET /maxxton/v1/accommodationtypes/details
Description

Gets a page of accommodationtype details.

Parameters
Type Name Description Schema

Query

brand
optional

brand to filter records based on brand.

string

Query

endDate
optional

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

string (date)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
code:String,
resortId:0,
priority:0,
nrOfBedrooms:0.0,
nrOfBathrooms:0.0,
hasObjects:true,
path:String)

Query

startDate
optional

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

string (date)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching AccommodationTypeUnitDetail.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/details
Example HTTP response
Response 200
{
  "accommodationTypeKindCode" : "string",
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityCategorysets" : [ {
    "categories" : [ {
      "amenities" : [ {
        "amenityId" : 0,
        "amenityLinkId" : 0,
        "archivedFrom" : "string",
        "code" : "string",
        "endDate" : "string",
        "metric" : {
          "code" : "string",
          "metricId" : 0,
          "translations" : [ {
            "language" : "string",
            "name" : "string"
          } ]
        },
        "numberValue" : 0,
        "origin" : "string",
        "parentAmenityId" : 0,
        "preferenceExtraId" : 0,
        "startDate" : "string",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "amenityGroups" : [ {
        "amenities" : [ {
          "amenityId" : 0,
          "amenityLinkId" : 0,
          "archivedFrom" : "string",
          "code" : "string",
          "endDate" : "string",
          "metric" : {
            "code" : "string",
            "metricId" : 0,
            "translations" : [ {
              "language" : "string",
              "name" : "string"
            } ]
          },
          "numberValue" : 0,
          "origin" : "string",
          "parentAmenityId" : 0,
          "preferenceExtraId" : 0,
          "startDate" : "string",
          "textValue" : "string",
          "translations" : [ {
            "description" : "string",
            "language" : "string",
            "name" : "string"
          } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityId" : 0,
        "amenityLinkId" : 0,
        "archivedFrom" : "string",
        "code" : "string",
        "endDate" : "string",
        "metric" : {
          "code" : "string",
          "metricId" : 0,
          "translations" : [ {
            "language" : "string",
            "name" : "string"
          } ]
        },
        "numberValue" : 0,
        "origin" : "string",
        "parentAmenityId" : 0,
        "preferenceExtraId" : 0,
        "startDate" : "string",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "code" : "string",
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    } ],
    "code" : "string",
    "translations" : [ {
      "language" : "string",
      "name" : "string"
    } ]
  } ],
  "brand" : "string",
  "brandId" : 0,
  "capacities" : [ {
    "capacity" : 0,
    "capacityId" : 0,
    "endDate" : "string",
    "startDate" : "string",
    "subject" : {
      "controlAccess" : true,
      "endDate" : "string",
      "includeInTotal" : true,
      "maxAge" : 0,
      "subjectId" : 0,
      "subjectOrder" : 0,
      "translations" : [ {
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "type" : "string"
    },
    "subjectId" : 0
  } ],
  "capacityRequirements" : [ {
    "required" : 0,
    "subject" : [ {
      "controlAccess" : true,
      "endDate" : "string",
      "includeInTotal" : true,
      "maxAge" : 0,
      "subjectId" : 0,
      "subjectOrder" : 0,
      "translations" : [ {
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "type" : "string"
    } ]
  } ],
  "code" : "string",
  "dynamicFields" : [ {
    "code" : "string",
    "fieldId" : 0,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "hasObjects" : true,
  "images" : [ {
    "endDate" : "string",
    "fileName" : "string",
    "imageId" : 0,
    "imageOrientation" : "string",
    "imageType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "string",
    "sequenceNumber" : 0,
    "startDate" : "string",
    "tags" : [ {
      "name" : "string",
      "tagId" : 0
    } ],
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string"
    } ],
    "uploadDate" : "string",
    "url" : "string",
    "urls" : {
      "string" : "string"
    },
    "version" : 0
  } ],
  "nrOfBathrooms" : 0.0,
  "nrOfBedrooms" : 0.0,
  "path" : "string",
  "priority" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "rooms" : [ {
    "amenities" : [ {
      "amenityLinkId" : 0,
      "numberValue" : 0,
      "roomId" : 0,
      "textValue" : "string"
    } ],
    "code" : "string",
    "lowestLevel" : true,
    "parentId" : 0,
    "roomId" : 0,
    "roomType" : {
      "code" : "string",
      "roomTypeId" : 0,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string"
      } ]
    },
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string"
    } ]
  } ],
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "videos" : [ {
    "endDate" : "string",
    "hostType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageCode" : "string",
    "mediaType" : "string",
    "sequenceNumber" : 0,
    "startDate" : "string",
    "thumbnailUrl" : "string",
    "url" : "string",
    "videoId" : 0
  } ]
}

3.1.6. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching resource implies.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/implies
Example HTTP response
Response 200
{
  "addToParent" : 0,
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "countFromMin" : true,
  "ignoreRentability" : true,
  "implicationManagerId" : 0,
  "implied" : [ {
    "objectId" : 0,
    "resourceId" : 0
  } ],
  "impliesId" : 0,
  "implyOnce" : true,
  "included" : true,
  "onBill" : true,
  "parent" : true,
  "parentId" : 0,
  "priority" : 0,
  "quantityMax" : 0,
  "quantityMin" : 0,
  "removable" : true,
  "required" : true,
  "resourceIds" : [ 0 ],
  "showOnAllInPriceBill" : true,
  "showPrice" : true,
  "stay" : true,
  "subjectsMax" : 0,
  "subjectsMin" : 0,
  "supplierImpliesId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.1.7. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
accommodationkindId:0,
code:String,
priority:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching AccommodationKind.

No Content

Produces
  • */*

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/kinds
Example HTTP response
Response 200
{
  "accommodationkindId" : 0,
  "code" : "string",
  "priority" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ]
}

3.1.8. Search accommodationtypes based on provided criteria

POST /maxxton/v1/accommodationtypes/search
Description

The above endpoint is used to search the different accommodation types which are bookable as per the requested criteria on the basis of arrival date , duration ,resort Id , accommodation type Id ,accommodation type code , amenity Id and subjects . The response can also be filtered on the basis of filter options that is displayed in response which displays all the possible arrivals , departure , resorts and amenities as per the criteria passed in the request .If Include all prices field is passed in the request as true then 10 records are displayed in response and if it is false then only first record is displayed in response.

Parameters
Type Name Description Schema

Query

sort
optional

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

Body

request
required

request

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching accommodationTypes

No Content

Consumes
  • application/json

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/search
Request body
{
  "accommodationKindIds" : [ 0 ],
  "amenityIds" : [ 0 ],
  "arrivalDate" : "string",
  "distributionChannelId" : 0,
  "duration" : 0,
  "filterOptions" : [ "string" ],
  "includeAllPrices" : true,
  "includeFilterOptionCounts" : true,
  "maxArrivalDate" : "string",
  "minArrivalDate" : "string",
  "offerCode" : "string",
  "petQuantity" : 0,
  "resortIds" : [ 0 ],
  "resourceIds" : [ 0 ],
  "subjects" : {
    "persons" : [ {
      "maxAge" : "string",
      "quantity" : 0
    } ]
  }
}
Example HTTP response
Response 200
{
  "filterOptionsResult" : {
    "accommodationKinds" : [ "object" ],
    "amenities" : [ "object" ],
    "arrivals" : [ "string" ],
    "departures" : [ "string" ],
    "resorts" : [ "object" ]
  },
  "result" : [ {
    "accommodationKindId" : 0,
    "arrivalDate" : "string",
    "basePrice" : 0.0,
    "basePriceInclusive" : 0.0,
    "departureDate" : "string",
    "duration" : 0,
    "offerCode" : "string",
    "offerName" : "string",
    "offerPrice" : 0.0,
    "offerPriceInclusive" : 0.0,
    "rateTypeId" : 0,
    "rating" : 0.0,
    "referencePrice" : 0.0,
    "referencePriceInclusive" : 0.0,
    "resortId" : 0,
    "resourceId" : 0,
    "totalCapacity" : 0,
    "units" : [ 0 ]
  } ]
}

3.1.9. 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
required

Resource id to fetch accommodationtype

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching AccommodationType.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0
Example HTTP response
Response 200
{
  "accommodationTypeKindCode" : "string",
  "accotypeKindId" : 0,
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "archivedFrom" : "string",
  "brand" : "string",
  "code" : "string",
  "dependsOnLedgerGroup" : true,
  "hasObjects" : true,
  "nrOfBathrooms" : 0.0,
  "nrOfBedrooms" : 0.0,
  "numberOfPersons" : 0,
  "parentId" : 0,
  "path" : "string",
  "priority" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "supplierOrigin" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.1.10. 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

Path

resourceId
required

resourceId of accommodation for which additions are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionResourceId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Query

type
optional

type to filter records based on the type on the resource addition

enum (ACCOMMODATIONTYPE, RESOURCEACTIVITY, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/additions
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.1.11. 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

Path

resourceId
required

Resource id for which to fetch Allotments

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentId:0,
distributionChannelId:0,
resourceId:0,
name:String,
description:String,
type:String,
exceedLimit:0,
expirePeriod:0,
amount:0,
modified:String(date),
isEnactive:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Allotments.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/allotments
Example HTTP response
Response 200
{
  "allotmentId" : 0,
  "amount" : 0,
  "description" : "string",
  "distributionChannelId" : 0,
  "exceedLimit" : 0,
  "expirePeriod" : 0,
  "hasObjects" : true,
  "isEnactive" : true,
  "modified" : "string",
  "name" : "string",
  "periods" : [ {
    "endDate" : "string",
    "quantity" : 0,
    "startDate" : "string",
    "unitIds" : [ 0 ]
  } ],
  "resourceId" : 0,
  "type" : "string"
}

3.1.12. 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

Path

resourceId
required

Resource id for which to fetch Allotment releases

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentReleaseId:0,
distributionChannelId:0,
name:String,
startDate:String(date),
endDate:String(date),
releasePeriod:0,
releaseDate:String(date),
performedDate:String(date),
resourceId:0,
resortId:0,
isEnactive:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Allotment releases.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/allotments/releases
Example HTTP response
Response 200
{
  "allotmentReleaseId" : 0,
  "distributionChannelId" : 0,
  "endDate" : "string",
  "isEnactive" : true,
  "name" : "string",
  "performedDate" : "string",
  "releaseDate" : "string",
  "releasePeriod" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "startDate" : "string"
}

3.1.13. 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

Path

resourceId
required

resourceId

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Amenity links.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/amenitylinks
Example HTTP response
Response 200
{
  "amenityId" : 0,
  "amenityLinkId" : 0,
  "endDate" : "string",
  "numberValue" : 0,
  "preferenceExtraId" : 0,
  "startDate" : "string",
  "textValue" : "string",
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ],
  "type" : "string",
  "visible" : true
}

3.1.14. 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

Path

resourceId
required

resourceId of accommodation type for which the budget needs to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
budgetId:0,
resourceId:0,
originalBudget:0.0,
modifiedBudget:0.0,
budgetDate:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/budgets
Example HTTP response
Response 200
{
  "budgetDate" : "string",
  "budgetId" : 0,
  "modifiedBudget" : 0.0,
  "originalBudget" : 0.0,
  "resourceId" : 0
}

3.1.15. 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

Path

resourceId
required

resourceId to fetch capacities

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
capacityId:0,
managerId:0,
capacity:0,
subjectId:0,
startDate:String(date),
endDate:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching capacities for AccommodationType.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/capacities
Example HTTP response
Response 200
{
  "capacity" : 0,
  "capacityId" : 0,
  "endDate" : "string",
  "name" : "string",
  "startDate" : "string",
  "subjectId" : 0
}

3.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
required

resourceId to fetch accommodationtypedetail

integer (int64)

Query

endDate
optional

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

string (date)

Query

startDate
optional

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

string (date)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching AccommodationTypeDetail.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/details
Example HTTP response
Response 200
{
  "accommodationTypeKindCode" : "string",
  "address" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "amenityCategorysets" : [ {
    "categories" : [ {
      "amenities" : [ {
        "amenityId" : 0,
        "amenityLinkId" : 0,
        "archivedFrom" : "string",
        "code" : "string",
        "endDate" : "string",
        "metric" : {
          "code" : "string",
          "metricId" : 0,
          "translations" : [ {
            "language" : "string",
            "name" : "string"
          } ]
        },
        "numberValue" : 0,
        "origin" : "string",
        "parentAmenityId" : 0,
        "preferenceExtraId" : 0,
        "startDate" : "string",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "amenityGroups" : [ {
        "amenities" : [ {
          "amenityId" : 0,
          "amenityLinkId" : 0,
          "archivedFrom" : "string",
          "code" : "string",
          "endDate" : "string",
          "metric" : {
            "code" : "string",
            "metricId" : 0,
            "translations" : [ {
              "language" : "string",
              "name" : "string"
            } ]
          },
          "numberValue" : 0,
          "origin" : "string",
          "parentAmenityId" : 0,
          "preferenceExtraId" : 0,
          "startDate" : "string",
          "textValue" : "string",
          "translations" : [ {
            "description" : "string",
            "language" : "string",
            "name" : "string"
          } ],
          "type" : "string",
          "visible" : true
        } ],
        "amenityId" : 0,
        "amenityLinkId" : 0,
        "archivedFrom" : "string",
        "code" : "string",
        "endDate" : "string",
        "metric" : {
          "code" : "string",
          "metricId" : 0,
          "translations" : [ {
            "language" : "string",
            "name" : "string"
          } ]
        },
        "numberValue" : 0,
        "origin" : "string",
        "parentAmenityId" : 0,
        "preferenceExtraId" : 0,
        "startDate" : "string",
        "textValue" : "string",
        "translations" : [ {
          "description" : "string",
          "language" : "string",
          "name" : "string"
        } ],
        "type" : "string",
        "visible" : true
      } ],
      "code" : "string",
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    } ],
    "code" : "string",
    "translations" : [ {
      "language" : "string",
      "name" : "string"
    } ]
  } ],
  "brand" : "string",
  "brandId" : 0,
  "capacities" : [ {
    "capacity" : 0,
    "capacityId" : 0,
    "endDate" : "string",
    "startDate" : "string",
    "subject" : {
      "controlAccess" : true,
      "endDate" : "string",
      "includeInTotal" : true,
      "maxAge" : 0,
      "subjectId" : 0,
      "subjectOrder" : 0,
      "translations" : [ {
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "type" : "string"
    },
    "subjectId" : 0
  } ],
  "capacityRequirements" : [ {
    "required" : 0,
    "subject" : [ {
      "controlAccess" : true,
      "endDate" : "string",
      "includeInTotal" : true,
      "maxAge" : 0,
      "subjectId" : 0,
      "subjectOrder" : 0,
      "translations" : [ {
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "type" : "string"
    } ]
  } ],
  "code" : "string",
  "dynamicFields" : [ {
    "code" : "string",
    "fieldId" : 0,
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string",
      "shortDescription" : "string",
      "text" : "string"
    } ],
    "type" : "string"
  } ],
  "hasObjects" : true,
  "images" : [ {
    "endDate" : "string",
    "fileName" : "string",
    "imageId" : 0,
    "imageOrientation" : "string",
    "imageType" : "string",
    "mimeType" : "string",
    "modifiedDate" : "string",
    "sequenceNumber" : 0,
    "startDate" : "string",
    "tags" : [ {
      "name" : "string",
      "tagId" : 0
    } ],
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string"
    } ],
    "uploadDate" : "string",
    "url" : "string",
    "urls" : {
      "string" : "string"
    },
    "version" : 0
  } ],
  "nrOfBathrooms" : 0.0,
  "nrOfBedrooms" : 0.0,
  "path" : "string",
  "priority" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "rooms" : [ {
    "amenities" : [ {
      "amenityLinkId" : 0,
      "numberValue" : 0,
      "roomId" : 0,
      "textValue" : "string"
    } ],
    "code" : "string",
    "lowestLevel" : true,
    "parentId" : 0,
    "roomId" : 0,
    "roomType" : {
      "code" : "string",
      "roomTypeId" : 0,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string"
      } ]
    },
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string"
    } ]
  } ],
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "videos" : [ {
    "endDate" : "string",
    "hostType" : "string",
    "isActive" : true,
    "isUploaded" : true,
    "isWebPresentation" : true,
    "mediaLanguageCode" : "string",
    "mediaType" : "string",
    "sequenceNumber" : 0,
    "startDate" : "string",
    "thumbnailUrl" : "string",
    "url" : "string",
    "videoId" : 0
  } ]
}

3.1.17. 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

Path

resourceId
required

Resource id for which dynamic fieilds are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fieldId:0,
code:String,
type:String)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/dynamicfields
Example HTTP response
Response 200
{
  "code" : "string",
  "fieldId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string",
    "text" : "string"
  } ],
  "type" : "string"
}

3.1.18. 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

fieldId
required

fieldId to fetch dynamic field

integer (int64)

Path

resourceId
required

resourceId to fetch accommodationtypedetail

integer (int64)

Body

dynamicFieldCriteria
required

Dynamic field which we want to insert or update for accommodationType.

Responses
HTTP Code Description Schema

200

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

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/dynamicfields/0
Request body
[ {
  "language" : "string",
  "text" : "string"
} ]

3.1.19. 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

Path

resourceId
required

Resource id for which images are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileName:String,
imageId:0,
startDate:String(date),
endDate:String(date),
mimeType:String,
version:0,
url:String,
uploadDate:String(date),
imageOrientation:String,
modifiedDate:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching resource images.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/images
Example HTTP response
Response 200
{
  "endDate" : "string",
  "fileName" : "string",
  "imageId" : 0,
  "imageOrientation" : "string",
  "imageType" : "string",
  "mimeType" : "string",
  "modifiedDate" : "string",
  "sequenceNumber" : 0,
  "startDate" : "string",
  "tags" : [ {
    "name" : "string",
    "tagId" : 0
  } ],
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ],
  "uploadDate" : "string",
  "url" : "string",
  "urls" : {
    "string" : "string"
  },
  "version" : 0
}

3.1.20. 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

Path

resourceId
required

Resource id for which implies are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Query

parentImplies
optional

Get a parent implies or resource implies

boolean

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching resource implies.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/implies
Example HTTP response
Response 200
{
  "addToParent" : 0,
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "countFromMin" : true,
  "ignoreRentability" : true,
  "implicationManagerId" : 0,
  "implied" : [ {
    "objectId" : 0,
    "resourceId" : 0
  } ],
  "impliesId" : 0,
  "implyOnce" : true,
  "included" : true,
  "onBill" : true,
  "parent" : true,
  "parentId" : 0,
  "priority" : 0,
  "quantityMax" : 0,
  "quantityMin" : 0,
  "removable" : true,
  "required" : true,
  "resourceIds" : [ 0 ],
  "showOnAllInPriceBill" : true,
  "showPrice" : true,
  "stay" : true,
  "subjectsMax" : 0,
  "subjectsMin" : 0,
  "supplierImpliesId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.1.21. 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

Path

resourceId
required

Resource id for which locks are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceLockId:0,
resourceManagerId:0,
reasonId:0,
detailDescription:String,
clientId:0,
blockDate:String(date),
startDate:String(date),
endDate:String(date),
type:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching resource locks.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/locks
Example HTTP response
Response 200
{
  "accoCreatedLock" : 0,
  "blockDate" : "string",
  "clientId" : 0,
  "created" : "string",
  "detailDescription" : "string",
  "endDate" : "string",
  "objectId" : 0,
  "reasonId" : 0,
  "resourceId" : 0,
  "resourceLockId" : 0,
  "resourceManagerId" : 0,
  "startDate" : "string",
  "type" : "string"
}

3.1.22. Insert accommodation rate

POST /maxxton/v1/accommodationtypes/{resourceId}/rates
Description

Inserts the accommodation rate type.The details are to be mentioned in the resquest 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 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 which lie in the past.

Parameters
Type Name Description Schema

Path

resourceId
required

Resource id for which resource rate will inserted

integer (int64)

Body

cashflowrule
required

rate for resource to insert

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

No Content

500

Error occurred while insert resource rate.

No Content

Consumes
  • application/json

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/rates
Request body
{
  "bookdateFrom" : "string",
  "bookdateTo" : "string",
  "cashflowmanagerId" : 0,
  "daysOfWeek" : [ "string" ],
  "duration" : 0,
  "maxDeviation" : 0,
  "maxDuration" : 0,
  "minDeviation" : 0,
  "minDuration" : 0,
  "priority" : 0,
  "quantifier" : "string",
  "rateId" : 0,
  "rateLevelId" : 0,
  "rateOptionId" : 0,
  "rateTypeId" : 0,
  "rateTypeIds" : [ 0 ],
  "remark" : "string",
  "repeatable" : 0,
  "resourceId" : 0,
  "status" : 0,
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ],
  "usageDow" : 0,
  "usageDurationFrom" : 0,
  "usageDurationTo" : 0,
  "validFrom" : "string",
  "validTo" : "string",
  "value" : 0.0,
  "valueType" : "string"
}

3.1.23. 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

Path

resourceId
required

Resource id for which Rates are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rateId:0,
value:0.0,
remark:String,
quantifier:String,
qrvType:String,
minDuration:0,
priority:0,
bookdateFrom:String(date),
bookdateTo:String(date),
usageDurationFrom:0,
usageDurationTo:0,
cashflowmanagerId:0,
validFrom:String(date),
validTo:String(date))

Query

rateTypeIds
optional

RateTypeIds to filter accommodation type Rates.

< integer (int64) > array(multi)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/rates
Example HTTP response
Response 200
{
  "bookdateFrom" : "string",
  "bookdateTo" : "string",
  "cashflowmanagerId" : 0,
  "daysOfWeek" : [ "string" ],
  "duration" : 0,
  "maxDeviation" : 0,
  "maxDuration" : 0,
  "maxDurationMinutes" : 0,
  "minDeviation" : 0,
  "minDuration" : 0,
  "minDurationMinutes" : 0,
  "priority" : 0,
  "qrvType" : "string",
  "qrvValues" : [ {
    "minQuantity" : 0,
    "value" : 0.0
  } ],
  "quantifier" : "string",
  "rateId" : 0,
  "rateTypeIds" : [ 0 ],
  "remark" : "string",
  "resourceId" : 0,
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ],
  "usageDurationFrom" : 0,
  "usageDurationTo" : 0,
  "validFrom" : "string",
  "validTo" : "string",
  "value" : 0.0,
  "valueType" : "string"
}

3.1.24. 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
required

Resource id for which rentability will be added for accommodation type

integer (int64)

Body

rentabilityDetail
required

Rentability for accommodation which contain the rentability configuration detail

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while adding rentability.

No Content

Consumes
  • application/json

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/rentability
Request body
{
  "bookdateFrom" : "string",
  "bookdateTo" : "string",
  "dateBegin" : "string",
  "dateEnd" : "string",
  "dayMax" : 0,
  "dayMin" : 0,
  "daysOfWeek" : [ "string" ],
  "isArrival" : true,
  "isDeparture" : true,
  "isTemporary" : 0,
  "managerId" : 0,
  "maxDeviationArrDepDate" : 0,
  "maxTimeAfterBookDate" : 0,
  "minDeviationArrDepDate" : 0,
  "minTimeAfterBookDate" : 0
}
Example HTTP response
Response 200
{
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "dateBegin" : "string",
  "dateEnd" : "string",
  "distributionChannelIds" : [ 0 ],
  "gap" : 0,
  "isTemporary" : 0,
  "maxDeviationArrDepDate" : 0,
  "maxTimeAfterBookDate" : 0,
  "minDeviationArrDepDate" : 0,
  "minTimeAfterBookDate" : 0,
  "rentabilityId" : 0,
  "rentabilityMarkers" : [ {
    "dowMask" : 0,
    "rentabilityMarkerId" : 0,
    "timeMax" : 0,
    "timeMin" : 0,
    "type" : "string"
  } ],
  "resourceIds" : [ 0 ]
}

3.1.25. 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
required

resourceId of accommodation for which representations are to be created

integer (int64)

Body

representation
required

representation object to create represenation for accommodation type

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/representations
Request body
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.1.26. 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

Path

resourceId
required

resourceId of accommodation for which representations are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
representationId:0,
resourceId:0,
visible:true,
bookable:true)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/representations
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.1.27. 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

Path

resourceId
required

Resource id for which videos are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
videoId:0,
startDate:String(date),
endDate:String(date),
url:String,
isUploaded:true,
mediaType:String,
hostType:String,
isActive:true,
isWebPresentation:true,
thumbnailUrl:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching resource videos.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/accommodationtypes/0/videos
Example HTTP response
Response 200
{
  "endDate" : "string",
  "hostType" : "string",
  "isActive" : true,
  "isUploaded" : true,
  "isWebPresentation" : true,
  "mediaLanguageCode" : "string",
  "mediaType" : "string",
  "sequenceNumber" : 0,
  "startDate" : "string",
  "thumbnailUrl" : "string",
  "url" : "string",
  "videoId" : 0
}

3.2. AddOn

Extras and products that can be booked with an accommodation type

3.2.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
code:String,
resortId:0,
parentId:0,
path:String,
cashflowManagerId:0,
allowPriceOverride:true,
source:String,
showNilPriceOnBill:true,
powerplaygroupId:0,
allowMovingToMainBill:true,
archivedFrom:String(date),
specialPriority:0,
autoValidateValue:0,
type:String,
resortArticle:true,
customizable:true,
showDatesOnInternet:true,
allowToAddInCiCo:true,
implicationManagerId:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching add-ons.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/add-ons
Example HTTP response
Response 200
{
  "adjustment" : true,
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToAddInCiCo" : true,
  "archivedFrom" : "string",
  "autoValidate" : true,
  "cancelCompensation" : true,
  "cancelPremium" : true,
  "cashArticle" : true,
  "cashflowManagerId" : 0,
  "code" : "string",
  "commission" : true,
  "commissionVatIncluded" : true,
  "correction" : true,
  "customizable" : true,
  "earlyCheckin" : true,
  "excludePriceCache" : true,
  "implicationManagerId" : 0,
  "invoiceArticle" : true,
  "ownerArticle" : true,
  "parentId" : 0,
  "path" : "string",
  "perDay" : true,
  "powerplaygroupId" : 0,
  "repaymentVoucher" : true,
  "reservationArticle" : true,
  "resortArticle" : true,
  "resortId" : 0,
  "resourceId" : 0,
  "searchCode" : "string",
  "showDatesOnInternet" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "specialPriority" : 0,
  "stayArticle" : true,
  "stockType" : "string",
  "tax" : true,
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "vatCommission" : true,
  "warrant" : true,
  "withholdingArticle" : true
}

3.2.2. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionResourceId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/add-ons/additions
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.2.3. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/add-ons/implies
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.2.4. 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

Path

additionResourceId
required

resourceId of add-on for which additions are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionResourceId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/add-ons/0/additions
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.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
required

resourceId

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/add-ons/0
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.2.6. 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

Path

resourceId
required

ResourceId of offer for which the implies needs to be fetched.

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/add-ons/0/implies
Example HTTP response
Response 200
{
  "addToParent" : 0,
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "countFromMin" : true,
  "ignoreRentability" : true,
  "implicationManagerId" : 0,
  "implied" : [ {
    "objectId" : 0,
    "resourceId" : 0
  } ],
  "impliesId" : 0,
  "implyOnce" : true,
  "included" : true,
  "onBill" : true,
  "parent" : true,
  "parentId" : 0,
  "priority" : 0,
  "quantityMax" : 0,
  "quantityMin" : 0,
  "removable" : true,
  "required" : true,
  "resourceIds" : [ 0 ],
  "showOnAllInPriceBill" : true,
  "showPrice" : true,
  "stay" : true,
  "subjectsMax" : 0,
  "subjectsMin" : 0,
  "supplierImpliesId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.3. Allotment

Guaranteed availability for a specific distribution channel

3.3.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentId:0,
distributionChannelId:0,
resourceId:0,
name:String,
description:String,
type:String,
exceedLimit:0,
expirePeriod:0,
amount:0,
modified:String(date),
isEnactive:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

204

No allotments found for given criteria.

500

Error occurred while fetching allotments

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/allotments
Example HTTP response
Response 200
{
  "allotmentId" : 0,
  "amount" : 0,
  "description" : "string",
  "distributionChannelId" : 0,
  "exceedLimit" : 0,
  "expirePeriod" : 0,
  "hasObjects" : true,
  "isEnactive" : true,
  "modified" : "string",
  "name" : "string",
  "periods" : [ {
    "endDate" : "string",
    "quantity" : 0,
    "startDate" : "string",
    "unitIds" : [ 0 ]
  } ],
  "resourceId" : 0,
  "type" : "string"
}
Response 204
{
  "allotmentId" : 0,
  "amount" : 0,
  "description" : "string",
  "distributionChannelId" : 0,
  "exceedLimit" : 0,
  "expirePeriod" : 0,
  "hasObjects" : true,
  "isEnactive" : true,
  "modified" : "string",
  "name" : "string",
  "periods" : [ {
    "endDate" : "string",
    "quantity" : 0,
    "startDate" : "string",
    "unitIds" : [ 0 ]
  } ],
  "resourceId" : 0,
  "type" : "string"
}

3.3.2. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
allotmentReleaseId:0,
distributionChannelId:0,
name:String,
startDate:String(date),
endDate:String(date),
releasePeriod:0,
releaseDate:String(date),
performedDate:String(date),
resourceId:0,
resortId:0,
isEnactive:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

204

No allotment releases found for given criteria.

500

Error occurred while fetching allotment releases

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/allotments/releases
Example HTTP response
Response 200
{
  "allotmentReleaseId" : 0,
  "distributionChannelId" : 0,
  "endDate" : "string",
  "isEnactive" : true,
  "name" : "string",
  "performedDate" : "string",
  "releaseDate" : "string",
  "releasePeriod" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "startDate" : "string"
}
Response 204
{
  "allotmentReleaseId" : 0,
  "distributionChannelId" : 0,
  "endDate" : "string",
  "isEnactive" : true,
  "name" : "string",
  "performedDate" : "string",
  "releaseDate" : "string",
  "releasePeriod" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "startDate" : "string"
}

3.4. Amenity

Features or facilities available on a resort or an accommodation type

3.4.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityId:0,
type:String,
identifier:String,
listMulti:true,
numberMinimum:0,
numberMaximum:0,
percentageDiscountPriority:0,
source:String,
standardCodeAmenityId:0,
linkedAmenityId:0,
parentAmenityId:0,
archivedFrom:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Amenities.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/amenities
Example HTTP response
Response 200
{
  "amenityId" : 0,
  "archivedFrom" : "string",
  "categories" : [ {
    "code" : "string",
    "translations" : [ {
      "language" : "string",
      "name" : "string"
    } ]
  } ],
  "identifier" : "string",
  "linkedAmenityId" : 0,
  "listMulti" : true,
  "metric" : {
    "code" : "string",
    "metricId" : 0,
    "translations" : [ {
      "language" : "string",
      "name" : "string"
    } ]
  },
  "numberMaximum" : 0,
  "numberMinimum" : 0,
  "parentAmenityId" : 0,
  "percentageDiscountPriority" : 0,
  "source" : "string",
  "standardCodeAmenityId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ],
  "type" : "string"
}

3.4.2. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
amenityCategorySetId:0,
code:String,
priority:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching amenity categories.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/amenities/categories
Example HTTP response
Response 200
{
  "amenityCategories" : [ {
    "amenityCategoryId" : 0,
    "code" : "string",
    "priority" : 0,
    "translations" : [ {
      "language" : "string",
      "name" : "string"
    } ]
  } ],
  "amenityCategorySetId" : 0,
  "code" : "string",
  "priority" : 0,
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ]
}

3.5. Authentication

Authorization Controller

3.5.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

client_id
required

This is the maxxton login name provided by Maxxton as part of API credentials.

string

Query

client_secret
required

This is the API key provided by Maxxton as part of API credentials.

string

Query

concern
optional

Concern code where you want to login(3 digits), alias for scope(deprecated)

string

Query

grant_type
required

GrantType which is used to authenticate (client_credentials etc)

string

Query

scope
required

scope of authorization.Contains a concern parameter to make it compatible with oauth2 standard.

string

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while processing.

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

Example HTTP request
Request path
/maxxton/v1/authenticate?client_id=string&client_secret=string&grant_type=string&scope=string
Example HTTP response
Response 200
{
  "access_token" : "string",
  "details" : {
    "apiKeyDistributionchannelId" : 0,
    "api_key_id" : 0,
    "client_id" : "string",
    "client_type" : 0,
    "concern_id" : 0,
    "environment" : [ "string" ]
  },
  "expires_in" : 0,
  "jti" : "string",
  "scope" : "string",
  "token_type" : "string"
}

3.6. Brands

Different labels used for marketing of an accommodation type

3.6.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
brandId:0,
defaultBrand:true,
name:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching brands.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/brands
Example HTTP response
Response 200
{
  "brandId" : 0,
  "defaultBrand" : true,
  "name" : "string"
}

3.6.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
required

Brand id to fetch brand

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Brand.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/brands/0
Example HTTP response
Response 200
{
  "brandId" : 0,
  "defaultBrand" : true,
  "name" : "string"
}

3.7. Contract Types

Type of agreement between the owner and the resort

3.7.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contractTypeId:0,
code:String,
remark:String,
settlementMethod:String,
settlementPct:0,
redirectionMinAmount:0,
contractKind:String,
priority:0,
round:true,
ownUsageAllowed:true,
archivedFrom:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching contract Types.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/contracts/types
Example HTTP response
Response 200
{
  "archivedFrom" : "string",
  "code" : "string",
  "contractKind" : "string",
  "contractTypeId" : 0,
  "nonRentable" : true,
  "ownUsageAllowed" : true,
  "priority" : 0,
  "redirectionMinAmount" : 0,
  "remark" : "string",
  "round" : true,
  "settlementMethod" : "string",
  "settlementPct" : 0,
  "translations" : [ {
    "contractTypeId" : 0,
    "language" : "string",
    "name" : "string"
  } ]
}

3.8. Contracts

Formal legal agreement between the owner and the resort

3.8.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contractId:0,
code:String,
name:String,
ownerId:0,
unitId:0,
startDate:String(date),
endDate:String(date),
contractTypeId:0,
resourceId:0,
poolOwnerId:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching contracts.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/contracts
Example HTTP response
Response 200
{
  "code" : "string",
  "contractId" : 0,
  "contractTypeId" : 0,
  "endDate" : "string",
  "name" : "string",
  "ownerId" : 0,
  "poolOwnerId" : 0,
  "resourceId" : 0,
  "startDate" : "string",
  "targetAmount" : 0.0,
  "unitId" : 0
}

3.8.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
required

Contract Id to fetch contract.

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching contract.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/contracts/0
Example HTTP response
Response 200
{
  "code" : "string",
  "contractId" : 0,
  "contractTypeId" : 0,
  "endDate" : "string",
  "name" : "string",
  "ownerId" : 0,
  "poolOwnerId" : 0,
  "resourceId" : 0,
  "startDate" : "string",
  "targetAmount" : 0.0,
  "unitId" : 0
}

3.9. Countries

List of countries.

3.9.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
countryId:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

< Country > array

500

Error occurred while fetching countries

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/countries
Example HTTP response
Response 200
[ {
  "code" : "string",
  "countryId" : 0,
  "default" : true,
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ]
} ]

3.10. Currency

List of currencies

3.10.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
currencyId:0,
code:String,
name:String,
symbol:String,
currencyLanguage:String,
currencyCountry:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching currencies.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/currencies
Example HTTP response
Response 200
{
  "code" : "string",
  "currencyCountry" : "string",
  "currencyId" : 0,
  "currencyLanguage" : "string",
  "name" : "string",
  "symbol" : "string"
}

3.10.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
required

currencyId

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/currencies/0
Example HTTP response
Response 200
{
  "code" : "string",
  "currencyCountry" : "string",
  "currencyId" : 0,
  "currencyLanguage" : "string",
  "name" : "string",
  "symbol" : "string"
}

3.11. Customer Status

Statuses given to customers as per customer’s reservation history

3.11.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerId:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching customers' status

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customerstatus
Example HTTP response
Response 200
{
  "customerClusters" : [ {
    "clusterId" : 0,
    "description" : "string",
    "name" : "string"
  } ]
}

3.12. Customers

Guest who can book reservations

3.12.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.

Parameters
Type Name Description Schema

Body

customer
required

A customer object to be added

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers
Request body
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "string",
  "clusterManagerId" : 0,
  "customerGroupId" : 0,
  "customerId" : 0,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "languageId" : 0,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 0,
  "mailAllowed" : true,
  "memoManagerId" : 0,
  "middle" : "string",
  "owner" : true,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "string",
  "socialSecurityNumber" : "string",
  "titleId" : 0
}
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "string",
  "clusterManagerId" : 0,
  "customerGroupId" : 0,
  "customerId" : 0,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "languageId" : 0,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 0,
  "mailAllowed" : true,
  "memoManagerId" : 0,
  "middle" : "string",
  "owner" : true,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "string",
  "socialSecurityNumber" : "string",
  "titleId" : 0
}

3.12.2. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerId:0,
customerGroupId:0,
titleId:0,
firstName:String,
middle:String,
lastName:String,
alternateName:String,
emailAllowed:true,
mailAllowed:true,
signatureDate:String(date),
socialSecurityNumber:String,
sex:String,
languageId:0,
ibanNumber:String,
bicSwift:String,
birthDate:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching customers

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "string",
  "clusterManagerId" : 0,
  "customerGroupId" : 0,
  "customerId" : 0,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "languageId" : 0,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 0,
  "mailAllowed" : true,
  "memoManagerId" : 0,
  "middle" : "string",
  "owner" : true,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "string",
  "socialSecurityNumber" : "string",
  "titleId" : 0
}

3.12.3. 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
required

An Id of customer to be fetched

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers/0
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "string",
  "clusterManagerId" : 0,
  "customerGroupId" : 0,
  "customerId" : 0,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "languageId" : 0,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 0,
  "mailAllowed" : true,
  "memoManagerId" : 0,
  "middle" : "string",
  "owner" : true,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "string",
  "socialSecurityNumber" : "string",
  "titleId" : 0
}

3.12.4. 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

Path

customerId
required

Customer id to fetch files associated with the customer

integer (int64)

Body

customerUpdate
optional

Request body to specify the modifications needed for a customer.

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers/0
Request body
{
  "bicSwift" : "string",
  "ibanNumber" : "string",
  "mailAddress" : {
    "email" : "string"
  }
}
Example HTTP response
Response 200
{
  "alternateName" : "string",
  "bicSwift" : "string",
  "birthDate" : "string",
  "clusterManagerId" : 0,
  "customerGroupId" : 0,
  "customerId" : 0,
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "languageId" : 0,
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddressManagerId" : 0,
  "mailAllowed" : true,
  "memoManagerId" : 0,
  "middle" : "string",
  "owner" : true,
  "questionnaireUnsubscribed" : true,
  "sex" : "string",
  "signatureDate" : "string",
  "socialSecurityNumber" : "string",
  "titleId" : 0
}

3.12.5. 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

Path

customerId
required

Customer id for which the communication calls are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerCommunicationId:0,
sendDate:String(date),
sendingType:String,
reservationId:0,
message:String,
senderEmail:String,
subject:String)

Responses
HTTP 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

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers/0/communications
Example HTTP response
Response 200
{
  "attachments" : [ {
    "endDate" : "string",
    "fileId" : 0,
    "fileName" : "string",
    "fileSize" : 0,
    "fileType" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string",
    "uploadDate" : "string",
    "validFrom" : "string",
    "validTo" : "string"
  } ],
  "customerCommunicationId" : 0,
  "message" : "string",
  "reportCode" : "string",
  "reportType" : "string",
  "reservationId" : 0,
  "sendDate" : "string",
  "senderEmail" : "string",
  "sendingType" : "string",
  "subject" : "string"
}

3.12.6. 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
required

customerId

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers/0/customerstatus
Example HTTP response
Response 200
{
  "customerClusters" : [ {
    "clusterId" : 0,
    "description" : "string",
    "name" : "string"
  } ]
}

3.12.7. 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

Path

customerId
required

Customer id for which the files are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileId:0,
name:String,
fileName:String,
fileSize:0,
fileType:String,
uploadDate:String(date),
endDate:String(date),
shortDescription:String,
validFrom:String(date),
validTo:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers/0/files
Example HTTP response
Response 200
{
  "endDate" : "string",
  "fileId" : 0,
  "fileName" : "string",
  "fileSize" : 0,
  "fileType" : "string",
  "language" : "string",
  "name" : "string",
  "shortDescription" : "string",
  "uploadDate" : "string",
  "validFrom" : "string",
  "validTo" : "string"
}

3.12.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
required

Customer id to fetch files associated with the customer

integer (int64)

Path

fileId
required

file id to fetch a specific file

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers/0/files/0
Example HTTP response
Response 200
{
  "downloadLink" : "string"
}

3.12.9. 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

Path

customerId
required

customerId

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
memoId:0,
employeeId:0,
content:String,
creationDate:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/customers/0/memos
Example HTTP response
Response 200
{
  "content" : "string",
  "creationDate" : "string",
  "employeeId" : 0,
  "memoCategoryId" : 0,
  "memoId" : 0
}

3.12.10. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
titleId:0,
code:String,
priority:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

< CustomerTitle > array

500

Error occurred while fetching customer titles

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/titles
Example HTTP response
Response 200
[ {
  "code" : "string",
  "priority" : 0,
  "titleId" : 0,
  "translations" : [ {
    "language" : "string",
    "title" : "string"
  } ]
} ]

3.13. DistributionChannels

Channel through which reservations can be booked

3.13.1. Gets a page with DistributionChannels

GET /maxxton/v1/distributionchannels
Description

Get a page with DistributionChannels. The records can be filtered based on distribution channel object.It also supports pageable.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
distributionChannelId:0,
code:String,
name:String,
representationSetParentId:0,
allotmentOnly:true,
activeStartDate:String(date),
activeEndDate:String(date),
type:String,
inheritedType:String,
parentId:0,
resellerId:0,
showAgentBill:0,
brandId:0,
currencyId:0,
currency:String,
archivedFrom:String(date),
availableOnInternet:true,
allotmentSetting:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

204

No distributionChannels found for given criteria.

500

Error occurred while fetching these distributionChannels

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/distributionchannels
Example HTTP response
Response 200
{
  "activeEndDate" : "string",
  "activeStartDate" : "string",
  "allotmentOnly" : true,
  "allotmentSetting" : "string",
  "archivedFrom" : "string",
  "availableOnInternet" : true,
  "brand" : "string",
  "brandId" : 0,
  "code" : "string",
  "communicationPermission" : "string",
  "currencyCode" : "string",
  "currencyId" : 0,
  "distributionChannelId" : 0,
  "invoiceAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "name" : "string",
  "parentId" : 0,
  "priceCacheDistributionChannelId" : 0,
  "representationSetParentId" : 0,
  "resellerId" : 0,
  "showAgentBill" : 0,
  "type" : "string"
}
Response 204
{
  "activeEndDate" : "string",
  "activeStartDate" : "string",
  "allotmentOnly" : true,
  "allotmentSetting" : "string",
  "archivedFrom" : "string",
  "availableOnInternet" : true,
  "brand" : "string",
  "brandId" : 0,
  "code" : "string",
  "communicationPermission" : "string",
  "currencyCode" : "string",
  "currencyId" : 0,
  "distributionChannelId" : 0,
  "invoiceAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "name" : "string",
  "parentId" : 0,
  "priceCacheDistributionChannelId" : 0,
  "representationSetParentId" : 0,
  "resellerId" : 0,
  "showAgentBill" : 0,
  "type" : "string"
}

3.13.2. 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
optional

distributionChannelCode to filter records.

string

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching payment methods

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/distributionchannels/paymentmethods
Example HTTP response
Response 200
{
  "distributionChannelCode" : "string",
  "paymentMethods" : [ {
    "code" : "string",
    "minDaysBeforeArrival" : 0,
    "paymentMethod" : "string",
    "paymentProvider" : "string",
    "paymentType" : "string",
    "translations" : [ {
      "language" : "string",
      "name" : "string"
    } ]
  } ]
}

3.13.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
required

distributionChannelId

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/distributionchannels/0
Example HTTP response
Response 200
{
  "activeEndDate" : "string",
  "activeStartDate" : "string",
  "allotmentOnly" : true,
  "allotmentSetting" : "string",
  "archivedFrom" : "string",
  "availableOnInternet" : true,
  "brand" : "string",
  "brandId" : 0,
  "code" : "string",
  "communicationPermission" : "string",
  "currencyCode" : "string",
  "currencyId" : 0,
  "distributionChannelId" : 0,
  "invoiceAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAddress" : {
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "name" : "string",
  "parentId" : 0,
  "priceCacheDistributionChannelId" : 0,
  "representationSetParentId" : 0,
  "resellerId" : 0,
  "showAgentBill" : 0,
  "type" : "string"
}

3.13.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
required

distributionchannelId

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/distributionchannels/0/paymentmethods
Example HTTP response
Response 200
{
  "code" : "string",
  "minDaysBeforeArrival" : 0,
  "paymentMethod" : "string",
  "paymentProvider" : "string",
  "paymentType" : "string",
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ]
}

3.14. Download Files

Document Controller

3.14.1. Get the downloaded file

GET /maxxton/v1/files/downloads/{hash}
Description

The file associated with the hash can be downloaded

Parameters
Type Name Description Schema

Path

hash
required

hash

string

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while downloading file.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/files/downloads/string

3.15. Events

Events occurred in the system due to modifications of the entities

3.15.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

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
eventId:0,
entityId:0,
entityType:String,
entityAction:String,
eventTimestamp:String(date),
type:String,
oldEntityId:0)

Query

modifiedAfter
optional

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

modifiedBefore
optional

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
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching events.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/events
Example HTTP response
Response 200
{
  "entityAction" : "string",
  "entityId" : 0,
  "entityType" : "string",
  "eventId" : 0,
  "eventTimestamp" : "2018-10-18T10:00:00.000",
  "oldEntityId" : 0,
  "type" : "string"
}

3.16. Groups

Grouping different kind of entities

3.16.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
groupId:0,
code:String,
type:String,
parentId:0,
priority:0,
resortId:0)

Query

type
optional

Specify the Group type criteria

string

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

204

No Groups found for given criteria.

500

Error occurred while fetching these Groups

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/groups
Example HTTP response
Response 200
{
  "code" : "string",
  "groupId" : 0,
  "linkedIds" : [ 0 ],
  "parentId" : 0,
  "priority" : 0,
  "resortId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}
Response 204
{
  "code" : "string",
  "groupId" : 0,
  "linkedIds" : [ 0 ],
  "parentId" : 0,
  "priority" : 0,
  "resortId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.17. Languages

Available languages in the system

3.17.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
languageId:String,
shortName:String,
defaultLanguage:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

< Language > array

500

Error occurred while fetching languages.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/languages
Example HTTP response
Response 200
[ {
  "defaultLanguage" : true,
  "languageId" : "string",
  "shortName" : "string"
} ]

3.18. Memos

Informative text on different entities

3.18.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
memoCategoryId:0,
code:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching memo categories

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/memos/categories
Example HTTP response
Response 200
{
  "code" : "string",
  "memoCategoryId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ]
}

3.19. Offer

Discounts or special offers on accommodations

3.19.1. 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

offer
required

A offer to be added

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers
Request body
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "string",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 0,
  "offerType" : "string",
  "parentId" : 0,
  "path" : "string",
  "poolWeightage" : 0,
  "powerplaygroupId" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}
Example HTTP response
Response 200
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "string",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 0,
  "offerType" : "string",
  "parentId" : 0,
  "path" : "string",
  "poolWeightage" : 0,
  "powerplaygroupId" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.19.2. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resourceId:0,
code:String,
resortId:0,
parentId:0,
path:String,
lowestLevel:true,
allowPriceOverride:true,
source:String,
showNilPriceOnBill:true,
powerplaygroupId:0,
allowMovingToMainBill:true,
archivedFrom:String(date),
offerType:String,
offerPolicy:String,
offerPriority:0,
autovalidateValue:0,
type:String,
poolWeightage:0,
customizableResource:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Specials

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers
Example HTTP response
Response 200
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "string",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 0,
  "offerType" : "string",
  "parentId" : 0,
  "path" : "string",
  "poolWeightage" : 0,
  "powerplaygroupId" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.19.3. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionResourceId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching offers additions.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/additions
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.19.4. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching implies.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/implies
Example HTTP response
Response 200
{
  "addToParent" : 0,
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "countFromMin" : true,
  "ignoreRentability" : true,
  "implicationManagerId" : 0,
  "implied" : [ {
    "objectId" : 0,
    "resourceId" : 0
  } ],
  "impliesId" : 0,
  "implyOnce" : true,
  "included" : true,
  "onBill" : true,
  "parent" : true,
  "parentId" : 0,
  "priority" : 0,
  "quantityMax" : 0,
  "quantityMin" : 0,
  "removable" : true,
  "required" : true,
  "resourceIds" : [ 0 ],
  "showOnAllInPriceBill" : true,
  "showPrice" : true,
  "stay" : true,
  "subjectsMax" : 0,
  "subjectsMin" : 0,
  "supplierImpliesId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.19.5. 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

additionId
required

Addition id which is going to be updated

integer (int64)

Path

additionResourceId
required

The resource on which the offer is applicable as an addition and needs to be modified.

integer (int64)

Body

resourceAddition
required

The resource on which the offer is applicable as an addition.

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/additions/0
Request body
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.19.6. 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
required

Resource id to fetched offer

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching Offer

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0
Example HTTP response
Response 200
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "string",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 0,
  "offerType" : "string",
  "parentId" : 0,
  "path" : "string",
  "poolWeightage" : 0,
  "powerplaygroupId" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.19.7. 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
required

Resource id of offer which want to update

integer (int64)

Body

offer
required

A offer to be update

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0
Request body
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "string",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 0,
  "offerType" : "string",
  "parentId" : 0,
  "path" : "string",
  "poolWeightage" : 0,
  "powerplaygroupId" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}
Example HTTP response
Response 200
{
  "allowMovingToMainBill" : true,
  "allowPriceOverride" : true,
  "allowToPublish" : true,
  "archivedFrom" : "string",
  "autovalidate" : true,
  "code" : "string",
  "customizableResource" : true,
  "excludePriceCache" : true,
  "lowestLevel" : true,
  "offerExactPeriodOnly" : true,
  "offerPolicy" : "string",
  "offerPriority" : 0,
  "offerType" : "string",
  "parentId" : 0,
  "path" : "string",
  "poolWeightage" : 0,
  "powerplaygroupId" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "searchCode" : "string",
  "secretOffer" : true,
  "showNilPriceOnBill" : true,
  "source" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.19.8. 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
required

Addition resource id of offer, which is an addition on a resource specified by resourceId in the request body.

integer (int64)

Body

resourceAddition
required

An addition(product/extra) that can be added on an offer.
Note: The translations are not allowed while adding an addtion on offer.

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/additions
Request body
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.19.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

Path

resourceId
required

ResourceId for which offer want to get additions

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
additionId:0,
additionResourceId:0,
additionFast:true,
mandatoryResource:true,
maxQuantity:0,
maxReservable:0,
maxTotalQuantity:0,
unitId:0,
priceCompare:true,
resourceId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching addtion.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/additions
Example HTTP response
Response 200
{
  "additionCode" : "string",
  "additionFast" : true,
  "additionI18n" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "additionId" : 0,
  "additionResourceId" : 0,
  "additionType" : "string",
  "code" : "string",
  "mandatoryResource" : true,
  "maxQuantity" : 0,
  "maxReservable" : 0,
  "maxTotalQuantity" : 0,
  "priceCompare" : true,
  "resortArticle" : true,
  "resourceId" : 0,
  "resourceMoment" : [ "string" ],
  "supplierAdditionId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string",
  "unitId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.19.10. 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
required

Resource id for which contract type will add for offers

integer (int64)

Body

offerContractType
required

Contract type of Offers

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/contracttypes
Request body
{
  "contracttypeId" : 0,
  "resourceId" : 0
}
Example HTTP response
Response 200
{
  "contracttypeId" : 0,
  "resourceId" : 0
}

3.19.11. 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

Path

resourceId
required

Resource id of offer which want to fetch contract types

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
contracttypeId:0,
resourceId:0)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/contracttypes
Example HTTP response
Response 200
{
  "contracttypeId" : 0,
  "resourceId" : 0
}

3.19.12. 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

contracttypeId
required

contracttype id which want to delete

integer (int64)

Path

resourceId
required

Resource id of offer

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

No Content

500

Error occurred while deleting contract type on offer

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/contracttypes/0

3.19.13. 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

Path

resourceId
required

ResourceId of offer for which the implies needs to be fetched.

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
impliesId:0,
addToParent:0,
bookDateFrom:String(date),
bookDateTo:String(date),
countFromMin:true,
ignoreRentability:true,
implicationManagerId:0,
implyOnce:true,
included:true,
onBill:true,
parentId:0,
priority:0,
quantityMax:0,
quantityMin:0,
removable:true,
required:true,
showOnAllInPriceBill:true,
showPrice:true,
subjectsMax:0,
subjectsMin:0,
supplierImpliesId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching implies.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/implies
Example HTTP response
Response 200
{
  "addToParent" : 0,
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "countFromMin" : true,
  "ignoreRentability" : true,
  "implicationManagerId" : 0,
  "implied" : [ {
    "objectId" : 0,
    "resourceId" : 0
  } ],
  "impliesId" : 0,
  "implyOnce" : true,
  "included" : true,
  "onBill" : true,
  "parent" : true,
  "parentId" : 0,
  "priority" : 0,
  "quantityMax" : 0,
  "quantityMin" : 0,
  "removable" : true,
  "required" : true,
  "resourceIds" : [ 0 ],
  "showOnAllInPriceBill" : true,
  "showPrice" : true,
  "stay" : true,
  "subjectsMax" : 0,
  "subjectsMin" : 0,
  "supplierImpliesId" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.19.14. 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
required

Resource id for which Offer rates will insert

integer (int64)

Body

cashflowrule
required

Rates for the Offer

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

No Content

500

Error occurred while fetching Offer rates.

No Content

Consumes
  • application/json

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/rates
Request body
{
  "bookdateFrom" : "string",
  "bookdateTo" : "string",
  "cashflowmanagerId" : 0,
  "daysOfWeek" : [ "string" ],
  "duration" : 0,
  "maxDeviation" : 0,
  "maxDuration" : 0,
  "minDeviation" : 0,
  "minDuration" : 0,
  "priority" : 0,
  "quantifier" : "string",
  "rateId" : 0,
  "rateLevelId" : 0,
  "rateOptionId" : 0,
  "rateTypeId" : 0,
  "rateTypeIds" : [ 0 ],
  "remark" : "string",
  "repeatable" : 0,
  "resourceId" : 0,
  "status" : 0,
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ],
  "usageDow" : 0,
  "usageDurationFrom" : 0,
  "usageDurationTo" : 0,
  "validFrom" : "string",
  "validTo" : "string",
  "value" : 0.0,
  "valueType" : "string"
}

3.19.15. 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

Path

resourceId
required

Resource id for which Rates are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rateId:0,
value:0.0,
remark:String,
quantifier:String,
qrvType:String,
minDuration:0,
priority:0,
bookdateFrom:String(date),
bookdateTo:String(date),
usageDurationFrom:0,
usageDurationTo:0,
cashflowmanagerId:0,
validFrom:String(date),
validTo:String(date))

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching offer rates.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/rates
Example HTTP response
Response 200
{
  "applicableTo" : [ {
    "accommodationKindId" : 0,
    "resourceId" : 0,
    "resourceType" : "string"
  } ],
  "bookdateFrom" : "string",
  "bookdateTo" : "string",
  "cashflowmanagerId" : 0,
  "daysOfWeek" : [ "string" ],
  "duration" : 0,
  "maxDeviation" : 0,
  "maxDuration" : 0,
  "maxDurationMinutes" : 0,
  "minDeviation" : 0,
  "minDuration" : 0,
  "minDurationMinutes" : 0,
  "priority" : 0,
  "qrvType" : "string",
  "qrvValues" : [ {
    "minQuantity" : 0,
    "value" : 0.0
  } ],
  "quantifier" : "string",
  "rateId" : 0,
  "rateTypeIds" : [ 0 ],
  "remark" : "string",
  "resourceId" : 0,
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ],
  "usageDurationFrom" : 0,
  "usageDurationTo" : 0,
  "validFrom" : "string",
  "validTo" : "string",
  "value" : 0.0,
  "valueType" : "string"
}

3.19.16. 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
required

Resource id for which rentability will be added for offers

integer (int64)

Body

rentabilityDetail
required

Rentability for offer, which contain the rentability configuration detail

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while adding rentability.

No Content

Consumes
  • application/json

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/rentability
Request body
{
  "bookdateFrom" : "string",
  "bookdateTo" : "string",
  "dateBegin" : "string",
  "dateEnd" : "string",
  "dayMax" : 0,
  "dayMin" : 0,
  "daysOfWeek" : [ "string" ],
  "isArrival" : true,
  "isDeparture" : true,
  "isTemporary" : 0,
  "managerId" : 0,
  "maxDeviationArrDepDate" : 0,
  "maxTimeAfterBookDate" : 0,
  "minDeviationArrDepDate" : 0,
  "minTimeAfterBookDate" : 0
}
Example HTTP response
Response 200
{
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "dateBegin" : "string",
  "dateEnd" : "string",
  "distributionChannelIds" : [ 0 ],
  "gap" : 0,
  "isTemporary" : 0,
  "maxDeviationArrDepDate" : 0,
  "maxTimeAfterBookDate" : 0,
  "minDeviationArrDepDate" : 0,
  "minTimeAfterBookDate" : 0,
  "rentabilityId" : 0,
  "rentabilityMarkers" : [ {
    "dowMask" : 0,
    "rentabilityMarkerId" : 0,
    "timeMax" : 0,
    "timeMin" : 0,
    "type" : "string"
  } ],
  "resourceIds" : [ 0 ]
}

3.19.17. 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
required

resourceId of offer for which the representations will be create.

integer (int64)

Body

representation
optional

representation object for creating representation for offer

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/representations
Request body
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.19.18. 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

Path

resourceId
required

ResourceId of offer for which the representations needs to be fetched.

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
representationId:0,
resourceId:0,
visible:true,
bookable:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching representations.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/offers/0/representations
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.20. Owners

Someone who owns an accommodation

3.20.1. 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

Path

ownerGroupId
required

OwnerGroup Id to fetch units of the owners

integer (int64)

Query

code
optional

Code of the unit

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
unitId:0)

Query

resourceId
optional

ResourceId of the accommodationType to which the unit is linked

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/ownergroups/0/units
Example HTTP response
Response 200
{
  "accommodationAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "archivedFrom" : "string",
  "brand" : "string",
  "choosableOnInternet" : true,
  "cleaningStatus" : "string",
  "code" : "string",
  "excludeQuestionnaireStats" : true,
  "nrOfBathrooms" : 0,
  "nrOfBedrooms" : 0,
  "ownerGroupId" : 0,
  "ownerId" : 0,
  "path" : "string",
  "resourceGroupId" : 0,
  "resourceId" : 0,
  "roomCode" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "unitId" : 0,
  "vsi" : 0
}

3.20.2. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
accountNr:String,
firstName:String,
lastName:String,
middle:String,
alternateName:String,
attentionOf:String,
birthDate:String(date),
mailAllowed:true,
sendMethodId:0,
sex:String,
emailAllowed:true,
titleId:0,
ibanNumber:String,
bicSwift:String,
companyName:String,
ownerGroupId:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching owners

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners
Example HTTP response
Response 200
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthDate" : "string",
  "company" : true,
  "companyName" : "string",
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "owner" : true,
  "ownerGroupId" : 0,
  "ownerId" : 0,
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 0,
  "sex" : "string",
  "titleId" : 0
}

3.20.3. 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

code
optional

Code of the accommodationType

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
resourceId:0)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/accommodationtypes
Example HTTP response
Response 200
{
  "accommodationAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "accotypeKindId" : 0,
  "archivedFrom" : "string",
  "brand" : "string",
  "code" : "string",
  "dependsOnLedgerGroup" : true,
  "hasObjects" : true,
  "nrOfBathrooms" : 0.0,
  "nrOfBedrooms" : 0.0,
  "numberOfPersons" : 0,
  "ownerId" : 0,
  "parentId" : 0,
  "path" : "string",
  "priority" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "supplierOrigin" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.20.4. Get owner’s reservation details

GET /maxxton/v1/owners/reservations/details
Description

Get owner’s reservation details. the recored can be filter based on employeeId and contactType. 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

contactType
optional

ContractType to filter the owner’s reservation detail

string

Query

employeeId
optional

Employee id to filter the owner reservation detail

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationId:0,
arrivalDate:String(date),
customerId:0,
departureDate:String(date),
distributionChannelId:0,
modifiedDate:String(date),
reservationCategoryId:0,
reservationDate:String(date),
reservationNumber:String,
resortId:0,
status:0,
supplierVoucher:String,
tncSigned:true,
tncSignedDate:String(date),
tncSigneeCustomerName:String,
type:String,
validationStatus:0,
voucher:String,
parentId:0,
cancelDate:String(date),
originId:String,
origin:String,
expireDate:String(date),
printedDate:String(date),
resellerId:0,
sendMethodId:0)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/reservations/details
Example HTTP response
Response 200
{
  "arrivalDate" : "string",
  "categoryCode" : "string",
  "customer" : {
    "countryCode" : "string",
    "firstName" : "string",
    "lastName" : "string"
  },
  "departureDate" : "string",
  "distributionChannelCode" : "string",
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "reservedResources" : [ {
    "addons" : [ {
      "addonType" : "string",
      "code" : "string",
      "resourceId" : 0,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ]
    } ],
    "ownerId" : 0,
    "unitCode" : "string",
    "unitId" : 0
  } ],
  "status" : 0,
  "statusValue" : "string",
  "subjects" : [ {
    "maxAge" : 0,
    "quantity" : 0,
    "subjectId" : 0,
    "translations" : [ {
      "language" : "string",
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string"
  } ]
}

3.20.5. 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

code
optional

Code of the unit

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
unitId:0)

Query

resourceId
optional

ResourceId of the accommodationType to which the unit is linked

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/units
Example HTTP response
Response 200
{
  "accommodationAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "archivedFrom" : "string",
  "brand" : "string",
  "choosableOnInternet" : true,
  "cleaningStatus" : "string",
  "code" : "string",
  "excludeQuestionnaireStats" : true,
  "nrOfBathrooms" : 0,
  "nrOfBedrooms" : 0,
  "ownerGroupId" : 0,
  "ownerId" : 0,
  "path" : "string",
  "resourceGroupId" : 0,
  "resourceId" : 0,
  "roomCode" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "unitId" : 0,
  "vsi" : 0
}

3.20.6. Gets an owner.

GET /maxxton/v1/owners/{ownerId}
Description

Gets information associated with specific owner. The records can be filtered based on owner object.It also supports pageable.

Parameters
Type Name Description Schema

Path

ownerId
required

An Id of owner to be fetched

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching owner

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/0
Example HTTP response
Response 200
{
  "accountNr" : "string",
  "alternateName" : "string",
  "attentionOf" : "string",
  "bicSwift" : "string",
  "birthDate" : "string",
  "company" : true,
  "companyName" : "string",
  "emailAllowed" : true,
  "firstName" : "string",
  "ibanNumber" : "string",
  "lastName" : "string",
  "mailAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "mailAllowed" : true,
  "middle" : "string",
  "owner" : true,
  "ownerGroupId" : 0,
  "ownerId" : 0,
  "questionnaireUnsubscribed" : true,
  "sendMethodId" : 0,
  "sex" : "string",
  "titleId" : 0
}

3.20.7. 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

Path

ownerId
required

Owner id to fetch accommodationtypes of the owner

integer (int64)

Query

code
optional

Code of the accommodationType

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
resourceId:0)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/0/accommodationtypes
Example HTTP response
Response 200
{
  "accommodationAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "accotypeKindId" : 0,
  "archivedFrom" : "string",
  "brand" : "string",
  "code" : "string",
  "dependsOnLedgerGroup" : true,
  "hasObjects" : true,
  "nrOfBathrooms" : 0.0,
  "nrOfBedrooms" : 0.0,
  "numberOfPersons" : 0,
  "ownerId" : 0,
  "parentId" : 0,
  "path" : "string",
  "priority" : 0,
  "resortId" : 0,
  "resourceId" : 0,
  "supplierOrigin" : "string",
  "translations" : [ {
    "accotypeKind" : "string",
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "namePath" : "string",
    "shortDescription" : "string"
  } ],
  "type" : "string"
}

3.20.8. 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

Path

ownerId
required

Owner id for which the communication calls are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
customerCommunicationId:0,
sendDate:String(date),
sendingType:String,
reservationId:0,
message:String,
senderEmail:String,
subject:String)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/0/communications
Example HTTP response
Response 200
{
  "attachments" : [ {
    "endDate" : "string",
    "fileId" : 0,
    "fileName" : "string",
    "fileSize" : 0,
    "fileType" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string",
    "uploadDate" : "string",
    "validFrom" : "string",
    "validTo" : "string"
  } ],
  "customerCommunicationId" : 0,
  "message" : "string",
  "reportCode" : "string",
  "reportType" : "string",
  "reservationId" : 0,
  "sendDate" : "string",
  "senderEmail" : "string",
  "sendingType" : "string",
  "subject" : "string"
}

3.20.9. 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

Path

ownerId
required

Owner id for which the files are to be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
fileId:0,
name:String,
fileName:String,
fileSize:0,
fileType:String,
uploadDate:String(date),
endDate:String(date),
shortDescription:String,
validFrom:String(date),
validTo:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/0/files
Example HTTP response
Response 200
{
  "endDate" : "string",
  "fileId" : 0,
  "fileName" : "string",
  "fileSize" : 0,
  "fileType" : "string",
  "language" : "string",
  "name" : "string",
  "shortDescription" : "string",
  "uploadDate" : "string",
  "validFrom" : "string",
  "validTo" : "string"
}

3.20.10. 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

fileId
required

file id to fetch a specific file

integer (int64)

Path

ownerId
required

Owner id to fetch files associated with the owner

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/0/files/0
Example HTTP response
Response 200
{
  "downloadLink" : "string"
}

3.20.11. 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

Path

ownerId
required

Owner id to fetch units of the owner

integer (int64)

Query

code
optional

Code of the unit

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
ownerId:0,
unitId:0)

Query

resourceId
optional

ResourceId of the accommodationType to which the unit is linked

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/0/units
Example HTTP response
Response 200
{
  "accommodationAddress" : {
    "accuracy" : "string",
    "address1" : "string",
    "address2" : "string",
    "address3" : "string",
    "addressId" : 0,
    "alternateContactPerson" : "string",
    "boxNumber" : "string",
    "city" : "string",
    "country" : {
      "code" : "string",
      "countryId" : 0,
      "default" : true,
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "countryId" : 0,
    "dateBegin" : "string",
    "dateEnd" : "string",
    "district" : "string",
    "email" : "string",
    "exposeLocation" : true,
    "fax" : "string",
    "houseNumber" : "string",
    "houseNumberSuffix" : "string",
    "latitude" : 0.0,
    "longitude" : 0.0,
    "managerId" : 0,
    "mobilePhone" : "string",
    "mobilePhone2" : "string",
    "municipality" : "string",
    "poBox" : "string",
    "poBoxCity" : "string",
    "poBoxZipcode" : "string",
    "privatePhone" : "string",
    "stateId" : 0,
    "workPhone" : "string",
    "zipCode" : "string"
  },
  "archivedFrom" : "string",
  "brand" : "string",
  "choosableOnInternet" : true,
  "cleaningStatus" : "string",
  "code" : "string",
  "excludeQuestionnaireStats" : true,
  "nrOfBathrooms" : 0,
  "nrOfBedrooms" : 0,
  "ownerGroupId" : 0,
  "ownerId" : 0,
  "path" : "string",
  "resourceGroupId" : 0,
  "resourceId" : 0,
  "roomCode" : "string",
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "unitId" : 0,
  "vsi" : 0
}

3.20.12. 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

Path

ownerId
required

Owner id to fetch units of the owner

integer (int64)

Path

unitId
required

Unit id to fetch reservations of the unit

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationId:0,
arrivalDate:String(date),
customerId:0,
departureDate:String(date),
distributionChannelId:0,
modifiedDate:String(date),
reservationCategoryId:0,
reservationDate:String(date),
reservationNumber:String,
resortId:0,
status:0,
supplierVoucher:String,
tncSigned:true,
tncSignedDate:String(date),
tncSigneeCustomerName:String,
type:String,
validationStatus:0,
voucher:String,
parentId:0,
cancelDate:String(date),
originId:String,
origin:String,
expireDate:String(date),
printedDate:String(date),
resellerId:0,
sendMethodId:0)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/owners/0/units/0/reservations
Example HTTP response
Response 200
{
  "arrivalDate" : "string",
  "categoryCode" : "string",
  "customer" : {
    "countryCode" : "string",
    "firstName" : "string",
    "lastName" : "string"
  },
  "departureDate" : "string",
  "distributionChannelCode" : "string",
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "reservedResources" : [ {
    "addons" : [ {
      "addonType" : "string",
      "code" : "string",
      "resourceId" : 0,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ]
    } ],
    "ownerId" : 0,
    "unitCode" : "string",
    "unitId" : 0
  } ],
  "status" : 0,
  "statusValue" : "string",
  "subjects" : [ {
    "maxAge" : 0,
    "quantity" : 0,
    "subjectId" : 0,
    "translations" : [ {
      "language" : "string",
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string"
  } ]
}

3.21. Rate Types

A group of different prices of an accommodation type

3.21.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

distributionChannelCode
optional

distributionChannelCode code to filter rate types.

string

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rateTypeId:0,
code:String,
priority:0,
isDefault:true,
name:String,
currencyId:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching contract Types.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/ratetypes
Example HTTP response
Response 200
{
  "code" : "string",
  "currencyCode" : "string",
  "currencyId" : 0,
  "distributionChannels" : [ {
    "bookdateFrom" : "string",
    "bookdateTo" : "string",
    "endDate" : "string",
    "id" : 0,
    "startDate" : "string"
  } ],
  "isDefault" : true,
  "name" : "string",
  "priority" : 0,
  "rateTypeId" : 0,
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ]
}

3.22. Regions

Defines region on a map

3.22.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
regionId:0,
code:String,
parentId:0,
priority:0)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching regions

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/regions
Example HTTP response
Response 200
{
  "childIds" : [ 0 ],
  "code" : "string",
  "geoShapePoints" : [ [ {
    "latitude" : 0.0,
    "longitude" : 0.0
  } ] ],
  "lowestLevel" : true,
  "parentId" : 0,
  "priority" : 0,
  "regionId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ]
}

3.22.2. 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
required

An Id of region to be fetched

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching region

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/regions/0
Example HTTP response
Response 200
{
  "childIds" : [ 0 ],
  "code" : "string",
  "geoShapePoints" : [ [ {
    "latitude" : 0.0,
    "longitude" : 0.0
  } ] ],
  "lowestLevel" : true,
  "parentId" : 0,
  "priority" : 0,
  "regionId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ]
}

3.23. Rentability

Possible arrival and departure days

3.23.1. 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

distributionChannelId
optional

A distributionChannelId to fetch rentability Markers

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
rentabilityId:0,
managerId:0,
dateBegin:String(date),
dateEnd:String(date),
minDeviationArrDepDate:0,
maxDeviationArrDepDate:0,
isTemporary:0,
bookDateFrom:String(date),
bookDateTo:String(date),
maxTimeAfterBookDate:0,
minTimeAfterBookDate:0,
gap:0)

Query

resourceId
optional

A resourceId to fetch rentability markers

integer (int64)

Query

resourceType
optional

resourceType

enum (ACCOMMODATIONTYPE, RESOURCEACTIVITY, ACTIVITY, PRODUCTTYPE, EXTRA, SPECIAL, COMPOSITION)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching rentability markers.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/rentability/config
Example HTTP response
Response 200
{
  "bookDateFrom" : "string",
  "bookDateTo" : "string",
  "dateBegin" : "string",
  "dateEnd" : "string",
  "distributionChannelIds" : [ 0 ],
  "gap" : 0,
  "isTemporary" : 0,
  "maxDeviationArrDepDate" : 0,
  "maxTimeAfterBookDate" : 0,
  "minDeviationArrDepDate" : 0,
  "minTimeAfterBookDate" : 0,
  "rentabilityId" : 0,
  "rentabilityMarkers" : [ {
    "dowMask" : 0,
    "rentabilityMarkerId" : 0,
    "timeMax" : 0,
    "timeMin" : 0,
    "type" : "string"
  } ],
  "resourceIds" : [ 0 ]
}

3.23.2. 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 Default

Query

distributionChannelId
required

A distributionChannelId to fetch stay summaries

integer (int64)

Query

maxArrival
optional

A maxArrival date to fetch stay summaries

string (date)

Query

maxDuration
optional

Max duration in days to limit records based on duration.

integer (int64)

28

Query

resourceId
required

A resourceId to fetch stay summaries

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching stay summaries.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/rentability/stays?distributionChannelId=0&resourceId=0
Example HTTP response
Response 200
{
  "arrivalDate" : "string",
  "duration" : 0,
  "validFrom" : "string",
  "validTo" : "string"
}

3.24. Representation

Defines accommodation type configuration valid for a distribution channel

3.24.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
representationId:0,
resourceId:0,
visible:true,
bookable:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching representations.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/representations
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.24.2. 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
required

representationId for which representation will be fetched

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching representations.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/representations/0
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.24.3. Update representation

PUT /maxxton/v1/representations/{representationId}
Description

Update representation of provided representationId.

Parameters
Type Name Description Schema

Path

representationId
required

representationId of representation which needs to be update

integer (int64)

Body

representation
optional

representation with field value that needs to be update

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/representations/0
Request body
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.24.4. Delete representation

DELETE /maxxton/v1/representations/{representationId}
Description

Delete representation of a provided representation id.

Parameters
Type Name Description Schema

Path

representationId
required

id of the representation which needs to be deleted

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while deleting representations.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/representations/0
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.24.5. 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
required

representationId for which distribution channel will be added

integer (int64)

Body

representationDistributionChannel
required

Distribution channels detail which is to be added to a representation

Responses
HTTP Code Description Schema

200

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

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/representations/0/distributionchannels
Request body
{
  "code" : "string",
  "distributionChannelId" : 0,
  "name" : "string",
  "path" : "string"
}

3.24.6. 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

Path

representationId
required

representationId to fetch the distribution channels of representation

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
distributionChannelId:0,
name:String,
code:String,
path:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching distribution channel.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/representations/0/distributionchannels
Example HTTP response
Response 200
{
  "code" : "string",
  "distributionChannelId" : 0,
  "name" : "string",
  "path" : "string"
}

3.24.7. 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

distributionChannelId
required

id of the distribution channel which needs to be removed from representation

integer (int64)

Path

representationId
required

id of the representation which needs to be deleted

integer (int64)

Body

channelRepresentation
optional

Distribution channel representation that needs to be updated

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while deleting representations.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/representations/0/distributionchannels/0
Request body
{
  "allotment" : 0,
  "distributionChannelId" : 0,
  "distributionChannelRepresentationId" : 0,
  "distributionChannelRepresentationParentId" : 0,
  "representationId" : 0
}
Example HTTP response
Response 200
{
  "bookable" : true,
  "distributionChannelIds" : [ 0 ],
  "representationId" : 0,
  "resourceId" : 0,
  "translations" : [ {
    "description" : "string",
    "description2" : "string",
    "language" : "string",
    "name" : "string",
    "shortDescription" : "string"
  } ],
  "visible" : true
}

3.25. Resellers

Agent who are selling accommodation types

3.25.1. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
resellerId:0,
code:String,
description:String,
distributionChannelId:0,
name:String)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching resellers.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/resellers
Example HTTP response
Response 200
{
  "code" : "string",
  "description" : "string",
  "distributionChannelId" : 0,
  "name" : "string",
  "resellerId" : 0
}

3.25.2. 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
required

resellerId to fetch reseller

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching reseller.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/resellers/0
Example HTTP response
Response 200
{
  "code" : "string",
  "description" : "string",
  "distributionChannelId" : 0,
  "name" : "string",
  "resellerId" : 0
}

3.25.3. 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
required

resellrId to fetch ResellerStopSell

integer (int64)

Query

stopSellType
required

enumerated value of type StopSellType to fetch ResellerStopSell(s)

enum (BLOCKING, LOWERING, RESTRICTION)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching resellers.

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/resellers/0/stopsells?stopSellType=string
Example HTTP response
Response 200
{
  "endDate" : "string",
  "resellerId" : 0,
  "resellerStopSellId" : 0,
  "reservableValue" : 0,
  "resourceId" : 0,
  "startDate" : "string",
  "stopSellType" : "string"
}

3.26. Reservability

Number of units available

3.26.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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservabilityId:0,
startDate:String(date),
endDate:String(date),
allocatable:0,
reservable:0,
modifiedDate:String(date))

Query

resourceId
optional

Resource id for which the result is valid

integer (int64)

Query

resourceType
optional

Resource type of the resourceid

string

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching reservability

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/resourcereservability
Example HTTP response
Response 200
{
  "allocatable" : 25,
  "endDate" : "2017-01-20",
  "modifiedDate" : "2017-01-22T15:43:14Z",
  "reservabilityId" : 287665016,
  "reservable" : 23,
  "reserved" : 24,
  "resourceId" : 842,
  "resourceType" : "accommodationtype",
  "startDate" : "2017-01-16"
}

3.26.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 ReservedResourceAllotment.
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

distributionChannelId
optional

The identifier of the DistributionChannel to fetch resource reservability

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
startDate:String(date),
endDate:String(date),
freeAllotments:0,
resourceId:0)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/resourcereservability/allotment
Example HTTP response
Response 200
{
  "distributionChannelId" : 0,
  "endDate" : "string",
  "freeAllotments" : 0,
  "modifiedDate" : "string",
  "resourceId" : 0,
  "startDate" : "string"
}

3.26.3. 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
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
modifiedDate:String(date),
arrivalDateFrom:String(date),
arrivalDateTo:String(date))

Query

resourceId
optional

resourceId for filtering unitReservability

integer (int64)

Query

unitId
optional

unitId for filtering unitReservability

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching reservability

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/unitreservability
Example HTTP response
Response 200
{
  "allocatable" : 25,
  "arrivalDateFrom" : "2017-01-16",
  "arrivalDateTo" : "2017-01-20",
  "modifiedDate" : "2017-01-22T15:43:14Z",
  "reservabilityId" : 287665016,
  "reservable" : 23,
  "reserved" : 24,
  "resourceId" : 842,
  "unitId" : 842
}

3.26.4. 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

distributionChannelId
optional

The identifier of the DistributionChannel to fetch unit reservability

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
unitId:0,
startDate:String(date),
endDate:String(date),
freeAllotments:0,
resourceId:0)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/unitreservability/allotment
Example HTTP response
Response 200
{
  "distributionChannelId" : 0,
  "endDate" : "string",
  "freeAllotments" : 0,
  "modifiedDate" : "string",
  "resourceId" : 0,
  "startDate" : "string",
  "unitId" : 0
}

3.26.5. 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 Schema

Query

endDate
optional

string (date)

Query

startDate
optional

string (date)

Query

unitId
optional

< integer (int64) > array(multi)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching reservability

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/unitreservability/period
Example HTTP response
Response 200
{
  "endDate" : "string",
  "reservability" : "string",
  "startDate" : "string",
  "unitId" : 0
}

3.27. Reservations

Customer booking of an accommodation

3.27.1. Creates a new reservation

POST /maxxton/v1/reservations
Description

Creates a new reservation based on given criteria

Parameters
Type Name Description Schema

Query

returnBill
optional

The customer bill will be returned when the value is set to true

boolean

Query

returnInstalments
optional

The instalments will be returned when the value is set to true

boolean

Body

reservationCriteria
required

Reservation criteria based on given detail new reservation will create

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while creating reservation

No Content

Consumes
  • application/json

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations
Request body
{
  "accommodationTypes" : [ {
    "additions" : [ {
      "additionResourceId" : 0,
      "endDate" : "string",
      "quantity" : 0,
      "startDate" : "string"
    } ],
    "arrivalDate" : "string",
    "duration" : 0,
    "offerCode" : "string",
    "preferences" : [ {
      "id" : 0,
      "type" : "string"
    } ],
    "rateTypeId" : 0,
    "removeImplies" : [ 0 ],
    "resourceId" : 0,
    "subjects" : {
      "persons" : [ {
        "age" : 0,
        "quantity" : 0
      } ],
      "petsQuantity" : 0
    },
    "unitId" : 0
  } ],
  "categoryCode" : "string",
  "customer" : {
    "alternateName" : "string",
    "birthDate" : "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" : 0.0,
      "longitude" : 0.0,
      "mobilePhone" : "string",
      "mobilePhone2" : "string",
      "poBox" : "string",
      "poBoxCity" : "string",
      "poBoxZipcode" : "string",
      "privatePhone" : "string",
      "stateId" : 0,
      "workPhone" : "string",
      "zipCode" : "string"
    },
    "mailAllowed" : true,
    "middle" : "string",
    "questionnaireUnsubscribed" : true,
    "sex" : "string",
    "socialSecurityNumber" : "string",
    "titleId" : 0
  },
  "customerId" : 0,
  "distributionChannelCode" : "string",
  "employee" : "string",
  "externalBookingReference" : "string",
  "remark" : "string",
  "sendMethodCode" : "string",
  "status" : "string",
  "statusValue" : "string"
}
Example HTTP response
Response 200
{
  "agentBill" : [ {
    "billLineType" : 10,
    "name" : "string",
    "resourceId" : 0,
    "total" : 0.0,
    "vatRate" : 0.0
  } ],
  "arrivalDate" : "string",
  "currencyCode" : "string",
  "customerBill" : [ {
    "billLineType" : 10,
    "name" : "string",
    "resourceId" : 0,
    "total" : 0.0,
    "vatRate" : 0.0
  } ],
  "customerId" : 0,
  "departureDate" : "string",
  "externalBookingReference" : "string",
  "infotexts" : [ {
    "description" : "string"
  } ],
  "instalments" : [ {
    "autopay" : true,
    "due" : 0.0,
    "dueDate" : "string",
    "issueDate" : "string",
    "payerType" : "string",
    "status" : "string",
    "taxValue" : 0.0,
    "term" : "string",
    "value" : 0.0
  } ],
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "reservedResources" : [ {
    "code" : "string",
    "description" : "string",
    "endDate" : "string",
    "hasPriceOverride" : true,
    "imply" : true,
    "infotexts" : [ {
      "description" : "string"
    } ],
    "name" : "string",
    "offerType" : "string",
    "parentId" : 0,
    "price" : 0.0,
    "quantity" : 0,
    "removable" : true,
    "reservedResourceId" : 0,
    "resourceId" : 0,
    "shortDescription" : "string",
    "startDate" : "string",
    "type" : "string",
    "unitId" : 0
  } ],
  "resortId" : 0,
  "status" : 0,
  "statusValue" : "string"
}

3.27.2. 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

accommodationtypecode
optional

accommodationtypecode

string

Query

customerName
optional

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

Query

customeremail
optional

customeremail

string

Query

distributionChannelCode
optional

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

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationId:0,
arrivalDate:String(date),
customerId:0,
departureDate:String(date),
distributionChannelId:0,
modifiedDate:String(date),
reservationCategoryId:0,
reservationDate:String(date),
reservationNumber:String,
resortId:0,
status:0,
supplierVoucher:String,
tncSigned:true,
tncSignedDate:String(date),
tncSigneeCustomerName:String,
type:String,
validationStatus:0,
voucher:String,
parentId:0,
cancelDate:String(date),
originId:String,
origin:String,
expireDate:String(date),
printedDate:String(date),
resellerId:0,
sendMethodId:0)

Query

resourceId
optional

resourceId

integer (int64)

Query

unitId
optional

The unitId for filtering the reservations

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

204

No reservations found for given criteria.

500

Error occurred while fetching these reservations

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations
Example HTTP response
Response 200
{
  "arrivalDate" : "string",
  "cancelDate" : "string",
  "categoryCode" : "string",
  "categoryName" : "string",
  "customerId" : 0,
  "departureDate" : "string",
  "distributionChannelId" : 0,
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "expireDate" : "string",
  "modifiedDate" : "string",
  "origin" : "string",
  "originId" : "string",
  "parentId" : 0,
  "printedDate" : "string",
  "resellerId" : 0,
  "reservationCategoryId" : 0,
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "resortId" : 0,
  "sendMethodId" : 0,
  "status" : 0,
  "statusValue" : "string",
  "supplierVoucher" : "string",
  "tncSigned" : true,
  "tncSignedDate" : "string",
  "tncSigneeCustomerName" : "string",
  "type" : "string",
  "validationStatus" : -101,
  "voucher" : "string"
}
Response 204
{
  "arrivalDate" : "string",
  "cancelDate" : "string",
  "categoryCode" : "string",
  "categoryName" : "string",
  "customerId" : 0,
  "departureDate" : "string",
  "distributionChannelId" : 0,
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "expireDate" : "string",
  "modifiedDate" : "string",
  "origin" : "string",
  "originId" : "string",
  "parentId" : 0,
  "printedDate" : "string",
  "resellerId" : 0,
  "reservationCategoryId" : 0,
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "resortId" : 0,
  "sendMethodId" : 0,
  "status" : 0,
  "statusValue" : "string",
  "supplierVoucher" : "string",
  "tncSigned" : true,
  "tncSignedDate" : "string",
  "tncSigneeCustomerName" : "string",
  "type" : "string",
  "validationStatus" : -101,
  "voucher" : "string"
}

3.27.3. Gets page of reservation categories

GET /maxxton/v1/reservations/categories
Description

Get reservation categories.

Parameters
Type Name Description Schema

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationCategoryId:0,
name:String,
code:String,
endDate:String,
markForOwnUse:true)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching reservation categories

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/categories
Example HTTP response
Response 200
{
  "code" : "string",
  "endDate" : "string",
  "markForOwnUse" : true,
  "name" : "string",
  "reservationCategoryId" : 0,
  "translations" : [ {
    "description" : "string",
    "language" : "string",
    "name" : "string"
  } ]
}

3.27.4. 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

accommodationKindIds
optional

Filter response based on accommodation kind ids. Its mandatory to pass either reservationIds or customerIds in request with accommodationKindIds.

< integer (int64) > array(multi)

Query

customerIds
optional

Filter reservations based on customer ids

< integer (int64) > array(multi)

Query

distributionChannelId
optional

Filter reservations based on distribution channel id

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
validationStatus:0,
status:0,
resortId:0,
reservationNumber:String,
reservationDate:String(date),
reservationCategoryId:0,
reservationId:0,
arrivalDate:String(date),
cancelDate:String(date),
departureDate:String(date),
distributionChannelId:0,
modifiedDate:String(date),
parentId:0,
sendMethodId:0,
tncSignedDate:String(date),
tncSigneeCustomerName:String)

Query

reservationCategoryIds
optional

Filter reservations based on reservation category ids

< integer (int64) > array(multi)

Query

reservationIds
optional

Filter reservations based on reservation ids

< integer (int64) > array(multi)

Query

reservationNumber
optional

The identifier of the reservation

string

Query

reservedResourceStatusIds
optional

Filter reservations based on reserved resource status ids

< integer (int32) > array(multi)

Query

reservedResourceType
optional

Filter reservations based on reserved resource type

string

Query

returnBill
optional

The reservation bill will be returned when the value is set to true

boolean

Query

returnCustomer
optional

The customer information will be returned when the value is set to true

boolean

Query

returnCustomerStatus
optional

The customer status will be returned when the value is set to true

boolean

Query

returnInstalments
optional

The reservation instalments will be returned when the value is set to true

boolean

Query

returnReservedResources
optional

The reserved resources will be returned when the value is set to true

boolean

Query

statusIds
optional

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) > array(multi)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

500

Error occurred while fetching this reservation

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/details
Example HTTP response
Response 200
{
  "agentBill" : [ {
    "billLineType" : 0,
    "endDate" : "string",
    "multiplier" : 0,
    "name" : "string",
    "quantity" : 0,
    "resourceId" : 0,
    "startDate" : "string",
    "total" : 0.0,
    "value" : 0.0,
    "vatRate" : 0.0
  } ],
  "arrivalDate" : "string",
  "cancelDate" : "string",
  "categoryCode" : "string",
  "customer" : {
    "alternateName" : "string",
    "bicSwift" : "string",
    "birthDate" : "string",
    "customerId" : 0,
    "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" : 0,
        "default" : true,
        "translations" : [ {
          "language" : "string",
          "name" : "string"
        } ]
      },
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 0.0,
      "longitude" : 0.0,
      "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",
        "title" : "string"
      } ]
    }
  },
  "customerBill" : [ {
    "billLineType" : 0,
    "endDate" : "string",
    "multiplier" : 0,
    "name" : "string",
    "quantity" : 0,
    "resourceId" : 0,
    "startDate" : "string",
    "total" : 0.0,
    "value" : 0.0,
    "vatRate" : 0.0
  } ],
  "customerStatus" : {
    "customerClusters" : [ {
      "clusterId" : 0,
      "description" : "string",
      "name" : "string"
    } ]
  },
  "departureDate" : "string",
  "distributionChannelCode" : "string",
  "distributionChannelId" : 0,
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "externalBookingReference" : "string",
  "infotexts" : [ {
    "description" : "string"
  } ],
  "instalments" : [ {
    "autopay" : true,
    "due" : 0.0,
    "dueDate" : "string",
    "issueDate" : "string",
    "payerType" : "string",
    "status" : "string",
    "taxValue" : 0.0,
    "term" : "string",
    "value" : 0.0
  } ],
  "modifiedDate" : "string",
  "parentId" : 0,
  "reservationCategoryId" : 0,
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "reservedResources" : [ {
    "amenities" : [ {
      "amenityId" : 0,
      "categories" : [ {
        "code" : "string",
        "translations" : [ {
          "language" : "string",
          "name" : "string"
        } ]
      } ],
      "endDate" : "string",
      "metricDetail" : {
        "code" : "string",
        "metricId" : 0,
        "translations" : [ {
          "language" : "string",
          "name" : "string"
        } ]
      },
      "parentAmenityId" : 0,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string"
      } ],
      "type" : "string"
    } ],
    "code" : "string",
    "description" : "string",
    "endDate" : "string",
    "impliesId" : 0,
    "imply" : true,
    "included" : true,
    "infotexts" : [ {
      "description" : "string"
    } ],
    "modifiedDate" : "string",
    "name" : "string",
    "offerType" : "string",
    "parentId" : 0,
    "preferences" : [ {
      "id" : 0,
      "type" : "string"
    } ],
    "price" : 0.0,
    "quantity" : 0,
    "rateType" : {
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "removable" : true,
    "reservationDate" : "string",
    "reservedResourceId" : 0,
    "resourceId" : 0,
    "shortDescription" : "string",
    "startDate" : "string",
    "status" : 0,
    "subjects" : [ {
      "maxAge" : 0,
      "quantity" : 0,
      "subjectId" : 0,
      "translations" : [ {
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "type" : "string"
    } ],
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unit" : {
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "unitId" : 0
    }
  } ],
  "resortId" : 0,
  "sendMethodId" : 0,
  "status" : 0,
  "statusValue" : "string",
  "supplierBookingReference" : "string",
  "tncSigned" : true,
  "tncSignedDate" : "string",
  "tncSigneeCustomerName" : "string",
  "validationStatusId" : 0
}

3.27.5. 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.

Parameters
Type Name Description Schema

Query

returnAdditions
optional

The applicable additions will be returned when the value is set to true

boolean

Query

returnBill
optional

The customer bill will be returned when the value is set to true

boolean

Query

returnInstalments
optional

The instalments will be returned when the value is set to true

boolean

Body

reservation proposal
required

A reservation proposal object to be added

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/proposals
Request body
{
  "accommodationTypes" : [ {
    "additions" : [ {
      "additionResourceId" : 0,
      "endDate" : "string",
      "quantity" : 0,
      "startDate" : "string"
    } ],
    "arrivalDate" : "string",
    "duration" : 0,
    "offerCode" : "string",
    "preferences" : [ {
      "id" : 0,
      "type" : "string"
    } ],
    "rateTypeId" : 0,
    "removeImplies" : [ 0 ],
    "resourceId" : 0,
    "subjects" : {
      "persons" : [ {
        "age" : 0,
        "quantity" : 0
      } ],
      "petsQuantity" : 0
    },
    "unitId" : 0
  } ],
  "categoryCode" : "string",
  "distributionChannelCode" : "string"
}
Example HTTP response
Response 200
{
  "additions" : [ {
    "additionResourceId" : 0,
    "code" : "string",
    "currency" : "string",
    "description" : "string",
    "endDate" : "string",
    "maxQuantity" : 0,
    "maxReservable" : 0,
    "minQuantity" : 0,
    "name" : "string",
    "price" : 0.0,
    "resortArticle" : true,
    "resourceId" : 0,
    "shortDescription" : "string",
    "startDate" : "string",
    "type" : "string"
  } ],
  "agentBill" : [ {
    "billLineType" : 10,
    "multiplier" : 0,
    "name" : "string",
    "quantity" : 0,
    "resourceId" : 0,
    "total" : 0.0,
    "value" : 0.0,
    "vatRate" : 0.0
  } ],
  "arrivalDate" : "string",
  "currencyCode" : "string",
  "customerBill" : [ {
    "billLineType" : 10,
    "multiplier" : 0,
    "name" : "string",
    "quantity" : 0,
    "resourceId" : 0,
    "total" : 0.0,
    "value" : 0.0,
    "vatRate" : 0.0
  } ],
  "departureDate" : "string",
  "infotexts" : [ {
    "description" : "string",
    "display" : "string",
    "name" : "string"
  } ],
  "instalments" : [ {
    "autopay" : true,
    "due" : 0.0,
    "dueDate" : "string",
    "issueDate" : "string",
    "payerType" : "string",
    "status" : "string",
    "taxValue" : 0.0,
    "term" : "string",
    "value" : 0.0
  } ],
  "reservedResources" : [ {
    "addOnMetricDescription" : "string",
    "code" : "string",
    "description" : "string",
    "endDate" : "string",
    "hasPriceOverride" : true,
    "impliesId" : 0,
    "imply" : true,
    "infotexts" : {
      "description" : "string",
      "display" : "string",
      "name" : "string"
    },
    "internetAdditionalCost" : true,
    "name" : "string",
    "offerType" : "string",
    "price" : 0.0,
    "quantity" : 0,
    "removable" : true,
    "resourceId" : 0,
    "shortDescription" : "string",
    "startDate" : "string",
    "type" : "string",
    "unitId" : 0
  } ]
}

3.27.6. 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
required

The identifier of the reservation.

integer (int64)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0
Example HTTP response
Response 200
{
  "arrivalDate" : "string",
  "cancelDate" : "string",
  "categoryCode" : "string",
  "categoryName" : "string",
  "customerId" : 0,
  "departureDate" : "string",
  "distributionChannelId" : 0,
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "expireDate" : "string",
  "modifiedDate" : "string",
  "origin" : "string",
  "originId" : "string",
  "parentId" : 0,
  "printedDate" : "string",
  "resellerId" : 0,
  "reservationCategoryId" : 0,
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "resortId" : 0,
  "sendMethodId" : 0,
  "status" : 0,
  "statusValue" : "string",
  "supplierVoucher" : "string",
  "tncSigned" : true,
  "tncSignedDate" : "string",
  "tncSigneeCustomerName" : "string",
  "type" : "string",
  "validationStatus" : -101,
  "voucher" : "string"
}

3.27.7. 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
required

Id of the reservation which needs to be updated.

integer (int64)

Body

reservationRequest
required

Request body to specify the modifications needed for a reservation.

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0
Request body
{
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "statusValue" : "string"
}
Example HTTP response
Response 200
{
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "reservationId" : 0,
  "statusValue" : "string"
}

3.27.8. 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
required

Reservation id for which amenities are to be fetched

integer (int64)

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

404

No reservation or amenities found for given reservation id.

No Content

500

Error occurred while fetching amenities

No Content

Produces
  • application/json

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/amenities
Example HTTP response
Response 200
[ {
  "amenityId" : 0,
  "reservedResourceId" : 0,
  "type" : "string"
} ]

3.27.9. 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

Path

reservationId
required

Reservation id for which bill is to be fetched

integer (int64)

Query

doFetchInternalBill
optional

true then fetch internal bill lines else don’t default value false

boolean

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservationBillId:0,
reservationId:0,
cashflowRuleName:String,
resourceName:String,
description:String,
quantity:0,
multiplier:0,
value:0.0,
total:0.0,
billLineType:0,
totalBottomSequenceNr:0,
reservedResourceId:0,
startDate:String(date),
endDate:String(date),
payerType:String,
virtualOverrideValue:0.0,
resourceId:0,
reservationBillLineId:0,
resourceType:String,
resourceDescription:String,
type:String,
vatRate:0.0,
resourceTypeSequenceNr:0,
overrideValue:0.0)

Query

payerType
required

payerType of the bill. Possible values: CUSTOMER or PAYING_CUSTOMER or AGENT

string

Responses
HTTP Code Description Schema

200

The request is completed successfully without any errors

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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/bills?payerType=string
Example HTTP response
Response 200
[ {
  "billLineType" : 10,
  "cashflowRuleName" : "string",
  "description" : "string",
  "endDate" : "string",
  "multiplier" : 0,
  "overrideValue" : 0.0,
  "payerType" : "string",
  "quantity" : 0,
  "reservationBillId" : 0,
  "reservationBillLineId" : 0,
  "reservationId" : 0,
  "reservedResourceId" : 0,
  "resourceDescription" : "string",
  "resourceId" : 0,
  "resourceName" : "string",
  "resourceType" : "string",
  "resourceTypeSequenceNr" : 0,
  "startDate" : "string",
  "total" : 0.0,
  "totalBottomSequenceNr" : 0,
  "type" : "string",
  "value" : 0.0,
  "vatRate" : 0.0,
  "virtualOverrideValue" : 0.0
} ]

3.27.10. 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

Path

reservationId
required

Reservation id for which reserved resources should be fetched

integer (int64)

Query

fetchTurnover
optional

Parameter to identify if Turnover is to be fetched for each reserved resource. By default this is false.

boolean

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
reservedResourceId:0,
reservationId:0,
resourceId:0,
unitId:0,
rateTypeId:0,
overrideEmployeeId:0,
overrideValue:0.0,
quantity:0,
type:String,
offerType:String,
vatRate:0.0,
statusName:String,
name:String,
code:String,
shortDescription:String,
description:String,
startDate:String(date),
endDate:String(date),
reservationDate:String(date),
onBill:true,
price:0.0,
hasPriceOverride:true,
totalInternalPrice:0.0,
employeeId:0,
removable:true,
modifiedDate:String(date),
implyOnce:true,
included:true,
turnOverValue:0.0,
representationId:0,
parentId:0,
impliesId:0,
resellerAddonCode:String,
actualStartDate:String(date),
actualEndDate:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/content
Example HTTP response
Response 200
{
  "actualEndDate" : "string",
  "actualStartDate" : "string",
  "code" : "string",
  "description" : "string",
  "employeeId" : 0,
  "endDate" : "string",
  "hasPriceOverride" : true,
  "impliesId" : 0,
  "imply" : true,
  "implyOnce" : true,
  "included" : true,
  "modifiedDate" : "string",
  "name" : "string",
  "offerType" : "string",
  "onBill" : true,
  "overrideEmployeeId" : 0,
  "overrideValue" : 0.0,
  "parentId" : 0,
  "price" : 0.0,
  "quantity" : 0,
  "rateTypeId" : 0,
  "removable" : true,
  "representationId" : 0,
  "resellerAddonCode" : "string",
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservedResourceId" : 0,
  "resourceId" : 0,
  "shortDescription" : "string",
  "startDate" : "string",
  "statusName" : "string",
  "totalInternalPrice" : 0.0,
  "turnOverValue" : 0.0,
  "type" : "string",
  "unitId" : 0,
  "vatRate" : 0.0
}

3.27.11. 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

Path

reservationId
required

Reservation id for which credit card authorisations will be fetched

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
creditCardAuthorisationId:0,
status:String,
type:String,
authorisedAmount:0.0,
availableAmount:0.0,
creationDate:String(date),
capturedAmount:0.0,
payerType:String)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/creditcardauthorisations
Example HTTP response
Response 200
{
  "authorisationStatus" : "string",
  "authorisedAmount" : 0.0,
  "availableAmount" : 0.0,
  "bankAccount" : {
    "currencyCode" : "string",
    "name" : "string"
  },
  "capturedAmount" : 0.0,
  "creationDate" : "string",
  "creditCardAuthorisationId" : 0,
  "payerType" : "string",
  "paymentMethod" : {
    "code" : "string",
    "name" : "string"
  },
  "type" : "string"
}

3.27.12. 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
required

The identifier of the reservation.

integer (int64)

Query

returnBill
optional

The instalments will be returned when the value is set to true

boolean

Query

returnCustomer
optional

The customer will be returned when the value is set to true

boolean

Query

returnCustomerStatus
optional

The customer status will be returned when the value is set to true

boolean

Query

returnInstalments
optional

The instalments will be returned when the value is set to true

boolean

Query

returnReservedResources
optional

The reserved resource will be returned when the value is set to true

boolean

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/details
Example HTTP response
Response 200
{
  "agentBill" : [ {
    "billLineType" : 0,
    "endDate" : "string",
    "multiplier" : 0,
    "name" : "string",
    "quantity" : 0,
    "resourceId" : 0,
    "startDate" : "string",
    "total" : 0.0,
    "value" : 0.0,
    "vatRate" : 0.0
  } ],
  "arrivalDate" : "string",
  "cancelDate" : "string",
  "categoryCode" : "string",
  "customer" : {
    "alternateName" : "string",
    "bicSwift" : "string",
    "birthDate" : "string",
    "customerId" : 0,
    "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" : 0,
        "default" : true,
        "translations" : [ {
          "language" : "string",
          "name" : "string"
        } ]
      },
      "district" : "string",
      "email" : "string",
      "exposeLocation" : true,
      "fax" : "string",
      "houseNumber" : "string",
      "houseNumberSuffix" : "string",
      "latitude" : 0.0,
      "longitude" : 0.0,
      "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",
        "title" : "string"
      } ]
    }
  },
  "customerBill" : [ {
    "billLineType" : 0,
    "endDate" : "string",
    "multiplier" : 0,
    "name" : "string",
    "quantity" : 0,
    "resourceId" : 0,
    "startDate" : "string",
    "total" : 0.0,
    "value" : 0.0,
    "vatRate" : 0.0
  } ],
  "customerStatus" : {
    "customerClusters" : [ {
      "clusterId" : 0,
      "description" : "string",
      "name" : "string"
    } ]
  },
  "departureDate" : "string",
  "distributionChannelCode" : "string",
  "distributionChannelId" : 0,
  "expectedArrivalDateTime" : "string",
  "expectedDepartureDateTime" : "string",
  "externalBookingReference" : "string",
  "infotexts" : [ {
    "description" : "string"
  } ],
  "instalments" : [ {
    "autopay" : true,
    "due" : 0.0,
    "dueDate" : "string",
    "issueDate" : "string",
    "payerType" : "string",
    "status" : "string",
    "taxValue" : 0.0,
    "term" : "string",
    "value" : 0.0
  } ],
  "modifiedDate" : "string",
  "parentId" : 0,
  "reservationCategoryId" : 0,
  "reservationDate" : "string",
  "reservationId" : 0,
  "reservationNumber" : "string",
  "reservedResources" : [ {
    "amenities" : [ {
      "amenityId" : 0,
      "categories" : [ {
        "code" : "string",
        "translations" : [ {
          "language" : "string",
          "name" : "string"
        } ]
      } ],
      "endDate" : "string",
      "metricDetail" : {
        "code" : "string",
        "metricId" : 0,
        "translations" : [ {
          "language" : "string",
          "name" : "string"
        } ]
      },
      "parentAmenityId" : 0,
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string"
      } ],
      "type" : "string"
    } ],
    "code" : "string",
    "description" : "string",
    "endDate" : "string",
    "impliesId" : 0,
    "imply" : true,
    "included" : true,
    "infotexts" : [ {
      "description" : "string"
    } ],
    "modifiedDate" : "string",
    "name" : "string",
    "offerType" : "string",
    "parentId" : 0,
    "preferences" : [ {
      "id" : 0,
      "type" : "string"
    } ],
    "price" : 0.0,
    "quantity" : 0,
    "rateType" : {
      "translations" : [ {
        "language" : "string",
        "name" : "string"
      } ]
    },
    "removable" : true,
    "reservationDate" : "string",
    "reservedResourceId" : 0,
    "resourceId" : 0,
    "shortDescription" : "string",
    "startDate" : "string",
    "status" : 0,
    "subjects" : [ {
      "maxAge" : 0,
      "quantity" : 0,
      "subjectId" : 0,
      "translations" : [ {
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "type" : "string"
    } ],
    "translations" : [ {
      "description" : "string",
      "language" : "string",
      "name" : "string",
      "shortDescription" : "string"
    } ],
    "type" : "string",
    "unit" : {
      "translations" : [ {
        "description" : "string",
        "language" : "string",
        "name" : "string",
        "shortDescription" : "string"
      } ],
      "unitId" : 0
    }
  } ],
  "resortId" : 0,
  "sendMethodId" : 0,
  "status" : 0,
  "statusValue" : "string",
  "supplierBookingReference" : "string",
  "tncSigned" : true,
  "tncSignedDate" : "string",
  "tncSigneeCustomerName" : "string",
  "validationStatusId" : 0
}

3.27.13. 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
required

Reservation id for which memo will be created for reservation

integer (int64)

Body

memoRequest
required

Memo for reservation which contain the memo detail

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/memos
Request body
{
  "memoCategoryId" : 0,
  "onCheckin" : true,
  "onInvoice" : true,
  "sensitive" : true,
  "text" : "string"
}
Example HTTP response
Response 200
{
  "content" : "string",
  "creationDate" : "string",
  "employeeId" : 0,
  "memoCategoryId" : 0,
  "memoId" : 0
}

3.27.14. 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

Path

reservationId
required

reservationId

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
memoId:0,
employeeId:0,
content:String,
creationDate:String(date))

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/memos
Example HTTP response
Response 200
{
  "content" : "string",
  "creationDate" : "string",
  "employeeId" : 0,
  "memoCategoryId" : 0,
  "memoId" : 0
}

3.27.15. 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

Path

reservationId
required

reservationId

integer (int64)

Query

filter
optional

Following fields can be used for filtering response.
For more information, check: Filtering

enum (
paymentMethod:String,
code:String,
paymentType:String,
paymentProvider:String,
minDaysBeforeArrival:0,
translations:String)

Responses
HTTP 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

Security
Type Name

oauth2

Example HTTP request
Request path
/maxxton/v1/reservations/0/paymentmethods
Example HTTP response
Response 200
{
  "code" : "string",
  "minDaysBeforeArrival" : 0,
  "paymentMethod" : "string",
  "paymentProvider" : "string",
  "paymentType" : "string",
  "translations" : [ {
    "language" : "string",
    "name" : "string"
  } ]
}

3.27.16. 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