Chilkat Online Tools

autoit / Support API / Set Agent Attribute Values

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.Http")
Local $bSuccess

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

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

Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/routing/agents/:user_id/instance_values")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

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

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

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

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

; {
;   "attribute_values": [
;     {
;       "attribute_id": "<string>",
;       "created_at": "<dateTime>",
;       "id": "<string>",
;       "name": "<string>",
;       "updated_at": "<dateTime>",
;       "url": "<string>"
;     },
;     {
;       "attribute_id": "<string>",
;       "created_at": "<dateTime>",
;       "id": "<string>",
;       "name": "<string>",
;       "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

Local $sAttribute_id
Local $sCreated_at
Local $sId
Local $sName
Local $sUpdated_at
Local $sUrl

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("attribute_values")
While $i < $iCount_i
    $oJResp.I = $i
    $sAttribute_id = $oJResp.StringOf("attribute_values[i].attribute_id")
    $sCreated_at = $oJResp.StringOf("attribute_values[i].created_at")
    $sId = $oJResp.StringOf("attribute_values[i].id")
    $sName = $oJResp.StringOf("attribute_values[i].name")
    $sUpdated_at = $oJResp.StringOf("attribute_values[i].updated_at")
    $sUrl = $oJResp.StringOf("attribute_values[i].url")
    $i = $i + 1
Wend

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/routing/agents/:user_id/instance_values

Postman Collection Item JSON

{
  "name": "Set Agent Attribute Values",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/routing/agents/:user_id/instance_values",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "routing",
        "agents",
        ":user_id",
        "instance_values"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Adds the specified attributes if no attributes exists, or replaces all existing attributes with the specified attributes.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/routing/agents/:user_id/instance_values",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "routing",
            "agents",
            ":user_id",
            "instance_values"
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attribute_values\": [\n    {\n      \"attribute_id\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"attribute_id\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}