Room Meta API

This endpoint allows users to handle requests related to room metadata. It provides information about room attributes, configurations, and supports various operations such as retrieving or updating room data.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/room/meta

Header

-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json

Header	Type	Required	Description
app-id	string	Yes	Your application ID. Required for authentication.
Authorization	string	Yes	Your API key. for authorization. Required for authentication.
Content-Type	string	Yes	Must be set to application/json.

---

Attributes

language_code string (Optional)

Specifies the language to retrieve the unit's metadata.

Default value: EN_GB

Accepts the values listed in the below table:

SN	Language Name	Language Code
1	English (UK)	EN_GB
2	English (US)	EN_US
3	German	DE
4	Dutch	NL
5	French	FR
6	Spanish	ES
7	Spanish (Argentina)	ES_AR
8	Spanish (Mexico)	ES_MX
9	Catalan	CA
10	Italian	IT
11	Portuguese (Portugal)	PT_PT
12	Portuguese (Brazil)	PT_BR
13	Norwegian	NO
14	Finnish	FI
15	Swedish	SV
16	Danish	DA
17	Czech	CS
18	Hungarian	HU
19	Romanian	RO
20	Japanese	JA
21	Chinese (Simplified)	ZH_CN
22	Chinese (Traditional)	ZH_TW
23	Polish	PL
24	Greek	EL
25	Russian	RU
26	Turkish	TR
27	Bulgarian	BG
28	Arabic	AR
29	Georgian	KA
30	Korean	KO
31	Hebrew	HE
32	Latvian	LV
33	Ukrainian	UK
34	Indonesian	ID
35	Malay	MS
36	Thai	TH
37	Estonian	ET
38	Croatian	HR
39	Lithuanian	LT
40	Slovak	SK
41	Serbian	SR
42	Slovenian	SL
43	Vietnamese	VI
44	Tagalog	TL
45	Icelandic	IS
46	Hindi	HI

---

Sample Request

{
   "language_code": "EN_GB"
}

---

Response

Sample Success Response

NOTE

This is sample response, please use the API to get exact data.

{
    "Status": "Success",
    "Data": {
        "language_code": "EN_GB",
        "unit_types": [
            {
                "unit_type_id": 1,
                "unit_type_name": "Apartment",
                "is_multi_room": true,
                "is_active": true,
                "valid_property_categories": [
                    201,
                    202,
                    204,
                    205,
                    206,
                    207,
                    217,
                    218,
                    219,
                    220,
                    221,
                    226,
                    227,
                    229,
                    230,
                    231,
                    232,
                    233,
                    234,
                    235
                ],
                "suggested_unit_names": [
                    {
                        "unit_name_id": 9,
                        "unit_name": "Apartment"
                    },
                    {
                        "unit_name_id": 41,
                        "unit_name": "Apartment with Balcony"
                    },
                    {
                        "unit_name_id": 7144403,
                        "unit_name": "Three-Bedroom Premium Apartment with Resort View"
                    }
                ]
            },
            {
                "unit_type_id": 2,
                "unit_type_name": "Presidential Suite",
                "is_multi_room": false,
                "is_active": false,
                "valid_property_categories": [
                    201,
                    202,
                    203,
                    204,
                    205,
                    206,
                    207,
                    208,
                    209,
                    210,
                    212,
                    213,
                    214,
                    215,
                    216,
                    217,
                    218,
                    219,
                    220,
                    221,
                    222,
                    224,
                    225,
                    226,
                    227,
                    228,
                    229,
                    230,
                    231,
                    232,
                    233,
                    234,
                    235
                ],
                "suggested_unit_names": []
            },
            {
                "unit_type_id": 39,
                "unit_type_name": "Large private room",
                "is_multi_room": false,
                "is_active": true,
                "valid_property_categories": [
                    201,
                    202,
                    203,
                    204,
                    205,
                    206,
                    207,
                    208,
                    209,
                    210,
                    212,
                    213,
                    214,
                    215,
                    216,
                    217,
                    218,
                    219,
                    220,
                    221,
                    222,
                    223,
                    224,
                    225,
                    226,
                    227,
                    228,
                    229,
                    230,
                    231,
                    232,
                    233,
                    234,
                    235
                ],
                "suggested_unit_names": []
            }
        ],
        "unit_names": [
            {
                "unit_name_id": 9,
                "unit_name": "Apartment"
            },
            {
                "unit_name_id": 41,
                "unit_name": "Apartment with Balcony"
            },
            {
                "unit_name_id": 12458,
                "unit_name": "Three-Bedroom Villa"
            },
            {
                "unit_name_id": 14845,
                "unit_name": "Superior Villa"
            },
            {
                "unit_name_id": 20710,
                "unit_name": "Standard Villa"
            },
            {
                "unit_name_id": 24616,
                "unit_name": "Deluxe Villa"
            },
            {
                "unit_name_id": 28588,
                "unit_name": "Villa with Garden View"
            },
            {
                "unit_name_id": 32174,
                "unit_name": "Villa with Private Pool"
            },
            {
                "unit_name_id": 62574,
                "unit_name": "Villa with Sea View"
            },
            {
                "unit_name_id": 3656,
                "unit_name": "Mobile Home"
            },
            {
                "unit_name_id": 57818,
                "unit_name": "Caravan"
            },
            {
                "unit_name_id": 160170,
                "unit_name": "Tent"
            },
            {
                "unit_name_id": 6685224,
                "unit_name": "Empty lot"
            }
        ],
        "bed_types": [
            {
                "bed_type_id": 1,
                "bed_type_name": "Single bed",
                "bed_type_description": "90-130 cm wide",
                "bed_type_description_imperial": "35-51 inches wide",
                "is_active": true
            },
            {
                "bed_type_id": 2,
                "bed_type_name": "Double bed",
                "bed_type_description": "131-150 cm wide",
                "bed_type_description_imperial": "52-59 inches wide",
                "is_active": true
            },
            {
                "bed_type_id": 3,
                "bed_type_name": "Extra-large double bed (Super-king size)",
                "bed_type_description": "181-210 cm wide",
                "bed_type_description_imperial": "71-82 inches wide",
                "is_active": true
            },
            {
                "bed_type_id": 4,
                "bed_type_name": "Bunk bed",
                "bed_type_description": "Variable Size",
                "bed_type_description_imperial": "Variable Size",
                "is_active": true
            },
            {
                "bed_type_id": 5,
                "bed_type_name": "Sofa bed",
                "bed_type_description": "Variable Size",
                "bed_type_description_imperial": "Variable Size",
                "is_active": true
            },
            {
                "bed_type_id": 6,
                "bed_type_name": "Large bed (King size)",
                "bed_type_description": "151-180cm wide",
                "bed_type_description_imperial": "60-70 inches wide",
                "is_active": true
            },
            {
                "bed_type_id": 7,
                "bed_type_name": "Futon Mat",
                "bed_type_description": "Variable Size",
                "bed_type_description_imperial": "Variable Size",
                "is_active": true
            },
            {
                "bed_type_id": 8,
                "bed_type_name": "Double bunk bed",
                "bed_type_description": "Double or larger",
                "bed_type_description_imperial": "Double or larger",
                "is_active": false
            }
        ]
    },
    "Message": "Property Pending Images Fetched Successfully",
    "Ruid": "3913bac3-d6ae-4793-8cad-5db1844dbc73"
}

Success Response Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

---

Data object

Contains the response payload

language_code string

Specifies the language code used to return the unit's metadata, for example, "EN_GB".

---

unit_types array

A list of objects, each representing a specific unit type.

unit_type_id integer

The unique ID for the unit type.

Use this value when creating or updating unit.

unit_type_name string

The name of the unit type (for example, "Apartment").

Human-readable representation of the ID.

is_multi_room boolean

Specifies if the unit type is of muti-room or mono-room type (true or false).

is_active boolean

A flag indicating if the unit type is currently active.

Active unit types can be used in the create and update requests, inactive types are read-only.

valid_property_categories array

A list of valid property category IDs associated with the unit type.

suggested_unit_names array

A list of suggested unit names with IDs.

---

unit_names array

A list of objects, each representing a different unit name.

unit_name_id integer

The unique ID for the unit name.

Use this value when creating or updating units.

unit_name string

The name of the unit (for example, "Apartment").

Human-readable representation of the ID.

---

bed_types array

A list of objects, each representing a specific bed type.

bed_type_id integer

The unique ID for the bed type.

Use this value when creating or updating units.

bed_type_name string

The name of the bed type (for example, "Single bed").

Human-readable representation of the ID.

bed_type_description string

The description of the bed type (for example, "90-130 cm wide").

bed_type_description_imperial string

The description of the bed type in imperial units (for example, "35-51 inches wide").

is_active boolean

A flag indicating if the bed type is currently active.

Active bed types can be used in the create and update requests, inactive types are read-only.

---

Ruid string

A unique identifier for tracking the request.

---

Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.

Errors

Sample Error Response 1

When you pass invalid language_code

{
   "Status": "Fail",
   "Errors": [
       {
           "Code": "780",
           "ShortText": "language_code is invalid"
       }
   ],
   "Message": "",
   "Ruid": ""
}

---

Error Response Body Elements

Status string

Indicates the result of the API call, which will be always "Fail" in case of an error response.

---

Error array

Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:

Code string

Specific error code that helps identify the type of error.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.

---

Message string

A message providing more information about the error.

---

Ruid string

A unique identifier for tracking the request.