Layouts

This section discusses the following services related to layouts:

Search for Available Layouts

GET /layouts

Description

Search for a list of available layouts.

Resource Information

HTTP Method GET
Resource Family layouts
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Optional Query Parameters

search Any text which is going to be used in conjunction with the searchtype if provided. Limited to 100 search results at a time.
searchtype When this field is empty, a wild-card search will be performed using the package name and description for the search value. Otherwise, the allowable values of exact or exactname will make more restrictive searches.
visibility

The visibility that will be used to search for layouts. The possible values are ACCOUNT (default) and SENDER.

from Specify the number of layouts to be returned, for pagination purposes.
to
sort The field according to which data will be sorted. Possible fields to sort by are: APPROVAL_SIGNING_DATE, attributeValue, created, completed, updated, due, name.
dir The direction according to which data will be sorted. Give the value asc for ascending, or des for descending.

Example Request

GET https://sandbox.e-signlive.com/api/layouts

Create a Layout

POST /layouts

Description

Create a new layout.

Resource Information

HTTP Method POST
Resource Family layouts
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

POST https://sandbox.e-signlive.com/api/layouts

Request Payload

{  
   "name":"Layout 02",
   "type":"LAYOUT",
   "id":"2ea60064-4737-4a16-9434-39c76c7e1c18",
   "visibility":"SENDER",
   "documents":[  
      {  
         "id":"0fd09aace54e040d"
      }
   ]
}

Delete a Layout

DELETE /packages/{layoutId}

Description

Delete a document layout.

Resource Information

HTTP Method DELETE
Resource Family packages
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

layoutId Unique ID of an eSignLive layout

Example Request

DELETE https://sandbox.e-signlive.com/api/packages/75b125e1-ece3-481e-b8a6-3c2ae39d310a

Response Payload

no content