Tcl

GeoOp - Create a New User

See more GeoOp Examples

Create a new GeoOp user. 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..
# 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.

set bAutoReconnect 1
set success [CkRest_Connect $rest "api.geoop.com" 443 1 $bAutoReconnect]
if {$success != 1} 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"

# To create a new user, we must build and send the following JSON:
# {
#     "users": [
#         {
#             "account": {
#                 "id": 39409    <--- This account ID must be one that already exists.
#             },
#             "firstName": "Geoff",
#             "lastName": "Wirtz",
#             "companyName": "Sample Company",
#             "phone": "+12349282001",
#             "mobile": "+12349332744",
#             "email": "gwirtz@example2.com",
#             "login": "gwirtz_sample2",
#             "newPassword": "pa$$wordz",
#             "newPasswordConfirm": "pa$$wordz"
#         }
#     ]
# }

set jsonUser [new_CkJsonObject]

CkJsonObject_UpdateInt $jsonUser "users[0].account.id" 39409
CkJsonObject_UpdateString $jsonUser "users[0].firstName" "Geoff"
CkJsonObject_UpdateString $jsonUser "users[0].lastName" "Wirtz"
CkJsonObject_UpdateString $jsonUser "users[0].companyName" "Sample Company"
CkJsonObject_UpdateString $jsonUser "users[0].phone" "+12349282001"
CkJsonObject_UpdateString $jsonUser "users[0].mobile" "+12349332744"
CkJsonObject_UpdateString $jsonUser "users[0].email" "gwirtz@example2.com"
CkJsonObject_UpdateString $jsonUser "users[0].login" "gwirtz_sample2"
CkJsonObject_UpdateString $jsonUser "users[0].newPassword" "pa$$wordz"
CkJsonObject_UpdateString $jsonUser "users[0].newPasswordConfirm" "pa$$wordz"

# Examine the JSON we're about to send...
CkJsonObject_put_EmitCompact $jsonUser 0
puts [CkJsonObject_emit $jsonUser]

CkRest_AddHeader $rest "Content-Type" "application/json"

CkJsonObject_put_EmitCompact $jsonUser 1
set responseBody [CkRest_fullRequestString $rest "POST" "/users" [CkJsonObject_emit $jsonUser]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    delete_CkRest $rest
    delete_CkJsonObject $jsonUser
    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
    delete_CkJsonObject $jsonUser
    exit
}

set json [new_CkJsonObject]

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

# The success JSON looks like this:
# {
#   "result": "success",
#   "users": [
#     {
#       "id": 984244,
#       "firstName": "Geoff",
#       "lastName": "Wirtz",
#       "companyName": "Sample Company",
#       "email": "gwirtz@example2.com",
#       "phone": "+12349282001",
#       "mobile": "+12349332744",
#       "hourlyRate": 0,
#       "active": 1,
#       "deleted": false,
#       "colour": "#000000",
#       "created": "2016-10-26T18:03:59+00:00",
#       "modified": "2016-10-26T18:03:59+00:00",
#       "isAssignable": true,
#       "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984244.jpg",
#       "role": {
#         "id": 2
#       },
#       "account": {
#         "id": 39409
#       },
#       "status": {}
#     }
#   ],
#   "metadata": {
#     "receivedItemsCount": 1,
#     "validItems": [
#       0
#     ],
#     "invalidItems": [
#     ]
#   }
# }
# 

delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkRest $rest
delete_CkJsonObject $jsonUser
delete_CkJsonObject $json