Chilkat Online Tools

PureBasic / DocuSign eSignature REST API / Gets a list of envelope documents.

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,"documents_by_userid","{{documents_by_userid}}")
    CkJsonObject::ckUpdateString(queryParams,"include_document_size","{{include_document_size}}")
    CkJsonObject::ckUpdateString(queryParams,"include_metadata","{{include_metadata}}")
    CkJsonObject::ckUpdateString(queryParams,"include_tabs","{{include_tabs}}")
    CkJsonObject::ckUpdateString(queryParams,"recipient_id","{{recipient_id}}")
    CkJsonObject::ckUpdateString(queryParams,"shared_user_id","{{shared_user_id}}")

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

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents",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 "documents_by_userid=%7B%7Bdocuments_by_userid%7D%7D"
	-d "include_document_size=%7B%7Binclude_document_size%7D%7D"
	-d "include_metadata=%7B%7Binclude_metadata%7D%7D"
	-d "include_tabs=%7B%7Binclude_tabs%7D%7D"
	-d "recipient_id=%7B%7Brecipient_id%7D%7D"
	-d "shared_user_id=%7B%7Bshared_user_id%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents

Postman Collection Item JSON

{
  "name": "Gets a list of envelope documents.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents?documents_by_userid={{documents_by_userid}}&include_document_size={{include_document_size}}&include_metadata={{include_metadata}}&include_tabs={{include_tabs}}&recipient_id={{recipient_id}}&shared_user_id={{shared_user_id}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents"
      ],
      "query": [
        {
          "key": "documents_by_userid",
          "value": "{{documents_by_userid}}"
        },
        {
          "key": "include_document_size",
          "value": "{{include_document_size}}"
        },
        {
          "key": "include_metadata",
          "value": "{{include_metadata}}"
        },
        {
          "key": "include_tabs",
          "value": "{{include_tabs}}"
        },
        {
          "key": "recipient_id",
          "value": "{{recipient_id}}"
        },
        {
          "key": "shared_user_id",
          "value": "{{shared_user_id}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves a list of documents associated with the specified envelope."
  },
  "response": [
  ]
}