Ruby

GeoOp - Get a list of all users

See more GeoOp Examples

Gets a list of all GeoOp users. 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 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 == false)
    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","/users")
if (rest.get_LastMethodSuccess() == false)
    print rest.lastErrorText() + "\n";
    exit
end

# 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";
    print responseBody + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.Load(responseBody)
# Show the full JSON response..
print json.emit() + "\n";

# These will be used for parsing date/time strings..
dtime = Chilkat::CkDateTime.new()
bLocalTime = true
dt = Chilkat::CkDtObj.new()

# Iterate over each user and get information from each.
numRecords = json.SizeOfArray("users")
i = 0
while i < numRecords

    json.put_I(i)
    print "id: " + json.stringOf("users[i].id") + "\n";
    print "firstName: " + json.stringOf("users[i].firstName") + "\n";
    print "lastName: " + json.stringOf("users[i].lastName") + "\n";
    print "companyName: " + json.stringOf("users[i].companyName") + "\n";
    print "active: " + json.IntOf("users[i].active").to_s() + "\n";
    print "isAssignable: " + json.BoolOf("users[i].isAssignable").to_s() + "\n";
    print "account id: " + json.BoolOf("users[i].account.id").to_s() + "\n";

    dtime.SetFromTimestamp(json.stringOf("users[i].created"))
    dtime.ToDtObj(bLocalTime,dt)

    print "created: " + dt.get_Month().to_s() + "/" + dt.get_Day().to_s() + "/" + dt.get_Year().to_s() + "  " + 
        dt.get_Hour().to_s() + ":" + dt.get_Minute().to_s() + "\n";

    print "----" + "\n";
    i = i + 1
end

# The responseJson looks like this:
# {
#   "result": "success",
#   "users": [
#     {
#       "id": 984236,
#       "firstName": "Joe",
#       "lastName": "Smith",
#       "companyName": "Chilkat Software, Inc.",
#       "email": "support@chilkatsoft.com",
#       "phone": "",
#       "mobile": "1-630-555-5555",
#       "hourlyRate": 0,
#       "active": 1,
#       "deleted": false,
#       "colour": "#D2BC14",
#       "created": "2016-10-26T12:05:09+00:00",
#       "modified": "2016-10-26T12:05:09+00:00",
#       "isAssignable": true,
#       "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984236.jpg",
#       "role": {
#         "id": 1
#       },
#       "account": {
#         "id": 39409
#       },
#       "status": {}
#     },
#     {
#       "id": 984237,
#       "firstName": "Demo",
#       "lastName": "Employee",
#       "companyName": "",
#       "email": "",
#       "phone": "",
#       "mobile": "58458458475854758",
#       "hourlyRate": 0,
#       "active": 0,
#       "deleted": true,
#       "colour": "#4C4CFF",
#       "created": "2015-09-03T01:56:17+00:00",
#       "modified": "2016-06-14T20:20:58+00:00",
#       "isAssignable": true,
#       "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984237.jpg",
#       "role": {
#         "id": 2
#       },
#       "account": {
#         "id": 39409
#       },
#       "status": {
#         "message": null,
#         "timestamp": "2015-09-03T01:57:45+00:00"
#       }
#     }
#   ],
#   "metadata": {
#     "page": 1,
#     "pagesCount": 1,
#     "recordsPerPage": 20,
#     "recordsCount": 2
#   }
# }
# 
#