PowerBuilder / DocuSign REST API / Update Consumer Disclosure.
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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"
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("companyName","sample string 1")
loo_Json.UpdateString("companyPhone","sample string 2")
loo_Json.UpdateString("withdrawEmail","sample string 3")
loo_Json.UpdateString("withdrawByEmail","sample string 4")
loo_Json.UpdateString("withdrawByPhone","sample string 5")
loo_Json.UpdateString("withdrawByMail","sample string 6")
loo_Json.UpdateString("withdrawAddressLine1","sample string 7")
loo_Json.UpdateString("withdrawAddressLine2","sample string 8")
loo_Json.UpdateString("withdrawCity","sample string 9")
loo_Json.UpdateString("withdrawState","sample string 10")
loo_Json.UpdateString("withdrawPostalCode","sample string 11")
loo_Json.UpdateString("withdrawConsequences","sample string 12")
loo_Json.UpdateString("withdrawOther","sample string 13")
loo_Json.UpdateString("withdrawPhone","sample string 14")
loo_Json.UpdateString("changeEmail","sample string 15")
loo_Json.UpdateString("changeEmailOther","sample string 16")
loo_Json.UpdateString("copyCostPerPage","sample string 17")
loo_Json.UpdateString("copyRequestEmail","sample string 18")
loo_Json.UpdateString("copyFeeCollectionMethod","sample string 19")
loo_Json.UpdateString("custom","sample string 20")
loo_Json.UpdateString("pdfId","sample string 21")
loo_Json.UpdateString("enableEsign","sample string 22")
loo_Json.UpdateString("useBrand","sample string 23")
loo_Json.UpdateString("esignAgreement","sample string 24")
loo_Json.UpdateString("esignText","sample string 25")
loo_Json.UpdateString("allowCDWithdraw","sample string 26")
loo_Json.UpdateString("mustAgreeToEsign","sample string 27")
loo_Json.UpdateString("useConsumerDisclosureWithinAccount","sample string 28")
// Adds the "Authorization: Bearer {{accessToken}}" header.
loo_Http.AuthToken = "{{accessToken}}"
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Json.EmitSb(loo_SbRequestBody)
loo_Resp = loo_Http.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
return
end if
Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
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": [
]
}
