Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

PureBasic Web API Examples

Primary Categories

ABN AMRO
AWS Secrets Manager
AWS Security Token Service
AWS Translate
Activix CRM
Adyen
Alibaba Cloud OSS
Amazon Cognito
Amazon DynamoDB
Amazon MWS
Amazon Pay
Amazon Rekognition
Amazon SP-API
Amazon Voice ID
Aruba Fatturazione
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Backblaze S3
Banco Inter
Belgian eHealth Platform
Bitfinex v2 REST
Bluzone
BrickLink
Bunny CDN
CallRail
CardConnect
Cerved
ClickBank
Clickatell
Cloudfare
Constant Contact
DocuSign
Duo Auth MFA
ETrade
Ecwid
Egypt ITIDA
Egypt eReceipt
Etsy
Facebook
Faire
Frame.io
GeoOp
GetHarvest
Global Payments
Google People
Google Search Console
Google Translate
Hungary NAV Invoicing
IBM Text to Speech
Ibanity
IntakeQ
Jira
Lightspeed
MYOB
Magento
Mailgun
Mastercard

MedTunnel
MercadoLibre
MessageMedia
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Microsoft Teams
Moody's
Okta OAuth/OIDC
OneLogin OIDC
OneNote
OpenAI ChatGPT
PRODA
PayPal
Paynow.pl
Peoplevox
Populi
QuickBooks
Rabobank
Refinitiv
Royal Mail OBA
SCiS Schools Catalogue
SII Chile
SMSAPI
SOAP finkok.com
SendGrid
Shippo
Shopify
Shopware
Shopware 6
SimpleTexting
Square
Stripe
SugarCRM
TicketBAI
Trello
Twilio
Twitter API v2
Twitter v1
UPS
UniPin
VoiceBase
Vonage
WaTrend
Walmart v3
Wasabi
WhatsApp
WiX
WooCommerce
WordPress
Xero
Yahoo Mail
Yapily
Yousign
ZATCA
Zendesk
Zoom
_Miscellaneous_
eBay
effectconnect
hacienda.go.cr

 

 

 

(PureBasic) GeoOp - Get a list of all users

Gets a list of all GeoOp users.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkDtObj.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"
IncludeFile "CkDateTime.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","/users")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        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)
        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)

    ; These will be used for parsing date/time strings..
    dtime.i = CkDateTime::ckCreate()
    If dtime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bLocalTime.i = 1
    dt.i

    ; Iterate over each user and get information from each.
    numRecords.i = CkJsonObject::ckSizeOfArray(json,"users")
    i.i = 0
    While i < numRecords

        CkJsonObject::setCkI(json, i)
        Debug "id: " + CkJsonObject::ckStringOf(json,"users[i].id")
        Debug "firstName: " + CkJsonObject::ckStringOf(json,"users[i].firstName")
        Debug "lastName: " + CkJsonObject::ckStringOf(json,"users[i].lastName")
        Debug "companyName: " + CkJsonObject::ckStringOf(json,"users[i].companyName")
        Debug "active: " + Str(CkJsonObject::ckIntOf(json,"users[i].active"))
        Debug "isAssignable: " + Str(CkJsonObject::ckBoolOf(json,"users[i].isAssignable"))
        Debug "account id: " + Str(CkJsonObject::ckBoolOf(json,"users[i].account.id"))

        CkDateTime::ckSetFromTimestamp(dtime,CkJsonObject::ckStringOf(json,"users[i].created"))
        dt = CkDateTime::ckGetDtObj(dtime,bLocalTime)
        Debug "created: " + Str(CkDtObj::ckMonth(dt)) + "/" + Str(CkDtObj::ckDay(dt)) + "/" + Str(CkDtObj::ckYear(dt)) + "  " + Str(CkDtObj::ckHour(dt)) + ":" + Str(CkDtObj::ckMinute(dt))
        CkDtObj::ckDispose(dt)

        Debug "----"
        i = i + 1
    Wend

    ; The responseJson looks like this:
    ; {
    ;   "result": "success",
    ;   "users": [
    ;     {
    ;       "id": 984236,
    ;       "firstName": "Joe",
    ;       "lastName": "Smith",
    ;       "companyName": "Chilkat Software, Inc.",
    ;       "email": "support@chilkatsoft.com",
    ;       "phone": "",
    ;       "mobile": "1-630-555-5555",
    ;       "hourlyRate": 0,
    ;       "active": 1,
    ;       "deleted": false,
    ;       "colour": "#D2BC14",
    ;       "created": "2016-10-26T12:05:09+00:00",
    ;       "modified": "2016-10-26T12:05:09+00:00",
    ;       "isAssignable": true,
    ;       "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984236.jpg",
    ;       "role": {
    ;         "id": 1
    ;       },
    ;       "account": {
    ;         "id": 39409
    ;       },
    ;       "status": {}
    ;     },
    ;     {
    ;       "id": 984237,
    ;       "firstName": "Demo",
    ;       "lastName": "Employee",
    ;       "companyName": "",
    ;       "email": "",
    ;       "phone": "",
    ;       "mobile": "58458458475854758",
    ;       "hourlyRate": 0,
    ;       "active": 0,
    ;       "deleted": true,
    ;       "colour": "#4C4CFF",
    ;       "created": "2015-09-03T01:56:17+00:00",
    ;       "modified": "2016-06-14T20:20:58+00:00",
    ;       "isAssignable": true,
    ;       "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984237.jpg",
    ;       "role": {
    ;         "id": 2
    ;       },
    ;       "account": {
    ;         "id": 39409
    ;       },
    ;       "status": {
    ;         "message": null,
    ;         "timestamp": "2015-09-03T01:57:45+00:00"
    ;       }
    ;     }
    ;   ],
    ;   "metadata": {
    ;     "page": 1,
    ;     "pagesCount": 1,
    ;     "recordsPerPage": 20,
    ;     "recordsCount": 2
    ;   }
    ; }
    ; 
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkOAuth2::ckDispose(oauth2)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(dtime)


    ProcedureReturn
EndProcedure

 

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