Chilkat Online Tools

Objective-C / Salesforce Platform APIs / Get Favorites

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/services/data/v{{version}}/ui-api/favorites" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

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

// {
//   "favorites": [
//     {
//       "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

int accessCount;
NSString *iconColor = 0;
NSString *iconUrl = 0;
NSString *id = 0;
NSString *lastAccessDate = 0;
NSString *name = 0;
NSString *objectType = 0;
int sortOrder;
NSString *subtitle = 0;
NSString *target = 0;
NSString *targetType = 0;

int i = 0;
int count_i = [[jResp SizeOfArray: @"favorites"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    accessCount = [[jResp IntOf: @"favorites[i].accessCount"] intValue];
    iconColor = [jResp StringOf: @"favorites[i].iconColor"];
    iconUrl = [jResp StringOf: @"favorites[i].iconUrl"];
    id = [jResp StringOf: @"favorites[i].id"];
    lastAccessDate = [jResp StringOf: @"favorites[i].lastAccessDate"];
    name = [jResp StringOf: @"favorites[i].name"];
    objectType = [jResp StringOf: @"favorites[i].objectType"];
    sortOrder = [[jResp IntOf: @"favorites[i].sortOrder"] intValue];
    subtitle = [jResp StringOf: @"favorites[i].subtitle"];
    target = [jResp StringOf: @"favorites[i].target"];
    targetType = [jResp StringOf: @"favorites[i].targetType"];
    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get Favorites",
  "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",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "favorites"
      ]
    },
    "description": "Get all of a user’s favorites."
  },
  "response": [
    {
      "name": "Get Favorites",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/favorites",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "favorites"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 10:03:55 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    \"favorites\": [\n        {\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        }\n    ]\n}"
    }
  ]
}