Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.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

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

    CkJsonObject::ckUpdateString(queryParams,"client_user_id","{{client_user_id}}")
    CkJsonObject::ckUpdateString(queryParams,"from_date","{{from_date}}")
    CkJsonObject::ckUpdateString(queryParams,"page_number","{{page_number}}")
    CkJsonObject::ckUpdateString(queryParams,"status","{{status}}")
    CkJsonObject::ckUpdateString(queryParams,"to_date","{{to_date}}")

    ; Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp::setCkAuthToken(http, "{{accessToken}}")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}/versions/{{versionId}}/users",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

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