Chilkat Online Tools

unicodeCpp / Support API / List Targets

Back to Collection Items

#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

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

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"login");
    http.put_Password(L"password");

    http.SetRequestHeader(L"Accept",L"application/json");

    CkStringBuilderW sbResponseBody;
    success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/targets",sbResponseBody);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

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

    int respStatusCode = http.get_LastStatus();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",http.lastHeader());
        wprintf(L"Failed.\n");
        return;
    }

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

    // {
    //   "targets": [
    //     {
    //       "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>"
    //     },
    //     {
    //       "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.

    const wchar_t *project_id = 0;
    const wchar_t *resource = 0;
    const wchar_t *target_url = 0;
    const wchar_t *title = 0;
    const wchar_t *token = 0;
    const wchar_t *v_type = 0;
    const wchar_t *active = 0;
    const wchar_t *created_at = 0;
    const wchar_t *id = 0;
    const wchar_t *message_id = 0;
    const wchar_t *password = 0;
    const wchar_t *todo_list_id = 0;
    const wchar_t *username = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray(L"targets");
    while (i < count_i) {
        jResp.put_I(i);
        project_id = jResp.stringOf(L"targets[i].project_id");
        resource = jResp.stringOf(L"targets[i].resource");
        target_url = jResp.stringOf(L"targets[i].target_url");
        title = jResp.stringOf(L"targets[i].title");
        token = jResp.stringOf(L"targets[i].token");
        v_type = jResp.stringOf(L"targets[i].type");
        active = jResp.stringOf(L"targets[i].active");
        created_at = jResp.stringOf(L"targets[i].created_at");
        id = jResp.stringOf(L"targets[i].id");
        message_id = jResp.stringOf(L"targets[i].message_id");
        password = jResp.stringOf(L"targets[i].password");
        todo_list_id = jResp.stringOf(L"targets[i].todo_list_id");
        username = jResp.stringOf(L"targets[i].username");
        i = i + 1;
    }
    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Targets",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/targets",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "targets"
      ]
    },
    "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "targets"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"targets\": [\n    {\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    {\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  ]\n}"
    }
  ]
}