Chilkat Online Tools

C / Support API / Show Custom Object

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 *Key;
    const char *Title;
    const char *Title_pluralized;
    const char *Created_at;
    const char *Created_by_user_id;
    const char *Description;
    const char *Raw_description;
    const char *Raw_title;
    const char *Raw_title_pluralized;
    const char *Updated_at;
    const char *Updated_by_user_id;
    const char *v_Url;

    // 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/custom_objects/:custom_object_key",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)

    // {
    //   "custom_object": {
    //     "key": "<string>",
    //     "title": "<string>",
    //     "title_pluralized": "<string>",
    //     "created_at": "<dateTime>",
    //     "created_by_user_id": "<string>",
    //     "description": "<string>",
    //     "raw_description": "<string>",
    //     "raw_title": "<string>",
    //     "raw_title_pluralized": "<string>",
    //     "updated_at": "<dateTime>",
    //     "updated_by_user_id": "<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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Key = CkJsonObject_stringOf(jResp,"custom_object.key");
    Title = CkJsonObject_stringOf(jResp,"custom_object.title");
    Title_pluralized = CkJsonObject_stringOf(jResp,"custom_object.title_pluralized");
    Created_at = CkJsonObject_stringOf(jResp,"custom_object.created_at");
    Created_by_user_id = CkJsonObject_stringOf(jResp,"custom_object.created_by_user_id");
    Description = CkJsonObject_stringOf(jResp,"custom_object.description");
    Raw_description = CkJsonObject_stringOf(jResp,"custom_object.raw_description");
    Raw_title = CkJsonObject_stringOf(jResp,"custom_object.raw_title");
    Raw_title_pluralized = CkJsonObject_stringOf(jResp,"custom_object.raw_title_pluralized");
    Updated_at = CkJsonObject_stringOf(jResp,"custom_object.updated_at");
    Updated_by_user_id = CkJsonObject_stringOf(jResp,"custom_object.updated_by_user_id");
    v_Url = CkJsonObject_stringOf(jResp,"custom_object.url");


    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/custom_objects/:custom_object_key

Postman Collection Item JSON

{
  "name": "Show Custom Object",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key"
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        }
      ]
    },
    "description": "Returns an object with the specified key\n#### Allowed For\n* Agents\n"
  },
  "response": [
    {
      "name": "Custom Object",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key"
          ],
          "variable": [
            {
              "key": "custom_object_key"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_object\": {\n    \"key\": \"<string>\",\n    \"title\": \"<string>\",\n    \"title_pluralized\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"created_by_user_id\": \"<string>\",\n    \"description\": \"<string>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"raw_title_pluralized\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"updated_by_user_id\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}