Property Status Check

This endpoint is used to check the status of a property. The API will return information about the property's status, including any difficulties that prohibit it from being processed properly.


Endpoint

POST

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


Status string (Required)

The status to check for the property.

Should be "Check", a predefined valid status indicating the status of the property is being queried.


Sample Request

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

Response

Sample Success Response

{
    "Status": "Success",
    "Data": [],
    "Message": "Property Status check successfully"
}

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.


Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.

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": "731",
            "ShortText": "property_status - is not valid or not found!"
        }
    ],
    "Message": ""
}

Sample Error Response 2 - Booking.Com

{
    "Status": "Success",
    "Data": "NotProcessed - 733 : No availability pushed, NotProcessed - 733 : No rates defined, NotProcessed - 733 : No rooms active, NotProcessed - 733 : No proper main photo is set, NotProcessed - 733 : No contacts specified, NotProcessed - 733 : Main photo is not enabled, NotProcessed - 733 : Valid Legal Entity or Contract not found, NotProcessed - 733 : No products defined, NotProcessed - 733 : No general contact is specified in the correct format",
    "Message": "Property Status fetched 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?