6.2 Get Signing Templates (Paginated)
6.2.1 Description
Some requests need to identify a signing template so that they don’t have to specify all signers and details each time a document is uploaded. This request allows to list the names of signing templates and their associated codes.
Signing templates can be created in the eSignatures Portal by a user with the appropriate permissions.
Please note that the Code field is a string. Its value may look numeric but its leading zeroes are part of the value. The code should be looked up every time it gets used because deleting a template and creating a new one means the Code field is set to a unique value.
This method uses paging so only a limited number of records is returned at a time (currently limited to maximum 50 records). Query parameters are then used to specify how many items to return and which page to continue with. Further parameters (sorting, sort order) can be seen below.
Note: signing templates can only be used in Instant Package Creation calls.
Note: the ContinuationToken is meant to be opaque to clients – either give an empty value for the first page or pass a token which was returned from a previous request. Trying to generate it on the client may not be supported in future versions when the format changes.
Note: currently the response will always contain a continuation token, even if there are no more records. The client is responsible for counting the number of items seen before and comparing it with the Total parameter in the response to know when to stop making calls.
6.2.2 URL
https://[servername]:[port]/webportalapi/v3/signingtemplates
6.2.3 HTTP Method
GET
6.2.4 MIME Type
application/json
6.2.5 Query parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
ContinuationToken | Optional | Token which holds information about which set of records needs to be returned. | String |
MaxQuantity | Optional | Maximum number of records. | Int |
SortField | Optional | Sort the returned records by the field which is specified. (Reserved for future use) | String |
SortOrder | Optional | ‘ASC’ or ‘DESC’ to specify in which way sorting happens. (Reserved for future use) | String |
Tags | Optional, 0...* | Labels (Tags) to define the correct template. Multiple labels (tags) are possible. | String |
6.2.6 Response parameters
Parameter | Content / Description | Type |
---|---|---|
ContinuationToken | Token which allows the client to retrieve the next set of records. | String |
MaxQuantity | The highest number of records that the result may contain. Useful when no quantity was given in the request (default subject to change). | Int |
Total | Number of records found in the database. The client can use the quantity and total to calculate the number of calls needed to retrieve all records. | Int |
Items | List of signing template items. | Array of objects |
Parameter | Content / Description | Type |
---|---|---|
Items (array of objects) | Array, 0..* | Array of objects |
Code | Unique id of the signing template. | String |
Name | Signing template name. | String |
CreationTimestamp | The creation date and time of the signing template. Uses the ISO 8601 date-time format, e.g. 2018-01-23T12:34:00.000Z | DateTime |
6.2.7 Example response
Take for example the following GET request:
https://[host]/webportalapi/v3/signingtemplates?MaxQuantity=2&ContinuationToken=
{
"ContinuationToken": "45b8530d-c54b-46ba-bbfe-7b80209c7e4e",
"Items": [
{
"Code": "c3940cf6-fa80-441f-8971-55af6d00fb9d",
"Name": "MyTemplate",
"CreationTimestamp": "2017-01-25T13:35:49.844Z"
},
{
"Code": "0eeaa964-4197-41aa-9d6e-875b8e6d1a92",
"Name": "DepartmentTemplate",
"CreationTimestamp": "2017-01-25T13:36:23.513Z"
}
],
"MaxQuantity": 2,
"Total": 21
}
6.2.8 Response codes
Response status code | Description |
---|---|
200 OK | The template list of templates gets returned successfully. |
400 Bad request | A request parameter was invalid. |
6.2.9 Error codes
HTTP code | Code |
---|---|
400 | Pagination.MaxQuantity.OutOfBounds |