Chilkat Online Tools

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

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

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

    // 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) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        return;
    }

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

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    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) {
        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;
    }



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