PureBasic

GeoOp - Create a New User

See more GeoOp Examples

Create a new GeoOp user. PureBasic

IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    success.i = 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}
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/geoop.json")

    ; This example assumes we previously obtained an access token
    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkOAuth2::setCkAccessToken(oauth2, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.i = 1
    success = CkRest::ckConnect(rest,"api.geoop.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide the authentication credentials (i.e. the access token)
    CkRest::ckSetAuthOAuth2(rest,oauth2)

    ; Set the X-Version header.
    CkRest::ckAddHeader(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"
    ;         }
    ;     ]
    ; }

    jsonUser.i = CkJsonObject::ckCreate()
    If jsonUser.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(jsonUser,"users[0].account.id",39409)
    CkJsonObject::ckUpdateString(jsonUser,"users[0].firstName","Geoff")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].lastName","Wirtz")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].companyName","Sample Company")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].phone","+12349282001")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].mobile","+12349332744")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].email","gwirtz@example2.com")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].login","gwirtz_sample2")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].newPassword","pa$$wordz")
    CkJsonObject::ckUpdateString(jsonUser,"users[0].newPasswordConfirm","pa$$wordz")

    ; Examine the JSON we're about to send...
    CkJsonObject::setCkEmitCompact(jsonUser, 0)
    Debug CkJsonObject::ckEmit(jsonUser)

    CkRest::ckAddHeader(rest,"Content-Type","application/json")

    CkJsonObject::setCkEmitCompact(jsonUser, 1)
    responseBody.s = CkRest::ckFullRequestString(rest,"POST","/users",CkJsonObject::ckEmit(jsonUser))
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonUser)
        ProcedureReturn
    EndIf

    ; If the response status code did not indicate success, then see what happened..
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Request Header: "
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "----"
        Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug responseBody
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonUser)
        ProcedureReturn
    EndIf

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckLoad(json,responseBody)
    ; Show the full JSON response..
    Debug CkJsonObject::ckEmit(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": [
    ;     ]
    ;   }
    ; }
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkOAuth2::ckDispose(oauth2)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(jsonUser)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure