Objective-C / Support API / Incremental Organization Export
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;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"start_time" value: @"<integer>"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://example.zendesk.com/api/v2/incremental/organizations" 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)
// {
// "count": "<integer>",
// "end_of_stream": "<boolean>",
// "end_time": "<integer>",
// "next_page": "<string>",
// "organizations": [
// {
// "created_at": "<string>",
// "details": "<string>",
// "domain_names": [
// "<string>",
// "<string>"
// ],
// "external_id": "<string>",
// "group_id": "<integer>",
// "id": "<integer>",
// "name": "<string>",
// "notes": "<string>",
// "organization_fields": {
// "et_37f": "<string>",
// "ea_0": "<string>",
// "esse_c9": "<string>"
// },
// "shared_comments": "<boolean>",
// "shared_tickets": "<boolean>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "updated_at": "<string>",
// "url": "<string>"
// },
// {
// "created_at": "<string>",
// "details": "<string>",
// "domain_names": [
// "<string>",
// "<string>"
// ],
// "external_id": "<string>",
// "group_id": "<integer>",
// "id": "<integer>",
// "name": "<string>",
// "notes": "<string>",
// "organization_fields": {
// "magna_6d_": "<string>",
// "nostrud_b": "<string>"
// },
// "shared_comments": "<boolean>",
// "shared_tickets": "<boolean>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "updated_at": "<string>",
// "url": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *created_at = 0;
NSString *details = 0;
NSString *external_id = 0;
NSString *group_id = 0;
NSString *id = 0;
NSString *name = 0;
NSString *notes = 0;
NSString *Et_37f = 0;
NSString *Ea_0 = 0;
NSString *Esse_c9 = 0;
NSString *shared_comments = 0;
NSString *shared_tickets = 0;
NSString *updated_at = 0;
NSString *url = 0;
NSString *Magna_6d_ = 0;
NSString *Nostrud_b = 0;
int j;
int count_j;
NSString *strVal = 0;
NSString *count = [jResp StringOf: @"count"];
NSString *end_of_stream = [jResp StringOf: @"end_of_stream"];
NSString *end_time = [jResp StringOf: @"end_time"];
NSString *next_page = [jResp StringOf: @"next_page"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"organizations"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
created_at = [jResp StringOf: @"organizations[i].created_at"];
details = [jResp StringOf: @"organizations[i].details"];
external_id = [jResp StringOf: @"organizations[i].external_id"];
group_id = [jResp StringOf: @"organizations[i].group_id"];
id = [jResp StringOf: @"organizations[i].id"];
name = [jResp StringOf: @"organizations[i].name"];
notes = [jResp StringOf: @"organizations[i].notes"];
Et_37f = [jResp StringOf: @"organizations[i].organization_fields.et_37f"];
Ea_0 = [jResp StringOf: @"organizations[i].organization_fields.ea_0"];
Esse_c9 = [jResp StringOf: @"organizations[i].organization_fields.esse_c9"];
shared_comments = [jResp StringOf: @"organizations[i].shared_comments"];
shared_tickets = [jResp StringOf: @"organizations[i].shared_tickets"];
updated_at = [jResp StringOf: @"organizations[i].updated_at"];
url = [jResp StringOf: @"organizations[i].url"];
Magna_6d_ = [jResp StringOf: @"organizations[i].organization_fields.magna_6d_"];
Nostrud_b = [jResp StringOf: @"organizations[i].organization_fields.nostrud_b"];
j = 0;
count_j = [[jResp SizeOfArray: @"organizations[i].domain_names"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"organizations[i].domain_names[j]"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"organizations[i].tags"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"organizations[i].tags[j]"];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -u login:password -G -d "start_time=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/organizations
Postman Collection Item JSON
{
"name": "Incremental Organization Export",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/organizations?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"organizations"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
]
},
"description": "#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Organizations sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).\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/incremental/organizations?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"organizations"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"end_of_stream\": \"<boolean>\",\n \"end_time\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"organizations\": [\n {\n \"created_at\": \"<string>\",\n \"details\": \"<string>\",\n \"domain_names\": [\n \"<string>\",\n \"<string>\"\n ],\n \"external_id\": \"<string>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"organization_fields\": {\n \"et_37f\": \"<string>\",\n \"ea_0\": \"<string>\",\n \"esse_c9\": \"<string>\"\n },\n \"shared_comments\": \"<boolean>\",\n \"shared_tickets\": \"<boolean>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"created_at\": \"<string>\",\n \"details\": \"<string>\",\n \"domain_names\": [\n \"<string>\",\n \"<string>\"\n ],\n \"external_id\": \"<string>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"organization_fields\": {\n \"magna_6d_\": \"<string>\",\n \"nostrud_b\": \"<string>\"\n },\n \"shared_comments\": \"<boolean>\",\n \"shared_tickets\": \"<boolean>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
