Chilkat Online Tools

lianja / Support API / List Target Failures

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/target_failures",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "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
    return
endif

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

// {
//   "target_failures": [
//     {
//       "consecutive_failure_count": "<integer>",
//       "created_at": "<dateTime>",
//       "id": "<integer>",
//       "raw_request": "<string>",
//       "raw_response": "<string>",
//       "status_code": "<integer>",
//       "target_name": "<string>",
//       "url": "<string>"
//     },
//     {
//       "consecutive_failure_count": "<integer>",
//       "created_at": "<dateTime>",
//       "id": "<integer>",
//       "raw_request": "<string>",
//       "raw_response": "<string>",
//       "status_code": "<integer>",
//       "target_name": "<string>",
//       "url": "<string>"
//     }
//   ]
// }

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

i = 0
lnCount_i = loJResp.SizeOfArray("target_failures")
do while i < lnCount_i
    loJResp.I = i
    lcConsecutive_failure_count = loJResp.StringOf("target_failures[i].consecutive_failure_count")
    lcCreated_at = loJResp.StringOf("target_failures[i].created_at")
    lcId = loJResp.StringOf("target_failures[i].id")
    lcRaw_request = loJResp.StringOf("target_failures[i].raw_request")
    lcRaw_response = loJResp.StringOf("target_failures[i].raw_response")
    lcStatus_code = loJResp.StringOf("target_failures[i].status_code")
    lcTarget_name = loJResp.StringOf("target_failures[i].target_name")
    lcUrl = loJResp.StringOf("target_failures[i].url")
    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/target_failures

Postman Collection Item JSON

{
  "name": "List Target Failures",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/target_failures",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "target_failures"
      ]
    },
    "description": "Returns the 25 most recent target failures, per target.\n\n#### Stability\n\n* Development\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/target_failures",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "target_failures"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"target_failures\": [\n    {\n      \"consecutive_failure_count\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"raw_request\": \"<string>\",\n      \"raw_response\": \"<string>\",\n      \"status_code\": \"<integer>\",\n      \"target_name\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"consecutive_failure_count\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"raw_request\": \"<string>\",\n      \"raw_response\": \"<string>\",\n      \"status_code\": \"<integer>\",\n      \"target_name\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}