Lianja
Lianja
GeoOp - Mark a User as Deleted
See more GeoOp Examples
Mark one or more users as deleted.Chilkat Lianja Downloads
llSuccess = .F.
// 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}
loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/geoop.json")
// This example assumes we previously obtained an access token
loOauth2 = createobject("CkOAuth2")
loOauth2.AccessToken = loJsonToken.StringOf("access_token")
loRest = createobject("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.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.geoop.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
? loRest.LastErrorText
release loJsonToken
release loOauth2
release loRest
return
endif
// Provide the authentication credentials (i.e. the access token)
loRest.SetAuthOAuth2(loOauth2)
// Set the X-Version header.
loRest.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
// }
// ]
// }
loJsonPostBody = createobject("CkJsonObject")
loJsonPostBody.UpdateInt("users[0].id",115)
loJsonPostBody.UpdateBool("users[0].deleted",.T.)
loJsonPostBody.UpdateInt("users[1].id",116)
loJsonPostBody.UpdateBool("users[1].deleted",.T.)
// Continue adding more users as needed..
// Examine the JSON we're about to send...
loJsonPostBody.EmitCompact = .F.
? loJsonPostBody.Emit()
loRest.AddHeader("Content-Type","application/json")
loJsonPostBody.EmitCompact = .T.
lcResponseBody = loRest.FullRequestString("PATCH","/users",loJsonPostBody.Emit())
if (loRest.LastMethodSuccess <> .T.) then
? loRest.LastErrorText
release loJsonToken
release loOauth2
release loRest
release loJsonPostBody
return
endif
loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.
// If the response status code did not indicate success, then see what happened..
if (loRest.ResponseStatusCode <> 200) then
? "Request Header: "
? loRest.LastRequestHeader
? "----"
? "Response StatusCode = " + str(loRest.ResponseStatusCode)
? "Response StatusLine: " + loRest.ResponseStatusText
? "Response Header:"
? loRest.ResponseHeader
loJson.Load(lcResponseBody)
? loJson.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
// ]
// }
// }
//
release loJsonToken
release loOauth2
release loRest
release loJsonPostBody
release loJson
return
endif
loJson.Load(lcResponseBody)
// Show the full JSON response..
? loJson.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": [
// ]
// }
// }
//
release loJsonToken
release loOauth2
release loRest
release loJsonPostBody
release loJson