PureBasic / Support API / List Target Failures
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/target_failures",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
consecutive_failure_count.s
created_at.s
id.s
raw_request.s
raw_response.s
status_code.s
target_name.s
url.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"target_failures")
While i < count_i
CkJsonObject::setCkI(jResp, i)
consecutive_failure_count = CkJsonObject::ckStringOf(jResp,"target_failures[i].consecutive_failure_count")
created_at = CkJsonObject::ckStringOf(jResp,"target_failures[i].created_at")
id = CkJsonObject::ckStringOf(jResp,"target_failures[i].id")
raw_request = CkJsonObject::ckStringOf(jResp,"target_failures[i].raw_request")
raw_response = CkJsonObject::ckStringOf(jResp,"target_failures[i].raw_response")
status_code = CkJsonObject::ckStringOf(jResp,"target_failures[i].status_code")
target_name = CkJsonObject::ckStringOf(jResp,"target_failures[i].target_name")
url = CkJsonObject::ckStringOf(jResp,"target_failures[i].url")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}