Retrieve Hotelier Message

This endpoint allows you to fetch the current messages set by the hotelier for a specific property.


Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/retrieveHotelierMessage
-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": {
       "hotelier_messages": [
           {
               "id": 454064949,
               "language_code": "en-gb",
               "message_type": "owner_info",
               "message": "Our owner is not available for 15 days"
           }
       ]
   },
   "Message": "Property Hotelier-Message Fetched Successfully",
   "Ruid": "023ae3a7-d4dd-4cda-9a90-08144d989dc3"
}

2nd

{
   "Status": "Success",
   "Data": {
       "hotelier_messages": []
   },
   "Message": "Property Hotelier-Message Fetched Successfully",
   "Ruid": "023ae3a7-d4dd-4cda-9a90-08144d989dc3"
}

Success Response Body Elements

Status string

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


Data object

Contains the main content of the response, specifically relevant information fetched by the API.

hotelier_messages array

A list of messages from the hotelier. Each message contains details such as:

id integer

A unique identifier for the message.

language_code string

Indicates the language of the message.

message_type string

Classifies the type of message.

For example,owner_info

message string

The actual content of the message.

For example, "Our owner is not available for 15 days"


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": ""
}

Sample Error Response 3

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Access denied",
  "Ruid": "xxxxxx"
}

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.

Last updated

Was this helpful?