Lua

GeoOp - Mark a User as Deleted

See more GeoOp Examples

Mark one or more users as deleted. Lua

local chilkat = require("chilkat")

-- 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}
local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/geoop.json")

-- This example assumes we previously obtained an access token
local oauth2 = chilkat.OAuth2.new()
oauth2.access_token = jsonToken:string_of("access_token")

local rest = chilkat.Rest.new()

-- 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
success = rest:connect("api.geoop.com", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- Provide the authentication credentials (i.e. the access token)
rest:set_auth_oauth2(oauth2)

-- Set the X-Version header.
rest:add_header("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
--             }
--         ]
--     }

local jsonPostBody = chilkat.JsonObject.new()
jsonPostBody:update_int("users[0].id", 115)
jsonPostBody:update_bool("users[0].deleted", true)
jsonPostBody:update_int("users[1].id", 116)
jsonPostBody:update_bool("users[1].deleted", true)
-- Continue adding more users as needed..

-- Examine the JSON we're about to send...
jsonPostBody.emit_compact = false
print(jsonPostBody:emit())

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

jsonPostBody.emit_compact = true
local responseBody = rest:full_request_string("PATCH", "/users", jsonPostBody:emit())
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

local json = chilkat.JsonObject.new()
json.emit_compact = false

-- If the response status code did not indicate success, then see what happened..
if rest.response_status_code ~= 200 then
    print("Request Header: ")
    print(rest.last_request_header)
    print("----")
    print("Response StatusCode = " .. rest.response_status_code)
    print("Response StatusLine: " .. rest.response_status_text)
    print("Response Header:")
    print(rest.response_header)
    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
    --             ]
    --           }
    --         }
    --

    return
end

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