Tcl
Tcl
GeoOp - Get all Jobs
See more GeoOp Examples
Gets all information about all jobs.Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# 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}
set jsonToken [new_CkJsonObject]
set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/geoop.json"]
# This example assumes we previously obtained an access token
set oauth2 [new_CkOAuth2]
CkOAuth2_put_AccessToken $oauth2 [CkJsonObject_stringOf $jsonToken "access_token"]
set rest [new_CkRest]
# Connect to GeoOp and send the following GET request:
# GET /users HTTP/1.1
# Host: api.geoop.com
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.geoop.com" 443 1 $bAutoReconnect]
if {$success == 0} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
exit
}
# Provide the authentication credentials (i.e. the access token)
CkRest_SetAuthOAuth2 $rest $oauth2
# Set the X-Version header.
CkRest_AddHeader $rest "X-Version" "1.0"
set responseBody [CkRest_fullRequestNoBody $rest "GET" "/jobs"]
if {[CkRest_get_LastMethodSuccess $rest] == 0} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
exit
}
set json [new_CkJsonObject]
CkJsonObject_put_EmitCompact $json 0
# If the response status code did not indicate success, then see what happened..
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
puts "Request Header: "
puts [CkRest_lastRequestHeader $rest]
puts "----"
puts "Response StatusCode = [CkRest_get_ResponseStatusCode $rest]"
puts "Response StatusLine: [CkRest_responseStatusText $rest]"
puts "Response Header:"
puts [CkRest_responseHeader $rest]
CkJsonObject_Load $json $responseBody
puts [CkJsonObject_emit $json]
delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
delete_CkJsonObject $json
exit
}
CkJsonObject_Load $json $responseBody
# Show the full JSON response.. (see below)
puts [CkJsonObject_emit $json]
# These will be used for parsing date/time strings..
set dtime [new_CkDateTime]
set bLocalTime 1
set dt [new_CkDtObj]
# Iterate over each job and get information..
set numRecords [CkJsonObject_SizeOfArray $json "jobs"]
set i 0
while {$i < $numRecords} {
CkJsonObject_put_I $json $i
puts "job id: [CkJsonObject_stringOf $json {jobs[i].id}]"
puts "client id: [CkJsonObject_stringOf $json {jobs[i].client.id}]"
puts "account id: [CkJsonObject_stringOf $json {jobs[i].account.id}]"
puts "address line1: [CkJsonObject_stringOf $json {jobs[i].address.line1}]"
CkDateTime_SetFromTimestamp $dtime [CkJsonObject_stringOf $json "jobs[i].startTime"]
CkDateTime_ToDtObj $dtime $bLocalTime $dt
puts "created: [CkDtObj_get_Month $dt]/[CkDtObj_get_Day $dt]/[CkDtObj_get_Year $dt] [CkDtObj_get_Hour $dt]:[CkDtObj_get_Minute $dt]"
puts "----"
set i [expr $i + 1]
}
# 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
# }
# }
#
delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkDateTime $dtime
delete_CkDtObj $dt