Retrieve Image Tags

This endpoint allows users to retrieve a list of image tags, which categorize images based on various attributes.

---

Endpoint

GET

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

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.

---

Response

Sample Success Response

{
    "Status": "Success",
    "Data": [
        {
            "tag": "Shower",
            "id": 1
        },
        {
            "id": 2,
            "tag": "Toilet"
        },
        {
            "tag": "Property building",
            "id": 3
        },
        {
            "id": 4,
            "tag": "Patio"
        },
        {
            "tag": "Nearby landmark",
            "id": 5
        },
        {
            "id": 6,
            "tag": "Staff"
        },
        {
            "id": 7,
            "tag": "Restaurant/places to eat"
        },
        {
            "id": 8,
            "tag": "Communal lounge/ TV room"
        },
        {
            "id": 10,
            "tag": "Facade/entrance"
        }
        {
            ......
        }
    ],
    "Message": "Image Tags Fetched Successfully",
    "Ruid": "xxxxxxxxx"
}

Success Response Body Elements

Status string

The value "Success" indicates that the request was processed successfully, meaning there were no errors, and the operation was completed as expected.

---

Data array

This is an array containing a list of objects, where each object represents an image tag with associated details. Each object has the following parameters:

tag string

A descriptive label or name for a specific image tag. These tags describe different aspects of the images, such as "Shower", "Toilet", "Property building", etc. The tag is used to categorize or label images based on specific features or attributes.

id integer

A unique identifier assigned to each tag. This ID is used to reference and manage the tag within the system. Each tag has its own distinct ID.

---

Message string

The value "Image Tags Fetched Successfully" indicates that the request to fetch the image tags was successful, and the relevant data has been retrieved.

---

Ruid string

This is a unique identifier or token associated with the request. It is used for tracking or auditing purposes, ensuring that the response corresponds to the original request.

The Ruid is useful for debugging or verifying requests.

---

Errors

Sample Error Response 1

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

---

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:

---

Message string

A message providing more information about the error.

---

Ruid string

This is a unique identifier or token associated with the request, which can be used for tracking or referencing the request.