Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Ruby Web API Examples

Primary Categories

AWS Translate
Azure Maps
Azure OAuth2
Azure Storage Accounts
CardConnect
Cloudfare
Facebook
GeoOp
Jira
Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans

PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(Ruby) GeoOp - Find Client ID by Name

Download the client JSON data and lookup a client ID by name.

Chilkat Ruby Downloads

Ruby Library for Linux and MAC OS X

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}
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 and send the following GET request:

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

responseBody = rest.fullRequestNoBody("GET","/clients")
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 rest.lastRequestStartLine() + "\n";
    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.. (see below)
print json.emit() + "\n";

# To find the client id for a given company name:
caseSensitive = false
clientId = json.findRecordString("clients","companyName","Miller Bakery",caseSensitive,"id")
if (json.get_LastMethodSuccess() != true)
    print "Client not found." + "\n";
else
    print "The client ID is: " + clientId + "\n";
end

# Find the client ID for the 1st company matching "M*Bakery*"
clientId = json.findRecordString("clients","companyName","M*Bakery*",caseSensitive,"id")
if (json.get_LastMethodSuccess() != true)
    print "Client not found." + "\n";
else
    print "The client ID is: " + clientId + "\n";
end

# The full JSON response containing all client data:
# 
# 	{
# 	  "result": "success",
# 	  "clients": [
# 	    {
# 	      "id": 9555868,
# 	      "firstName": "[ Demo",
# 	      "lastName": "Client ]",
# 	      "companyName": "Miller Park Cafe",
# 	      "businessType": "Licensed Restaurant",
# 	      "leadSource": "",
# 	      "emailAddress": null,
# 	      "phoneNumber": null,
# 	      "mobileNumber": null,
# 	      "faxNumber": null,
# 	      "notes": "",
# 	      "deleted": false,
# 	      "hasRecentJobs": true,
# 	      "created": "2016-10-26T12:05:09+00:00",
# 	      "modified": "2016-10-26T12:05:09+00:00",
# 	      "billingClient": null,
# 	      "account": {
# 	        "id": 39409
# 	      },
# 	      "address": {
# 	        "line1": "1732 Pennsylvania Avenue NW",
# 	        "line2": "",
# 	        "city": "Washington",
# 	        "postcode": "20006",
# 	        "latitude": 38.899037,
# 	        "longitude": -77.040207
# 	      },
# 	      "mailingAddress": {}
# 	    },
# 	    {
# 	      "id": 9571176,
# 	      "firstName": "Mildred",
# 	      "lastName": "Vanildred",
# 	      "companyName": "Ice Cream Industries",
# 	      "businessType": "Ice Cream",
# 	      "leadSource": null,
# 	      "emailAddress": "milli@icecreamindustries.com",
# 	      "phoneNumber": "678-555-1012",
# 	      "mobileNumber": null,
# 	      "faxNumber": null,
# 	      "notes": "",
# 	      "deleted": false,
# 	      "hasRecentJobs": true,
# 	      "created": "2016-10-31T12:32:12+00:00",
# 	      "modified": "2016-10-31T12:32:13+00:00",
# 	      "billingClient": null,
# 	      "account": {
# 	        "id": 39409
# 	      },
# 	      "address": {
# 	        "line1": "2101 West Roosevelt Road",
# 	        "line2": null,
# 	        "city": "Wheaton",
# 	        "postcode": "60187",
# 	        "latitude": 41.8581778,
# 	        "longitude": -88.1380111
# 	      },
# 	      "mailingAddress": {
# 	        "line1": "2101 West Roosevelt Road",
# 	        "line2": null,
# 	        "city": "Wheaton"
# 	      }
# 	    },
# 	    {
# 	      "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": true,
# 	      "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": {
# 	    "page": 1,
# 	    "pagesCount": 1,
# 	    "recordsPerPage": 20,
# 	    "recordsCount": 3
# 	  }
# 	}
# 

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.