Chilkat Online Tools

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

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("client_user_id","{{client_user_id}}")
loQueryParams.UpdateString("from_date","{{from_date}}")
loQueryParams.UpdateString("page_number","{{page_number}}")
loQueryParams.UpdateString("status","{{status}}")
loQueryParams.UpdateString("to_date","{{to_date}}")

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

loResp = loHttp.QuickRequestParams("GET","https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}/versions/{{versionNumber}}/users",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loQueryParams

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/{{versionNumber}}/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/{{versionNumber}}/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",
        "{{versionNumber}}",
        "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": "versionNumber",
          "value": "{{versionNumber}}"
        }
      ]
    }
  },
  "response": [
  ]
}