Retrieve Associate Images

This endpoint allows you to retrieve property-level or room-level associated images. The request must include the hotel_id and either channel_hotel_id (for property-level) or channel_room_id (for room-level).

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/photo/retrieveAssociateImages

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)

The unique property ID as assigned by the provider upon creation of the property.

---

channel_hotel_id string (Required)

The unique identifier of the hotel in the specified channel.

---

channel_room_id string (Required for room-level images)

The unique identifier of the room in the specified channel. This ID is used to associate an image with a specific room in a hotel on the channel.

---

Sample Request

Retrieve property-level associate image

{
   "hotel_id":"NT7",
   "channel_hotel_id" : "12837615"
}

Retrieve room-level associate image

{
   "hotel_id":"NT7",
   "channel_room_id": "555555",
   "channel_hotel_id" : "12837615"
}

---

Response

Sample Success Response - Retrieve property-level associate image

{
   "Status": "Success",
   "Data": {
       "main_photo": {
           "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
           "photo_id": "vIY7mKlAoUw",
           "name": "lobby-398845_1280.jpg"
       },
       "is_ordered": true,
       "other_photos": [
           {
               "name": "51eb350001ddfa3b7bb9c2cd1d1d4866.jpeg",
               "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
               "photo_id": "2nzdsMfFYJc",
               "tags": [
                   7,
                   8
               ]
           },
           {
               "photo_id": "KAVVUsPDrSg",
               "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
               "name": "dc83485eb1ea7771ed71aebe7a31691e.jpeg",
               "tags": []
           }
       ]
   },
   "Message": "Associate Images Retrieved Successfully"
}

Sample Success Response - Retrieve room-level associate image

{
   "Status": "Fail",
   "Data": {
       "photos": [
           {
               "name": "51eb350001ddfa3b7bb9c2cd1d1d4866.jpeg",
               "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
               "photo_id": "2nzdsMfFYJc"
           },
           {
               "photo_id": "KAVVUsPDrSg",
               "url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg",
               "name": "dc83485eb1ea7771ed71aebe7a31691e.jpeg"
           }
       ]
   },
   "Message": "Associate Images Retrieved Successfully"
}

Response Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

---

Data object

Data Contains the associated image data. Data object can have the below parameters:

Parameter	Description	Example Value
main_photo	The primary image for the property
url	URL of the main photo	https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg
photo_id	Unique identifier for the main photo	vIY7mKlAoUw
name	Name of the main photo file	lobby-398845_1280.jpg
is_ordered	Indicates if the images are ordered	true
other_photos	List of additional associated images
name	Name of each additional photo	51eb350001ddfa3b7bb9c2cd1d1d4866.jpeg
url	URL of each additional photo	https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg
photo_id	Unique identifier for each additional photo	2nzdsMfFYJc
tags	An array of numeric tags associated with the photo. These tags can be used for categorization or filtering purposes.
tagid	The taguds are represented as integers.	For example, 7, 8.

Room-Level Associated Images

Parameter	Description	Example Value
photos	List of associated images
name	Name of each associated photo	51eb350001ddfa3b7bb9c2cd1d1d4866.jpeg
url	URL of each associated photo	https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg
photo_id	Unique identifier for each associated photo	2nzdsMfFYJc

---

Message string

Descriptive message regarding the outcome of the request.

Error

Sample Error Response 1

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

Sample Error Response 2

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

Sample Error Response 3

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Access denied"
}

---

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.