C / Support API / Ticket Related Information
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *strVal;
const char *from_archive;
const char *incidents;
const char *topic_id;
int Dolor__1;
BOOL Commodo4b;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/tickets/:ticket_id/related",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "followup_source_ids": [
// "<string>",
// "<string>"
// ],
// "from_archive": "<boolean>",
// "incidents": "<integer>",
// "topic_id": "<string>",
// "twitter": {
// "dolor__1": 77550121,
// "commodo4b": true
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
from_archive = CkJsonObject_stringOf(jResp,"from_archive");
incidents = CkJsonObject_stringOf(jResp,"incidents");
topic_id = CkJsonObject_stringOf(jResp,"topic_id");
Dolor__1 = CkJsonObject_IntOf(jResp,"twitter.dolor__1");
Commodo4b = CkJsonObject_BoolOf(jResp,"twitter.commodo4b");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"followup_source_ids");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"followup_source_ids[i]");
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/related
Postman Collection Item JSON
{
"name": "Ticket Related Information",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/related",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"related"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "The request returns a data object with the following properties:\n\n| Name | Type | Comment\n| ------------------- | ------- | -------\n| topic_id | string | Related topic in the Web portal (deprecated feature)\n| followup_source_ids | array | Sources to follow up\n| from_archive | boolean | Is true if the current ticket is archived\n| incidents | integer | A count of related incident occurrences\n| twitter | object | Twitter information associated with the ticket\n\n#### Allowed For\n\n* Agents"
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/related",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"related"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"followup_source_ids\": [\n \"<string>\",\n \"<string>\"\n ],\n \"from_archive\": \"<boolean>\",\n \"incidents\": \"<integer>\",\n \"topic_id\": \"<string>\",\n \"twitter\": {\n \"dolor__1\": 77550121,\n \"commodo4b\": true\n }\n}"
}
]
}