Chilkat Online Tools

Python / Support API / Create a Satisfaction Rating

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("password")

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

# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/tickets/:ticket_id/satisfaction_rating")
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.header())
    print("Failed.")

    sys.exit()

# 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
count_i = jResp.SizeOfArray("satisfaction_rating")
while i < count_i :
    jResp.put_I(i)
    assignee_id = jResp.stringOf("satisfaction_rating[i].assignee_id")
    group_id = jResp.stringOf("satisfaction_rating[i].group_id")
    requester_id = jResp.stringOf("satisfaction_rating[i].requester_id")
    ticket_id = jResp.stringOf("satisfaction_rating[i].ticket_id")
    score = jResp.stringOf("satisfaction_rating[i].score")
    comment = jResp.stringOf("satisfaction_rating[i].comment")
    created_at = jResp.stringOf("satisfaction_rating[i].created_at")
    id = jResp.stringOf("satisfaction_rating[i].id")
    reason = jResp.stringOf("satisfaction_rating[i].reason")
    reason_code = jResp.stringOf("satisfaction_rating[i].reason_code")
    reason_id = jResp.stringOf("satisfaction_rating[i].reason_id")
    updated_at = jResp.stringOf("satisfaction_rating[i].updated_at")
    url = jResp.stringOf("satisfaction_rating[i].url")
    i = i + 1

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