Ruby

GeoOp - Create Job

See more GeoOp Examples

Create a new job. Ruby

require 'chilkat'

success = false

# 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}
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/geoop.json")

# This example assumes we previously obtained an access token
oauth2 = Chilkat::CkOAuth2.new()
oauth2.put_AccessToken(jsonToken.stringOf("access_token"))

rest = Chilkat::CkRest.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.

bAutoReconnect = true
success = rest.Connect("api.geoop.com",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Provide the authentication credentials (i.e. the access token)
rest.SetAuthOAuth2(oauth2)

# Set the X-Version header.
rest.AddHeader("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",
# 	      }
# 	    }
# 	  ]
# 	}
# 

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

# Examine the JSON we're about to send...
jsonJob.put_EmitCompact(false)
print jsonJob.emit() + "\n";

rest.AddHeader("Content-Type","application/json")

jsonJob.put_EmitCompact(true)
responseBody = rest.fullRequestString("POST","/jobs",jsonJob.emit())
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)

# If the response status code did not indicate success, then see what happened..
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    json.Load(responseBody)
    print json.emit() + "\n";
    exit
end

json.Load(responseBody)
# Show the full JSON response..
print json.emit() + "\n";

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