6.1 Get DocumentGroups
6.1.1 Description
Some requests need to identify a Document Group in which a document is to be used. This request allows to list the names of document groups and most importantly their associated codes.
There is always at least one document group: “My Documents” (the name could be different) with Code “00001”. This group is special because the documents in this group are only visible to the eSignatures Portal user who uploaded the document (in case of an upload made through the API from this document it will be the user whose email was given as Initiator).
Please note that the Code field is a string. Its value may look numeric but its leading zeroes are part of the value.
6.1.2 URL
https://[servername]:[port]/webportalapi/v3/documentgroups
6.1.3 HTTP Method
GET
6.1.4 MIME Type
application/json
6.1.5 Response parameters
Parameter | Content / Description | Type |
---|---|---|
DocumentGroups | List of all document groups | Array of objects |
Parameter | Content / Description | Type |
---|---|---|
DocumentGroups (array of objects) | Document group details | Array of objects |
Name | Name or description of the document group | String |
Code | A unique value identifying each document group | String |
6.1.6 Example response
{
"DocumentGroups" : [{
"Name" : "My Documents",
"Code" : "00001"
}, {
"Name" : "HR",
"Code" : "00002"
}, ]
}
6.1.7 Response codes
Response status code | Description |
---|---|
200 OK | The documentgroups gets returned successfully. |
6.1.8 Error codes
HTTP code | Code |
---|---|
None | No error messages possible |