C / Support API / List Custom Roles
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *name;
const char *role_type;
const char *Assign_tickets_to_any_group;
const char *Chat_access;
const char *End_user_list_access;
const char *End_user_profile_access;
const char *Explore_access;
const char *Forum_access;
const char *Forum_access_restricted_content;
const char *Group_access;
const char *Light_agent;
const char *Macro_access;
const char *Manage_business_rules;
const char *Manage_contextual_workspaces;
const char *Manage_dynamic_content;
const char *Manage_extensions_and_channels;
const char *Manage_facebook;
const char *Manage_organization_fields;
const char *Manage_ticket_fields;
const char *Manage_ticket_forms;
const char *Manage_user_fields;
const char *Moderate_forums;
const char *Organization_editing;
const char *Organization_notes_editing;
const char *Report_access;
const char *Side_conversation_create;
const char *Ticket_access;
const char *Ticket_comment_access;
const char *Ticket_deletion;
const char *Ticket_editing;
const char *Ticket_merge;
const char *Ticket_tag_editing;
const char *Twitter_search_access;
const char *User_view_access;
const char *View_access;
const char *View_deleted_tickets;
const char *Voice_access;
const char *Voice_dashboard_access;
const char *created_at;
const char *description;
const char *id;
const char *team_member_count;
const char *updated_at;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/custom_roles",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "custom_roles": [
// {
// "name": "<string>",
// "role_type": "<integer>",
// "configuration": {
// "assign_tickets_to_any_group": "<boolean>",
// "chat_access": "<boolean>",
// "end_user_list_access": "<string>",
// "end_user_profile_access": "<string>",
// "explore_access": "<string>",
// "forum_access": "<string>",
// "forum_access_restricted_content": "<boolean>",
// "group_access": "<boolean>",
// "light_agent": "<boolean>",
// "macro_access": "<string>",
// "manage_business_rules": "<boolean>",
// "manage_contextual_workspaces": "<boolean>",
// "manage_dynamic_content": "<boolean>",
// "manage_extensions_and_channels": "<boolean>",
// "manage_facebook": "<boolean>",
// "manage_organization_fields": "<boolean>",
// "manage_ticket_fields": "<boolean>",
// "manage_ticket_forms": "<boolean>",
// "manage_user_fields": "<boolean>",
// "moderate_forums": "<boolean>",
// "organization_editing": "<boolean>",
// "organization_notes_editing": "<boolean>",
// "report_access": "<string>",
// "side_conversation_create": "<boolean>",
// "ticket_access": "<string>",
// "ticket_comment_access": "<string>",
// "ticket_deletion": "<boolean>",
// "ticket_editing": "<boolean>",
// "ticket_merge": "<boolean>",
// "ticket_tag_editing": "<boolean>",
// "twitter_search_access": "<boolean>",
// "user_view_access": "<string>",
// "view_access": "<string>",
// "view_deleted_tickets": "<boolean>",
// "voice_access": "<boolean>",
// "voice_dashboard_access": "<boolean>"
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "team_member_count": "<integer>",
// "updated_at": "<dateTime>"
// },
// {
// "name": "<string>",
// "role_type": "<integer>",
// "configuration": {
// "assign_tickets_to_any_group": "<boolean>",
// "chat_access": "<boolean>",
// "end_user_list_access": "<string>",
// "end_user_profile_access": "<string>",
// "explore_access": "<string>",
// "forum_access": "<string>",
// "forum_access_restricted_content": "<boolean>",
// "group_access": "<boolean>",
// "light_agent": "<boolean>",
// "macro_access": "<string>",
// "manage_business_rules": "<boolean>",
// "manage_contextual_workspaces": "<boolean>",
// "manage_dynamic_content": "<boolean>",
// "manage_extensions_and_channels": "<boolean>",
// "manage_facebook": "<boolean>",
// "manage_organization_fields": "<boolean>",
// "manage_ticket_fields": "<boolean>",
// "manage_ticket_forms": "<boolean>",
// "manage_user_fields": "<boolean>",
// "moderate_forums": "<boolean>",
// "organization_editing": "<boolean>",
// "organization_notes_editing": "<boolean>",
// "report_access": "<string>",
// "side_conversation_create": "<boolean>",
// "ticket_access": "<string>",
// "ticket_comment_access": "<string>",
// "ticket_deletion": "<boolean>",
// "ticket_editing": "<boolean>",
// "ticket_merge": "<boolean>",
// "ticket_tag_editing": "<boolean>",
// "twitter_search_access": "<boolean>",
// "user_view_access": "<string>",
// "view_access": "<string>",
// "view_deleted_tickets": "<boolean>",
// "voice_access": "<boolean>",
// "voice_dashboard_access": "<boolean>"
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "team_member_count": "<integer>",
// "updated_at": "<dateTime>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"custom_roles");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
name = CkJsonObject_stringOf(jResp,"custom_roles[i].name");
role_type = CkJsonObject_stringOf(jResp,"custom_roles[i].role_type");
Assign_tickets_to_any_group = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.assign_tickets_to_any_group");
Chat_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.chat_access");
End_user_list_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.end_user_list_access");
End_user_profile_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.end_user_profile_access");
Explore_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.explore_access");
Forum_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.forum_access");
Forum_access_restricted_content = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.forum_access_restricted_content");
Group_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.group_access");
Light_agent = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.light_agent");
Macro_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.macro_access");
Manage_business_rules = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_business_rules");
Manage_contextual_workspaces = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_contextual_workspaces");
Manage_dynamic_content = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_dynamic_content");
Manage_extensions_and_channels = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_extensions_and_channels");
Manage_facebook = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_facebook");
Manage_organization_fields = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_organization_fields");
Manage_ticket_fields = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_ticket_fields");
Manage_ticket_forms = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_ticket_forms");
Manage_user_fields = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.manage_user_fields");
Moderate_forums = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.moderate_forums");
Organization_editing = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.organization_editing");
Organization_notes_editing = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.organization_notes_editing");
Report_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.report_access");
Side_conversation_create = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.side_conversation_create");
Ticket_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.ticket_access");
Ticket_comment_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.ticket_comment_access");
Ticket_deletion = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.ticket_deletion");
Ticket_editing = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.ticket_editing");
Ticket_merge = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.ticket_merge");
Ticket_tag_editing = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.ticket_tag_editing");
Twitter_search_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.twitter_search_access");
User_view_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.user_view_access");
View_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.view_access");
View_deleted_tickets = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.view_deleted_tickets");
Voice_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.voice_access");
Voice_dashboard_access = CkJsonObject_stringOf(jResp,"custom_roles[i].configuration.voice_dashboard_access");
created_at = CkJsonObject_stringOf(jResp,"custom_roles[i].created_at");
description = CkJsonObject_stringOf(jResp,"custom_roles[i].description");
id = CkJsonObject_stringOf(jResp,"custom_roles[i].id");
team_member_count = CkJsonObject_stringOf(jResp,"custom_roles[i].team_member_count");
updated_at = CkJsonObject_stringOf(jResp,"custom_roles[i].updated_at");
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_roles
Postman Collection Item JSON
{
"name": "List Custom Roles",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_roles"
]
},
"description": "#### Availability\n\n* Accounts on the Enterprise plan or above\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_roles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_roles\": [\n {\n \"name\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"configuration\": {\n \"assign_tickets_to_any_group\": \"<boolean>\",\n \"chat_access\": \"<boolean>\",\n \"end_user_list_access\": \"<string>\",\n \"end_user_profile_access\": \"<string>\",\n \"explore_access\": \"<string>\",\n \"forum_access\": \"<string>\",\n \"forum_access_restricted_content\": \"<boolean>\",\n \"group_access\": \"<boolean>\",\n \"light_agent\": \"<boolean>\",\n \"macro_access\": \"<string>\",\n \"manage_business_rules\": \"<boolean>\",\n \"manage_contextual_workspaces\": \"<boolean>\",\n \"manage_dynamic_content\": \"<boolean>\",\n \"manage_extensions_and_channels\": \"<boolean>\",\n \"manage_facebook\": \"<boolean>\",\n \"manage_organization_fields\": \"<boolean>\",\n \"manage_ticket_fields\": \"<boolean>\",\n \"manage_ticket_forms\": \"<boolean>\",\n \"manage_user_fields\": \"<boolean>\",\n \"moderate_forums\": \"<boolean>\",\n \"organization_editing\": \"<boolean>\",\n \"organization_notes_editing\": \"<boolean>\",\n \"report_access\": \"<string>\",\n \"side_conversation_create\": \"<boolean>\",\n \"ticket_access\": \"<string>\",\n \"ticket_comment_access\": \"<string>\",\n \"ticket_deletion\": \"<boolean>\",\n \"ticket_editing\": \"<boolean>\",\n \"ticket_merge\": \"<boolean>\",\n \"ticket_tag_editing\": \"<boolean>\",\n \"twitter_search_access\": \"<boolean>\",\n \"user_view_access\": \"<string>\",\n \"view_access\": \"<string>\",\n \"view_deleted_tickets\": \"<boolean>\",\n \"voice_access\": \"<boolean>\",\n \"voice_dashboard_access\": \"<boolean>\"\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"team_member_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"name\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"configuration\": {\n \"assign_tickets_to_any_group\": \"<boolean>\",\n \"chat_access\": \"<boolean>\",\n \"end_user_list_access\": \"<string>\",\n \"end_user_profile_access\": \"<string>\",\n \"explore_access\": \"<string>\",\n \"forum_access\": \"<string>\",\n \"forum_access_restricted_content\": \"<boolean>\",\n \"group_access\": \"<boolean>\",\n \"light_agent\": \"<boolean>\",\n \"macro_access\": \"<string>\",\n \"manage_business_rules\": \"<boolean>\",\n \"manage_contextual_workspaces\": \"<boolean>\",\n \"manage_dynamic_content\": \"<boolean>\",\n \"manage_extensions_and_channels\": \"<boolean>\",\n \"manage_facebook\": \"<boolean>\",\n \"manage_organization_fields\": \"<boolean>\",\n \"manage_ticket_fields\": \"<boolean>\",\n \"manage_ticket_forms\": \"<boolean>\",\n \"manage_user_fields\": \"<boolean>\",\n \"moderate_forums\": \"<boolean>\",\n \"organization_editing\": \"<boolean>\",\n \"organization_notes_editing\": \"<boolean>\",\n \"report_access\": \"<string>\",\n \"side_conversation_create\": \"<boolean>\",\n \"ticket_access\": \"<string>\",\n \"ticket_comment_access\": \"<string>\",\n \"ticket_deletion\": \"<boolean>\",\n \"ticket_editing\": \"<boolean>\",\n \"ticket_merge\": \"<boolean>\",\n \"ticket_tag_editing\": \"<boolean>\",\n \"twitter_search_access\": \"<boolean>\",\n \"user_view_access\": \"<string>\",\n \"view_access\": \"<string>\",\n \"view_deleted_tickets\": \"<boolean>\",\n \"voice_access\": \"<boolean>\",\n \"voice_dashboard_access\": \"<boolean>\"\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"team_member_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\"\n }\n ]\n}"
}
]
}
