Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Get Active Theme

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcBrandColor
LOCAL lcLargeUrl
LOCAL lcMediumUrl
LOCAL lcSmallUrl
LOCAL lcFullSizeUrl
LOCAL lcDefaultGroupImageLargeUrl
LOCAL lcDefaultGroupImageMediumUrl
LOCAL lcDefaultGroupImageSmallUrl
LOCAL lcDefaultPageBannerFullSizeUrl
LOCAL lcDefaultUserBannerFullSizeUrl
LOCAL lcDefaultUserImageLargeUrl
LOCAL lcDefaultUserImageMediumUrl
LOCAL lcDefaultUserImageSmallUrl
LOCAL lcDensity
LOCAL lcHeaderColor
LOCAL lcLinkColor
LOCAL lcPageColor

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/themes/active",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "brandColor": "#0176D3",
*   "brandImage": {
*     "largeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png",
*     "mediumUrl": "/_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png",
*     "smallUrl": "/_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png"
*   },
*   "defaultGroupBanner": {
*     "fullSizeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group.png"
*   },
*   "defaultGroupImage": {
*     "largeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png",
*     "mediumUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png",
*     "smallUrl": "/_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png"
*   },
*   "defaultPageBanner": {
*     "fullSizeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_background.png"
*   },
*   "defaultUserBanner": {
*     "fullSizeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile.png"
*   },
*   "defaultUserImage": {
*     "largeUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png",
*     "mediumUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png",
*     "smallUrl": "/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png"
*   },
*   "density": "ViewOne",
*   "headerColor": "#FFFFFF",
*   "linkColor": "#0176D3",
*   "pageColor": "#B0C4DF"
* }

* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcBrandColor = loJResp.StringOf("brandColor")
lcLargeUrl = loJResp.StringOf("brandImage.largeUrl")
lcMediumUrl = loJResp.StringOf("brandImage.mediumUrl")
lcSmallUrl = loJResp.StringOf("brandImage.smallUrl")
lcFullSizeUrl = loJResp.StringOf("defaultGroupBanner.fullSizeUrl")
lcDefaultGroupImageLargeUrl = loJResp.StringOf("defaultGroupImage.largeUrl")
lcDefaultGroupImageMediumUrl = loJResp.StringOf("defaultGroupImage.mediumUrl")
lcDefaultGroupImageSmallUrl = loJResp.StringOf("defaultGroupImage.smallUrl")
lcDefaultPageBannerFullSizeUrl = loJResp.StringOf("defaultPageBanner.fullSizeUrl")
lcDefaultUserBannerFullSizeUrl = loJResp.StringOf("defaultUserBanner.fullSizeUrl")
lcDefaultUserImageLargeUrl = loJResp.StringOf("defaultUserImage.largeUrl")
lcDefaultUserImageMediumUrl = loJResp.StringOf("defaultUserImage.mediumUrl")
lcDefaultUserImageSmallUrl = loJResp.StringOf("defaultUserImage.smallUrl")
lcDensity = loJResp.StringOf("density")
lcHeaderColor = loJResp.StringOf("headerColor")
lcLinkColor = loJResp.StringOf("linkColor")
lcPageColor = loJResp.StringOf("pageColor")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/themes/active

Postman Collection Item JSON

{
  "name": "Get Active Theme",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/themes/active",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "themes",
        "active"
      ]
    },
    "description": "Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection."
  },
  "response": [
    {
      "name": "Get Active Theme",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/themes/active",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "themes",
            "active"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 09:24:07 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"brandColor\": \"#0176D3\",\n    \"brandImage\": {\n        \"largeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_logo_3x.png\",\n        \"mediumUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_logo_2x.png\",\n        \"smallUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_logo_1x.png\"\n    },\n    \"defaultGroupBanner\": {\n        \"fullSizeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group.png\"\n    },\n    \"defaultGroupImage\": {\n        \"largeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group_icon_200.png\",\n        \"mediumUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group_icon_160.png\",\n        \"smallUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_group_icon_96.png\"\n    },\n    \"defaultPageBanner\": {\n        \"fullSizeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_background.png\"\n    },\n    \"defaultUserBanner\": {\n        \"fullSizeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile.png\"\n    },\n    \"defaultUserImage\": {\n        \"largeUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_200.png\",\n        \"mediumUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_160.png\",\n        \"smallUrl\": \"/_slds/images/themes/lightning_blue/lightning_blue_profile_avatar_96.png\"\n    },\n    \"density\": \"ViewOne\",\n    \"headerColor\": \"#FFFFFF\",\n    \"linkColor\": \"#0176D3\",\n    \"pageColor\": \"#B0C4DF\"\n}"
    }
  ]
}