Chilkat Online Tools

VB6 / Support API / List Job Statuses

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/job_statuses",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)

' {
'   "job_statuses": [
'     {
'       "id": "<string>",
'       "message": "<string>",
'       "progress": "<integer>",
'       "results": [
'         {
'           "id": "<integer>",
'           "index": "<integer>"
'         },
'         {
'           "id": "<integer>",
'           "index": "<integer>"
'         }
'       ],
'       "status": "<string>",
'       "total": "<integer>",
'       "url": "<string>"
'     },
'     {
'       "id": "<string>",
'       "message": "<string>",
'       "progress": "<integer>",
'       "results": [
'         {
'           "id": "<integer>",
'           "index": "<integer>"
'         },
'         {
'           "id": "<integer>",
'           "index": "<integer>"
'         }
'       ],
'       "status": "<string>",
'       "total": "<integer>",
'       "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 id As String
Dim message As String
Dim progress As String
Dim status As String
Dim total As String
Dim url As String
Dim j As Long
Dim count_j As Long
Dim index As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("job_statuses")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("job_statuses[i].id")
    message = jResp.StringOf("job_statuses[i].message")
    progress = jResp.StringOf("job_statuses[i].progress")
    status = jResp.StringOf("job_statuses[i].status")
    total = jResp.StringOf("job_statuses[i].total")
    url = jResp.StringOf("job_statuses[i].url")
    j = 0
    count_j = jResp.SizeOfArray("job_statuses[i].results")
    Do While j < count_j
        jResp.J = j
        id = jResp.StringOf("job_statuses[i].results[j].id")
        index = jResp.StringOf("job_statuses[i].results[j].index")
        j = j + 1
    Loop
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Job Statuses",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/job_statuses",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "job_statuses"
      ]
    },
    "description": "Shows the statuses for background jobs. Statuses are sorted first by completion date and then by creation date in descending order.\n\n#### Allowed For:\n\n* Agents\n\n#### Pagination\n\n* Cursor pagination\n\nSee [Pagination](/api-reference/introduction/pagination/#using-cursor-pagination).\n\nReturns a maximum of 100 records per page sorted by `completed_at desc, created_at desc`. Does not allow any other sort order.\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/job_statuses",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "job_statuses"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"job_statuses\": [\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}