Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PureBasic Web API Examples

Primary Categories

AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Jira
MYOB

Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
Xero
eBay
effectconnect

 

 

 

(PureBasic) GeoOp - Export Clients to CSV

Export client data to a CSV.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkCsv.pb"
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 and send the following GET request:

    ; GET /users HTTP/1.1
    ; Host: api.geoop.com
    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")

    responseBody.s = CkRest::ckFullRequestNoBody(rest,"GET","/clients")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        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(json)
        ProcedureReturn
    EndIf

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

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

    CkCsv::setCkHasColumnNames(csv, 1)
    CkCsv::ckSetColumnName(csv,0,"id")
    CkCsv::ckSetColumnName(csv,1,"companyName")
    CkCsv::ckSetColumnName(csv,2,"businessType")
    CkCsv::ckSetColumnName(csv,3,"account_id")
    CkCsv::ckSetColumnName(csv,4,"address_line1")
    CkCsv::ckSetColumnName(csv,5,"address_city")
    CkCsv::ckSetColumnName(csv,6,"address_postcode")

    ; Iterate over each client and populate the CSV...
    numRecords.i = CkJsonObject::ckSizeOfArray(json,"clients")
    i.i = 0
    While i < numRecords

        CkJsonObject::setCkI(json, i)
        CkCsv::ckSetCellByName(csv,i,"id",CkJsonObject::ckStringOf(json,"clients[i].id"))
        CkCsv::ckSetCellByName(csv,i,"companyName",CkJsonObject::ckStringOf(json,"clients[i].companyName"))
        CkCsv::ckSetCellByName(csv,i,"businessType",CkJsonObject::ckStringOf(json,"clients[i].businessType"))
        CkCsv::ckSetCellByName(csv,i,"account_id",CkJsonObject::ckStringOf(json,"clients[i].account.id"))
        CkCsv::ckSetCellByName(csv,i,"address_line1",CkJsonObject::ckStringOf(json,"clients[i].address.line1"))
        CkCsv::ckSetCellByName(csv,i,"address_city",CkJsonObject::ckStringOf(json,"clients[i].address.city"))
        CkCsv::ckSetCellByName(csv,i,"address_postcode",CkJsonObject::ckStringOf(json,"clients[i].address.postcode"))
        i = i + 1
    Wend

    ; Show the CSV.
    Debug CkCsv::ckSaveToString(csv)

    ; Save the CSV.
    CkCsv::ckSaveFile(csv,"qa_output/clients.csv")

    ; ---------------------------------------------------------------------
    ; The full JSON response containing all client data:
    ; 
    ; 	{
    ; 	  "result": "success",
    ; 	  "clients": [
    ; 	    {
    ; 	      "id": 9555868,
    ; 	      "firstName": "[ Demo",
    ; 	      "lastName": "Client ]",
    ; 	      "companyName": "Miller Park Cafe",
    ; 	      "businessType": "Licensed Restaurant",
    ; 	      "leadSource": "",
    ; 	      "emailAddress": null,
    ; 	      "phoneNumber": null,
    ; 	      "mobileNumber": null,
    ; 	      "faxNumber": null,
    ; 	      "notes": "",
    ; 	      "deleted": false,
    ; 	      "hasRecentJobs": true,
    ; 	      "created": "2016-10-26T12:05:09+00:00",
    ; 	      "modified": "2016-10-26T12:05:09+00:00",
    ; 	      "billingClient": null,
    ; 	      "account": {
    ; 	        "id": 39409
    ; 	      },
    ; 	      "address": {
    ; 	        "line1": "1732 Pennsylvania Avenue NW",
    ; 	        "line2": "",
    ; 	        "city": "Washington",
    ; 	        "postcode": "20006",
    ; 	        "latitude": 38.899037,
    ; 	        "longitude": -77.040207
    ; 	      },
    ; 	      "mailingAddress": {}
    ; 	    },
    ; 	    {
    ; 	      "id": 9571176,
    ; 	      "firstName": "Mildred",
    ; 	      "lastName": "Vanildred",
    ; 	      "companyName": "Ice Cream Industries",
    ; 	      "businessType": "Ice Cream",
    ; 	      "leadSource": null,
    ; 	      "emailAddress": "milli@icecreamindustries.com",
    ; 	      "phoneNumber": "678-555-1012",
    ; 	      "mobileNumber": null,
    ; 	      "faxNumber": null,
    ; 	      "notes": "",
    ; 	      "deleted": false,
    ; 	      "hasRecentJobs": true,
    ; 	      "created": "2016-10-31T12:32:12+00:00",
    ; 	      "modified": "2016-10-31T12:32:13+00:00",
    ; 	      "billingClient": null,
    ; 	      "account": {
    ; 	        "id": 39409
    ; 	      },
    ; 	      "address": {
    ; 	        "line1": "2101 West Roosevelt Road",
    ; 	        "line2": null,
    ; 	        "city": "Wheaton",
    ; 	        "postcode": "60187",
    ; 	        "latitude": 41.8581778,
    ; 	        "longitude": -88.1380111
    ; 	      },
    ; 	      "mailingAddress": {
    ; 	        "line1": "2101 West Roosevelt Road",
    ; 	        "line2": null,
    ; 	        "city": "Wheaton"
    ; 	      }
    ; 	    },
    ; 	    {
    ; 	      "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": true,
    ; 	      "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": {
    ; 	    "page": 1,
    ; 	    "pagesCount": 1,
    ; 	    "recordsPerPage": 20,
    ; 	    "recordsCount": 3
    ; 	  }
    ; 	}
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkOAuth2::ckDispose(oauth2)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkCsv::ckDispose(csv)


    ProcedureReturn
EndProcedure

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.