Chilkat Online Tools

C# / Support API / Show Ticket Form

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

http.SetRequestHeader("Accept","application/json");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.zendesk.com/api/v2/ticket_forms/:ticket_form_id",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "ticket_form": {
//     "name": "<string>",
//     "active": "<boolean>",
//     "agent_conditions": [
//       {
//         "aliqua6": "proident deserunt",
//         "Lorem_d": "cillum dolor Excepteur ut",
//         "mollit_cf": -33059877,
//         "ullamco_f7": "dolore occaeca"
//       },
//       {
//         "consequate_": 29214347.18513973,
//         "consectetur_00": 83697330,
//         "laborum50": "cillum Ut"
//       }
//     ],
//     "created_at": "<dateTime>",
//     "default": "<boolean>",
//     "display_name": "<string>",
//     "end_user_conditions": [
//       {
//         "irure__c": false,
//         "Excepteur_38": -15203265.607602075,
//         "sunt_8": "culpa laboris Ut"
//       },
//       {
//         "nulla_48": "quis esse",
//         "ullamco_f6": -25516091.19614251
//       }
//     ],
//     "end_user_visible": "<boolean>",
//     "id": "<integer>",
//     "in_all_brands": "<boolean>",
//     "position": "<integer>",
//     "raw_display_name": "<string>",
//     "raw_name": "<string>",
//     "restricted_brand_ids": [
//       "<integer>",
//       "<integer>"
//     ],
//     "ticket_field_ids": [
//       "<integer>",
//       "<integer>"
//     ],
//     "updated_at": "<dateTime>",
//     "url": "<string>"
//   }
// }

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

string aliqua6;
string Lorem_d;
int mollit_cf;
string ullamco_f7;
string consequate_;
int consectetur_00;
string laborum50;
bool irure__c;
string Excepteur_38;
string sunt_8;
string nulla_48;
string ullamco_f6;
string strVal;

string Name = jResp.StringOf("ticket_form.name");
string Active = jResp.StringOf("ticket_form.active");
string Created_at = jResp.StringOf("ticket_form.created_at");
string Default = jResp.StringOf("ticket_form.default");
string Display_name = jResp.StringOf("ticket_form.display_name");
string End_user_visible = jResp.StringOf("ticket_form.end_user_visible");
string Id = jResp.StringOf("ticket_form.id");
string In_all_brands = jResp.StringOf("ticket_form.in_all_brands");
string Position = jResp.StringOf("ticket_form.position");
string Raw_display_name = jResp.StringOf("ticket_form.raw_display_name");
string Raw_name = jResp.StringOf("ticket_form.raw_name");
string Updated_at = jResp.StringOf("ticket_form.updated_at");
string v_Url = jResp.StringOf("ticket_form.url");
int i = 0;
int count_i = jResp.SizeOfArray("ticket_form.agent_conditions");
while (i < count_i) {
    jResp.I = i;
    aliqua6 = jResp.StringOf("ticket_form.agent_conditions[i].aliqua6");
    Lorem_d = jResp.StringOf("ticket_form.agent_conditions[i].Lorem_d");
    mollit_cf = jResp.IntOf("ticket_form.agent_conditions[i].mollit_cf");
    ullamco_f7 = jResp.StringOf("ticket_form.agent_conditions[i].ullamco_f7");
    consequate_ = jResp.StringOf("ticket_form.agent_conditions[i].consequate_");
    consectetur_00 = jResp.IntOf("ticket_form.agent_conditions[i].consectetur_00");
    laborum50 = jResp.StringOf("ticket_form.agent_conditions[i].laborum50");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("ticket_form.end_user_conditions");
while (i < count_i) {
    jResp.I = i;
    irure__c = jResp.BoolOf("ticket_form.end_user_conditions[i].irure__c");
    Excepteur_38 = jResp.StringOf("ticket_form.end_user_conditions[i].Excepteur_38");
    sunt_8 = jResp.StringOf("ticket_form.end_user_conditions[i].sunt_8");
    nulla_48 = jResp.StringOf("ticket_form.end_user_conditions[i].nulla_48");
    ullamco_f6 = jResp.StringOf("ticket_form.end_user_conditions[i].ullamco_f6");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("ticket_form.restricted_brand_ids");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("ticket_form.restricted_brand_ids[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("ticket_form.ticket_field_ids");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("ticket_form.ticket_field_ids[i]");
    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Ticket Form",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_forms/:ticket_form_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_forms",
        ":ticket_form_id"
      ],
      "variable": [
        {
          "key": "ticket_form_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins, Agents, and End Users\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/ticket_forms/:ticket_form_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_forms",
            ":ticket_form_id"
          ],
          "variable": [
            {
              "key": "ticket_form_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket_form\": {\n    \"name\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"agent_conditions\": [\n      {\n        \"aliqua6\": \"proident deserunt\",\n        \"Lorem_d\": \"cillum dolor Excepteur ut\",\n        \"mollit_cf\": -33059877,\n        \"ullamco_f7\": \"dolore occaeca\"\n      },\n      {\n        \"consequate_\": 29214347.18513973,\n        \"consectetur_00\": 83697330,\n        \"laborum50\": \"cillum Ut\"\n      }\n    ],\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"display_name\": \"<string>\",\n    \"end_user_conditions\": [\n      {\n        \"irure__c\": false,\n        \"Excepteur_38\": -15203265.607602075,\n        \"sunt_8\": \"culpa laboris Ut\"\n      },\n      {\n        \"nulla_48\": \"quis esse\",\n        \"ullamco_f6\": -25516091.19614251\n      }\n    ],\n    \"end_user_visible\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"in_all_brands\": \"<boolean>\",\n    \"position\": \"<integer>\",\n    \"raw_display_name\": \"<string>\",\n    \"raw_name\": \"<string>\",\n    \"restricted_brand_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"ticket_field_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}