Retrieves general information about the template lock.

If the call is made by the user who has the lock and the request has the same integration key as original, then the X-DocuSign-Edit header field and additional lock information is included in the response. This enables users to recover a lost editing session token and the X-DocuSign-Edit header.

Request

HTTP request

GET /v2.1/accounts/{accountId}/templates/{templateId}/lock

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

templateIdstring

The id of the template.

Responses

CodeDescriptionReference
200

Successful response.

TemplateLocks
400

Error encountered.

errorDetails

SDK Method

Templates::getLock

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

userInfo

accountIdstring

The external account number (int) or account ID GUID.

accountNamestring

The name of the account associated with the current workspace user.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

membershipIdstring

The user's membership ID.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

uristring

A URI containing the user ID.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

userNamestring

The name of the user.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

TemplateLocks

This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

lockDurationInSecondsstring

Sets the time, in seconds, until the lock expires when there is no activity on the envelope.

If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.

The lock duration can be extended.

lockedByAppstring

Specifies the friendly name of the application that is locking the envelope.

lockedByUseruserInfo

A complex type containing information about the user that has the envelope or template locked.

lockedUntilDateTimestring

The date and time that the lock expires.

lockTokenstring

A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.

lockTypestring

The type of lock. Currently edit is the only supported type.

useScratchPadstring

When set to true, a scratchpad is used to edit information.

Examples

Generic JSON Response

Response
{
  "lockedByUser": {
    "userName": "sample string 1",
    "userId": "sample string 2",
    "email": "sample string 3",
    "userType": "sample string 4",
    "userStatus": "sample string 5",
    "uri": "sample string 6",
    "loginStatus": "sample string 7",
    "sendActivationEmail": "sample string 8",
    "activationAccessCode": "sample string 9",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    }
  },
  "lockedByApp": "sample string 1",
  "lockedUntilDateTime": "sample string 2",
  "lockDurationInSeconds": "sample string 3",
  "lockType": "sample string 4",
  "useScratchPad": "sample string 5",
  "lockToken": "sample string 6",
  "errorDetails": {
    "errorCode": "SUCCESS",
    "message": ""
  }
}
Generic XML Response

Response
<lockInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <errorDetails>
    <errorCode>SUCCESS</errorCode>
    <message></message>
  </errorDetails>
  <lockDurationInSeconds>sample string 3</lockDurationInSeconds>
  <lockToken>sample string 6</lockToken>
  <lockType>sample string 4</lockType>
  <lockedByApp>sample string 1</lockedByApp>
  <lockedByUser>
    <activationAccessCode>sample string 9</activationAccessCode>
    <email>sample string 3</email>
    <errorDetails>
      <errorCode>sample string 1</errorCode>
      <message>sample string 2</message>
    </errorDetails>
    <loginStatus>sample string 7</loginStatus>
    <sendActivationEmail>sample string 8</sendActivationEmail>
    <uri>sample string 6</uri>
    <userId>sample string 2</userId>
    <userName>sample string 1</userName>
    <userStatus>sample string 5</userStatus>
    <userType>sample string 4</userType>
  </lockedByUser>
  <lockedUntilDateTime>sample string 2</lockedUntilDateTime>
  <useScratchPad>sample string 5</useScratchPad>
</lockInformation> 
}} />