Chilkat Online Tools

delphiDll / Support API / List Ticket Skips

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
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;
Created_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;
Id: 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;
In_56: Integer;
Magnae7: PWideChar;
Deseruntc1e: Boolean;
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;
Utacc: PWideChar;
Enim049: Boolean;
In__: PWideChar;
Reprehenderit_06: Integer;
Via_followup_source_id: PWideChar;
Via_id: PWideChar;
ticket_id: PWideChar;
updated_at: PWideChar;
user_id: PWideChar;
Velit_05: Integer;
Tempor__e: Integer;
j: Integer;
count_j: Integer;
email: PWideChar;
name: 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');

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'sort_order','asc');

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

resp := CkHttp_QuickRequestParams(http,'GET','https://example.zendesk.com/api/v2/users/:user_id/skips',queryParams);
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)

// {
//   "skips": [
//     {
//       "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": "urgent",
//         "problem_id": "<integer>",
//         "raw_subject": "<string>",
//         "recipient": "<string>",
//         "requester": {},
//         "safe_update": "<boolean>",
//         "satisfaction_rating": {
//           "in_56": -77996997,
//           "magnae7": "quis aliqua voluptate et",
//           "deseruntc1e": false
//         },
//         "sharing_agreement_ids": "<array>",
//         "status": "closed",
//         "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": {
//             "utacc": "do aliqua magn",
//             "enim049": false,
//             "in__": "culpa officia ex non",
//             "reprehenderit_06": -27967024
//           }
//         },
//         "via_followup_source_id": "<integer>",
//         "via_id": "<integer>",
//         "voice_comment": {}
//       },
//       "ticket_id": "<integer>",
//       "updated_at": "<dateTime>",
//       "user_id": "<integer>"
//     },
//     {
//       "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": "urgent",
//         "problem_id": "<integer>",
//         "raw_subject": "<string>",
//         "recipient": "<string>",
//         "requester": {},
//         "safe_update": "<boolean>",
//         "satisfaction_rating": {
//           "velit_05": -77931495
//         },
//         "sharing_agreement_ids": "<array>",
//         "status": "closed",
//         "subject": "<string>",
//         "submitter_id": "<integer>",
//         "tags": "<array>",
//         "ticket_form_id": "<integer>",
//         "type": "problem",
//         "updated_at": "<dateTime>",
//         "updated_stamp": "<string>",
//         "url": "<string>",
//         "via": {
//           "channel": "<string>",
//           "source": {
//             "tempor__e": -69130011
//           }
//         },
//         "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

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'skips');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    created_at := CkJsonObject__stringOf(jResp,'skips[i].created_at');
    id := CkJsonObject__stringOf(jResp,'skips[i].id');
    reason := CkJsonObject__stringOf(jResp,'skips[i].reason');
    Requester_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.requester_id');
    Allow_attachments := CkJsonObject__stringOf(jResp,'skips[i].ticket.allow_attachments');
    Allow_channelback := CkJsonObject__stringOf(jResp,'skips[i].ticket.allow_channelback');
    Assignee_email := CkJsonObject__stringOf(jResp,'skips[i].ticket.assignee_email');
    Assignee_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.assignee_id');
    Attribute_value_ids := CkJsonObject__stringOf(jResp,'skips[i].ticket.attribute_value_ids');
    Brand_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.brand_id');
    Collaborator_ids := CkJsonObject__stringOf(jResp,'skips[i].ticket.collaborator_ids');
    Created_at := CkJsonObject__stringOf(jResp,'skips[i].ticket.created_at');
    Custom_fields := CkJsonObject__stringOf(jResp,'skips[i].ticket.custom_fields');
    Custom_status_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.custom_status_id');
    Description := CkJsonObject__stringOf(jResp,'skips[i].ticket.description');
    Due_at := CkJsonObject__stringOf(jResp,'skips[i].ticket.due_at');
    Email_cc_ids := CkJsonObject__stringOf(jResp,'skips[i].ticket.email_cc_ids');
    External_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.external_id');
    Follower_ids := CkJsonObject__stringOf(jResp,'skips[i].ticket.follower_ids');
    Followup_ids := CkJsonObject__stringOf(jResp,'skips[i].ticket.followup_ids');
    Forum_topic_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.forum_topic_id');
    From_messaging_channel := CkJsonObject__stringOf(jResp,'skips[i].ticket.from_messaging_channel');
    Group_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.group_id');
    Has_incidents := CkJsonObject__stringOf(jResp,'skips[i].ticket.has_incidents');
    Id := CkJsonObject__stringOf(jResp,'skips[i].ticket.id');
    Is_public := CkJsonObject__stringOf(jResp,'skips[i].ticket.is_public');
    Macro_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.macro_id');
    Macro_ids := CkJsonObject__stringOf(jResp,'skips[i].ticket.macro_ids');
    Organization_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.organization_id');
    Priority := CkJsonObject__stringOf(jResp,'skips[i].ticket.priority');
    Problem_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.problem_id');
    Raw_subject := CkJsonObject__stringOf(jResp,'skips[i].ticket.raw_subject');
    Recipient := CkJsonObject__stringOf(jResp,'skips[i].ticket.recipient');
    Safe_update := CkJsonObject__stringOf(jResp,'skips[i].ticket.safe_update');
    In_56 := CkJsonObject_IntOf(jResp,'skips[i].ticket.satisfaction_rating.in_56');
    Magnae7 := CkJsonObject__stringOf(jResp,'skips[i].ticket.satisfaction_rating.magnae7');
    Deseruntc1e := CkJsonObject_BoolOf(jResp,'skips[i].ticket.satisfaction_rating.deseruntc1e');
    Sharing_agreement_ids := CkJsonObject__stringOf(jResp,'skips[i].ticket.sharing_agreement_ids');
    Status := CkJsonObject__stringOf(jResp,'skips[i].ticket.status');
    Subject := CkJsonObject__stringOf(jResp,'skips[i].ticket.subject');
    Submitter_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.submitter_id');
    Tags := CkJsonObject__stringOf(jResp,'skips[i].ticket.tags');
    Ticket_form_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.ticket_form_id');
    v_Type := CkJsonObject__stringOf(jResp,'skips[i].ticket.type');
    Updated_at := CkJsonObject__stringOf(jResp,'skips[i].ticket.updated_at');
    Updated_stamp := CkJsonObject__stringOf(jResp,'skips[i].ticket.updated_stamp');
    v_Url := CkJsonObject__stringOf(jResp,'skips[i].ticket.url');
    Channel := CkJsonObject__stringOf(jResp,'skips[i].ticket.via.channel');
    Utacc := CkJsonObject__stringOf(jResp,'skips[i].ticket.via.source.utacc');
    Enim049 := CkJsonObject_BoolOf(jResp,'skips[i].ticket.via.source.enim049');
    In__ := CkJsonObject__stringOf(jResp,'skips[i].ticket.via.source.in__');
    Reprehenderit_06 := CkJsonObject_IntOf(jResp,'skips[i].ticket.via.source.reprehenderit_06');
    Via_followup_source_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.via_followup_source_id');
    Via_id := CkJsonObject__stringOf(jResp,'skips[i].ticket.via_id');
    ticket_id := CkJsonObject__stringOf(jResp,'skips[i].ticket_id');
    updated_at := CkJsonObject__stringOf(jResp,'skips[i].updated_at');
    user_id := CkJsonObject__stringOf(jResp,'skips[i].user_id');
    Velit_05 := CkJsonObject_IntOf(jResp,'skips[i].ticket.satisfaction_rating.velit_05');
    Tempor__e := CkJsonObject_IntOf(jResp,'skips[i].ticket.via.source.tempor__e');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'skips[i].ticket.collaborators');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        email := CkJsonObject__stringOf(jResp,'skips[i].ticket.collaborators[j].email');
        name := CkJsonObject__stringOf(jResp,'skips[i].ticket.collaborators[j].name');
        j := j + 1;
      end;

    i := i + 1;
  end;

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

Curl Command

curl  -u login:password -G -d "sort_order=asc"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/skips

Postman Collection Item JSON

{
  "name": "List Ticket Skips",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id/skips?sort_order=asc",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id",
        "skips"
      ],
      "query": [
        {
          "key": "sort_order",
          "value": "asc",
          "description": "Sort order. Defaults to \"asc\""
        }
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        },
        {
          "key": "ticket_id",
          "value": "<integer>",
          "description": "(Required) The ID of the ticket"
        }
      ]
    },
    "description": "Archived tickets are not included in the response. See\n[About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756) in\nthe Support Help Center.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n* Agents with \"View only\" or higher reports permissions in Support.\n  These permissions are distinct from Explore permissions.\n* Agents retrieving their own skips\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/:user_id/skips?sort_order=asc",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id",
            "skips"
          ],
          "query": [
            {
              "key": "sort_order",
              "value": "asc",
              "description": "Sort order. Defaults to \"asc\""
            }
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"skips\": [\n    {\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\": \"urgent\",\n        \"problem_id\": \"<integer>\",\n        \"raw_subject\": \"<string>\",\n        \"recipient\": \"<string>\",\n        \"requester\": {},\n        \"safe_update\": \"<boolean>\",\n        \"satisfaction_rating\": {\n          \"in_56\": -77996997,\n          \"magnae7\": \"quis aliqua voluptate et\",\n          \"deseruntc1e\": false\n        },\n        \"sharing_agreement_ids\": \"<array>\",\n        \"status\": \"closed\",\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            \"utacc\": \"do aliqua magn\",\n            \"enim049\": false,\n            \"in__\": \"culpa officia ex non\",\n            \"reprehenderit_06\": -27967024\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    {\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\": \"urgent\",\n        \"problem_id\": \"<integer>\",\n        \"raw_subject\": \"<string>\",\n        \"recipient\": \"<string>\",\n        \"requester\": {},\n        \"safe_update\": \"<boolean>\",\n        \"satisfaction_rating\": {\n          \"velit_05\": -77931495\n        },\n        \"sharing_agreement_ids\": \"<array>\",\n        \"status\": \"closed\",\n        \"subject\": \"<string>\",\n        \"submitter_id\": \"<integer>\",\n        \"tags\": \"<array>\",\n        \"ticket_form_id\": \"<integer>\",\n        \"type\": \"problem\",\n        \"updated_at\": \"<dateTime>\",\n        \"updated_stamp\": \"<string>\",\n        \"url\": \"<string>\",\n        \"via\": {\n          \"channel\": \"<string>\",\n          \"source\": {\n            \"tempor__e\": -69130011\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  ]\n}"
    }
  ]
}