Chilkat2-Python

GeoOp - Mark a User as Deleted

See more GeoOp Examples

Mark one or more users as deleted. Chilkat2-Python

import sys
import chilkat2

success = 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}
jsonToken = chilkat2.JsonObject()
success = jsonToken.LoadFile("qa_data/tokens/geoop.json")

# This example assumes we previously obtained an access token
oauth2 = chilkat2.OAuth2()
oauth2.AccessToken = jsonToken.StringOf("access_token")

rest = chilkat2.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.

bAutoReconnect = True
success = rest.Connect("api.geoop.com",443,True,bAutoReconnect)
if (success != True):
    print(rest.LastErrorText)
    sys.exit()

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

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

jsonPostBody = chilkat2.JsonObject()
jsonPostBody.UpdateInt("users[0].id",115)
jsonPostBody.UpdateBool("users[0].deleted",True)
jsonPostBody.UpdateInt("users[1].id",116)
jsonPostBody.UpdateBool("users[1].deleted",True)
# Continue adding more users as needed..

# Examine the JSON we're about to send...
jsonPostBody.EmitCompact = False
print(jsonPostBody.Emit())

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

jsonPostBody.EmitCompact = True
responseBody = rest.FullRequestString("PATCH","/users",jsonPostBody.Emit())
if (rest.LastMethodSuccess != True):
    print(rest.LastErrorText)
    sys.exit()

json = chilkat2.JsonObject()
json.EmitCompact = False

# If the response status code did not indicate success, then see what happened..
if (rest.ResponseStatusCode != 200):
    print("Request Header: ")
    print(rest.LastRequestHeader)
    print("----")
    print("Response StatusCode = " + str(rest.ResponseStatusCode))
    print("Response StatusLine: " + rest.ResponseStatusText)
    print("Response Header:")
    print(rest.ResponseHeader)
    json.Load(responseBody)
    print(json.Emit())

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

    sys.exit()

json.Load(responseBody)
# Show the full JSON response..
print(json.Emit())

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