Chilkat Online Tools

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

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("client_user_id","{{client_user_id}}")
queryParams.UpdateString("from_date","{{from_date}}")
queryParams.UpdateString("page_number","{{page_number}}")
queryParams.UpdateString("status","{{status}}")
queryParams.UpdateString("to_date","{{to_date}}")

# Adds the "Authorization: Bearer {{accessToken}}" header.
http.put_AuthToken("{{accessToken}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}/versions/{{versionNumber}}/users",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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": [
  ]
}