AutoIt

GeoOp - Mark a User as Deleted

See more GeoOp Examples

Mark one or more users as deleted. AutoIt

Local $bSuccess = False

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

; This example also assumes an OAuth2 access token was previously fetched.
; and saved in a JSON file.  

; First get our previously obtained access token.
; {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":999236}
$oJsonToken = ObjCreate("Chilkat.JsonObject")
$bSuccess = $oJsonToken.LoadFile("qa_data/tokens/geoop.json")

; This example assumes we previously obtained an access token
$oOauth2 = ObjCreate("Chilkat.OAuth2")
$oOauth2.AccessToken = $oJsonToken.StringOf("access_token")

$oRest = ObjCreate("Chilkat.Rest")

; Connect to GeoOp..
; Note: The same REST object, once connected, can be used for many requests.
; The bAutoReconnect argument allows it to automatically reconnect as required for any subsequent request.

Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("api.geoop.com",443,True,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; Provide the authentication credentials (i.e. the access token)
$oRest.SetAuthOAuth2($oOauth2)

; Set the X-Version header.
$oRest.AddHeader("X-Version","1.0")

; We'll send a POST that looks like this:
; 
; 	PATCH /users HTTP/1.1
; 	Host: api.geoop.com
; 	Authorization: Bearer oJ_7Hj.f-F3f.kL
; 	Content-Type: application/json
; 	X-Version: 1.0
; 
; 	{
; 	    "users": [
; 	        {
; 	            "id": 115,
; 	            "deleted": true
; 	        },
; 	        {
; 	            "id": 116,
; 	            "deleted": true
; 	        }
; 	    ]
; 	}

$oJsonPostBody = ObjCreate("Chilkat.JsonObject")
$oJsonPostBody.UpdateInt("users[0].id",115)
$oJsonPostBody.UpdateBool("users[0].deleted",True)
$oJsonPostBody.UpdateInt("users[1].id",116)
$oJsonPostBody.UpdateBool("users[1].deleted",True)
; Continue adding more users as needed..

; Examine the JSON we're about to send...
$oJsonPostBody.EmitCompact = False
ConsoleWrite($oJsonPostBody.Emit() & @CRLF)

$oRest.AddHeader("Content-Type","application/json")

$oJsonPostBody.EmitCompact = True
Local $sResponseBody = $oRest.FullRequestString("PATCH","/users",$oJsonPostBody.Emit())
If ($oRest.LastMethodSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False

; If the response status code did not indicate success, then see what happened..
If ($oRest.ResponseStatusCode <> 200) Then
    ConsoleWrite("Request Header: " & @CRLF)
    ConsoleWrite($oRest.LastRequestHeader & @CRLF)
    ConsoleWrite("----" & @CRLF)
    ConsoleWrite("Response StatusCode = " & $oRest.ResponseStatusCode & @CRLF)
    ConsoleWrite("Response StatusLine: " & $oRest.ResponseStatusText & @CRLF)
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oRest.ResponseHeader & @CRLF)
    $oJson.Load($sResponseBody)
    ConsoleWrite($oJson.Emit() & @CRLF)

    ; If a user ID does not exist, we'll get an error response body that looks like this:

    ; 		{
    ; 		  "result": "failure",
    ; 		  "failures": [
    ; 		    {
    ; 		      "rawData": {
    ; 		        "id": 115,
    ; 		        "deleted": true
    ; 		      },
    ; 		      "errors": [
    ; 		        {
    ; 		          "type": "client",
    ; 		          "code": 1012,
    ; 		          "message": "Item does not exist, or you do not have permission to access the item.",
    ; 		          "description": "Make certain that you specified the correct item ID, and that you have permission to access the item."
    ; 		        }
    ; 		      ]
    ; 		    }
    ; 		  ],
    ; 		  "metadata": {
    ; 		    "receivedItemsCount": 1,
    ; 		    "validItems": [
    ; 		    ],
    ; 		    "invalidItems": [
    ; 		      0
    ; 		    ]
    ; 		  }
    ; 		}
    ; 

    Exit

EndIf

$oJson.Load($sResponseBody)
; Show the full JSON response..
ConsoleWrite($oJson.Emit() & @CRLF)

; The success JSON looks like this:

; 	{
; 	  "result": "success",
; 	  "users": [
; 	    {
; 	      "id": 984242,
; 	      "firstName": "John",
; 	      "lastName": "Doe",
; 	      "companyName": "Chilkat Software, inc.",
; 	      "email": "sales@chilkatsoft.com",
; 	      "phone": "",
; 	      "mobile": "2223334444",
; 	      "hourlyRate": 0,
; 	      "active": 1,
; 	      "deleted": true,
; 	      "colour": "#8162E7",
; 	      "created": "2016-10-26T17:52:30+00:00",
; 	      "modified": "2016-10-31T11:47:18+00:00",
; 	      "isAssignable": true,
; 	      "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984242.jpg",
; 	      "role": {
; 	        "id": 3
; 	      },
; 	      "account": {
; 	        "id": 39409
; 	      },
; 	      "status": {
; 	        "message": "",
; 	        "timestamp": "2016-10-26T17:52:30+00:00"
; 	      }
; 	    }
; 	  ],
; 	  "metadata": {
; 	    "receivedItemsCount": 1,
; 	    "validItems": [
; 	      0
; 	    ],
; 	    "invalidItems": [
; 	    ]
; 	  }
; 	}
;