Chilkat Online Tools

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

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
email: PWideChar;
name: PWideChar;
Created_at: PWideChar;
Id: PWideChar;
Reason: PWideChar;
Requester_id: PWideChar;
Allow_attachments: PWideChar;
Allow_channelback: PWideChar;
Assignee_email: PWideChar;
Assignee_id: PWideChar;
Attribute_value_ids: PWideChar;
Brand_id: PWideChar;
Collaborator_ids: PWideChar;
TicketCreated_at: PWideChar;
Custom_fields: PWideChar;
Custom_status_id: PWideChar;
Description: PWideChar;
Due_at: PWideChar;
Email_cc_ids: PWideChar;
External_id: PWideChar;
Follower_ids: PWideChar;
Followup_ids: PWideChar;
Forum_topic_id: PWideChar;
From_messaging_channel: PWideChar;
Group_id: PWideChar;
Has_incidents: PWideChar;
TicketId: PWideChar;
Is_public: PWideChar;
Macro_id: PWideChar;
Macro_ids: PWideChar;
Organization_id: PWideChar;
Priority: PWideChar;
Problem_id: PWideChar;
Raw_subject: PWideChar;
Recipient: PWideChar;
Safe_update: PWideChar;
Ut_6f: Boolean;
Sed_fb1: Integer;
Sharing_agreement_ids: PWideChar;
Status: PWideChar;
Subject: PWideChar;
Submitter_id: PWideChar;
Tags: PWideChar;
Ticket_form_id: PWideChar;
v_Type: PWideChar;
Updated_at: PWideChar;
Updated_stamp: PWideChar;
v_Url: PWideChar;
Channel: PWideChar;
Officiab: PWideChar;
Duisa4: Boolean;
Ida: PWideChar;
Via_followup_source_id: PWideChar;
Via_id: PWideChar;
Ticket_id: PWideChar;
skipUpdated_at: PWideChar;
User_id: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');

CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequest(http,'POST','https://example.zendesk.com/api/v2/skips');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

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

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

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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