Lua

GeoOp - Create Client

See more GeoOp Examples

Creates a new client. 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")

-- To create a new client, we can build and send the following JSON:
--     {
--       "clients": [
--         {
--           "firstName": "Joe",
--           "lastName": "Miller",
--           "companyName": "Miller Bakery",
--           "businessType": "Licensed Bakery",
--           "account": {
--             "id": 39409
--           },
--           "address": {
--             "line1": "1832 Pennsylvania Avenue NW",
--             "city": "Washington",
--             "postcode": "20006",
--           }
--         }
--     }

local jsonClient = chilkat.JsonObject.new()
jsonClient:update_int("clients[0].account.id", 39409)
jsonClient:update_string("clients[0].firstName", "Joe")
jsonClient:update_string("clients[0].lastName", "Miller")
jsonClient:update_string("clients[0].companyName", "Miller Bakery")
jsonClient:update_string("clients[0].businessType", "Licensed Bakery")
jsonClient:update_string("clients[0].address.line1", "1832 Pennsylvania Avenue NW")
jsonClient:update_string("clients[0].address.city", "Washington")
jsonClient:update_string("clients[0].address.postcode", "20006")

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

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

jsonClient.emit_compact = true
local responseBody = rest:full_request_string("POST", "/clients", jsonClient: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())
    return
end

json:load(responseBody)
-- Show the full JSON response..
print(json:emit())

-- The success JSON looks like this:

--     {
--       "result": "success",
--       "clients": [
--         {
--           "id": 9571218,
--           "firstName": "Joe",
--           "lastName": "Miller",
--           "companyName": "Miller Bakery",
--           "businessType": "Licensed Bakery",
--           "leadSource": "",
--           "emailAddress": null,
--           "phoneNumber": null,
--           "mobileNumber": null,
--           "faxNumber": null,
--           "notes": "",
--           "deleted": false,
--           "hasRecentJobs": false,
--           "created": "2016-10-31T13:02:07+00:00",
--           "modified": "2016-10-31T13:02:07+00:00",
--           "billingClient": null,
--           "account": {
--             "id": 39409
--           },
--           "address": {
--             "line1": "1832 Pennsylvania Avenue NW",
--             "line2": "",
--             "city": "Washington",
--             "postcode": "20006",
--             "latitude": 0,
--             "longitude": 0
--           },
--           "mailingAddress": {
--             "line1": "",
--             "line2": "",
--             "city": ""
--           }
--         }
--       ],
--       "metadata": {
--         "receivedItemsCount": 1,
--         "validItems": [
--           0
--         ],
--         "invalidItems": [
--         ]
--       }
--     }
--
--