Chilkat Online Tools

Swift / Support API / Record a new skip for the current user

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/skips")
    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)

    // {
    //   "skip": {
    //     "created_at": "<dateTime>",
    //     "id": "<integer>",
    //     "reason": "<string>",
    //     "ticket": {
    //       "requester_id": "<integer>",
    //       "allow_attachments": "<boolean>",
    //       "allow_channelback": "<boolean>",
    //       "assignee_email": "<string>",
    //       "assignee_id": "<integer>",
    //       "attribute_value_ids": "<array>",
    //       "brand_id": "<integer>",
    //       "collaborator_ids": "<array>",
    //       "collaborators": [
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         },
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         }
    //       ],
    //       "comment": {},
    //       "created_at": "<dateTime>",
    //       "custom_fields": "<array>",
    //       "custom_status_id": "<integer>",
    //       "description": "<string>",
    //       "due_at": "<dateTime>",
    //       "email_cc_ids": "<array>",
    //       "email_ccs": {},
    //       "external_id": "<string>",
    //       "follower_ids": "<array>",
    //       "followers": {},
    //       "followup_ids": "<array>",
    //       "forum_topic_id": "<integer>",
    //       "from_messaging_channel": "<boolean>",
    //       "group_id": "<integer>",
    //       "has_incidents": "<boolean>",
    //       "id": "<integer>",
    //       "is_public": "<boolean>",
    //       "macro_id": "<integer>",
    //       "macro_ids": "<array>",
    //       "metadata": {},
    //       "organization_id": "<integer>",
    //       "priority": "normal",
    //       "problem_id": "<integer>",
    //       "raw_subject": "<string>",
    //       "recipient": "<string>",
    //       "requester": {},
    //       "safe_update": "<boolean>",
    //       "satisfaction_rating": {
    //         "ut_6f": true,
    //         "sed_fb1": -48186207
    //       },
    //       "sharing_agreement_ids": "<array>",
    //       "status": "pending",
    //       "subject": "<string>",
    //       "submitter_id": "<integer>",
    //       "tags": "<array>",
    //       "ticket_form_id": "<integer>",
    //       "type": "task",
    //       "updated_at": "<dateTime>",
    //       "updated_stamp": "<string>",
    //       "url": "<string>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "officiab": "mollit laborum nulla",
    //           "Duisa4": false,
    //           "ida": -77800757.90579444
    //         }
    //       },
    //       "via_followup_source_id": "<integer>",
    //       "via_id": "<integer>",
    //       "voice_comment": {}
    //     },
    //     "ticket_id": "<integer>",
    //     "updated_at": "<dateTime>",
    //     "user_id": "<integer>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var email: String?
    var name: String?

    var Created_at: String? = jResp.StringOf("skip.created_at")
    var Id: String? = jResp.StringOf("skip.id")
    var Reason: String? = jResp.StringOf("skip.reason")
    var Requester_id: String? = jResp.StringOf("skip.ticket.requester_id")
    var Allow_attachments: String? = jResp.StringOf("skip.ticket.allow_attachments")
    var Allow_channelback: String? = jResp.StringOf("skip.ticket.allow_channelback")
    var Assignee_email: String? = jResp.StringOf("skip.ticket.assignee_email")
    var Assignee_id: String? = jResp.StringOf("skip.ticket.assignee_id")
    var Attribute_value_ids: String? = jResp.StringOf("skip.ticket.attribute_value_ids")
    var Brand_id: String? = jResp.StringOf("skip.ticket.brand_id")
    var Collaborator_ids: String? = jResp.StringOf("skip.ticket.collaborator_ids")
    var TicketCreated_at: String? = jResp.StringOf("skip.ticket.created_at")
    var Custom_fields: String? = jResp.StringOf("skip.ticket.custom_fields")
    var Custom_status_id: String? = jResp.StringOf("skip.ticket.custom_status_id")
    var Description: String? = jResp.StringOf("skip.ticket.description")
    var Due_at: String? = jResp.StringOf("skip.ticket.due_at")
    var Email_cc_ids: String? = jResp.StringOf("skip.ticket.email_cc_ids")
    var External_id: String? = jResp.StringOf("skip.ticket.external_id")
    var Follower_ids: String? = jResp.StringOf("skip.ticket.follower_ids")
    var Followup_ids: String? = jResp.StringOf("skip.ticket.followup_ids")
    var Forum_topic_id: String? = jResp.StringOf("skip.ticket.forum_topic_id")
    var From_messaging_channel: String? = jResp.StringOf("skip.ticket.from_messaging_channel")
    var Group_id: String? = jResp.StringOf("skip.ticket.group_id")
    var Has_incidents: String? = jResp.StringOf("skip.ticket.has_incidents")
    var TicketId: String? = jResp.StringOf("skip.ticket.id")
    var Is_public: String? = jResp.StringOf("skip.ticket.is_public")
    var Macro_id: String? = jResp.StringOf("skip.ticket.macro_id")
    var Macro_ids: String? = jResp.StringOf("skip.ticket.macro_ids")
    var Organization_id: String? = jResp.StringOf("skip.ticket.organization_id")
    var Priority: String? = jResp.StringOf("skip.ticket.priority")
    var Problem_id: String? = jResp.StringOf("skip.ticket.problem_id")
    var Raw_subject: String? = jResp.StringOf("skip.ticket.raw_subject")
    var Recipient: String? = jResp.StringOf("skip.ticket.recipient")
    var Safe_update: String? = jResp.StringOf("skip.ticket.safe_update")
    var Ut_6f: Bool = jResp.BoolOf("skip.ticket.satisfaction_rating.ut_6f")
    var Sed_fb1: Int = jResp.IntOf("skip.ticket.satisfaction_rating.sed_fb1").intValue
    var Sharing_agreement_ids: String? = jResp.StringOf("skip.ticket.sharing_agreement_ids")
    var Status: String? = jResp.StringOf("skip.ticket.status")
    var Subject: String? = jResp.StringOf("skip.ticket.subject")
    var Submitter_id: String? = jResp.StringOf("skip.ticket.submitter_id")
    var Tags: String? = jResp.StringOf("skip.ticket.tags")
    var Ticket_form_id: String? = jResp.StringOf("skip.ticket.ticket_form_id")
    var v_Type: String? = jResp.StringOf("skip.ticket.type")
    var Updated_at: String? = jResp.StringOf("skip.ticket.updated_at")
    var Updated_stamp: String? = jResp.StringOf("skip.ticket.updated_stamp")
    var v_Url: String? = jResp.StringOf("skip.ticket.url")
    var Channel: String? = jResp.StringOf("skip.ticket.via.channel")
    var Officiab: String? = jResp.StringOf("skip.ticket.via.source.officiab")
    var Duisa4: Bool = jResp.BoolOf("skip.ticket.via.source.Duisa4")
    var Ida: String? = jResp.StringOf("skip.ticket.via.source.ida")
    var Via_followup_source_id: String? = jResp.StringOf("skip.ticket.via_followup_source_id")
    var Via_id: String? = jResp.StringOf("skip.ticket.via_id")
    var Ticket_id: String? = jResp.StringOf("skip.ticket_id")
    var skipUpdated_at: String? = jResp.StringOf("skip.updated_at")
    var User_id: String? = jResp.StringOf("skip.user_id")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("skip.ticket.collaborators").intValue
    while i < count_i {
        jResp.I = i
        email = jResp.StringOf("skip.ticket.collaborators[i].email")
        name = jResp.StringOf("skip.ticket.collaborators[i].name")
        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Record a new skip for the current user",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/skips",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "skips"
      ]
    },
    "description": "Record a new ticket skip for the current user.\n\n#### Allowed For\n\n* Agents\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/skips",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "skips"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"skip\": {\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"reason\": \"<string>\",\n    \"ticket\": {\n      \"requester_id\": \"<integer>\",\n      \"allow_attachments\": \"<boolean>\",\n      \"allow_channelback\": \"<boolean>\",\n      \"assignee_email\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"attribute_value_ids\": \"<array>\",\n      \"brand_id\": \"<integer>\",\n      \"collaborator_ids\": \"<array>\",\n      \"collaborators\": [\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"comment\": {},\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": \"<array>\",\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": \"<array>\",\n      \"email_ccs\": {},\n      \"external_id\": \"<string>\",\n      \"follower_ids\": \"<array>\",\n      \"followers\": {},\n      \"followup_ids\": \"<array>\",\n      \"forum_topic_id\": \"<integer>\",\n      \"from_messaging_channel\": \"<boolean>\",\n      \"group_id\": \"<integer>\",\n      \"has_incidents\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"macro_id\": \"<integer>\",\n      \"macro_ids\": \"<array>\",\n      \"metadata\": {},\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"normal\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"ut_6f\": true,\n        \"sed_fb1\": -48186207\n      },\n      \"sharing_agreement_ids\": \"<array>\",\n      \"status\": \"pending\",\n      \"subject\": \"<string>\",\n      \"submitter_id\": \"<integer>\",\n      \"tags\": \"<array>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"task\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_stamp\": \"<string>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"officiab\": \"mollit laborum nulla\",\n          \"Duisa4\": false,\n          \"ida\": -77800757.90579444\n        }\n      },\n      \"via_followup_source_id\": \"<integer>\",\n      \"via_id\": \"<integer>\",\n      \"voice_comment\": {}\n    },\n    \"ticket_id\": \"<integer>\",\n    \"updated_at\": \"<dateTime>\",\n    \"user_id\": \"<integer>\"\n  }\n}"
    }
  ]
}