Maxxton External API

Sections

upload image for a unit

Path Parameters

unitIdinteger Required

Body Parameters

filestring

Response

200
Object
The request is completed successfully without any errors

Response Attributes

fileNamestring

Name of the file uploaded

imageIdinteger

Unique id associated with each image

startDatestring

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

endDatestring

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

Version of the image

urlstring

Url of the image

urlsobject

Different urls related to the image based on the size

uploadDatestring

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 when the image was last modified. The format of the date will be YYYY-MM-DDThh:mm:ss.

sequenceNumberinteger

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 uploading unit.

POST

/

Select
1

Response