Retrieve CheckIn Method

This endpoint retrieves the available check-in methods based on a specified stream variation for a hotel, allowing for tailored guest experiences.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/keycollection/retrieveCheckInMethodStreamVariation

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

---

stream_variation_name string (Required)

Description

---

Sample Request

{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "stream_variation_name": "primary_checkin_method"
}

---

Response

Sample Success Response

{
   "Status": "Success",
   "Data": {
       "checkin_methods": [
           {
               "description": "The keys are at the reception",
               "name": "reception"
           },
           {
               "name": "someone_will_meet",
               "description": "Someone will meet the guest"
           },
           {
               "description": "There is a door code",
               "name": "door_code"
           }
       ]
   },
   "Message": "Check-In Method Stream-Variation Fetched Successfully",
   "Ruid": "UmFuZG9tSVYkc2RlIyh9YR8UCyEd6Sj0AX4+V23Sf3/Xg+YnvmBgZx5ynkqh+xvqL4kIuJenSDmz08p/yA9xPpc5J7gMWNoj5jq9SzmrKz0="
}

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 primary data returned by the API. This object includes relevant information regarding the check-in methods for the property.

checkin_methods array

An array of objects that describes the various check-in methods available for guests at the property.

description string

A brief explanation of what the check-in method entails, helping guests understand the process.

Example Values:

• "The keys are at the reception"

• "Someone will meet the guest"

• "There is a door code"

name string

A unique identifier for the check-in method. This name is used to reference the specific method in other API calls or contexts.

Example Values:

• "reception"

• "someone_will_meet"

• "door_code"

---

Message string

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

---

Ruid string

A unique request identifier.

UUID format

---

Errors

Sample Error Response 1

{
   "Errors": [
       {
           "Code": "400",
           "ShortText": "HotelCode: Invalid HotelCode ('NT711')"
       }
   ],
   "Status": "Fail",
  "Ruid": ""
}

Sample Error Response 2

{
   "Errors": [
       {
           "Code": "573",
           "ShortText": "channel-mapping not found for this property!"
       }
   ],
   "Status": "Fail",
  "Ruid": ""
}

Sample Error Response 3

{
   "Status": "Success",
   "Data": {
       "checkin_methods": []
   },
   "Message": "Check-In Method Stream-Variation Fetched Successfully",
   "Ruid": "UmFuZG9tSVYkc2RlIyh9YR8UCyEd6Sj0+iZ0JwAy5cv8KAPbzWZ3al2iP5cT3znXqIFtgIAxSDjcr/flvyCz/eagVotXScjn0qkOUhIhQvo="
}

---

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.