Chilkat Online Tools

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

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/skips")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sEmail
Local $sName

Local $sCreated_at = $oJResp.StringOf("skip.created_at")
Local $sId = $oJResp.StringOf("skip.id")
Local $sReason = $oJResp.StringOf("skip.reason")
Local $sRequester_id = $oJResp.StringOf("skip.ticket.requester_id")
Local $sAllow_attachments = $oJResp.StringOf("skip.ticket.allow_attachments")
Local $sAllow_channelback = $oJResp.StringOf("skip.ticket.allow_channelback")
Local $sAssignee_email = $oJResp.StringOf("skip.ticket.assignee_email")
Local $sAssignee_id = $oJResp.StringOf("skip.ticket.assignee_id")
Local $sAttribute_value_ids = $oJResp.StringOf("skip.ticket.attribute_value_ids")
Local $sBrand_id = $oJResp.StringOf("skip.ticket.brand_id")
Local $sCollaborator_ids = $oJResp.StringOf("skip.ticket.collaborator_ids")
Local $sTicketCreated_at = $oJResp.StringOf("skip.ticket.created_at")
Local $sCustom_fields = $oJResp.StringOf("skip.ticket.custom_fields")
Local $sCustom_status_id = $oJResp.StringOf("skip.ticket.custom_status_id")
Local $sDescription = $oJResp.StringOf("skip.ticket.description")
Local $sDue_at = $oJResp.StringOf("skip.ticket.due_at")
Local $sEmail_cc_ids = $oJResp.StringOf("skip.ticket.email_cc_ids")
Local $sExternal_id = $oJResp.StringOf("skip.ticket.external_id")
Local $sFollower_ids = $oJResp.StringOf("skip.ticket.follower_ids")
Local $sFollowup_ids = $oJResp.StringOf("skip.ticket.followup_ids")
Local $sForum_topic_id = $oJResp.StringOf("skip.ticket.forum_topic_id")
Local $sFrom_messaging_channel = $oJResp.StringOf("skip.ticket.from_messaging_channel")
Local $sGroup_id = $oJResp.StringOf("skip.ticket.group_id")
Local $sHas_incidents = $oJResp.StringOf("skip.ticket.has_incidents")
Local $sTicketId = $oJResp.StringOf("skip.ticket.id")
Local $sIs_public = $oJResp.StringOf("skip.ticket.is_public")
Local $sMacro_id = $oJResp.StringOf("skip.ticket.macro_id")
Local $sMacro_ids = $oJResp.StringOf("skip.ticket.macro_ids")
Local $sOrganization_id = $oJResp.StringOf("skip.ticket.organization_id")
Local $sPriority = $oJResp.StringOf("skip.ticket.priority")
Local $sProblem_id = $oJResp.StringOf("skip.ticket.problem_id")
Local $sRaw_subject = $oJResp.StringOf("skip.ticket.raw_subject")
Local $sRecipient = $oJResp.StringOf("skip.ticket.recipient")
Local $sSafe_update = $oJResp.StringOf("skip.ticket.safe_update")
Local $bUt_6f = $oJResp.BoolOf("skip.ticket.satisfaction_rating.ut_6f")
Local $iSed_fb1 = $oJResp.IntOf("skip.ticket.satisfaction_rating.sed_fb1")
Local $sSharing_agreement_ids = $oJResp.StringOf("skip.ticket.sharing_agreement_ids")
Local $sStatus = $oJResp.StringOf("skip.ticket.status")
Local $sSubject = $oJResp.StringOf("skip.ticket.subject")
Local $sSubmitter_id = $oJResp.StringOf("skip.ticket.submitter_id")
Local $sTags = $oJResp.StringOf("skip.ticket.tags")
Local $sTicket_form_id = $oJResp.StringOf("skip.ticket.ticket_form_id")
Local $sV_Type = $oJResp.StringOf("skip.ticket.type")
Local $sUpdated_at = $oJResp.StringOf("skip.ticket.updated_at")
Local $sUpdated_stamp = $oJResp.StringOf("skip.ticket.updated_stamp")
Local $sV_Url = $oJResp.StringOf("skip.ticket.url")
Local $sChannel = $oJResp.StringOf("skip.ticket.via.channel")
Local $sOfficiab = $oJResp.StringOf("skip.ticket.via.source.officiab")
Local $bDuisa4 = $oJResp.BoolOf("skip.ticket.via.source.Duisa4")
Local $sIda = $oJResp.StringOf("skip.ticket.via.source.ida")
Local $sVia_followup_source_id = $oJResp.StringOf("skip.ticket.via_followup_source_id")
Local $sVia_id = $oJResp.StringOf("skip.ticket.via_id")
Local $sTicket_id = $oJResp.StringOf("skip.ticket_id")
Local $skipUpdated_at = $oJResp.StringOf("skip.updated_at")
Local $sUser_id = $oJResp.StringOf("skip.user_id")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("skip.ticket.collaborators")
While $i < $iCount_i
    $oJResp.I = $i
    $sEmail = $oJResp.StringOf("skip.ticket.collaborators[i].email")
    $sName = $oJResp.StringOf("skip.ticket.collaborators[i].name")
    $i = $i + 1
Wend

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