ERROR!
------------------- GenerateCode ----------------------
---- begin chilkat script ----
// This example assumes the Chilkat API to have been previously unlocked.
// See {{-global_unlock:::Global Unlock Sample-}} for sample code.
new Http http;
ckbool success;
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
new StringBuilder sbResponseBody;
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/favorites",sbResponseBody);
if (success == ckfalse) {
println http.LastErrorText;
return;
}
new JsonObject jResp;
call jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = ckfalse;
println "Response Body:";
println jResp.Emit();
int respStatusCode = http.LastStatus;
println "Response Status Code = ",respStatusCode;
if (respStatusCode >= 400) {
println "Response Header:";
println http.LastHeader;
println "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: {{.https://tools.chilkat.io/jsonParse|||Generate JSON Parsing Code.}}
#ifdef IS_C_CPP
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
#undef IS_C_CPP
string id;
string name;
string target;
string targetType;
int i = 0;
int count_i = jResp.SizeOfArray("favorites");
while i < count_i {
jResp.I = i;
accessCount = jResp.IntOf("favorites[i].accessCount");
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");
subtitle = jResp.StringOf("favorites[i].subtitle");
target = jResp.StringOf("favorites[i].target");
targetType = jResp.StringOf("favorites[i].targetType");
i = i + 1;
}
---- end chilkat script ----
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/favorites",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim id As String
Dim name As String
Dim target As String
Dim targetType As String
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("favorites")
While i < count_i
jResp.I = i
ERROR: Undefined variable(accessCount)
ERROR: Undefined variable(iconColor)
ERROR: Undefined variable(iconUrl)
id = jResp.StringOf("favorites[i].id")
ERROR: Undefined variable(lastAccessDate)
name = jResp.StringOf("favorites[i].name")
ERROR: Undefined variable(objectType)
ERROR: Undefined variable(sortOrder)
ERROR: Undefined variable(subtitle)
target = jResp.StringOf("favorites[i].target")
targetType = jResp.StringOf("favorites[i].targetType")
i = i + 1
End While
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}"
}
]
}
