Retrieve Property Profile

This endpoint allows you to retrive the property profile.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/retrieveProfile

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.
Content-Type	string	Yes	Must be set to application/json.

---

Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.

---

channel_hotel_id string (Required)

The unique id for the hotel on the specific channel.

---

Sample Request

{
   "hotel_id": "NT7",
   "channel_hotel_id": "12837615"
}

---

Response

Sample Success Response

{
   "Status": "Success",
   "Data": {
       "host_location": "onsite",
       "name_or_company": "test-use-demo",
       "renting_date": "2024-10-11",
       "renovating_date": "2024-10-12",
       "built_date": "2024-10-09",
       "is_company_profile": 1
   },
   "Message": "Property Profile Details Fetched Successfully",
   "Ruid": "91e769ab-592a-48d5-9820-9233d9ef75b8"
}

Success Response Body Elements

Status string

Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.

---

Data array

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

host_location string

Specifies the location type of the host.

name_or_company string

The name of the hotel or company. This field is optional and can be used for branding purposes or internal identification.

renting_date string

The date when the property will be available for rent.

renovating_date string

The date when renovations are expected to be completed.

built_date string

The date when the property was built.

is_company_profile integer

Indicates whether the profile is for a company.

---

Message string

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

---

Ruid string

A unique request identifier.

UUID format

---

Errors

Sample Error Response 1

{
   "Errors": [
       {
           "Code": "400",
           "ShortText": "HotelCode: Invalid HotelCode ('NT711')"
       }
   ],
   "Status": "Fail",
  "Ruid": ""
}

Sample Error Response 2

{
   "Errors": [
       {
           "Code": "573",
           "ShortText": "channel-mapping not found for this property!"
       }
   ],
   "Status": "Fail",
  "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 associated with the error code.

For example, "channel-mapping not found for this property!"

---

Message string

A message providing more information about the error.