Skip to main content

Assistance requests icons

1. Icon Specifications​

  • Shape: Round
  • Format: PNG
  • Background: None (transparent)
  • Sizes (Required):
    • Small: 22x22 pixels
    • Medium: 44x44 pixels
    • Large: 66x66 pixels
  • Reason for Three Sizes: Different devices have varying pixel densities (DPI), so multiple resolutions ensure that icons appear sharp and correctly scaled across all screens.

2. Available Configuration Keys​

  • age_verification
  • partial_rescan
  • full_rescan
  • assistance_requested

3. Configuration in CCC​

Each alert icon must be defined in the CCC configuration as follows:

"<configuration_key>": {
    "name": "Assistance request",
    "url": "<server_url>/<configuration_key>.png",
    "url@2x": "<server_url>/<configuration_key>@2x.png",
    "url@3x": "<server_url>/<configuration_key>@3x.png"
}
  • <configuration_key> is the mandatory unique ID for assistance request icon must be replaced with one of the available keys.
  • <server_url> must be replaced with the actual host server URL.
  • name is a short descriptive name that must remain unchanged.
  • url fields indicate the hosted image locations.

Note:

The correct server structure and identification must be followed to ensure proper access to the icons.

By enforcing these guidelines, we ensure uniformity, control, and seamless integration of assistance requests icons.

4. API requests for configuring values​

Set values

⚠️ Important:
When using the set request, all toggle settings of this type will be overwritten with the provided values.
If you intend to change only specific settings, consider using the update request instead.

  • Permission required ["ccc.configuration.update"]
curl --location --request PUT 'https://ccc-api.retailsvc.com/api/v1/config/att.icons-config.v1/values/tenant' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>' \
--data-raw '{
  "value": {
    "icons": {
        "<configuration_key>": {
          "name": "Assistance request",
          "url": "<server_url>/<configuration_key>.png",
          "url@2x": "<server_url>/<configuration_key>@2x.png",
          "url@3x": "<server_url>/<configuration_key>@3x.png"
      }
    }
  }
}'

Update values

  • Permission required ["ccc.configuration.update"]
curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/att.icons-config.v1/values/tenant?replaceExistingPatch=false&calculateDiff=false&dryRun=false' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>' \
--data-raw '{
  "value": {
    "icons": {
       "<configuration_key>": {
          "name": "Assistance request",
          "url": "<server_url>/<configuration_key>.png",
          "url@2x": "<server_url>/<configuration_key>@2x.png",
          "url@3x": "<server_url>/<configuration_key>@3x.png"
      }
    }
  }
}'

Get configured values

  • Permission required ["ccc.configuration.get"]
curl --location 'https://ccc-api.retailsvc.com/api/v1/config/att.icons-config.v1/values/tenant?tags=%3Cstring%3E&tags=%3Cstring%3E&getPatch=false' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>'

Delete configured values

  • Permission required ["ccc.configuration.delete"]
curl --location --request DELETE 'https://ccc-api.retailsvc.com/api/v1/config/att.icons-config.v1/values/tenant' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>'