Chilkat Online Tools

Perl / DocuSign REST API / Gets the status of a envelope.

Back to Collection Items

use 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("advanced_update","{{advanced_update}}");
$queryParams->UpdateString("include","{{include}}");

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

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print $resp->get_StatusCode() . "\r\n";
print $resp->bodyStr() . "\r\n";

Curl Command

curl -G -d "advanced_update=%7B%7Badvanced_update%7D%7D"
	-d "include=%7B%7Binclude%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}

Postman Collection Item JSON

{
  "name": "Gets the status of a envelope.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}?advanced_update={{advanced_update}}&include={{include}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}"
      ],
      "query": [
        {
          "key": "advanced_update",
          "value": "{{advanced_update}}"
        },
        {
          "key": "include",
          "value": "{{include}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Retrieves the overall status for the specified envelope."
  },
  "response": [
  ]
}