(PureBasic) GeoOp - Mark a User as Deleted

Mark one or more users as deleted.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    ; 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.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/geoop.json")

    ; This example assumes we previously obtained an access token
    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkOAuth2::setCkAccessToken(oauth2, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.i = 1
    success = CkRest::ckConnect(rest,"api.geoop.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide the authentication credentials (i.e. the access token)
    CkRest::ckSetAuthOAuth2(rest,oauth2)

    ; Set the X-Version header.
    CkRest::ckAddHeader(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
    ; 	        }
    ; 	    ]
    ; 	}

    jsonPostBody.i = CkJsonObject::ckCreate()
    If jsonPostBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(jsonPostBody,"users[0].id",115)
    CkJsonObject::ckUpdateBool(jsonPostBody,"users[0].deleted",1)
    CkJsonObject::ckUpdateInt(jsonPostBody,"users[1].id",116)
    CkJsonObject::ckUpdateBool(jsonPostBody,"users[1].deleted",1)
    ; Continue adding more users as needed..

    ; Examine the JSON we're about to send...
    CkJsonObject::setCkEmitCompact(jsonPostBody, 0)
    Debug CkJsonObject::ckEmit(jsonPostBody)

    CkRest::ckAddHeader(rest,"Content-Type","application/json")

    CkJsonObject::setCkEmitCompact(jsonPostBody, 1)
    responseBody.s = CkRest::ckFullRequestString(rest,"PATCH","/users",CkJsonObject::ckEmit(jsonPostBody))
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonPostBody)
        ProcedureReturn
    EndIf

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)

    ; If the response status code did not indicate success, then see what happened..
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Request Header: "
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "----"
        Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        CkJsonObject::ckLoad(json,responseBody)
        Debug CkJsonObject::ckEmit(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
        ; 		    ]
        ; 		  }
        ; 		}
        ; 

        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonPostBody)
        CkJsonObject::ckDispose(json)
        ProcedureReturn

    EndIf

    CkJsonObject::ckLoad(json,responseBody)
    ; Show the full JSON response..
    Debug CkJsonObject::ckEmit(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": [
    ; 	    ]
    ; 	  }
    ; 	}
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkOAuth2::ckDispose(oauth2)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(jsonPostBody)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure