Ruby

GeoOp - Create Client

See more GeoOp Examples

Creates a new client. 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 client, we can build and send the following JSON:
# 	{
# 	  "clients": [
# 	    {
# 	      "firstName": "Joe",
# 	      "lastName": "Miller",
# 	      "companyName": "Miller Bakery",
# 	      "businessType": "Licensed Bakery",
# 	      "account": {
# 	        "id": 39409
# 	      },
# 	      "address": {
# 	        "line1": "1832 Pennsylvania Avenue NW",
# 	        "city": "Washington",
# 	        "postcode": "20006",
# 	      }
# 	    }
# 	}

jsonClient = Chilkat::CkJsonObject.new()
jsonClient.UpdateInt("clients[0].account.id",39409)
jsonClient.UpdateString("clients[0].firstName","Joe")
jsonClient.UpdateString("clients[0].lastName","Miller")
jsonClient.UpdateString("clients[0].companyName","Miller Bakery")
jsonClient.UpdateString("clients[0].businessType","Licensed Bakery")
jsonClient.UpdateString("clients[0].address.line1","1832 Pennsylvania Avenue NW")
jsonClient.UpdateString("clients[0].address.city","Washington")
jsonClient.UpdateString("clients[0].address.postcode","20006")

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

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

jsonClient.put_EmitCompact(true)
responseBody = rest.fullRequestString("POST","/clients",jsonClient.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",
# 	  "clients": [
# 	    {
# 	      "id": 9571218,
# 	      "firstName": "Joe",
# 	      "lastName": "Miller",
# 	      "companyName": "Miller Bakery",
# 	      "businessType": "Licensed Bakery",
# 	      "leadSource": "",
# 	      "emailAddress": null,
# 	      "phoneNumber": null,
# 	      "mobileNumber": null,
# 	      "faxNumber": null,
# 	      "notes": "",
# 	      "deleted": false,
# 	      "hasRecentJobs": false,
# 	      "created": "2016-10-31T13:02:07+00:00",
# 	      "modified": "2016-10-31T13:02:07+00:00",
# 	      "billingClient": null,
# 	      "account": {
# 	        "id": 39409
# 	      },
# 	      "address": {
# 	        "line1": "1832 Pennsylvania Avenue NW",
# 	        "line2": "",
# 	        "city": "Washington",
# 	        "postcode": "20006",
# 	        "latitude": 0,
# 	        "longitude": 0
# 	      },
# 	      "mailingAddress": {
# 	        "line1": "",
# 	        "line2": "",
# 	        "city": ""
# 	      }
# 	    }
# 	  ],
# 	  "metadata": {
# 	    "receivedItemsCount": 1,
# 	    "validItems": [
# 	      0
# 	    ],
# 	    "invalidItems": [
# 	    ]
# 	  }
# 	}
# 
#