Chilkat Online Tools

PowerBuilder / DocuSign Click API / Gets the agreement responses for a clickwrap version

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
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

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("client_user_id","{{client_user_id}}")
loo_QueryParams.UpdateString("from_date","{{from_date}}")
loo_QueryParams.UpdateString("page_number","{{page_number}}")
loo_QueryParams.UpdateString("status","{{status}}")
loo_QueryParams.UpdateString("to_date","{{to_date}}")

// Adds the "Authorization: Bearer {{accessToken}}" header.
loo_Http.AuthToken = "{{accessToken}}"
loo_Http.SetRequestHeader("Accept","application/json")

loo_Resp = loo_Http.QuickRequestParams("GET","https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}/versions/{{versionId}}/users",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_QueryParams

Curl Command

curl -G -d "client_user_id=%7B%7Bclient_user_id%7D%7D"
	-d "from_date=%7B%7Bfrom_date%7D%7D"
	-d "page_number=%7B%7Bpage_number%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-d "to_date=%7B%7Bto_date%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}/versions/{{versionId}}/users

Postman Collection Item JSON

{
  "name": "Gets the agreement responses for a clickwrap version",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}/versions/{{versionId}}/users?client_user_id={{client_user_id}}&from_date={{from_date}}&page_number={{page_number}}&status={{status}}&to_date={{to_date}}",
      "protocol": "https",
      "host": [
        "{{hostenv}}"
      ],
      "path": [
        "clickapi",
        "v1",
        "accounts",
        "{{accountId}}",
        "clickwraps",
        "{{clickwrapId}}",
        "versions",
        "{{versionId}}",
        "users"
      ],
      "query": [
        {
          "key": "client_user_id",
          "value": "{{client_user_id}}"
        },
        {
          "key": "from_date",
          "value": "{{from_date}}"
        },
        {
          "key": "page_number",
          "value": "{{page_number}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "to_date",
          "value": "{{to_date}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "clickwrapId",
          "value": "{{clickwrapId}}"
        },
        {
          "key": "versionId",
          "value": "{{versionId}}"
        }
      ]
    }
  },
  "response": [
  ]
}