DataFlex / Support API / List Satisfaction Ratings
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAssignee_id
String sGroup_id
String sRequester_id
String sTicket_id
String sScore
String sComment
String sCreated_at
String sId
String sReason
String sReason_code
String sReason_id
String sUpdated_at
String sUrl
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://example.zendesk.com/api/v2/satisfaction_ratings" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "satisfaction_ratings" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "satisfaction_ratings[i].assignee_id" To sAssignee_id
Get ComStringOf Of hoJResp "satisfaction_ratings[i].group_id" To sGroup_id
Get ComStringOf Of hoJResp "satisfaction_ratings[i].requester_id" To sRequester_id
Get ComStringOf Of hoJResp "satisfaction_ratings[i].ticket_id" To sTicket_id
Get ComStringOf Of hoJResp "satisfaction_ratings[i].score" To sScore
Get ComStringOf Of hoJResp "satisfaction_ratings[i].comment" To sComment
Get ComStringOf Of hoJResp "satisfaction_ratings[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "satisfaction_ratings[i].id" To sId
Get ComStringOf Of hoJResp "satisfaction_ratings[i].reason" To sReason
Get ComStringOf Of hoJResp "satisfaction_ratings[i].reason_code" To sReason_code
Get ComStringOf Of hoJResp "satisfaction_ratings[i].reason_id" To sReason_id
Get ComStringOf Of hoJResp "satisfaction_ratings[i].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "satisfaction_ratings[i].url" To sUrl
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
