Chilkat Online Tools

Foxpro / Support API / Show Custom Ticket Status

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStatus_category
LOCAL lcAgent_label
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcDescription
LOCAL lcEnd_user_description
LOCAL lcEnd_user_label
LOCAL lcId
LOCAL lcRaw_agent_label
LOCAL lcRaw_description
LOCAL lcRaw_end_user_description
LOCAL lcRaw_end_user_label
LOCAL lcUpdated_at

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/custom_statuses/:custom_status_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
ENDIF

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

* {
*   "custom_status": {
*     "status_category": "open",
*     "agent_label": "<string>",
*     "active": "<boolean>",
*     "created_at": "<dateTime>",
*     "default": "<boolean>",
*     "description": "<string>",
*     "end_user_description": "<string>",
*     "end_user_label": "<string>",
*     "id": "<integer>",
*     "raw_agent_label": "<string>",
*     "raw_description": "<string>",
*     "raw_end_user_description": "<string>",
*     "raw_end_user_label": "<string>",
*     "updated_at": "<dateTime>"
*   }
* }

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

lcStatus_category = loJResp.StringOf("custom_status.status_category")
lcAgent_label = loJResp.StringOf("custom_status.agent_label")
lcActive = loJResp.StringOf("custom_status.active")
lcCreated_at = loJResp.StringOf("custom_status.created_at")
lcDefault = loJResp.StringOf("custom_status.default")
lcDescription = loJResp.StringOf("custom_status.description")
lcEnd_user_description = loJResp.StringOf("custom_status.end_user_description")
lcEnd_user_label = loJResp.StringOf("custom_status.end_user_label")
lcId = loJResp.StringOf("custom_status.id")
lcRaw_agent_label = loJResp.StringOf("custom_status.raw_agent_label")
lcRaw_description = loJResp.StringOf("custom_status.raw_description")
lcRaw_end_user_description = loJResp.StringOf("custom_status.raw_end_user_description")
lcRaw_end_user_label = loJResp.StringOf("custom_status.raw_end_user_label")
lcUpdated_at = loJResp.StringOf("custom_status.updated_at")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Custom Ticket Status",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_statuses",
        ":custom_status_id"
      ],
      "variable": [
        {
          "key": "custom_status_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns the custom ticket status object.\n\n#### Allowed For\n\n* End Users\n"
  },
  "response": [
    {
      "name": "Custom Status",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_statuses",
            ":custom_status_id"
          ],
          "variable": [
            {
              "key": "custom_status_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_status\": {\n    \"status_category\": \"open\",\n    \"agent_label\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"raw_agent_label\": \"<string>\",\n    \"raw_description\": \"<string>\",\n    \"raw_end_user_description\": \"<string>\",\n    \"raw_end_user_label\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}