Chilkat Online Tools

unicodeC / Support API / Show Target

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *Project_id;
    const wchar_t *Resource;
    const wchar_t *Target_url;
    const wchar_t *Title;
    const wchar_t *Token;
    const wchar_t *v_Type;
    const wchar_t *Active;
    const wchar_t *Created_at;
    const wchar_t *Id;
    const wchar_t *Message_id;
    const wchar_t *Password;
    const wchar_t *Todo_list_id;
    const wchar_t *Username;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"login");
    CkHttpW_putPassword(http,L"password");

    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://example.zendesk.com/api/v2/targets/:target_id",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "target": {
    //     "project_id": "<string>",
    //     "resource": "<string>",
    //     "target_url": "<string>",
    //     "title": "<string>",
    //     "token": "<string>",
    //     "type": "<string>",
    //     "active": "<boolean>",
    //     "created_at": "<dateTime>",
    //     "id": "<integer>",
    //     "message_id": "<string>",
    //     "password": "<string>",
    //     "todo_list_id": "<string>",
    //     "username": "<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.

    Project_id = CkJsonObjectW_stringOf(jResp,L"target.project_id");
    Resource = CkJsonObjectW_stringOf(jResp,L"target.resource");
    Target_url = CkJsonObjectW_stringOf(jResp,L"target.target_url");
    Title = CkJsonObjectW_stringOf(jResp,L"target.title");
    Token = CkJsonObjectW_stringOf(jResp,L"target.token");
    v_Type = CkJsonObjectW_stringOf(jResp,L"target.type");
    Active = CkJsonObjectW_stringOf(jResp,L"target.active");
    Created_at = CkJsonObjectW_stringOf(jResp,L"target.created_at");
    Id = CkJsonObjectW_stringOf(jResp,L"target.id");
    Message_id = CkJsonObjectW_stringOf(jResp,L"target.message_id");
    Password = CkJsonObjectW_stringOf(jResp,L"target.password");
    Todo_list_id = CkJsonObjectW_stringOf(jResp,L"target.todo_list_id");
    Username = CkJsonObjectW_stringOf(jResp,L"target.username");


    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/targets/:target_id

Postman Collection Item JSON

{
  "name": "Show Target",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/targets/:target_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "targets",
        ":target_id"
      ],
      "variable": [
        {
          "key": "target_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Agents\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/targets/:target_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "targets",
            ":target_id"
          ],
          "variable": [
            {
              "key": "target_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"target\": {\n    \"project_id\": \"<string>\",\n    \"resource\": \"<string>\",\n    \"target_url\": \"<string>\",\n    \"title\": \"<string>\",\n    \"token\": \"<string>\",\n    \"type\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"message_id\": \"<string>\",\n    \"password\": \"<string>\",\n    \"todo_list_id\": \"<string>\",\n    \"username\": \"<string>\"\n  }\n}"
    }
  ]
}