Objective-C / Support API / Show Custom Role
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;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://example.zendesk.com/api/v2/custom_roles/:custom_role_id" 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)
// {
// "custom_role": {
// "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
NSString *Name = [jResp StringOf: @"custom_role.name"];
NSString *Role_type = [jResp StringOf: @"custom_role.role_type"];
NSString *Assign_tickets_to_any_group = [jResp StringOf: @"custom_role.configuration.assign_tickets_to_any_group"];
NSString *Chat_access = [jResp StringOf: @"custom_role.configuration.chat_access"];
NSString *End_user_list_access = [jResp StringOf: @"custom_role.configuration.end_user_list_access"];
NSString *End_user_profile_access = [jResp StringOf: @"custom_role.configuration.end_user_profile_access"];
NSString *Explore_access = [jResp StringOf: @"custom_role.configuration.explore_access"];
NSString *Forum_access = [jResp StringOf: @"custom_role.configuration.forum_access"];
NSString *Forum_access_restricted_content = [jResp StringOf: @"custom_role.configuration.forum_access_restricted_content"];
NSString *Group_access = [jResp StringOf: @"custom_role.configuration.group_access"];
NSString *Light_agent = [jResp StringOf: @"custom_role.configuration.light_agent"];
NSString *Macro_access = [jResp StringOf: @"custom_role.configuration.macro_access"];
NSString *Manage_business_rules = [jResp StringOf: @"custom_role.configuration.manage_business_rules"];
NSString *Manage_contextual_workspaces = [jResp StringOf: @"custom_role.configuration.manage_contextual_workspaces"];
NSString *Manage_dynamic_content = [jResp StringOf: @"custom_role.configuration.manage_dynamic_content"];
NSString *Manage_extensions_and_channels = [jResp StringOf: @"custom_role.configuration.manage_extensions_and_channels"];
NSString *Manage_facebook = [jResp StringOf: @"custom_role.configuration.manage_facebook"];
NSString *Manage_organization_fields = [jResp StringOf: @"custom_role.configuration.manage_organization_fields"];
NSString *Manage_ticket_fields = [jResp StringOf: @"custom_role.configuration.manage_ticket_fields"];
NSString *Manage_ticket_forms = [jResp StringOf: @"custom_role.configuration.manage_ticket_forms"];
NSString *Manage_user_fields = [jResp StringOf: @"custom_role.configuration.manage_user_fields"];
NSString *Moderate_forums = [jResp StringOf: @"custom_role.configuration.moderate_forums"];
NSString *Organization_editing = [jResp StringOf: @"custom_role.configuration.organization_editing"];
NSString *Organization_notes_editing = [jResp StringOf: @"custom_role.configuration.organization_notes_editing"];
NSString *Report_access = [jResp StringOf: @"custom_role.configuration.report_access"];
NSString *Side_conversation_create = [jResp StringOf: @"custom_role.configuration.side_conversation_create"];
NSString *Ticket_access = [jResp StringOf: @"custom_role.configuration.ticket_access"];
NSString *Ticket_comment_access = [jResp StringOf: @"custom_role.configuration.ticket_comment_access"];
NSString *Ticket_deletion = [jResp StringOf: @"custom_role.configuration.ticket_deletion"];
NSString *Ticket_editing = [jResp StringOf: @"custom_role.configuration.ticket_editing"];
NSString *Ticket_merge = [jResp StringOf: @"custom_role.configuration.ticket_merge"];
NSString *Ticket_tag_editing = [jResp StringOf: @"custom_role.configuration.ticket_tag_editing"];
NSString *Twitter_search_access = [jResp StringOf: @"custom_role.configuration.twitter_search_access"];
NSString *User_view_access = [jResp StringOf: @"custom_role.configuration.user_view_access"];
NSString *View_access = [jResp StringOf: @"custom_role.configuration.view_access"];
NSString *View_deleted_tickets = [jResp StringOf: @"custom_role.configuration.view_deleted_tickets"];
NSString *Voice_access = [jResp StringOf: @"custom_role.configuration.voice_access"];
NSString *Voice_dashboard_access = [jResp StringOf: @"custom_role.configuration.voice_dashboard_access"];
NSString *Created_at = [jResp StringOf: @"custom_role.created_at"];
NSString *Description = [jResp StringOf: @"custom_role.description"];
NSString *Id = [jResp StringOf: @"custom_role.id"];
NSString *Team_member_count = [jResp StringOf: @"custom_role.team_member_count"];
NSString *Updated_at = [jResp StringOf: @"custom_role.updated_at"];
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_roles/:custom_role_id
Postman Collection Item JSON
{
"name": "Show Custom Role",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_roles/:custom_role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_roles",
":custom_role_id"
],
"variable": [
{
"key": "custom_role_id",
"value": "<integer>"
}
]
},
"description": "#### Availability\n\n* Accounts on the Enterprise plan or above\n\n#### Allowed for\n\n* Administrators\n* Agents with the `manage_roles` permission\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/:custom_role_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_roles",
":custom_role_id"
],
"variable": [
{
"key": "custom_role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_role\": {\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}"
}
]
}
