5.3 Get Signing Locations
5.3.1 Description
This call provides an overview of all signing locations inside the documents within a package. You can use this call in case the separate location lists returned by the different Add document calls were not stored for instance.
Note however that this call provides a subset of the responses that are returned by the Add document calls.
5.3.2 URL
https://[servername]:[port]/webportalapi/v3/packages/{id}/locations
5.3.3 HTTP Method
GET
5.3.4 MIME Type
Not applicable
5.3.5 Template parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
id | Required | Unique id for the signing package. Use the value you receive as PackageId parameter in 5.1.6. | String |
5.3.6 Response parameters
The root level has currently only one parameter: 'Documents'.
Parameter | Content / Description | Type |
---|---|---|
Documents | Zero or more document objects | Array of objects |
Parameter | Content / Description | Type |
---|---|---|
Documents (array of objects) | Zero or more document objects | Array of objects |
DocumentId | Unique id for the document | String |
ExternalDocumentReference | External reference for identification. Make sure to use a unique value. | String |
Locations | List of detected or created signature locations | Array of objects |
Parameter | Content / Description | Type |
---|---|---|
Documents --> Locations (object) | Possible locations for signatures. | Object |
Id | Unique id for this location, to be used when refering to it later. | String |
Label | Detected or specified label. | String |
PageNumber | The page on which the location was found. Numbering starts with 1 and the last index is equal to the number of pages. | Integer |
5.3.7 Example response
{
"Documents": [
{
"DocumentId": "7c0af947-e3db-417a-900a-c25852be3d97",
"ExternalDocumentReference": "INV-2019-04-23-0037",
"Locations": [
{
"Id": "ae554ac8-bacc-4e8a-81a1-46af780142ea",
"Label": "SIG01",
"PageNumber": 1
}
]
},
{
"DocumentId": "176232c3-c97b-4b4a-91e3-c2f347c92e9f",
"ExternalDocumentReference": "INV-2019-04-23-0038",
"Locations": [
{
"Id": "2dd4ed18-ce80-49a8-aa75-f177045b2488",
"Label": "SIG02",
"PageNumber": 1
}
]
}
]
}
5.3.8 Response codes
Response status code | Description |
---|---|
200 OK | The signing locations from the package are returned successfully. |
404 Not Found | The package Id given does not exist. |
409 Conflict | The package with the specified id was made with an old version of the api. |
5.3.9 Error codes
HTTP Code | Code |
---|---|
404 | Package.NotFound |
409 | Package.ApiVersionMismatch |