(PureBasic) Constant Contact - Create a List

Create a new list using a POST call to the /contact_lists endpoint.

For more information, see https://v3.developer.constantcontact.com/api_guide/lists_overview.html#create-a-list

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
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 POST \
    ;   https://api.cc.email/v3/contact_lists \
    ;   -H 'Accept: application/json' \
    ;   -H 'Authorization: Bearer {access_token}' \
    ;   -H 'cache-control: no-cache' \
    ;   -H 'content-type: application/json' \
    ;   -d '{
    ;   "name": "Multiple purchases",
    ;   "favorite": true,
    ;   "description": "List of repeat customers"
    ; }'

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

    ; Use this online tool to generate code from sample JSON:
    ; Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "name": "Multiple purchases",
    ;   "favorite": true,
    ;   "description": "List of repeat customers"
    ; }

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

    CkJsonObject::ckUpdateString(json,"name","Multiple purchases")
    CkJsonObject::ckUpdateBool(json,"favorite",1)
    CkJsonObject::ckUpdateString(json,"description","List of repeat customers")

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

    resp.i = CkHttp::ckPostJson3(http,"https://api.cc.email/v3/contact_lists","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    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 = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "list_id": "{list_id}",
    ;   "name": "Multiple purchases",
    ;   "description": "List of repeat customers",
    ;   "favorite": true,
    ;   "created_at": "2017-07-14T11:25:00-04:00",
    ;   "updated_at": "2017-07-14T11:25:00-04: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

    list_id.s = CkJsonObject::ckStringOf(jResp,"list_id")
    name.s = CkJsonObject::ckStringOf(jResp,"name")
    description.s = CkJsonObject::ckStringOf(jResp,"description")
    favorite.i = CkJsonObject::ckBoolOf(jResp,"favorite")
    created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
    updated_at.s = CkJsonObject::ckStringOf(jResp,"updated_at")


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


    ProcedureReturn
EndProcedure