Tcl

GeoOp - Get a list of all users

See more GeoOp Examples

Gets a list of all GeoOp users. Tcl

load ./chilkat.dll

set success 0

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

# GET /users HTTP/1.1
# Host: api.geoop.com
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.geoop.com" 443 1 $bAutoReconnect]
if {$success == 0} 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"

set responseBody [CkRest_fullRequestNoBody $rest "GET" "/users"]
if {[CkRest_get_LastMethodSuccess $rest] == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    delete_CkRest $rest
    exit
}

# 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]
    puts "$responseBody"
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    delete_CkRest $rest
    exit
}

set json [new_CkJsonObject]

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

# These will be used for parsing date/time strings..
set dtime [new_CkDateTime]

set bLocalTime 1
set dt [new_CkDtObj]

# Iterate over each user and get information from each.
set numRecords [CkJsonObject_SizeOfArray $json "users"]
set i 0
while {$i < $numRecords} {

    CkJsonObject_put_I $json $i
    puts "id: [CkJsonObject_stringOf $json {users[i].id}]"
    puts "firstName: [CkJsonObject_stringOf $json {users[i].firstName}]"
    puts "lastName: [CkJsonObject_stringOf $json {users[i].lastName}]"
    puts "companyName: [CkJsonObject_stringOf $json {users[i].companyName}]"
    puts "active: [CkJsonObject_IntOf $json {users[i].active}]"
    puts "isAssignable: [CkJsonObject_BoolOf $json {users[i].isAssignable}]"
    puts "account id: [CkJsonObject_BoolOf $json {users[i].account.id}]"

    CkDateTime_SetFromTimestamp $dtime [CkJsonObject_stringOf $json "users[i].created"]
    CkDateTime_ToDtObj $dtime $bLocalTime $dt

    puts "created: [CkDtObj_get_Month $dt]/[CkDtObj_get_Day $dt]/[CkDtObj_get_Year $dt]  [CkDtObj_get_Hour $dt]:[CkDtObj_get_Minute $dt]"

    puts "----"
    set i [expr $i + 1]
}

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

delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkDateTime $dtime
delete_CkDtObj $dt