Foxpro / Support API / List OLA Policies
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcTitle
LOCAL lcCreated_at
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL j
LOCAL lnCount_j
LOCAL lcField
LOCAL lcOperator
LOCAL lcValue
LOCAL lcBusiness_hours
LOCAL lcMetric
LOCAL lcPriority
LOCAL lcTarget
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
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",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)
* {
* "count": "<integer>",
* "next_page": "<string>",
* "ola_policies": [
* {
* "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>"
* },
* {
* "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>"
* }
* ],
* "previous_page": "<string>"
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("ola_policies")
DO WHILE i < lnCount_i
loJResp.I = i
lcTitle = loJResp.StringOf("ola_policies[i].title")
lcCreated_at = loJResp.StringOf("ola_policies[i].created_at")
lcDescription = loJResp.StringOf("ola_policies[i].description")
lcId = loJResp.StringOf("ola_policies[i].id")
lcPosition = loJResp.StringOf("ola_policies[i].position")
lcUpdated_at = loJResp.StringOf("ola_policies[i].updated_at")
lcUrl = loJResp.StringOf("ola_policies[i].url")
j = 0
lnCount_j = loJResp.SizeOfArray("ola_policies[i].filter.all")
DO WHILE j < lnCount_j
loJResp.J = j
lcField = loJResp.StringOf("ola_policies[i].filter.all[j].field")
lcOperator = loJResp.StringOf("ola_policies[i].filter.all[j].operator")
lcValue = loJResp.StringOf("ola_policies[i].filter.all[j].value")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("ola_policies[i].filter.any")
DO WHILE j < lnCount_j
loJResp.J = j
lcField = loJResp.StringOf("ola_policies[i].filter.any[j].field")
lcOperator = loJResp.StringOf("ola_policies[i].filter.any[j].operator")
lcValue = loJResp.StringOf("ola_policies[i].filter.any[j].value")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("ola_policies[i].policy_metrics")
DO WHILE j < lnCount_j
loJResp.J = j
lcBusiness_hours = loJResp.StringOf("ola_policies[i].policy_metrics[j].business_hours")
lcMetric = loJResp.StringOf("ola_policies[i].policy_metrics[j].metric")
lcPriority = loJResp.StringOf("ola_policies[i].policy_metrics[j].priority")
lcTarget = loJResp.StringOf("ola_policies[i].policy_metrics[j].target")
j = j + 1
ENDDO
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
Postman Collection Item JSON
{
"name": "List OLA Policies",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/olas/policies",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies"
]
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"ola_policies\": [\n {\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 {\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 ],\n \"previous_page\": \"<string>\"\n}"
}
]
}
