Chilkat Online Tools

Swift / Support API / Create a Satisfaction Rating

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    http.BasicAuth = true
    http.Login = "login"
    http.Password = "password"

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

    var resp: CkoHttpResponse? = http.QuickRequest("POST", url: "https://example.zendesk.com/api/v2/tickets/:ticket_id/satisfaction_rating")
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var assignee_id: String?
    var group_id: String?
    var requester_id: String?
    var ticket_id: String?
    var score: String?
    var comment: String?
    var created_at: String?
    var id: String?
    var reason: String?
    var reason_code: String?
    var reason_id: String?
    var updated_at: String?
    var url: String?

    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("satisfaction_rating").intValue
    while i < count_i {
        jResp.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}"
    }
  ]
}