Chilkat Online Tools

PureBasic / DocuSign REST API / Get watermark preview.

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.

    ; {
    ;   "id": "sample string 1",
    ;   "enabled": "sample string 2",
    ;   "font": "sample string 3",
    ;   "fontSize": "sample string 4",
    ;   "fontColor": "sample string 5",
    ;   "displayAngle": "sample string 6",
    ;   "transparency": "sample string 7",
    ;   "watermarkText": "sample string 8",
    ;   "imageBase64": "sample string 9"
    ; }

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

    CkJsonObject::ckUpdateString(json,"id","sample string 1")
    CkJsonObject::ckUpdateString(json,"enabled","sample string 2")
    CkJsonObject::ckUpdateString(json,"font","sample string 3")
    CkJsonObject::ckUpdateString(json,"fontSize","sample string 4")
    CkJsonObject::ckUpdateString(json,"fontColor","sample string 5")
    CkJsonObject::ckUpdateString(json,"displayAngle","sample string 6")
    CkJsonObject::ckUpdateString(json,"transparency","sample string 7")
    CkJsonObject::ckUpdateString(json,"watermarkText","sample string 8")
    CkJsonObject::ckUpdateString(json,"imageBase64","sample string 9")

    ; 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}}/watermark/preview",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 '{
  "id": "sample string 1",
  "enabled": "sample string 2",
  "font": "sample string 3",
  "fontSize": "sample string 4",
  "fontColor": "sample string 5",
  "displayAngle": "sample string 6",
  "transparency": "sample string 7",
  "watermarkText": "sample string 8",
  "imageBase64": "sample string 9"
}'
https://domain.com/v2.1/accounts/{{accountId}}/watermark/preview

Postman Collection Item JSON

{
  "name": "Get watermark preview.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"id\": \"sample string 1\",\n  \"enabled\": \"sample string 2\",\n  \"font\": \"sample string 3\",\n  \"fontSize\": \"sample string 4\",\n  \"fontColor\": \"sample string 5\",\n  \"displayAngle\": \"sample string 6\",\n  \"transparency\": \"sample string 7\",\n  \"watermarkText\": \"sample string 8\",\n  \"imageBase64\": \"sample string 9\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/watermark/preview",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "watermark",
        "preview"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}