Retrieve All Stream Variation

This endpoint fetches all available check-in method variations for a specific hotel, providing an overview of all check-in options.

---

Endpoint

POST

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

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.

---

Sample Request

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

---

Response

Sample Success Response

{
   "Status": "Success",
   "Data": {
       "stream_variations": [
           {
               "description": "Primary method of checkin to the property",
               "name": "primary_checkin_method"
           },
           {
               "description": "Alternative method of checkin to the property",
               "name": "alternative_checkin_method"
           }
       ]
   },
   "Message": "All Check-In Method Stream-Variation Fetched Successfully",
   "Ruid": "UmFuZG9tSVYkc2RlIyh9YR8UCyEd6Sj0xBQTRpZeEoT5v5fKy+7/X13Rsn7gQKz0UH4/GrRLpxcPvBvQULsURQj1a7ZbebGCcfSzqbAgbwo="
}

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 holds relevant information pertaining to the request.

stream_variations array

An array of objects that describes the different check-in method variations available for the property.

description string

A brief description of the check-in method variation. Provides context on how this method is utilized.

Example Values:

• "Primary method of checkin to the property"

• "Alternative method of checkin to the property"

name string

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

Example Values:

• "primary_checkin_method"

• "alternative_checkin_method"

---

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": "Fail",
   "Errors": [],
   "Message": "Access denied",
  "Ruid": "xxxxxx"
}

---

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.