(PureBasic) Constant Contact - View List Members

View the list membership by making a GET call to the Contact Collection endpointl

For more information, see https://v3.developer.constantcontact.com/api_guide/lists_overview.html#example-request---get-list-membership

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

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

    success.i

    ; Implements the following CURL command:

    ; curl -X GET \
    ;   'https://api.cc.email/v3/contacts?lists={list_id},{list_id2}' \
    ;   -H 'accept: application/json' \
    ;   -H 'authorization: Bearer {access_token}' \
    ;   -H 'cache-control: no-cache' \
    ;   -H 'content-type: application/json'

    ; Use the following online tool to generate HTTP code from a CURL command
    ; Convert a cURL Command to HTTP Source Code

    CkHttp::ckSetRequestHeader(http,"content-type","application/json")
    ; Adds the "Authorization: Bearer ACCESS_TOKEN" header.
    CkHttp::setCkAuthToken(http, "ACCESS_TOKEN")
    CkHttp::ckSetRequestHeader(http,"cache-control","no-cache")
    CkHttp::ckSetRequestHeader(http,"accept","application/json")

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

    success = CkHttp::ckQuickGetSb(http,"https://api.cc.email/v3/contacts?lists={list_id},{list_id2}",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "contacts": [
    ;     {
    ;       "contact_id": "{contact_id}",
    ;       "email_address": {
    ;         "address": "dprice@example.com",
    ;         "permission_to_send": "implicit",
    ;         "created_at": "2013-11-26T15:45:42-05:00",
    ;         "updated_at": "2013-11-26T15:45:42-05:00",
    ;         "opt_in_source": "Account",
    ;         "opt_in_date": "2013-11-26T15:45:42-05:00",
    ;         "confirm_status": "off"
    ;       },
    ;       "first_name": "David",
    ;       "last_name": "Price",
    ;       "update_source": "Account",
    ;       "create_source": "Account",
    ;       "created_at": "2013-11-26T15:45:42-05:00",
    ;       "updated_at": "2017-09-06T15:48:31-04:00"
    ;     },
    ;     {
    ;       "contact_id": "{contact_id}",
    ;       "email_address": {
    ;         "address": "jprice@example.com",
    ;         "permission_to_send": "implicit",
    ;         "created_at": "2013-11-26T15:45:50-05:00",
    ;         "updated_at": "2013-11-26T15:45:50-05:00",
    ;         "opt_in_source": "Account",
    ;         "opt_in_date": "2013-11-26T15:45:50-05:00",
    ;         "confirm_status": "off"
    ;       },
    ;       "first_name": "Jennifer",
    ;       "last_name": "Price",
    ;       "create_source": "Account",
    ;       "created_at": "2013-11-26T15:45:50-05:00",
    ;       "updated_at": "2013-11-26T15:45:50-05:00"
    ;     },
    ;     {
    ;       "contact_id": "{contact_id}",
    ;       "email_address": {
    ;         "address": "joe.jones@example.com",
    ;         "permission_to_send": "implicit",
    ;         "created_at": "2017-11-06T15:35:30-05:00",
    ;         "updated_at": "2017-11-06T15:35:30-05:00",
    ;         "opt_in_source": "Account",
    ;         "opt_in_date": "2017-11-06T15:35:30-05:00",
    ;         "confirm_status": "off"
    ;       },
    ;       "first_name": "Joe",
    ;       "last_name": "Jones",
    ;       "job_title": "Chief Innovation Officer",
    ;       "company_name": "RelativeGravity, Inc.",
    ;       "birthday_month": 11,
    ;       "birthday_day": 24,
    ;       "anniversary": "2006-11-15",
    ;       "create_source": "Account",
    ;       "created_at": "2017-11-06T15:35:30-05:00",
    ;       "updated_at": "2017-11-06T15:35:30-05:00"
    ;     },
    ;     {
    ;       "contact_id": "{contact_id}",
    ;       "email_address": {
    ;         "address": "mmiller@example.com",
    ;         "permission_to_send": "implicit",
    ;         "created_at": "2013-11-26T15:46:04-05:00",
    ;         "updated_at": "2013-11-26T15:46:04-05:00",
    ;         "opt_in_source": "Account",
    ;         "opt_in_date": "2013-11-26T15:46:04-05:00",
    ;         "confirm_status": "off"
    ;       },
    ;       "first_name": "Mike",
    ;       "last_name": "Miller.",
    ;       "create_source": "Account",
    ;       "created_at": "2013-11-26T15:46:04-05:00",
    ;       "updated_at": "2013-11-26T15:46:04-05:00"
    ;     },
    ;     {
    ;       "contact_id": "{contact_id}",
    ;       "email_address": {
    ;         "address": "sheryl.kavanaugh@example.com",
    ;         "permission_to_send": "implicit",
    ;         "created_at": "2013-11-26T15:46:10-05:00",
    ;         "updated_at": "2013-11-26T15:46:10-05:00",
    ;         "opt_in_source": "Account",
    ;         "opt_in_date": "2013-11-26T15:46:10-05:00",
    ;         "confirm_status": "off"
    ;       },
    ;       "first_name": "Sheryl",
    ;       "last_name": "Kavanaugh",
    ;       "create_source": "Account",
    ;       "created_at": "2013-11-26T15:46:10-05:00",
    ;       "updated_at": "2013-11-26T15:46:10-05:00"
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use the following online tool to generate parsing code from sample JSON:
    ; Generate Parsing Code from JSON

    contact_id.s
    email_addressAddress.s
    email_addressPermission_to_send.s
    email_addressCreated_at.s
    email_addressUpdated_at.s
    email_addressOpt_in_source.s
    email_addressOpt_in_date.s
    email_addressConfirm_status.s
    first_name.s
    last_name.s
    update_source.s
    create_source.s
    created_at.s
    updated_at.s
    job_title.s
    company_name.s
    birthday_month.i
    birthday_day.i
    anniversary.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"contacts")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        contact_id = CkJsonObject::ckStringOf(jResp,"contacts[i].contact_id")
        email_addressAddress = CkJsonObject::ckStringOf(jResp,"contacts[i].email_address.address")
        email_addressPermission_to_send = CkJsonObject::ckStringOf(jResp,"contacts[i].email_address.permission_to_send")
        email_addressCreated_at = CkJsonObject::ckStringOf(jResp,"contacts[i].email_address.created_at")
        email_addressUpdated_at = CkJsonObject::ckStringOf(jResp,"contacts[i].email_address.updated_at")
        email_addressOpt_in_source = CkJsonObject::ckStringOf(jResp,"contacts[i].email_address.opt_in_source")
        email_addressOpt_in_date = CkJsonObject::ckStringOf(jResp,"contacts[i].email_address.opt_in_date")
        email_addressConfirm_status = CkJsonObject::ckStringOf(jResp,"contacts[i].email_address.confirm_status")
        first_name = CkJsonObject::ckStringOf(jResp,"contacts[i].first_name")
        last_name = CkJsonObject::ckStringOf(jResp,"contacts[i].last_name")
        update_source = CkJsonObject::ckStringOf(jResp,"contacts[i].update_source")
        create_source = CkJsonObject::ckStringOf(jResp,"contacts[i].create_source")
        created_at = CkJsonObject::ckStringOf(jResp,"contacts[i].created_at")
        updated_at = CkJsonObject::ckStringOf(jResp,"contacts[i].updated_at")
        job_title = CkJsonObject::ckStringOf(jResp,"contacts[i].job_title")
        company_name = CkJsonObject::ckStringOf(jResp,"contacts[i].company_name")
        birthday_month = CkJsonObject::ckIntOf(jResp,"contacts[i].birthday_month")
        birthday_day = CkJsonObject::ckIntOf(jResp,"contacts[i].birthday_day")
        anniversary = CkJsonObject::ckStringOf(jResp,"contacts[i].anniversary")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure