Chilkat Online Tools

PureBasic / DocuSign REST API / Update Consumer Disclosure.

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "companyName": "sample string 1",
    ;   "companyPhone": "sample string 2",
    ;   "withdrawEmail": "sample string 3",
    ;   "withdrawByEmail": "sample string 4",
    ;   "withdrawByPhone": "sample string 5",
    ;   "withdrawByMail": "sample string 6",
    ;   "withdrawAddressLine1": "sample string 7",
    ;   "withdrawAddressLine2": "sample string 8",
    ;   "withdrawCity": "sample string 9",
    ;   "withdrawState": "sample string 10",
    ;   "withdrawPostalCode": "sample string 11",
    ;   "withdrawConsequences": "sample string 12",
    ;   "withdrawOther": "sample string 13",
    ;   "withdrawPhone": "sample string 14",
    ;   "changeEmail": "sample string 15",
    ;   "changeEmailOther": "sample string 16",
    ;   "copyCostPerPage": "sample string 17",
    ;   "copyRequestEmail": "sample string 18",
    ;   "copyFeeCollectionMethod": "sample string 19",
    ;   "custom": "sample string 20",
    ;   "pdfId": "sample string 21",
    ;   "enableEsign": "sample string 22",
    ;   "useBrand": "sample string 23",
    ;   "esignAgreement": "sample string 24",
    ;   "esignText": "sample string 25",
    ;   "allowCDWithdraw": "sample string 26",
    ;   "mustAgreeToEsign": "sample string 27",
    ;   "useConsumerDisclosureWithinAccount": "sample string 28"
    ; }

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

    CkJsonObject::ckUpdateString(json,"companyName","sample string 1")
    CkJsonObject::ckUpdateString(json,"companyPhone","sample string 2")
    CkJsonObject::ckUpdateString(json,"withdrawEmail","sample string 3")
    CkJsonObject::ckUpdateString(json,"withdrawByEmail","sample string 4")
    CkJsonObject::ckUpdateString(json,"withdrawByPhone","sample string 5")
    CkJsonObject::ckUpdateString(json,"withdrawByMail","sample string 6")
    CkJsonObject::ckUpdateString(json,"withdrawAddressLine1","sample string 7")
    CkJsonObject::ckUpdateString(json,"withdrawAddressLine2","sample string 8")
    CkJsonObject::ckUpdateString(json,"withdrawCity","sample string 9")
    CkJsonObject::ckUpdateString(json,"withdrawState","sample string 10")
    CkJsonObject::ckUpdateString(json,"withdrawPostalCode","sample string 11")
    CkJsonObject::ckUpdateString(json,"withdrawConsequences","sample string 12")
    CkJsonObject::ckUpdateString(json,"withdrawOther","sample string 13")
    CkJsonObject::ckUpdateString(json,"withdrawPhone","sample string 14")
    CkJsonObject::ckUpdateString(json,"changeEmail","sample string 15")
    CkJsonObject::ckUpdateString(json,"changeEmailOther","sample string 16")
    CkJsonObject::ckUpdateString(json,"copyCostPerPage","sample string 17")
    CkJsonObject::ckUpdateString(json,"copyRequestEmail","sample string 18")
    CkJsonObject::ckUpdateString(json,"copyFeeCollectionMethod","sample string 19")
    CkJsonObject::ckUpdateString(json,"custom","sample string 20")
    CkJsonObject::ckUpdateString(json,"pdfId","sample string 21")
    CkJsonObject::ckUpdateString(json,"enableEsign","sample string 22")
    CkJsonObject::ckUpdateString(json,"useBrand","sample string 23")
    CkJsonObject::ckUpdateString(json,"esignAgreement","sample string 24")
    CkJsonObject::ckUpdateString(json,"esignText","sample string 25")
    CkJsonObject::ckUpdateString(json,"allowCDWithdraw","sample string 26")
    CkJsonObject::ckUpdateString(json,"mustAgreeToEsign","sample string 27")
    CkJsonObject::ckUpdateString(json,"useConsumerDisclosureWithinAccount","sample string 28")

    ; Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp::setCkAuthToken(http, "{{accessToken}}")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "companyName": "sample string 1",
  "companyPhone": "sample string 2",
  "withdrawEmail": "sample string 3",
  "withdrawByEmail": "sample string 4",
  "withdrawByPhone": "sample string 5",
  "withdrawByMail": "sample string 6",
  "withdrawAddressLine1": "sample string 7",
  "withdrawAddressLine2": "sample string 8",
  "withdrawCity": "sample string 9",
  "withdrawState": "sample string 10",
  "withdrawPostalCode": "sample string 11",
  "withdrawConsequences": "sample string 12",
  "withdrawOther": "sample string 13",
  "withdrawPhone": "sample string 14",
  "changeEmail": "sample string 15",
  "changeEmailOther": "sample string 16",
  "copyCostPerPage": "sample string 17",
  "copyRequestEmail": "sample string 18",
  "copyFeeCollectionMethod": "sample string 19",
  "custom": "sample string 20",
  "pdfId": "sample string 21",
  "enableEsign": "sample string 22",
  "useBrand": "sample string 23",
  "esignAgreement": "sample string 24",
  "esignText": "sample string 25",
  "allowCDWithdraw": "sample string 26",
  "mustAgreeToEsign": "sample string 27",
  "useConsumerDisclosureWithinAccount": "sample string 28"
}'
https://domain.com/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}

Postman Collection Item JSON

{
  "name": "Update Consumer Disclosure.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"companyName\": \"sample string 1\",\n  \"companyPhone\": \"sample string 2\",\n  \"withdrawEmail\": \"sample string 3\",\n  \"withdrawByEmail\": \"sample string 4\",\n  \"withdrawByPhone\": \"sample string 5\",\n  \"withdrawByMail\": \"sample string 6\",\n  \"withdrawAddressLine1\": \"sample string 7\",\n  \"withdrawAddressLine2\": \"sample string 8\",\n  \"withdrawCity\": \"sample string 9\",\n  \"withdrawState\": \"sample string 10\",\n  \"withdrawPostalCode\": \"sample string 11\",\n  \"withdrawConsequences\": \"sample string 12\",\n  \"withdrawOther\": \"sample string 13\",\n  \"withdrawPhone\": \"sample string 14\",\n  \"changeEmail\": \"sample string 15\",\n  \"changeEmailOther\": \"sample string 16\",\n  \"copyCostPerPage\": \"sample string 17\",\n  \"copyRequestEmail\": \"sample string 18\",\n  \"copyFeeCollectionMethod\": \"sample string 19\",\n  \"custom\": \"sample string 20\",\n  \"pdfId\": \"sample string 21\",\n  \"enableEsign\": \"sample string 22\",\n  \"useBrand\": \"sample string 23\",\n  \"esignAgreement\": \"sample string 24\",\n  \"esignText\": \"sample string 25\",\n  \"allowCDWithdraw\": \"sample string 26\",\n  \"mustAgreeToEsign\": \"sample string 27\",\n  \"useConsumerDisclosureWithinAccount\": \"sample string 28\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "consumer_disclosure",
        "{{langCode}}"
      ],
      "query": [
        {
          "key": "include_metadata",
          "value": "{{include_metadata}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "langCode",
          "value": "{{langCode}}"
        }
      ]
    }
  },
  "response": [
  ]
}