lianja / 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.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/ticket_forms/:ticket_form_id",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// 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
lcName = loJResp.StringOf("ticket_form.name")
lcActive = loJResp.StringOf("ticket_form.active")
lcCreated_at = loJResp.StringOf("ticket_form.created_at")
lcDefault = loJResp.StringOf("ticket_form.default")
lcDisplay_name = loJResp.StringOf("ticket_form.display_name")
lcEnd_user_visible = loJResp.StringOf("ticket_form.end_user_visible")
lcId = loJResp.StringOf("ticket_form.id")
lcIn_all_brands = loJResp.StringOf("ticket_form.in_all_brands")
lcPosition = loJResp.StringOf("ticket_form.position")
lcRaw_display_name = loJResp.StringOf("ticket_form.raw_display_name")
lcRaw_name = loJResp.StringOf("ticket_form.raw_name")
lcUpdated_at = loJResp.StringOf("ticket_form.updated_at")
lcV_Url = loJResp.StringOf("ticket_form.url")
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_form.agent_conditions")
do while i < lnCount_i
loJResp.I = i
lcAliqua6 = loJResp.StringOf("ticket_form.agent_conditions[i].aliqua6")
lcLorem_d = loJResp.StringOf("ticket_form.agent_conditions[i].Lorem_d")
lnMollit_cf = loJResp.IntOf("ticket_form.agent_conditions[i].mollit_cf")
lcUllamco_f7 = loJResp.StringOf("ticket_form.agent_conditions[i].ullamco_f7")
lcConsequate_ = loJResp.StringOf("ticket_form.agent_conditions[i].consequate_")
lnConsectetur_00 = loJResp.IntOf("ticket_form.agent_conditions[i].consectetur_00")
lcLaborum50 = loJResp.StringOf("ticket_form.agent_conditions[i].laborum50")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_form.end_user_conditions")
do while i < lnCount_i
loJResp.I = i
llIrure__c = loJResp.BoolOf("ticket_form.end_user_conditions[i].irure__c")
lcExcepteur_38 = loJResp.StringOf("ticket_form.end_user_conditions[i].Excepteur_38")
lcSunt_8 = loJResp.StringOf("ticket_form.end_user_conditions[i].sunt_8")
lcNulla_48 = loJResp.StringOf("ticket_form.end_user_conditions[i].nulla_48")
lcUllamco_f6 = loJResp.StringOf("ticket_form.end_user_conditions[i].ullamco_f6")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_form.restricted_brand_ids")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("ticket_form.restricted_brand_ids[i]")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_form.ticket_field_ids")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("ticket_form.ticket_field_ids[i]")
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
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}"
}
]
}
