Chilkat Online Tools

Foxpro / Support API / List Routing Attribute Definitions

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcConditions_allType
LOCAL lcItemsType
LOCAL lcSubjectType
LOCAL lcDefault
LOCAL lcTitleType
LOCAL lcTitleDefault
LOCAL lnMaxItems
LOCAL lcConditions_anyType
LOCAL lcSubjectDefault
LOCAL lnConditions_anyMaxItems

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

loHttp = CreateObject('Chilkat.Http')

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

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

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

loJResp = CreateObject('Chilkat.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)

* {
*   "definitions": {
*     "type": "object",
*     "properties": {
*       "conditions_all": {
*         "type": "array",
*         "items": {
*           "type": "object",
*           "properties": {
*             "subject": {
*               "type": "string",
*               "default": "<string>"
*             },
*             "title": {
*               "type": "string",
*               "default": "<string>"
*             }
*           }
*         },
*         "maxItems": 2
*       },
*       "conditions_any": {
*         "type": "array",
*         "items": {
*           "type": "object",
*           "properties": {
*             "subject": {
*               "type": "string",
*               "default": "<string>"
*             },
*             "title": {
*               "type": "string",
*               "default": "<string>"
*             }
*           }
*         },
*         "maxItems": 2
*       }
*     }
*   }
* }

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

lcV_Type = loJResp.StringOf("definitions.type")
lcConditions_allType = loJResp.StringOf("definitions.properties.conditions_all.type")
lcItemsType = loJResp.StringOf("definitions.properties.conditions_all.items.type")
lcSubjectType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.type")
lcDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.subject.default")
lcTitleType = loJResp.StringOf("definitions.properties.conditions_all.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.conditions_all.items.properties.title.default")
lnMaxItems = loJResp.IntOf("definitions.properties.conditions_all.maxItems")
lcConditions_anyType = loJResp.StringOf("definitions.properties.conditions_any.type")
lcItemsType = loJResp.StringOf("definitions.properties.conditions_any.items.type")
lcSubjectType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.type")
lcSubjectDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.subject.default")
lcTitleType = loJResp.StringOf("definitions.properties.conditions_any.items.properties.title.type")
lcTitleDefault = loJResp.StringOf("definitions.properties.conditions_any.items.properties.title.default")
lnConditions_anyMaxItems = loJResp.IntOf("definitions.properties.conditions_any.maxItems")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Routing Attribute Definitions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/routing/attributes/definitions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "routing",
        "attributes",
        "definitions"
      ]
    },
    "description": "Returns the condition definitions that can be configured to apply attributes to a ticket.\n\n#### Allowed For\n\n* Admins\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/routing/attributes/definitions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "routing",
            "attributes",
            "definitions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"definitions\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"conditions_all\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      },\n      \"conditions_any\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      }\n    }\n  }\n}"
    }
  ]
}