Property License Retrieve All Rule (Without property id)

This endpoint allows you to retrieve the license rules for a property based on location and category. The request requires geographical coordinates, a country code, and a property category.

---

Endpoint

POST

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

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

latitude float (Required)

Specifies the latitude of the property location.

Valid range: -90 to 90.

---

longitude float (Required)

Specifies the longitude of the property location.

Valid range: -180 to 180.

---

country_code string (Required)

Specifies the country code of the property.

To retrieve a list of the available country codes, see retrieving country codes.

---

property_category integer (Required)

Specifies the category of the property.

---

Sample Request

{
    "latitude": 41.8967,
    "longitude": 12.4822,
    "country_code": "IT",
    "property_category": 3
}

---

Response

Sample Success Response

{
  "Status": "Success",
  "Data": {
    "variants": [
      {
        "name": "lazio_v1",
        "id": 25,
        "content": [
          {
            "format": "^(?i:(IT)\\d{6}[A-Za-z]\\d[A-Za-z\\d]{4,8})(?:,(IT\\d{6}[A-Za-z]\\d[A-Za-z\\d]{4,8}))*$",
            "name": "National_licence_number",
            "required": false,
            "dataType": "string"
          },
          {
            "format": "^([a-zA-Z0-9!@#$%^&*()_+\\-=\\[\\]{};':\"\\\\|,.<>\\/?]+)(,[a-zA-Z0-9!@#$%^&*()_+\\-=\\[\\]{};':\"\\\\|,.<>\\/?]+)*$",
            "name": "number",
            "required": false,
            "dataType": "string",
            "possibleValues": [
              "primary",
              "secondary",
              "other"
            ]
          }
        ]
      }
    ],
    "name": "lazio",
    "id": 20,
    "active": true,
    "level": "property"
  },
  "Message": "License All Rule fetched successfully"
}

Success Response Body Elements

Status string

Indicates the result of the API call.

---

Data object

Contains the data returned by the API when the request is successful.

variants array of objects

A list of variants for the property license rules.

---

content array of objects

A list of fields for each variant.

format string

A regular expression pattern that validates the field.

required boolean

Specifies whether the field is required or optional.

Possible Values:

• false: The field is optional.

• true: The field is required.

dataType string

Specifies the data type of the field.

For example, string.

---

possibleValues array

Contains three possible values in an array (possible string values):

• "primary"

• "secondary"

• "other"

---

name string

Specifies the name of the license variant.

id integer

Specifies the unique identifier of the license variant.

active boolean

Indicates whether the variant is active.

Possible Values:

• true: The variant is active.

• false: The variant is inactive.

level string

Specifies the level of the license rule.

For example, property.

---

Message string

Provides a descriptive message about the result of the request.

In this case, "License All Rule fetched successfully".

---

Errors

Sample Error Response 1 - Validation Error Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "898",
            "ShortText": "Latitude: Value is not a latitude (a valid latitude (-90 to 90)), found ':value_replace'"
        },
        {
            "Code": "899",
            "ShortText": "Longitude: Value is not a longitude (a valid longitude (-180 to 180)), found ':value_replace'"
        },
        {
            "Code": "991",
            "ShortText": "Enter valid countrycode"
        },
        {
            "Code": "599",
            "ShortText": "property_category is invalid or not found!"
        }
    ],
    "Message": ""
}

Sample Error Response 2 - Booking.com Error Response

{
    "Status": "Fail",
    "Errors": [],
    "Message": "Not found"
}

---

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: "898" indicates a bad request.

ShortText string

A short description of the error.

---

Message string

A message providing more information about the error.