Sending License Information of Room

This endpoint allows you to to submit license information related to a specific room in a hotel.


Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/room/license/sending
-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

hotel_id string (Required)

Specifies the hotel ID for the property.


channel_hotel_id string (Required)

Specifies the channel-specific hotel ID for the property.


room_id string (Required)

This field specifies the unique identifier for the room associated with the property.

content_data array (Required)

This array contains the details about the property license exception. Each entry in the array represents a field and its corresponding value.

name string (Required)

Specifies the name of the field to be included in the property license exception data.

value string (Required)

Specifies the value corresponding to the exception type.

variant_id integer (Required)

This field specifies the ID of the license variant that should be applied for the request.


Sample Request

{
    "hotel_id": "new1", 
    "channel_hotel_id": "12926584", 
    "room_id": "123",
    "content_data": [ 
        {
            "name": "exception_type",
            "value": "dependent_room"
        }
    ],
    "variant_id": 321 
}

Response

Sample Success Response

{
    "Status": "Success",
    "Data": {
        "success": 1
    },
    "Message": "Room License sending successfully"
}

Success Response Body Elements

Status string

Indicates the result of the API call.


Message string

A message describing the outcome.


Data object

Contains the actual response data.


Errors

Sample Error Response 1 - Validation Error Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "400",
            "ShortText": "hotel_id: Invalid HotelCode ('')"
        },
        {
            "Code": "572",
            "ShortText": "channel_hotel_id - is invalid or not found!"
        },
        {
            "Code": "941",
            "ShortText": "Invalid Room Id"
        },
        {
            "Code": "620",
            "ShortText": "content_data is invalid or not found!"
        },
        {
            "Code": "622",
            "ShortText": "variant_id is invalid or not found!"
        }
    ],
    "Message": ""
}

Sample Error Response 2 - Booking.com Error Response

{
    "Status": "Fail",
    "Errors": [],
    "Message": "This variant is not eligible for the given owner"
}
{
    "Status": "Success",
    "Data": {
        "success": 1
    },
    "Message": "Room License sending successfully"
}

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?