Chilkat Online Tools

VB6 / Support API / Show SLA Policy

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

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

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/slas/policies/:sla_policy_id",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

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

' {
'   "sla_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

Dim field As String
Dim operator As String
Dim value As String
Dim business_hours As String
Dim metric As String
Dim priority As String
Dim target As String

Dim Title As String
Title = jResp.StringOf("sla_policy.title")
Dim Created_at As String
Created_at = jResp.StringOf("sla_policy.created_at")
Dim Description As String
Description = jResp.StringOf("sla_policy.description")
Dim Id As String
Id = jResp.StringOf("sla_policy.id")
Dim Position As String
Position = jResp.StringOf("sla_policy.position")
Dim Updated_at As String
Updated_at = jResp.StringOf("sla_policy.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("sla_policy.url")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("sla_policy.filter.all")
Do While i < count_i
    jResp.I = i
    field = jResp.StringOf("sla_policy.filter.all[i].field")
    operator = jResp.StringOf("sla_policy.filter.all[i].operator")
    value = jResp.StringOf("sla_policy.filter.all[i].value")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("sla_policy.filter.any")
Do While i < count_i
    jResp.I = i
    field = jResp.StringOf("sla_policy.filter.any[i].field")
    operator = jResp.StringOf("sla_policy.filter.any[i].operator")
    value = jResp.StringOf("sla_policy.filter.any[i].value")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("sla_policy.policy_metrics")
Do While i < count_i
    jResp.I = i
    business_hours = jResp.StringOf("sla_policy.policy_metrics[i].business_hours")
    metric = jResp.StringOf("sla_policy.policy_metrics[i].metric")
    priority = jResp.StringOf("sla_policy.policy_metrics[i].priority")
    target = jResp.StringOf("sla_policy.policy_metrics[i].target")
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show SLA Policy",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/slas/policies/:sla_policy_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "slas",
        "policies",
        ":sla_policy_id"
      ],
      "variable": [
        {
          "key": "sla_policy_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Availability\n\n* Accounts on the Support Professional or Suite Growth plan or above\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/slas/policies/:sla_policy_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "slas",
            "policies",
            ":sla_policy_id"
          ],
          "variable": [
            {
              "key": "sla_policy_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sla_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}"
    }
  ]
}