Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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;
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateInt: @"page[size]" value: [NSNumber numberWithInt: 10]];
[queryParams UpdateInt: @"page[number]" value: [NSNumber numberWithInt: 0]];
[queryParams UpdateString: @"sort" value: @"name"];
[queryParams UpdateString: @"filter" value: @"<string>"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.app.ddog-gov.com/api/v2/roles" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "type": "roles",
// "attributes": {
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "user_count": "<long>"
// },
// "id": "<string>",
// "relationships": {
// "permissions": {
// "data": [
// {
// "id": "<string>",
// "type": "permissions"
// },
// {
// "id": "<string>",
// "type": "permissions"
// }
// ]
// }
// }
// },
// {
// "type": "roles",
// "attributes": {
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "user_count": "<long>"
// },
// "id": "<string>",
// "relationships": {
// "permissions": {
// "data": [
// {
// "id": "<string>",
// "type": "permissions"
// },
// {
// "id": "<string>",
// "type": "permissions"
// }
// ]
// }
// }
// }
// ],
// "meta": {
// "page": {
// "total_count": "<long>",
// "total_filtered_count": "<long>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *v_type = 0;
NSString *Created_at = 0;
NSString *Modified_at = 0;
NSString *Name = 0;
NSString *User_count = 0;
NSString *id = 0;
int j;
int count_j;
NSString *Total_count = [jResp StringOf: @"meta.page.total_count"];
NSString *Total_filtered_count = [jResp StringOf: @"meta.page.total_filtered_count"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
v_type = [jResp StringOf: @"data[i].type"];
Created_at = [jResp StringOf: @"data[i].attributes.created_at"];
Modified_at = [jResp StringOf: @"data[i].attributes.modified_at"];
Name = [jResp StringOf: @"data[i].attributes.name"];
User_count = [jResp StringOf: @"data[i].attributes.user_count"];
id = [jResp StringOf: @"data[i].id"];
j = 0;
count_j = [[jResp SizeOfArray: @"data[i].relationships.permissions.data"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
id = [jResp StringOf: @"data[i].relationships.permissions.data[j].id"];
v_type = [jResp StringOf: @"data[i].relationships.permissions.data[j].type"];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-d "sort=name"
-d "filter=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/roles
Postman Collection Item JSON
{
"name": "List roles",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
},
"description": "Returns all roles, including their names and their unique identifiers."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"user_count\": \"<long>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n },\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"user_count\": \"<long>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": \"<long>\",\n \"total_filtered_count\": \"<long>\"\n }\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
