Chilkat Online Tools

autoit / Support API / List Targets

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/targets",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "targets": [
;     {
;       "project_id": "<string>",
;       "resource": "<string>",
;       "target_url": "<string>",
;       "title": "<string>",
;       "token": "<string>",
;       "type": "<string>",
;       "active": "<boolean>",
;       "created_at": "<dateTime>",
;       "id": "<integer>",
;       "message_id": "<string>",
;       "password": "<string>",
;       "todo_list_id": "<string>",
;       "username": "<string>"
;     },
;     {
;       "project_id": "<string>",
;       "resource": "<string>",
;       "target_url": "<string>",
;       "title": "<string>",
;       "token": "<string>",
;       "type": "<string>",
;       "active": "<boolean>",
;       "created_at": "<dateTime>",
;       "id": "<integer>",
;       "message_id": "<string>",
;       "password": "<string>",
;       "todo_list_id": "<string>",
;       "username": "<string>"
;     }
;   ]
; }

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

Local $sProject_id
Local $sResource
Local $sTarget_url
Local $sTitle
Local $sToken
Local $sV_type
Local $sActive
Local $sCreated_at
Local $sId
Local $sMessage_id
Local $sPassword
Local $sTodo_list_id
Local $sUsername

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("targets")
While $i < $iCount_i
    $oJResp.I = $i
    $sProject_id = $oJResp.StringOf("targets[i].project_id")
    $sResource = $oJResp.StringOf("targets[i].resource")
    $sTarget_url = $oJResp.StringOf("targets[i].target_url")
    $sTitle = $oJResp.StringOf("targets[i].title")
    $sToken = $oJResp.StringOf("targets[i].token")
    $sV_type = $oJResp.StringOf("targets[i].type")
    $sActive = $oJResp.StringOf("targets[i].active")
    $sCreated_at = $oJResp.StringOf("targets[i].created_at")
    $sId = $oJResp.StringOf("targets[i].id")
    $sMessage_id = $oJResp.StringOf("targets[i].message_id")
    $sPassword = $oJResp.StringOf("targets[i].password")
    $sTodo_list_id = $oJResp.StringOf("targets[i].todo_list_id")
    $sUsername = $oJResp.StringOf("targets[i].username")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Targets",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/targets",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "targets"
      ]
    },
    "description": "#### Allowed For\n\n* Agents\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/targets",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "targets"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"targets\": [\n    {\n      \"project_id\": \"<string>\",\n      \"resource\": \"<string>\",\n      \"target_url\": \"<string>\",\n      \"title\": \"<string>\",\n      \"token\": \"<string>\",\n      \"type\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"message_id\": \"<string>\",\n      \"password\": \"<string>\",\n      \"todo_list_id\": \"<string>\",\n      \"username\": \"<string>\"\n    },\n    {\n      \"project_id\": \"<string>\",\n      \"resource\": \"<string>\",\n      \"target_url\": \"<string>\",\n      \"title\": \"<string>\",\n      \"token\": \"<string>\",\n      \"type\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"message_id\": \"<string>\",\n      \"password\": \"<string>\",\n      \"todo_list_id\": \"<string>\",\n      \"username\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}