Xbase++
Xbase++
GeoOp - Create Client
See more GeoOp Examples
Creates a new client.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oJsonToken
LOCAL oOauth2
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oJsonClient
LOCAL cResponseBody
LOCAL oJson
nSuccess := 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}
oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/geoop.json")
// This example assumes we previously obtained an access token
oOauth2 := CreateObject("Chilkat.OAuth2")
oOauth2:AccessToken := oJsonToken:StringOf("access_token")
oRest := CreateObject("Chilkat.Rest")
// 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.
nBAutoReconnect := 1
nSuccess := oRest:Connect("api.geoop.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
? oRest:LastErrorText
oJsonToken:destroy()
oOauth2:destroy()
oRest:destroy()
RETURN
ENDIF
// Provide the authentication credentials (i.e. the access token)
oRest:SetAuthOAuth2(oOauth2)
// Set the X-Version header.
oRest:AddHeader("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",
// }
// }
// }
oJsonClient := CreateObject("Chilkat.JsonObject")
oJsonClient:UpdateInt("clients[0].account.id", 39409)
oJsonClient:UpdateString("clients[0].firstName", "Joe")
oJsonClient:UpdateString("clients[0].lastName", "Miller")
oJsonClient:UpdateString("clients[0].companyName", "Miller Bakery")
oJsonClient:UpdateString("clients[0].businessType", "Licensed Bakery")
oJsonClient:UpdateString("clients[0].address.line1", "1832 Pennsylvania Avenue NW")
oJsonClient:UpdateString("clients[0].address.city", "Washington")
oJsonClient:UpdateString("clients[0].address.postcode", "20006")
// Examine the JSON we're about to send...
oJsonClient:EmitCompact := 0
? oJsonClient:Emit()
oRest:AddHeader("Content-Type", "application/json")
oJsonClient:EmitCompact := 1
cResponseBody := oRest:FullRequestString("POST", "/clients", oJsonClient:Emit())
IF (oRest:LastMethodSuccess != 1)
? oRest:LastErrorText
oJsonToken:destroy()
oOauth2:destroy()
oRest:destroy()
oJsonClient:destroy()
RETURN
ENDIF
oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0
// If the response status code did not indicate success, then see what happened..
IF (oRest:ResponseStatusCode != 200)
? "Request Header: "
? oRest:LastRequestHeader
? "----"
? "Response StatusCode = " + Str(oRest:ResponseStatusCode)
? "Response StatusLine: " + oRest:ResponseStatusText
? "Response Header:"
? oRest:ResponseHeader
oJson:Load(cResponseBody)
? oJson:Emit()
oJsonToken:destroy()
oOauth2:destroy()
oRest:destroy()
oJsonClient:destroy()
oJson:destroy()
RETURN
ENDIF
oJson:Load(cResponseBody)
// Show the full JSON response..
? oJson:Emit()
// 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": [
// ]
// }
// }
//
//
oJsonToken:destroy()
oOauth2:destroy()
oRest:destroy()
oJsonClient:destroy()
oJson:destroy()