(Tcl) GeoOp - Mark a User as Deleted

Mark one or more users as deleted.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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}
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/geoop.json"]

# This example assumes we previously obtained an access token
set oauth2 [new_CkOAuth2]

CkOAuth2_put_AccessToken $oauth2 [CkJsonObject_stringOf $jsonToken "access_token"]

set rest [new_CkRest]

# 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.

set bAutoReconnect 1
set success [CkRest_Connect $rest "api.geoop.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    delete_CkRest $rest
    exit
}

# Provide the authentication credentials (i.e. the access token)
CkRest_SetAuthOAuth2 $rest $oauth2

# Set the X-Version header.
CkRest_AddHeader $rest "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
# 	        }
# 	    ]
# 	}

set jsonPostBody [new_CkJsonObject]

CkJsonObject_UpdateInt $jsonPostBody "users[0].id" 115
CkJsonObject_UpdateBool $jsonPostBody "users[0].deleted" 1
CkJsonObject_UpdateInt $jsonPostBody "users[1].id" 116
CkJsonObject_UpdateBool $jsonPostBody "users[1].deleted" 1
# Continue adding more users as needed..

# Examine the JSON we're about to send...
CkJsonObject_put_EmitCompact $jsonPostBody 0
puts [CkJsonObject_emit $jsonPostBody]

CkRest_AddHeader $rest "Content-Type" "application/json"

CkJsonObject_put_EmitCompact $jsonPostBody 1
set responseBody [CkRest_fullRequestString $rest "PATCH" "/users" [CkJsonObject_emit $jsonPostBody]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    delete_CkRest $rest
    delete_CkJsonObject $jsonPostBody
    exit
}

set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0

# If the response status code did not indicate success, then see what happened..
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "Request Header: "
    puts [CkRest_lastRequestHeader $rest]
    puts "----"
    puts "Response StatusCode = [CkRest_get_ResponseStatusCode $rest]"
    puts "Response StatusLine: [CkRest_responseStatusText $rest]"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    CkJsonObject_Load $json $responseBody
    puts [CkJsonObject_emit $json]

    # 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
    # 		    ]
    # 		  }
    # 		}
    # 

    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    delete_CkRest $rest
    delete_CkJsonObject $jsonPostBody
    delete_CkJsonObject $json
    exit

}

CkJsonObject_Load $json $responseBody
# Show the full JSON response..
puts [CkJsonObject_emit $json]

# 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": [
# 	    ]
# 	  }
# 	}
# 

delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
delete_CkJsonObject $jsonPostBody
delete_CkJsonObject $json