PureBasic / Support API / Show Ticket Form
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/ticket_forms/:ticket_form_id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
aliqua6.s
Lorem_d.s
mollit_cf.i
ullamco_f7.s
consequate_.s
consectetur_00.i
laborum50.s
irure__c.i
Excepteur_38.s
sunt_8.s
nulla_48.s
ullamco_f6.s
strVal.s
Name.s = CkJsonObject::ckStringOf(jResp,"ticket_form.name")
Active.s = CkJsonObject::ckStringOf(jResp,"ticket_form.active")
Created_at.s = CkJsonObject::ckStringOf(jResp,"ticket_form.created_at")
Default.s = CkJsonObject::ckStringOf(jResp,"ticket_form.default")
Display_name.s = CkJsonObject::ckStringOf(jResp,"ticket_form.display_name")
End_user_visible.s = CkJsonObject::ckStringOf(jResp,"ticket_form.end_user_visible")
Id.s = CkJsonObject::ckStringOf(jResp,"ticket_form.id")
In_all_brands.s = CkJsonObject::ckStringOf(jResp,"ticket_form.in_all_brands")
Position.s = CkJsonObject::ckStringOf(jResp,"ticket_form.position")
Raw_display_name.s = CkJsonObject::ckStringOf(jResp,"ticket_form.raw_display_name")
Raw_name.s = CkJsonObject::ckStringOf(jResp,"ticket_form.raw_name")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"ticket_form.updated_at")
v_Url.s = CkJsonObject::ckStringOf(jResp,"ticket_form.url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"ticket_form.agent_conditions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
aliqua6 = CkJsonObject::ckStringOf(jResp,"ticket_form.agent_conditions[i].aliqua6")
Lorem_d = CkJsonObject::ckStringOf(jResp,"ticket_form.agent_conditions[i].Lorem_d")
mollit_cf = CkJsonObject::ckIntOf(jResp,"ticket_form.agent_conditions[i].mollit_cf")
ullamco_f7 = CkJsonObject::ckStringOf(jResp,"ticket_form.agent_conditions[i].ullamco_f7")
consequate_ = CkJsonObject::ckStringOf(jResp,"ticket_form.agent_conditions[i].consequate_")
consectetur_00 = CkJsonObject::ckIntOf(jResp,"ticket_form.agent_conditions[i].consectetur_00")
laborum50 = CkJsonObject::ckStringOf(jResp,"ticket_form.agent_conditions[i].laborum50")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"ticket_form.end_user_conditions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
irure__c = CkJsonObject::ckBoolOf(jResp,"ticket_form.end_user_conditions[i].irure__c")
Excepteur_38 = CkJsonObject::ckStringOf(jResp,"ticket_form.end_user_conditions[i].Excepteur_38")
sunt_8 = CkJsonObject::ckStringOf(jResp,"ticket_form.end_user_conditions[i].sunt_8")
nulla_48 = CkJsonObject::ckStringOf(jResp,"ticket_form.end_user_conditions[i].nulla_48")
ullamco_f6 = CkJsonObject::ckStringOf(jResp,"ticket_form.end_user_conditions[i].ullamco_f6")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"ticket_form.restricted_brand_ids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"ticket_form.restricted_brand_ids[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"ticket_form.ticket_field_ids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"ticket_form.ticket_field_ids[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
