Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Get a Favorite

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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

    ; {
    ;   "accessCount": 1,
    ;   "iconColor": "5867E8",
    ;   "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
    ;   "id": "0MV4H0000004qIeWAI",
    ;   "lastAccessDate": "2023-10-06T10:03:32.000Z",
    ;   "name": "AllAccountsListView",
    ;   "objectType": "Account",
    ;   "sortOrder": 1,
    ;   "subtitle": "Accounts",
    ;   "target": "00B58000002ssinEAA",
    ;   "targetType": "ListView"
    ; }

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

    accessCount.i = CkJsonObject::ckIntOf(jResp,"accessCount")
    iconColor.s = CkJsonObject::ckStringOf(jResp,"iconColor")
    iconUrl.s = CkJsonObject::ckStringOf(jResp,"iconUrl")
    id.s = CkJsonObject::ckStringOf(jResp,"id")
    lastAccessDate.s = CkJsonObject::ckStringOf(jResp,"lastAccessDate")
    name.s = CkJsonObject::ckStringOf(jResp,"name")
    objectType.s = CkJsonObject::ckStringOf(jResp,"objectType")
    sortOrder.i = CkJsonObject::ckIntOf(jResp,"sortOrder")
    subtitle.s = CkJsonObject::ckStringOf(jResp,"subtitle")
    target.s = CkJsonObject::ckStringOf(jResp,"target")
    targetType.s = CkJsonObject::ckStringOf(jResp,"targetType")


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get a Favorite",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "favorites",
        ":FAVORITE_ID"
      ],
      "variable": [
        {
          "key": "FAVORITE_ID",
          "value": "",
          "description": "The ID of a favorite"
        }
      ]
    },
    "description": "Get a favorite."
  },
  "response": [
    {
      "name": "Get a Favorite",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites/:FAVORITE_ID",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "favorites",
            ":FAVORITE_ID"
          ],
          "variable": [
            {
              "key": "FAVORITE_ID",
              "value": "0MV4H0000004qIeWAI",
              "description": "The ID of a favorite"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:04:41 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    \"accessCount\": 1,\n    \"iconColor\": \"5867E8\",\n    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n    \"id\": \"0MV4H0000004qIeWAI\",\n    \"lastAccessDate\": \"2023-10-06T10:03:32.000Z\",\n    \"name\": \"AllAccountsListView\",\n    \"objectType\": \"Account\",\n    \"sortOrder\": 1,\n    \"subtitle\": \"Accounts\",\n    \"target\": \"00B58000002ssinEAA\",\n    \"targetType\": \"ListView\"\n}"
    }
  ]
}