Chilkat Online Tools

Foxpro / Support API / Create a Satisfaction Rating

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
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")

loResp = loHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/tickets/:ticket_id/satisfaction_rating")
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

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

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

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

RELEASE loResp

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

* {
*   "satisfaction_rating": [
*     {
*       "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_rating")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcAssignee_id = loJResp.StringOf("satisfaction_rating[i].assignee_id")
    lcGroup_id = loJResp.StringOf("satisfaction_rating[i].group_id")
    lcRequester_id = loJResp.StringOf("satisfaction_rating[i].requester_id")
    lcTicket_id = loJResp.StringOf("satisfaction_rating[i].ticket_id")
    lcScore = loJResp.StringOf("satisfaction_rating[i].score")
    lcComment = loJResp.StringOf("satisfaction_rating[i].comment")
    lcCreated_at = loJResp.StringOf("satisfaction_rating[i].created_at")
    lcId = loJResp.StringOf("satisfaction_rating[i].id")
    lcReason = loJResp.StringOf("satisfaction_rating[i].reason")
    lcReason_code = loJResp.StringOf("satisfaction_rating[i].reason_code")
    lcReason_id = loJResp.StringOf("satisfaction_rating[i].reason_id")
    lcUpdated_at = loJResp.StringOf("satisfaction_rating[i].updated_at")
    lcUrl = loJResp.StringOf("satisfaction_rating[i].url")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/satisfaction_rating

Postman Collection Item JSON

{
  "name": "Create a Satisfaction Rating",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/satisfaction_rating",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "satisfaction_rating"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates a CSAT rating for a solved ticket, or for a ticket that was previously\nsolved and then reopened.\n\nOnly the end user listed as the ticket requester can create a satisfaction rating for the ticket.\n\n#### Allowed For\n\n* End user who requested the ticket\n\nThe end user must be a verified user.\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/satisfaction_rating",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "satisfaction_rating"
          ],
          "variable": [
            {
              "key": "ticket_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"satisfaction_rating\": [\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}"
    }
  ]
}