delphiAx / Support API / Incremental Organization Export
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
created_at: WideString;
details: WideString;
external_id: WideString;
group_id: WideString;
id: WideString;
name: WideString;
notes: WideString;
Et_37f: WideString;
Ea_0: WideString;
Esse_c9: WideString;
shared_comments: WideString;
shared_tickets: WideString;
updated_at: WideString;
url: WideString;
Magna_6d_: WideString;
Nostrud_b: WideString;
j: Integer;
count_j: Integer;
strVal: WideString;
count: WideString;
end_of_stream: WideString;
end_time: WideString;
next_page: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('start_time','<integer>');
http.SetRequestHeader('Accept','application/json');
resp := http.QuickRequestParams('GET','https://example.zendesk.com/api/v2/incremental/organizations',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
count := jResp.StringOf('count');
end_of_stream := jResp.StringOf('end_of_stream');
end_time := jResp.StringOf('end_time');
next_page := jResp.StringOf('next_page');
i := 0;
count_i := jResp.SizeOfArray('organizations');
while i < count_i do
begin
jResp.I := 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');
while j < count_j do
begin
jResp.J := j;
strVal := jResp.StringOf('organizations[i].domain_names[j]');
j := j + 1;
end;
j := 0;
count_j := jResp.SizeOfArray('organizations[i].tags');
while j < count_j do
begin
jResp.J := j;
strVal := jResp.StringOf('organizations[i].tags[j]');
j := j + 1;
end;
i := i + 1;
end;
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}"
}
]
}
