Chilkat Online Tools

Foxpro / Support API / Show OLA Policy

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcField
LOCAL lcOperator
LOCAL lcValue
LOCAL lcBusiness_hours
LOCAL lcMetric
LOCAL lcPriority
LOCAL lcTarget
LOCAL lcTitle
LOCAL lcCreated_at
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/:ola_policy_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
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)

* {
*   "ola_policy": {
*     "title": "<string>",
*     "filter": {
*       "all": [
*         {
*           "field": "<string>",
*           "operator": "<string>",
*           "value": "<string>"
*         },
*         {
*           "field": "<string>",
*           "operator": "<string>",
*           "value": "<string>"
*         }
*       ],
*       "any": [
*         {
*           "field": "<string>",
*           "operator": "<string>",
*           "value": "<string>"
*         },
*         {
*           "field": "<string>",
*           "operator": "<string>",
*           "value": "<string>"
*         }
*       ]
*     },
*     "created_at": "<dateTime>",
*     "description": "<string>",
*     "id": "<integer>",
*     "policy_metrics": [
*       {
*         "business_hours": "<boolean>",
*         "metric": "<string>",
*         "priority": "<string>",
*         "target": "<integer>"
*       },
*       {
*         "business_hours": "<boolean>",
*         "metric": "<string>",
*         "priority": "<string>",
*         "target": "<integer>"
*       }
*     ],
*     "position": "<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

lcTitle = loJResp.StringOf("ola_policy.title")
lcCreated_at = loJResp.StringOf("ola_policy.created_at")
lcDescription = loJResp.StringOf("ola_policy.description")
lcId = loJResp.StringOf("ola_policy.id")
lcPosition = loJResp.StringOf("ola_policy.position")
lcUpdated_at = loJResp.StringOf("ola_policy.updated_at")
lcV_Url = loJResp.StringOf("ola_policy.url")
i = 0
lnCount_i = loJResp.SizeOfArray("ola_policy.filter.all")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("ola_policy.filter.all[i].field")
    lcOperator = loJResp.StringOf("ola_policy.filter.all[i].operator")
    lcValue = loJResp.StringOf("ola_policy.filter.all[i].value")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("ola_policy.filter.any")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("ola_policy.filter.any[i].field")
    lcOperator = loJResp.StringOf("ola_policy.filter.any[i].operator")
    lcValue = loJResp.StringOf("ola_policy.filter.any[i].value")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("ola_policy.policy_metrics")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcBusiness_hours = loJResp.StringOf("ola_policy.policy_metrics[i].business_hours")
    lcMetric = loJResp.StringOf("ola_policy.policy_metrics[i].metric")
    lcPriority = loJResp.StringOf("ola_policy.policy_metrics[i].priority")
    lcTarget = loJResp.StringOf("ola_policy.policy_metrics[i].target")
    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/olas/policies/:ola_policy_id

Postman Collection Item JSON

{
  "name": "Show OLA Policy",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/olas/policies/:ola_policy_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "olas",
        "policies",
        ":ola_policy_id"
      ],
      "variable": [
        {
          "key": "ola_policy_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/olas/policies/:ola_policy_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "olas",
            "policies",
            ":ola_policy_id"
          ],
          "variable": [
            {
              "key": "ola_policy_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ola_policy\": {\n    \"title\": \"<string>\",\n    \"filter\": {\n      \"all\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"any\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    },\n    \"created_at\": \"<dateTime>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"policy_metrics\": [\n      {\n        \"business_hours\": \"<boolean>\",\n        \"metric\": \"<string>\",\n        \"priority\": \"<string>\",\n        \"target\": \"<integer>\"\n      },\n      {\n        \"business_hours\": \"<boolean>\",\n        \"metric\": \"<string>\",\n        \"priority\": \"<string>\",\n        \"target\": \"<integer>\"\n      }\n    ],\n    \"position\": \"<integer>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}