Chilkat Online Tools

Mono / Support API / List Custom Roles

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

http.SetRequestHeader("Accept","application/json");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.zendesk.com/api/v2/custom_roles",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    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

string name;
string role_type;
string Assign_tickets_to_any_group;
string Chat_access;
string End_user_list_access;
string End_user_profile_access;
string Explore_access;
string Forum_access;
string Forum_access_restricted_content;
string Group_access;
string Light_agent;
string Macro_access;
string Manage_business_rules;
string Manage_contextual_workspaces;
string Manage_dynamic_content;
string Manage_extensions_and_channels;
string Manage_facebook;
string Manage_organization_fields;
string Manage_ticket_fields;
string Manage_ticket_forms;
string Manage_user_fields;
string Moderate_forums;
string Organization_editing;
string Organization_notes_editing;
string Report_access;
string Side_conversation_create;
string Ticket_access;
string Ticket_comment_access;
string Ticket_deletion;
string Ticket_editing;
string Ticket_merge;
string Ticket_tag_editing;
string Twitter_search_access;
string User_view_access;
string View_access;
string View_deleted_tickets;
string Voice_access;
string Voice_dashboard_access;
string created_at;
string description;
string id;
string team_member_count;
string updated_at;

int i = 0;
int count_i = jResp.SizeOfArray("custom_roles");
while (i < count_i) {
    jResp.I = i;
    name = jResp.StringOf("custom_roles[i].name");
    role_type = jResp.StringOf("custom_roles[i].role_type");
    Assign_tickets_to_any_group = jResp.StringOf("custom_roles[i].configuration.assign_tickets_to_any_group");
    Chat_access = jResp.StringOf("custom_roles[i].configuration.chat_access");
    End_user_list_access = jResp.StringOf("custom_roles[i].configuration.end_user_list_access");
    End_user_profile_access = jResp.StringOf("custom_roles[i].configuration.end_user_profile_access");
    Explore_access = jResp.StringOf("custom_roles[i].configuration.explore_access");
    Forum_access = jResp.StringOf("custom_roles[i].configuration.forum_access");
    Forum_access_restricted_content = jResp.StringOf("custom_roles[i].configuration.forum_access_restricted_content");
    Group_access = jResp.StringOf("custom_roles[i].configuration.group_access");
    Light_agent = jResp.StringOf("custom_roles[i].configuration.light_agent");
    Macro_access = jResp.StringOf("custom_roles[i].configuration.macro_access");
    Manage_business_rules = jResp.StringOf("custom_roles[i].configuration.manage_business_rules");
    Manage_contextual_workspaces = jResp.StringOf("custom_roles[i].configuration.manage_contextual_workspaces");
    Manage_dynamic_content = jResp.StringOf("custom_roles[i].configuration.manage_dynamic_content");
    Manage_extensions_and_channels = jResp.StringOf("custom_roles[i].configuration.manage_extensions_and_channels");
    Manage_facebook = jResp.StringOf("custom_roles[i].configuration.manage_facebook");
    Manage_organization_fields = jResp.StringOf("custom_roles[i].configuration.manage_organization_fields");
    Manage_ticket_fields = jResp.StringOf("custom_roles[i].configuration.manage_ticket_fields");
    Manage_ticket_forms = jResp.StringOf("custom_roles[i].configuration.manage_ticket_forms");
    Manage_user_fields = jResp.StringOf("custom_roles[i].configuration.manage_user_fields");
    Moderate_forums = jResp.StringOf("custom_roles[i].configuration.moderate_forums");
    Organization_editing = jResp.StringOf("custom_roles[i].configuration.organization_editing");
    Organization_notes_editing = jResp.StringOf("custom_roles[i].configuration.organization_notes_editing");
    Report_access = jResp.StringOf("custom_roles[i].configuration.report_access");
    Side_conversation_create = jResp.StringOf("custom_roles[i].configuration.side_conversation_create");
    Ticket_access = jResp.StringOf("custom_roles[i].configuration.ticket_access");
    Ticket_comment_access = jResp.StringOf("custom_roles[i].configuration.ticket_comment_access");
    Ticket_deletion = jResp.StringOf("custom_roles[i].configuration.ticket_deletion");
    Ticket_editing = jResp.StringOf("custom_roles[i].configuration.ticket_editing");
    Ticket_merge = jResp.StringOf("custom_roles[i].configuration.ticket_merge");
    Ticket_tag_editing = jResp.StringOf("custom_roles[i].configuration.ticket_tag_editing");
    Twitter_search_access = jResp.StringOf("custom_roles[i].configuration.twitter_search_access");
    User_view_access = jResp.StringOf("custom_roles[i].configuration.user_view_access");
    View_access = jResp.StringOf("custom_roles[i].configuration.view_access");
    View_deleted_tickets = jResp.StringOf("custom_roles[i].configuration.view_deleted_tickets");
    Voice_access = jResp.StringOf("custom_roles[i].configuration.voice_access");
    Voice_dashboard_access = jResp.StringOf("custom_roles[i].configuration.voice_dashboard_access");
    created_at = jResp.StringOf("custom_roles[i].created_at");
    description = jResp.StringOf("custom_roles[i].description");
    id = jResp.StringOf("custom_roles[i].id");
    team_member_count = jResp.StringOf("custom_roles[i].team_member_count");
    updated_at = jResp.StringOf("custom_roles[i].updated_at");
    i = i + 1;
}

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}"
    }
  ]
}