Sending License Information of Property

This endpoint allows you send property license information for a specific hotel.


Endpoint

POST

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


content_data array (Required)

This array contains the actual property license details that need to be sent. Each entry in the array includes a specific field and its corresponding value.

name string (Required)

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

value string (Required)

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


variant_id integer (Required)

Specifies the ID of the license variant that should be applied for this request. This field is required to indicate which license variant's data is being sent.


Sample Request

{
    "hotel_id": "new1",
    "channel_hotel_id": "12926584", 
    "content_data": [ 
        {
            "name": "number",
            "value": "FR-AB-120027016"
        },
        {
            "name": "license_holder_company_name",
            "value": "test"
        },
        {
            "name": "street_name",
            "value": "abc"
        },
        {
            "name": "street_number",
            "value": "123"
        },
        {
            "name": "additional_address_info",
            "value": "def"
        },
        {
            "name": "residence_type",
            "value": "other"
        }
    ],
    "variant_id": 320
}

Response

Sample Success Response

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

Success Response Body Elements

Status string

Specifies the overall status of the API request. In this case, it indicates that the operation was successful. A value of "Success" signifies that the request was processed successfully without any issues.


Data object

Contains the data returned by the API after processing the request. In this case, it contains a specific success indicator to confirm that the property license information was successfully received or processed.

success integer

A success flag indicating whether the operation was successful. A value of 1 indicates that the operation was successfully processed. If it were set to 0, it would signify that the operation failed.

Possible values are: 0 and 1

Example: "success": 1


Message string

A descriptive message providing additional information regarding the status of the operation.


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": "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": "Incorrect data format"
}

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?