Retrieve Supported Facilities

This endpoint allows you to retrieve a list of supported facilities for a property and room. The response provides details about the facilities available at the property, including what instances are required or optional for each facility.

---

Endpoint

GET

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/facilities/retrieveFacilities

---

Response

{
   "Status": "Success",
   "Data": {
"property": [
       {
           "facility_id": 2,
           "facility_name": "parking fee required",
           "instances": {
               "required": [
                   "parking_details",
                   "payment_details"
               ],
               "optional": []
           },
           "multiple_instances": true
       },
       {
           "facility_id": 3,
           "facility_name": "restaurant",
           "instances": {
               "required": [
                   "restaurant_details"
               ],
               "optional": [
                   "temporarily_closed_details",
                   "schedule_details"
               ]
           },
           "multiple_instances": true
       },
       {
           "facility_id": 5,
           "facility_name": "roomservice",
           "instances": {
               "required": [],
               "optional": []
           },
           "multiple_instances": false
       },
       {
           "facility_id": 6,
           "facility_name": "meetingbanquet facilities",
           "instances": {
               "required": [],
               "optional": []
           },
           "multiple_instances": false
       },
       {
           "facility_id": 7,
           "facility_name": "bar",
           "instances": {
               "required": [],
               "optional": [
                   "temporarily_closed_details"
               ]
           },
           "multiple_instances": false
       },
       {
           "facility_id": 8,
           "facility_name": "twenty four hour front desk",
           "instances": {
               "required": [],
               "optional": []
           },
           "multiple_instances": false
       }
      ],
"room": [
           {
               "facility_id": 1,
               "facility_name": "coffeetea maker",
               "accepted_value": "boolean"
           },
           {
               "facility_id": 2,
               "facility_name": "internet facilities",
               "accepted_value": "boolean"
           },
           {
               "facility_id": 3,
               "facility_name": "minibar",
               "accepted_value": "boolean"
           }
	]
    },
   "Message": "Property Facility data retrieved successfully"
}

Success Response Body Elements

Indicates the result of the API call.

Will be "Success" for successful operations.

---

Data array

An array containing data related to the successful image creation. This typically includes identifiers for the created images.

---

Message string

Provides a brief message about the outcome. Here, it states "Successfully fetch details," confirming that the requested information was retrieved.

---

property array

This array contains details about the facilities available at the property level (e.g., parking, restaurant, bar, etc.).

Each facility object contains the following fields:

facility_id string

A unique identifier for the facility.

facility_name string

The name of the facility.

Example: "facility_name": "parking fee required"

instances object

Contains required and optional details for the facility.

required array

A list of attributes that must be provided for this facility.

optional array

A list of optional attributes that can be provided but are not mandatory.

Example:

"instances": {
  "required": ["parking_details", "payment_details"],
  "optional": []
}

multiple_instances boolean

Indicates whether multiple instances of this facility can be available (for example, multiple restaurants or multiple parking spaces).

Example: "multiple_instances": true

---

room array

This array contains details about the facilities available within individual rooms.

Each room facility object contains the following fields:

facility_id string

A unique identifier for the room facility.

Example: "facility_id": "1"

facility_name string

The name of the facility available in the room (for example, coffee/tea maker, minibar).

Example: "facility_name": "coffeetea maker"

accepted_value string

The type of value expected for this room facility (usually a boolean indicating if the facility is available or not).

Example: "accepted_value": "boolean"

---

Errors

Sample Error Response

{
   "success": false,
   "message": "Something went wrong"
}

---

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.