Get all images for a unit

Sections

V1 docs (deprecated)API explorerGuidesChangelog
V1 docs (deprecated)
API explorer
Guides
Changelog

Theme switcher

Maxxton External API

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.

Base URL

Production:

https://api.maxxton.net

Language Box

Accommodation Types

A collection of similar units grouped together.

Endpoints

POST
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
POST
GET
POST
GET
GET
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
GET
POST
GET
GET
POST
POST
GET
GET
POST
POST
GET

AddOn

A product or extra that can be booked optionally in a reservation or will be added mandatory to the reservation. Examples of optional addons are: bedlinnen, breakfast, baby cot. Example of mandatory addons are: cleaning, tourist tax

Endpoints

GET
GET
GET
GET
GET
PUT
GET
GET
GET

Admin Organisation

A main level to funnel the companies, locations, employees, accounts and other properties that exclusively belongs to that Admin organisation.

Endpoints

POST
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
PUT

Allotment

The allocation of a certain number of accommodation types or units for a specific period or purpose per distribution channel.

Endpoints

GET
GET

Amenity

A feature or service provided to enhance the guest experience, such as a pool, gym, or Wi-Fi.

Endpoints

POST
GET
GET
GET

Authentication

Authenticate to get access to the API. Authentication details can be provided by the Maxxton client who would like to give access to their environment using the API.

Endpoints

POST

Brands

A distinctive name associated with a specific product or service.

Endpoints

GET
GET

Cash Clearance

The process of reconciling and recording cash transactions to ensure accurate financial records.

Endpoints

GET
GET
GET
GET
GET
GET

Contracts

A formal agreement outlining the terms and conditions between an owner and an organisation about renting his unit.

Endpoints

POST
DELETE
GET
GET
PUT
GET
GET

Countries

All available countries, the countries are configured in Maxxton.

Endpoints

GET
GET

Currency

The type of money used in financial transactions, such as USD or EUR.

Endpoints

GET
GET

Customer Status

A certain label that is given to a customer. This can be assigned automatically or manually.

Endpoints

GET
GET

Customers

An individual or entity that purchases or uses accommodations or services.

Endpoints

POST
GET
GET
GET
PUT
GET
PUT
GET
PUT
GET
GET
POST
GET
GET
POST
GET
GET

DistributionChannels

The sales channel through which products or services are delivered to customers.

Endpoints

GET
GET
GET
GET
GET
GET
GET

Employee

An individual working for an organization, responsible for various tasks or roles.

Endpoints

POST
GET
PUT

Events

When certain entities are changed this will result in an event. This event can be used to update/refresh the data in the external system.

Endpoints

GET

Facilities

A physical location or infrastructure used to support operations or services.

Endpoints

GET
GET

Groups

Grouping of certain entities such as marketing groups, location groups in Maxxton.

Endpoints

GET
GET

Housekeeping

A specific job or duty that needs to be done on an accommodation on a specified date and time.

Endpoints

GET
GET

Icals

Ical calendar file to show reservations made for a certain unit. Mostly used for owners to show the usage of their unit.

Endpoints

GET

Infotexts

A piece of informative text visible to the customer.

Endpoints

POST
GET

Languages

The choice of language for user interfaces, or communication within the system.

Endpoints

GET

Ledgers

A comprehensive record of all financial transactions, including accounts and balances.

Endpoints

GET
GET
GET
GET

Locations

A physical place or address where accommodations or services are provided like a location.

Endpoints

POST
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
POST
POST
GET

Locks

A lock will make the accommodationtype or unit unavailable to book because of a certain reason like maintenance.

Endpoints

GET

Memos

A remark or informative text added to an entity.

Endpoints

GET

Offer

A discount or additional product/service that can be added to a reservation.

Endpoints

POST
GET
GET
PUT
POST
GET
GET
PUT
POST
DELETE
GET
GET
GET
POST
GET
POST
POST
GET

Operations

Technical services which handles tasks to fix issues or maintenance in units.

Endpoints

GET
GET
GET

Owners

An individual or entity that holds a contractual agreement with the admin organization. Based on this agreement, the owner earns income when specific accommodations they control are utilized in reservations.

Endpoints

POST
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
POST
GET
GET
GET
POST
GET
GET
GET
GET
GET
PUT

Packages

Multiple add-ons which can be booked together.

Endpoints

GET
GET

Payment Term Set

Conditions like when and in how many times to pay the full reservation. The payment term sets will result in the instalments, with the actual amount to pay, when chosen in the reservation.

Endpoints

GET

Points Of Interests

Certain interesting features around the location such as cities, airports, theme parks.

Endpoints

GET
GET

Predefined Memo

A brief written message or note used for communication or record-keeping within the software.

Endpoints

GET

Rate Types

The category or classification of rates based on their application and currency such as BAR rate or tour operator rate.

Endpoints

GET
GET
GET

Region

A geographical area or division used for organizing and managing locations or data.

Endpoints

GET
GET

Rentability

The rules and conditions that define how an accommodation, product or services property can be booked or used. For example, the allowed arrival and departure date for an accommodation type.

Endpoints

GET
GET
GET

Representation

Triangle view of rentability, accommodation type, and distribution channel. Representations exist to connect a (set) of rentability rules to a (group) of distribution channels.

Endpoints

DELETE
GET
GET
PUT
POST
DELETE
GET

Resellers

An individual or entity that sells products or services on behalf of another company.

Endpoints

GET
GET
GET

Reservability

Actual count of available units per period or date without considering if it's allowed to arrive or depart on the certain date.

Endpoints

GET
GET
GET
GET
GET

Reservations

An arrangement to secure an accommodation or service for a specific time and date.

Endpoints

POST
POST
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
POST
GET
GET
GET
POST
GET
GET
GET
GET
POST
GET
GET
GET
GET
GET
POST
POST
POST
GET
POST
GET
POST
GET
DELETE
PUT
GET
GET
DELETE
GET
GET
PUT
POST
GET

Room Types

The classification of rooms based on their characteristics, such as bedroom, bathroom, or living area.

Endpoints

GET

Rooms

A distinct space within a unit provided for guests to stay.

Endpoints

GET
GET

Send Methods

Defines how to communicate with the customer.

Endpoints

GET

Subjects

A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.

Endpoints

GET

Suppliers

An integration with Maxxton to make it possible to to book external inventory from the Maxxton system

Endpoints

GET

Units

A place where guests stay, such as a hotel room, apartment, or vacation rental.

Endpoints

POST
GET
GET
PUT
GET
POST
DELETE
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
PUT
GET
PUT
POST
GET
POST
DELETE
GET
GET
GET
POST
GET

Create unit

Adds a new Unit. The details are to be added in request body. Note: The country field in mailAddress is not allowed while adding a unit.

Body Parameters

resourceIdinteger (int64)Required

Accommodationtype the unit applies to

addressobject

Show child attributes

codestring

Unique code of the unit

nrOfBathroomsnumber (double)
nrOfBedroomsinteger (int32)
translationsarray

Show child attributes

originstring

System the unit is created in

originIdstring

Identifier from the origin system

rentableUnitIdinteger (int64)
groupPriorityinteger (int32)

Response

200
Object
unit created without any error.

Response Attributes

unitIdinteger (int64)
accommodationAddressManagerIdinteger (int64)
accommodationMemoManagerIdinteger (int64)
archivedFromstring (date)
resourceIdinteger (int64)
brandIdinteger (int64)
capacityManagerIdinteger (int64)
choosableOnInternetboolean
codestring
concernIdinteger (int64)
costCenterIdinteger (int64)
dynamicManagerIdinteger (int64)
eventManagerIdinteger (int64)
excludeQuestionnaireStatsboolean
fileManagerIdinteger (int64)
genericMemoManagerIdinteger (int64)
groupPriorityinteger (int32)
imageManagerIdinteger (int64)
implicationManagerIdinteger (int64)
ledgerIdinteger (int64)
nrOfBathroomsnumber (double)
nrOfBedroomsinteger (int32)
originIdstring
pathstring
amenityManagerIdinteger (int64)
questionnaireStatsManagerIdinteger (int64)
rentableUnitIdinteger (int64)
resourceGroupIdinteger (int64)
resourceManagerIdinteger (int64)
roomCodestring
secondLedgerIdinteger (int64)
cleaningStatusstring
Enum values:
CLEANTO_BE_CLEANEDIN_PROGRESSCHECKEDPOSTPONEDOCCUPIED_CLEANTOUCH_UP
supervisorIdinteger (int64)
typestring
virtualboolean
vsiinteger (int64)
roomManagerIdinteger (int64)
contactManagerIdinteger (int64)
setupDatestring (date)
isSeasonalRuleExcludedboolean
cadastralIdstring
showOnPlanningChartboolean
translationsarray

Show child attributes

originstring
addressobject

details of the visit address of the user

Show child attributes

impliedObjectboolean
500
Object
Error occurred while creating unit.

POST

/maxxton/v2/units

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 curl --location 'https://api.maxxton.net/maxxton/v2/units' \ --data '{ "resourceId": 0, "address": { "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "countryId": 0, "dateEnd": "2025-06-10", "dateBegin": "2025-06-10", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "code": "string", "nrOfBathrooms": 0, "nrOfBedrooms": 0, "translations": [ { "languageId": 0, "language": "string", "name": "string", "description": "string", "description2": "string", "shortDescription": "string", "unitId": 0 } ], "origin": "string", "originId": "string", "rentableUnitId": 0, "groupPriority": 0 }'

Response

{
  "unitId": 0,
  "accommodationAddressManagerId": 0,
  "accommodationMemoManagerId": 0,
  "archivedFrom": "2025-06-10",
  "resourceId": 0,
  "brandId": 0,
  "capacityManagerId": 0,
  "choosableOnInternet": true,
  "code": "string",
  "concernId": 0,
  "costCenterId": 0,
  "dynamicManagerId": 0,
  "eventManagerId": 0,
  "excludeQuestionnaireStats": true,
  "fileManagerId": 0,
  "genericMemoManagerId": 0,
  "groupPriority": 0,
  "imageManagerId": 0,
  "implicationManagerId": 0,
  "ledgerId": 0,
  "nrOfBathrooms": 0,
  "nrOfBedrooms": 0,
  "originId": "string",
  "path": "string",
  "amenityManagerId": 0,
  "questionnaireStatsManagerId": 0,
  "rentableUnitId": 0,
  "resourceGroupId": 0,
  "resourceManagerId": 0,
  "roomCode": "string",
  "secondLedgerId": 0,
  "cleaningStatus": "CLEAN",
  "supervisorId": 0,
  "type": "string",
  "virtual": true,
  "vsi": 0,
  "roomManagerId": 0,
  "contactManagerId": 0,
  "setupDate": "2025-06-10",
  "isSeasonalRuleExcluded": true,
  "cadastralId": "string",
  "showOnPlanningChart": true,
  "translations": [
    {
      "language": "string",
      "name": "string",
      "description": "string",
      "description2": "string",
      "shortDescription": "string"
    }
  ],
  "origin": "string",
  "address": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-10",
    "dateBegin": "2025-06-10",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "impliedObject": true
}

Get all units

Get a page with units. The records can be filtered based on unit object.It also supports pageable.

Query Parameters

returnWorkOrderUnitsboolean

Work order type units are not returned by default. To get work order type units, this request parameter can be used

unitIdsarray
pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
unitId:0,
type:String,
resourceId:0,
code:String,
nrOfBathrooms:0.0,
path:String,
excludeQuestionnaireStats:true,
choosableOnInternet:true,
resourceGroupId:0,
cleaningStatus:String,
roomCode:String,
nrOfBedrooms:0,
archivedFrom:2025-06-10,
vsi:0,
origin:String,
originId:String,
energyLabelRegistrationNumber:String,
previousPmsId:String,
rentableUnitId:0For...

Response

200
Object
The request is completed successfully without any errors

Response Attributes

totalElementsinteger (int64)

Total number of elements available in the whole response.

totalPagesinteger (int32)

Total number of pages the response has.

firstboolean

Boolean field to specify if its the first page or not.

lastboolean

Boolean field to specify if its the last page or not.

sizeinteger (int32)

Size of the current page.

contentarray

Show child attributes

numberinteger (int32)

Page number currently accessed.

sortarray

Show child attributes

numberOfElementsinteger (int32)

Total number of elements in the current page.

emptyboolean
500
Object
Error occurred while fetching units.

GET

/maxxton/v2/units?returnWorkOrderUnits=&unitIds=&page=&size=&sort=&filter=

Select
1 curl --location 'https://api.maxxton.net/maxxton/v2/units'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "unitId": 0,
      "resourceId": 0,
      "code": "string",
      "nrOfBathrooms": 0,
      "path": "string",
      "excludeQuestionnaireStats": true,
      "choosableOnInternet": true,
      "resourceGroupId": 0,
      "cleaningStatus": "CLEAN",
      "roomCode": "string",
      "nrOfBedrooms": 0,
      "archivedFrom": "2025-06-10",
      "vsi": 0,
      "address": {
        "addressId": 0,
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "boxNumber": "string",
        "houseNumberSuffix": "string",
        "zipCode": "string",
        "poBox": "string",
        "poBoxZipcode": "string",
        "poBoxCity": "string",
        "city": "string",
        "countryId": 0,
        "municipality": "string",
        "mobilePhone2": "string",
        "latitude": 0,
        "longitude": 0,
        "email": "string",
        "stateId": 0,
        "mobilePhone": "string",
        "houseNumber": "string",
        "district": "string",
        "privatePhone": "string",
        "workPhone": "string",
        "exposeLocation": true,
        "dateEnd": "2025-06-10",
        "dateBegin": "2025-06-10",
        "fax": "string",
        "alternateContactPerson": "string",
        "accuracy": "ROOFTOP",
        "country": {
          "countryId": 0,
          "priority": 0,
          "translations": [
            {
              "name": "string",
              "language": "string"
            }
          ],
          "default": true,
          "code": "string"
        }
      },
      "translations": [
        {
          "language": "string",
          "name": "string",
          "description": "string",
          "description2": "string",
          "shortDescription": "string"
        }
      ],
      "origin": "string",
      "originId": "string",
      "energyLabelRegistrationNumber": "string",
      "previousPmsId": "string",
      "rentableUnitId": 0
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Get unit

Get a single unit based on a specific unit id.

Query Parameters

returnWorkOrderUnitsboolean

Work order type units are not returned by default. To get work order type units, this request parameter can be used

Path Parameters

unitIdinteger (int64)Required

Unit id of the unit

Response

200
Object
The request is completed successfully without any errors

Response Attributes

unitIdinteger (int64)

Unique id associated with each unit

resourceIdinteger (int64)

Unique id associated with the accommodationtype to which the unit belong

codestring

Unique code associated with each unit

nrOfBathroomsnumber (double)

Total number of bathrooms that a unit possess

pathstring

The field denotes where the unit is located

excludeQuestionnaireStatsboolean

If the questionnaire is to be excluded then the checkbox is selected in the system and the value is true else false

choosableOnInternetboolean

If this is selected then the unit will be available in the dropdownbox on internet, then the value is true else

resourceGroupIdinteger (int64)

Unique id associated with the group of accommodationtype to which the unit belongs

cleaningStatusstring

Status of clean is defined i.e

Enum values:
CLEANTO_BE_CLEANEDIN_PROGRESSCHECKEDPOSTPONEDOCCUPIED_CLEANTOUCH_UP
roomCodestring

Unique code associated with each room which lies in the unit

nrOfBedroomsinteger (int64)

Total number of bedrooms in the unit

archivedFromstring (date)

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

vsiinteger (int64)

Vsi value of unit

addressobject

Show child attributes

translationsarray

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

Show child attributes

originstring
originIdstring
energyLabelRegistrationNumberstring

Energy Label RegistrationNumber associated with each unit

previousPmsIdstring

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

rentableUnitIdinteger (int64)

GET

/maxxton/v2/units/{unitId}?returnWorkOrderUnits=

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/units/{unitId}'

Response

{
  "unitId": 0,
  "resourceId": 0,
  "code": "string",
  "nrOfBathrooms": 0,
  "path": "string",
  "excludeQuestionnaireStats": true,
  "choosableOnInternet": true,
  "resourceGroupId": 0,
  "cleaningStatus": "CLEAN",
  "roomCode": "string",
  "nrOfBedrooms": 0,
  "archivedFrom": "2025-06-10",
  "vsi": 0,
  "address": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-10",
    "dateBegin": "2025-06-10",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "translations": [
    {
      "language": "string",
      "name": "string",
      "description": "string",
      "description2": "string",
      "shortDescription": "string"
    }
  ],
  "origin": "string",
  "originId": "string",
  "energyLabelRegistrationNumber": "string",
  "previousPmsId": "string",
  "rentableUnitId": 0
}

Update unit

Updates a single unit

Path Parameters

unitIdinteger (int64)Required

Unit id of the unit

Body Parameters

cleaningStatusstring
translationsarray

Show child attributes

addressobject

Show child attributes

codestring

Unique code of the unit

nrOfBathroomsnumber (double)
nrOfBedroomsinteger (int32)
resourceIdinteger (int64)

Accommodationtype the unit applies to

originIdstring

Identifier from the origin system

originstring

System the unit is created in

rentableUnitIdinteger (int64)

Response

204
Object
The request is completed successfully without any errors
500
Object
Error occurred while updating the unit.

PUT

/maxxton/v2/units/{unitId}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/units/{unitId}' \ --data '{ "cleaningStatus": "string", "translations": [ { "languageId": 0, "language": "string", "name": "string", "description": "string", "description2": "string", "shortDescription": "string", "unitId": 0 } ], "address": { "addressId": 0, "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "dateEnd": "2025-06-10", "dateBegin": "2025-06-10", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "code": "string", "nrOfBathrooms": 0, "nrOfBedrooms": 0, "resourceId": 0, "originId": "string", "origin": "string", "rentableUnitId": 0 }'

Response

The request is completed successfully without any errors

Allotments

Endpoints

GET

Amenitylinks

Endpoints

POST
DELETE
GET
GET
PUT

Capacities

Endpoints

GET

Children

Endpoints

GET

Contracts

A formal agreement outlining the terms and conditions between an owner and an organisation about renting his unit.

Endpoints

GET

Details

Endpoints

GET
GET

Doorlocks

Endpoints

GET

Doorlocktypes

Endpoints

GET

Dynamicfields

Endpoints

GET
PUT

Images

Endpoints

GET
PUT
POST

Get all images for a unit

Get a page with images to a specific uint. The records can be filtered based on the image object.It also supports pageable.

Query Parameters

pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
fileName:String,
imageId:0,
startDate:2025-06-10,
endDate:2025-06-10,
mimeType:String,
version:0,
url:String,
uploadDate:2025-06-10T07:59:10.334Z,
imageType:String,
imageOrientation:String,
modifiedDate:2025-06-10T07:59:10.334ZFor more information, check: Filtering

Path Parameters

unitIdinteger (int64)Required

Unit id for which images are to be fetched

Response

200
Object
The request is completed successfully without any errors

Response Attributes

totalElementsinteger (int64)

Total number of elements available in the whole response.

totalPagesinteger (int32)

Total number of pages the response has.

firstboolean

Boolean field to specify if its the first page or not.

lastboolean

Boolean field to specify if its the last page or not.

sizeinteger (int32)

Size of the current page.

contentarray

Show child attributes

numberinteger (int32)

Page number currently accessed.

sortarray

Show child attributes

numberOfElementsinteger (int32)

Total number of elements in the current page.

emptyboolean
500
Object
Error occurred while fetching unit images.

GET

/maxxton/v2/units/{unitId}/images?page=&size=&sort=&filter=

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/units/{unitId}/images'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "fileName": "string",
      "imageId": 0,
      "startDate": "2025-06-10",
      "endDate": "2025-06-10",
      "mimeType": "IMAGE_AVIF",
      "version": 0,
      "url": "string",
      "urls": {},
      "uploadDate": "2025-06-10T07:59:10.319Z",
      "imageType": "LOGO",
      "imageOrientation": "string",
      "modifiedDate": "2025-06-10T07:59:10.319Z",
      "sequenceNumber": 0,
      "translations": [
        {
          "name": "string",
          "description": "string",
          "language": "string"
        }
      ],
      "tags": [
        {
          "tagId": 0,
          "name": "string"
        }
      ]
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Update image of a unit

Updates details of existing image.

Path Parameters

imageIdinteger (int64)Required

imageId id of the image to be updated

unitIdinteger (int64)Required

unitId id of the Unit

Body Parameters

startDatestring (date)
endDatestring (date)
imageOrientationstring
imageTypestring
Enum values:
LOGOFLOORPLANROADMAPINTERIOREXTERIORMUGSHOTPICTUREMAPIMPRESSIONUNKNOWN
... 6 other enums
sequenceNumberinteger (int64)
tagsarray

Show child attributes

translationsarray

Show child attributes

versioninteger (int64)

Response

200
Object
Image is updated without any error.

Response Attributes

fileNamestring

Name of the file uploaded

imageIdinteger (int64)

Unique id associated with each image

startDatestring (date)

Date from which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd).

endDatestring (date)

Date till which the image will be visible.Date should be added using ISO 8601 standard(yyyy-MM-dd).

mimeTypestring

Type of the image. Possible values that can be encountered are:IMAGE_JPG, IMAGE_JPEG, IMAGE_GIF, IMAGE_PNG, IMAGE_SVG, IMAGE_ICO, IMAGE_TIFF, UNKNOWN

Enum values:
IMAGE_AVIFIMAGE_BMPIMAGE_HEICIMAGE_HEIFIMAGE_ICOIMAGE_JPGIMAGE_JXLIMAGE_JPEGIMAGE_GIFIMAGE_PNG
... 5 other enums
versioninteger (int64)

Version of the image

urlstring

Url of the image

urlsobject

Different urls related to the image based on the size

uploadDatestring (date-time)

Date when the image was uploaded. The format of the date will be YYYY-MM-DDThh:mm:ss

imageTypestring

Type of image ex: if the image depicts the exterior of the accommodationtype/unit/location then it gives 'EXTERIOR', if the image denotes the interior of the accommodationtype/unit/location the value of this field is 'INTERIOR'

Enum values:
LOGOFLOORPLANROADMAPINTERIOREXTERIORMUGSHOTPICTUREMAPIMPRESSIONUNKNOWN
... 6 other enums
imageOrientationstring

Orientation of the image i.e horizontal, vertical etc

modifiedDatestring (date-time)

date when the image was last modified. The format of the date will be YYYY-MM-DDThh:mm:ss.

sequenceNumberinteger (int32)

Sequence in which the image will be visible to the user

translationsarray

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

Show child attributes

tagsarray

Details related to the tags attached to the image

Show child attributes

500
Object
Error occurred while updating image.

PUT

/maxxton/v2/units/{unitId}/images/{imageId}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/units/{unitId}/images/{imageId}' \ --data '{ "startDate": "2025-06-10", "endDate": "2025-06-10", "imageOrientation": "string", "imageType": "LOGO", "sequenceNumber": 0, "tags": [ { "tagId": 0, "name": "string" } ], "translations": [ { "languageId": 0, "name": "string", "description": "string", "language": "string" } ], "version": 0 }'

Response

{
  "fileName": "string",
  "imageId": 0,
  "startDate": "2025-06-10",
  "endDate": "2025-06-10",
  "mimeType": "IMAGE_AVIF",
  "version": 0,
  "url": "string",
  "urls": {},
  "uploadDate": "2025-06-10T07:59:10.319Z",
  "imageType": "LOGO",
  "imageOrientation": "string",
  "modifiedDate": "2025-06-10T07:59:10.319Z",
  "sequenceNumber": 0,
  "translations": [
    {
      "name": "string",
      "description": "string",
      "language": "string"
    }
  ],
  "tags": [
    {
      "tagId": 0,
      "name": "string"
    }
  ]
}

Upload

Endpoints

POST

Implies

Endpoints

GET

Locks

A lock will make the accommodationtype or unit unavailable to book because of a certain reason like maintenance.

Endpoints

POST
DELETE
GET
GET

Rooms

A distinct space within a unit provided for guests to stay.

Endpoints

GET

Search

Endpoints

POST

Workorders

Endpoints

GET