(Tcl) GeoOp - Create Job

Create a new job.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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..
# 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.

set bAutoReconnect 1
set success [CkRest_Connect $rest "api.geoop.com" 443 1 $bAutoReconnect]
if {$success != 1} 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"

# 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",
# 	      }
# 	    }
# 	  ]
# 	}
# 

set jsonJob [new_CkJsonObject]

CkJsonObject_UpdateInt $jsonJob "jobs[0].priority" 2
CkJsonObject_UpdateString $jsonJob "jobs[0].title" "Deliver More Donuts"
CkJsonObject_UpdateString $jsonJob "jobs[0].description" "Deliver more donuts to the cafe."
CkJsonObject_UpdateInt $jsonJob "jobs[0].client.id" 9571218
CkJsonObject_UpdateInt $jsonJob "jobs[0].account.id" 39409
CkJsonObject_UpdateInt $jsonJob "jobs[0].status.id" 675900
CkJsonObject_UpdateString $jsonJob "jobs[0].address.line1" "1732 Pennsylvania Avenue NW"
CkJsonObject_UpdateString $jsonJob "jobs[0].address.city" "Washington"
CkJsonObject_UpdateString $jsonJob "jobs[0].address.postcode" "20006"

# Examine the JSON we're about to send...
CkJsonObject_put_EmitCompact $jsonJob 0
puts [CkJsonObject_emit $jsonJob]

CkRest_AddHeader $rest "Content-Type" "application/json"

CkJsonObject_put_EmitCompact $jsonJob 1
set responseBody [CkRest_fullRequestString $rest "POST" "/jobs" [CkJsonObject_emit $jsonJob]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    delete_CkRest $rest
    delete_CkJsonObject $jsonJob
    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 $jsonJob
    delete_CkJsonObject $json
    exit
}

CkJsonObject_Load $json $responseBody
# Show the full JSON response..
puts [CkJsonObject_emit $json]

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

delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
delete_CkJsonObject $jsonJob
delete_CkJsonObject $json