Property License Retrieve Rule (With property id)

This endpoint allows you to retrieve the license rule details for a specific property based on the hotel and channel-specific hotel ID.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/license/retrieveRule

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. 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.

---

Sample Request

{
    "hotel_id": "new1",
    "channel_hotel_id": "12926584"
}

---

Response

Sample Success Response

{
    "Status": "Success",
    "Data": {
        "variants": [
            {
                "name": "paris_new_license_private_person",
                "id": 319,
                "content": [
                    {
                        "format": "^75[0-9]{11}$",
                        "name": "number",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "license_holder_first_name",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "license_holder_last_name",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "street_name",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "street_number",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "additional_address_info",
                        "required": false,
                        "dataType": "string"
                    },
                    {
                        "name": "residence_type",
                        "required": true,
                        "dataType": "string",
                        "possibleValues": [
                            "primary",
                            "secondary",
                            "other"
                        ]
                    }
                ]
            },
            {
                "name": "paris_new_license_company",
                "id": 320,
                "content": [
                    {
                        "format": "^75[0-9]{11}$",
                        "name": "number",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "license_holder_company_name",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "street_name",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "street_number",
                        "required": true,
                        "dataType": "string"
                    },
                    {
                        "name": "additional_address_info",
                        "required": false,
                        "dataType": "string"
                    },
                    {
                        "name": "residence_type",
                        "required": true,
                        "dataType": "string",
                        "possibleValues": [
                            "primary",
                            "secondary",
                            "other"
                        ]
                    }
                ]
            },
            {
                "name": "paris_new_exception",
                "id": 321,
                "content": [
                    {
                        "name": "exception_type",
                        "required": true,
                        "dataType": "string",
                        "possibleValues": [
                            "mobility_lease",
                            "dependent_room",
                            "bed_breakfast"
                        ]
                    }
                ]
            }
        ],
        "name": "paris_new",
        "id": 214,
        "active": true,
        "level": "room"
    },
    "Message": "License Rule fetched successfully"
}

Success Response Body Elements

Status string

Indicates the result of the API call.

---

Data object

This parameter contains the main body of the response and includes all relevant information regarding the license rule variants for the property.

It consists of the following sub-parameters:

variants array

An array containing different license rule variants.

Each variant has the following parameters:

name string

The name of the license rule variant.

For example, paris_new_license_private_person or paris_new_license_company

id integer

A unique identifier for the license variant.

content array

An array of fields that belong to the license variant, with specific validation rules.

Each field in content includes the following parameters:

format string

A regular expression pattern used for validating the field value.

For example, "^75[0-9]{11}$" for validating a number field.

name string The name of the field

For example, number, license_holder_first_name

required boolean

Specifies if the field is required (true) or optional (false).

dataType string

The data type of the field.

For example, string, integer.

possibleValues array

A list of valid values for fields that have predefined options.

For instance, for the residence_type field, the possible values might include "primary", "secondary", and "other".

name string The name of the license rule set, such as "paris_new".

This is a descriptive name identifying the particular set of rules.

id integer

A unique identifier for the license rule set.

active boolean

Indicates whether the license rule set is active.

Possible values are true (active) or false (inactive).

level string

Specifies the level at which the license rule is applied

For example, room, property.

Message string

A string containing a message that gives more context or feedback about the success of the request.

In this case, the message is "License Rule fetched successfully", indicating that the license rule set has been successfully retrieved.

---

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!"
        }
    ],
    "Message": ""
}

---

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.