Chilkat Online Tools

Foxpro / Support API / List Satisfaction Ratings

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAssignee_id
LOCAL lcGroup_id
LOCAL lcRequester_id
LOCAL lcTicket_id
LOCAL lcScore
LOCAL lcComment
LOCAL lcCreated_at
LOCAL lcId
LOCAL lcReason
LOCAL lcReason_code
LOCAL lcReason_id
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL i
LOCAL lnCount_i

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/satisfaction_ratings",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

i = 0
lnCount_i = loJResp.SizeOfArray("satisfaction_ratings")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcAssignee_id = loJResp.StringOf("satisfaction_ratings[i].assignee_id")
    lcGroup_id = loJResp.StringOf("satisfaction_ratings[i].group_id")
    lcRequester_id = loJResp.StringOf("satisfaction_ratings[i].requester_id")
    lcTicket_id = loJResp.StringOf("satisfaction_ratings[i].ticket_id")
    lcScore = loJResp.StringOf("satisfaction_ratings[i].score")
    lcComment = loJResp.StringOf("satisfaction_ratings[i].comment")
    lcCreated_at = loJResp.StringOf("satisfaction_ratings[i].created_at")
    lcId = loJResp.StringOf("satisfaction_ratings[i].id")
    lcReason = loJResp.StringOf("satisfaction_ratings[i].reason")
    lcReason_code = loJResp.StringOf("satisfaction_ratings[i].reason_code")
    lcReason_id = loJResp.StringOf("satisfaction_ratings[i].reason_id")
    lcUpdated_at = loJResp.StringOf("satisfaction_ratings[i].updated_at")
    lcUrl = loJResp.StringOf("satisfaction_ratings[i].url")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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}"
    }
  ]
}