Lua

GeoOp - Create Job

See more GeoOp Examples

Create a new job. 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 user, we must build and send the following JSON:

--     {
--       "jobs": [
--         {
--           "priority": 2,
--           "title": "Deliver More Donuts",
--           "description": "Deliver more donuts to the cafe.",
--           "client": {
--             "id": 9571218
--           },
--           "account": {
--             "id": 39409
--           },
--           "status": {
--             "id": 675900
--           },
--           "address": {
--             "line1": "1732 Pennsylvania Avenue NW",
--             "city": "Washington",
--             "postcode": "20006",
--           }
--         }
--       ]
--     }
--

local jsonJob = chilkat.JsonObject.new()
jsonJob:update_int("jobs[0].priority", 2)
jsonJob:update_string("jobs[0].title", "Deliver More Donuts")
jsonJob:update_string("jobs[0].description", "Deliver more donuts to the cafe.")
jsonJob:update_int("jobs[0].client.id", 9571218)
jsonJob:update_int("jobs[0].account.id", 39409)
jsonJob:update_int("jobs[0].status.id", 675900)
jsonJob:update_string("jobs[0].address.line1", "1732 Pennsylvania Avenue NW")
jsonJob:update_string("jobs[0].address.city", "Washington")
jsonJob:update_string("jobs[0].address.postcode", "20006")

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

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

jsonJob.emit_compact = true
local responseBody = rest:full_request_string("POST", "/jobs", jsonJob: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",
--       "jobs": [
--         {
--           "id": 17639811,
--           "reference": "1001",
--           "startTime": null,
--           "endTime": null,
--           "priority": 2,
--           "title": "Deliver More Donuts",
--           "description": "Deliver more donuts to the cafe.",
--           "jobNumber": null,
--           "deleted": false,
--           "type": "normal",
--           "created": "2016-10-31T13:36:47+00:00",
--           "modified": "2016-10-31T13:36:47+00:00",
--           "client": {
--             "id": 9571218
--           },
--           "billingClient": null,
--           "status": {
--             "id": 675900
--           },
--           "account": {
--             "id": 39409
--           },
--           "address": {
--             "line1": "1732 Pennsylvania Avenue NW",
--             "line2": "",
--             "city": "Washington",
--             "postcode": "20006",
--             "latitude": 38.8990534,
--             "longitude": -77.0401866
--           },
--           "metadata": {
--             "visitsCount": 0,
--             "assignedVisitsCount": 0,
--             "unassignedVisitsCount": 0,
--             "partsCount": 0,
--             "chargesCount": 0,
--             "timersCount": 0,
--             "notesCount": 0,
--             "parcelsCount": 0,
--             "paymentsCount": 0,
--             "documentsCount": 0
--           }
--         }
--       ],
--       "metadata": {
--         "receivedItemsCount": 1,
--         "validItems": [
--           0
--         ],
--         "invalidItems": [
--         ]
--       }
--     }
--