(PureBasic) GeoOp - Create Client

Creates a new client.

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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.i = 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 client, we can build and send the following JSON:
    ; 	{
    ; 	  "clients": [
    ; 	    {
    ; 	      "firstName": "Joe",
    ; 	      "lastName": "Miller",
    ; 	      "companyName": "Miller Bakery",
    ; 	      "businessType": "Licensed Bakery",
    ; 	      "account": {
    ; 	        "id": 39409
    ; 	      },
    ; 	      "address": {
    ; 	        "line1": "1832 Pennsylvania Avenue NW",
    ; 	        "city": "Washington",
    ; 	        "postcode": "20006",
    ; 	      }
    ; 	    }
    ; 	}

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

    CkJsonObject::ckUpdateInt(jsonClient,"clients[0].account.id",39409)
    CkJsonObject::ckUpdateString(jsonClient,"clients[0].firstName","Joe")
    CkJsonObject::ckUpdateString(jsonClient,"clients[0].lastName","Miller")
    CkJsonObject::ckUpdateString(jsonClient,"clients[0].companyName","Miller Bakery")
    CkJsonObject::ckUpdateString(jsonClient,"clients[0].businessType","Licensed Bakery")
    CkJsonObject::ckUpdateString(jsonClient,"clients[0].address.line1","1832 Pennsylvania Avenue NW")
    CkJsonObject::ckUpdateString(jsonClient,"clients[0].address.city","Washington")
    CkJsonObject::ckUpdateString(jsonClient,"clients[0].address.postcode","20006")

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

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

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

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

    CkJsonObject::setCkEmitCompact(json, 0)

    ; 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)
        CkJsonObject::ckLoad(json,responseBody)
        Debug CkJsonObject::ckEmit(json)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonClient)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,responseBody)
    ; Show the full JSON response..
    Debug CkJsonObject::ckEmit(json)

    ; The success JSON looks like this:

    ; 	{
    ; 	  "result": "success",
    ; 	  "clients": [
    ; 	    {
    ; 	      "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": false,
    ; 	      "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": {
    ; 	    "receivedItemsCount": 1,
    ; 	    "validItems": [
    ; 	      0
    ; 	    ],
    ; 	    "invalidItems": [
    ; 	    ]
    ; 	  }
    ; 	}
    ; 
    ; 


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


    ProcedureReturn
EndProcedure