Chilkat Online Tools

phpExt / DocuSign eSignature REST API / Gets template lock information.

Back to Collection Items

<?php

include("chilkat.php");

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

$http = new CkHttp();

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

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/lock',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print 'Response status code = ' . $http->get_LastStatus() . "\n";
print $sbResponseBody->getAsString() . "\n";

?>

Curl Command

curl -X GET
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/lock

Postman Collection Item JSON

{
  "name": "Gets template lock information.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/lock",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "lock"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves general information about the template lock.\n\nIf the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header  field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header."
  },
  "response": [
  ]
}