Chilkat Online Tools

C / Support API / List Satisfaction Ratings

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 *assignee_id;
    const char *group_id;
    const char *requester_id;
    const char *ticket_id;
    const char *score;
    const char *comment;
    const char *created_at;
    const char *id;
    const char *reason;
    const char *reason_code;
    const char *reason_id;
    const char *updated_at;
    const char *url;
    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/satisfaction_ratings",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)

    // {
    //   "satisfaction_ratings": [
    //     {
    //       "assignee_id": "<integer>",
    //       "group_id": "<integer>",
    //       "requester_id": "<integer>",
    //       "ticket_id": "<integer>",
    //       "score": "<string>",
    //       "comment": "<string>",
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "reason": "<string>",
    //       "reason_code": "<integer>",
    //       "reason_id": "<integer>",
    //       "updated_at": "<dateTime>",
    //       "url": "<string>"
    //     },
    //     {
    //       "assignee_id": "<integer>",
    //       "group_id": "<integer>",
    //       "requester_id": "<integer>",
    //       "ticket_id": "<integer>",
    //       "score": "<string>",
    //       "comment": "<string>",
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "reason": "<string>",
    //       "reason_code": "<integer>",
    //       "reason_id": "<integer>",
    //       "updated_at": "<dateTime>",
    //       "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.

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"satisfaction_ratings");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        assignee_id = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].assignee_id");
        group_id = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].group_id");
        requester_id = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].requester_id");
        ticket_id = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].ticket_id");
        score = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].score");
        comment = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].comment");
        created_at = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].created_at");
        id = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].id");
        reason = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].reason");
        reason_code = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].reason_code");
        reason_id = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].reason_id");
        updated_at = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].updated_at");
        url = CkJsonObject_stringOf(jResp,"satisfaction_ratings[i].url");
        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/satisfaction_ratings

Postman Collection Item JSON

{
  "name": "List Satisfaction Ratings",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/satisfaction_ratings",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "satisfaction_ratings"
      ]
    },
    "description": "#### Allowed For\n* Agents\n\n#### Filters\n\n| Parameter  | Value\n| ---------- | -----\n| score      | offered, unoffered, received, received\\_with\\_comment, received\\_without\\_comment,<br/>good, good\\_with\\_comment, good\\_without\\_comment,<br/>bad, bad\\_with\\_comment, bad\\_without\\_comment\n| start_time | Time of the oldest satisfaction rating, as a [Unix epoch time](https://www.epochconverter.com/)\n| end_time   | Time of the most recent satisfaction rating, as a [Unix epoch time](https://www.epochconverter.com/)\n\nIf you specify an unqualified score such as `good`, the results include all the records with and without comments.\n\nExamples:\n\n* `/api/v2/satisfaction_ratings.json?score=bad`\n* `/api/v2/satisfaction_ratings.json?score=bad&start_time=1498151194`\n* `/api/v2/satisfaction_ratings.json?start_time=1340384793&end_time=1371920793`\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/satisfaction_ratings",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "satisfaction_ratings"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"satisfaction_ratings\": [\n    {\n      \"assignee_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"requester_id\": \"<integer>\",\n      \"ticket_id\": \"<integer>\",\n      \"score\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"reason\": \"<string>\",\n      \"reason_code\": \"<integer>\",\n      \"reason_id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"assignee_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"requester_id\": \"<integer>\",\n      \"ticket_id\": \"<integer>\",\n      \"score\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"reason\": \"<string>\",\n      \"reason_code\": \"<integer>\",\n      \"reason_id\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}