Lua

GeoOp - Get all Jobs

See more GeoOp Examples

Gets all information about all jobs. 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 and send the following GET request:

-- GET /users HTTP/1.1
-- Host: api.geoop.com
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")

local responseBody = rest:full_request_no_body("GET", "/jobs")
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.. (see below)
print(json:emit())

-- These will be used for parsing date/time strings..
local dtime = chilkat.DateTime.new()
local bLocalTime = true
local dt = chilkat.DtObj.new()

-- Iterate over each job and get information..
local numRecords = json:size_of_array("jobs")
local i = 0
while i < numRecords do
    json.i = i
    print("job id: " .. json:string_of("jobs[i].id"))
    print("client id: " .. json:string_of("jobs[i].client.id"))
    print("account id: " .. json:string_of("jobs[i].account.id"))
    print("address line1: " .. json:string_of("jobs[i].address.line1"))

    dtime:set_from_timestamp(json:string_of("jobs[i].startTime"))
    dtime:to_dt_obj(bLocalTime, dt)

    print("created: " .. dt.month .. "/" .. dt.day .. "/" .. dt.year .. "  " .. dt.hour .. ":" .. dt.minute)

    print("----")
    i = i + 1
end

-- A sample jobs listing response:
--
--     {
--       "result": "success",
--       "jobs": [
--         {
--           "id": 17580761,
--           "reference": "1000",
--           "startTime": "2016-10-26T02:10:00+00:00",
--           "endTime": "2016-10-28T02:40:00+00:00",
--           "priority": 2,
--           "title": "[ Demo Job ]",
--           "description": "",
--           "jobNumber": null,
--           "deleted": false,
--           "type": "demo",
--           "created": "2015-09-03T02:11:32+00:00",
--           "modified": "2016-10-26T12:05:09+00:00",
--           "client": {
--             "id": 9555868
--           },
--           "billingClient": null,
--           "status": {
--             "id": 675900
--           },
--           "account": {
--             "id": 39409
--           },
--           "address": {
--             "line1": "21462 New York Avenue NW",
--             "line2": null,
--             "city": "Washington",
--             "postcode": "20005",
--             "latitude": 38.903959,
--             "longitude": -77.02137
--           },
--           "metadata": {
--             "visitsCount": 3,
--             "assignedVisitsCount": 3,
--             "unassignedVisitsCount": 0,
--             "partsCount": 1,
--             "chargesCount": 1,
--             "timersCount": 0,
--             "notesCount": 0,
--             "parcelsCount": 0,
--             "paymentsCount": 0,
--             "documentsCount": 1
--           }
--         },
--         {
--           "id": 17639295,
--           "reference": "1000",
--           "startTime": "2016-10-31T12:00:00+00:00",
--           "endTime": "2016-10-31T12:30:00+00:00",
--           "priority": 2,
--           "title": "Deliver Donuts",
--           "description": "Deliver donuts to the cafe.",
--           "jobNumber": "21122",
--           "deleted": false,
--           "type": "normal",
--           "created": "2016-10-31T12:07:14+00:00",
--           "modified": "2016-10-31T12:07:14+00:00",
--           "client": {
--             "id": 9555868
--           },
--           "billingClient": null,
--           "status": {
--             "id": 675900
--           },
--           "account": {
--             "id": 39409
--           },
--           "address": {
--             "line1": "1732 Pennsylvania Avenue NW",
--             "line2": null,
--             "city": "Washington",
--             "postcode": "20006",
--             "latitude": 38.8990534,
--             "longitude": -77.0401866
--           },
--           "metadata": {
--             "visitsCount": 1,
--             "assignedVisitsCount": 0,
--             "unassignedVisitsCount": 1,
--             "partsCount": 0,
--             "chargesCount": 0,
--             "timersCount": 0,
--             "notesCount": 0,
--             "parcelsCount": 0,
--             "paymentsCount": 0,
--             "documentsCount": 0
--           }
--         }
--       ],
--       "metadata": {
--         "page": 1,
--         "pagesCount": 1,
--         "recordsPerPage": 20,
--         "recordsCount": 2
--       }
--     }
--