Skip to main content

RoomsResponse

Response containing room data

rooms object

Room connection wrapper with pagination

rooms object[]

List of room records

  • Array [
  • codestring

    Room code

    roomData object

    Complete room data

    codestring

    Room code

    roomCodestring

    Provider-specific room code

    sourcestring

    Room source/provider

    namestring

    Room name

    maxOccupancyinteger

    Maximum occupancy

    bedTypestring

    Type of bed

    sizeSqMinteger

    Room size in square meters

    texts object[]

    Room descriptions in different languages

  • Array [
  • typestring

    Type of text (e.g., description, shortDescription)

    languageCodestring

    ISO 639-1 language code

    textstring

    Text content

  • ]
  • images object[]

    Room images

  • Array [
  • codestring

    Image code

    urlstring

    Image URL

    orderinteger

    Display order

    mediaTypestring

    Type of media

    captionstring

    Image caption

  • ]
  • occupancy object

    Occupancy details

    adultsinteger

    Number of adults

    childreninteger

    Number of children

    totalinteger

    Total occupancy

    beds object[]

    Bed information

  • Array [
  • typestring

    Bed type

    countinteger

    Number of beds

  • ]
  • createdAtstring<date-time>

    Record creation timestamp

    updatedAtstring<date-time>

    Record last update timestamp

  • ]
  • countinteger

    Total number of rooms matching the query

    tokenstring

    Pagination token for retrieving the next page

    errors object[]

    Array of errors encountered during processing

  • Array [
  • codestring

    Error code identifier

    typestring

    Error type category

    Possible values: [CLIENT, SERVER]

    descriptionstring

    Human-readable error description

  • ]
  • RoomsResponse
    {
    "rooms": {
    "rooms": [
    {
    "code": "string",
    "roomData": {
    "code": "string",
    "roomCode": "string",
    "source": "string",
    "name": "string",
    "maxOccupancy": 0,
    "bedType": "string",
    "sizeSqM": 0,
    "texts": [
    {
    "type": "string",
    "languageCode": "string",
    "text": "string"
    }
    ],
    "images": [
    {
    "code": "string",
    "url": "string",
    "order": 0,
    "mediaType": "string",
    "caption": "string"
    }
    ],
    "occupancy": {
    "adults": 0,
    "children": 0,
    "total": 0
    },
    "beds": [
    {
    "type": "string",
    "count": 0
    }
    ]
    },
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "count": 0,
    "token": "string"
    },
    "errors": [
    {
    "code": "string",
    "type": "CLIENT",
    "description": "string"
    }
    ]
    }