A valid request URL is required to generate request examples[
{
"Id": "00000000-0000-0000-0000-000000000000",
"ActorId": "00000000-0000-0000-0000-000000000000",
"Type": "signingField",
"Location": {
"Page": 1,
"Top": 200,
"Left": 200
},
"Dimensions": {
"Width": 200,
"Height": 200
}
},
{
"Id": "00000000-0000-0000-0000-000000000001",
"ActorId": "00000000-0000-0000-0000-000000000000",
"Type": "TextBoxField",
"Name": "TextBox1",
"Label": "Empty textbox",
"IsRequired": false,
"IsMultiline": false,
"Value": null,
"DefaultValue": null,
"CharLimit": 115,
"Location": {
"Page": 1,
"Top": 200,
"Left": 200
},
"Dimensions": {
"Width": 200,
"Height": 200
},
"ExternalReference": "my_checkboxfield"
},
{
"Id": "00000000-0000-0000-0000-000000000002",
"ActorId": "00000000-0000-0000-0000-000000000000",
"Type": "CheckBoxField",
"Name": "CheckBox1",
"Label": "To be checked",
"IsRequired": true,
"Checked": null,
"DefaultValue": false,
"Location": {
"Page": 1,
"Top": 200,
"Left": 200
},
"Dimensions": {
"Width": 200,
"Height": 200
},
"ExternalReference": "my_checkboxfield"
}
][
{
"ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
"ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
}
]List document elements
Retrieves all elements that currently exist on the specified document within the specified package.
A valid request URL is required to generate request examples[
{
"Id": "00000000-0000-0000-0000-000000000000",
"ActorId": "00000000-0000-0000-0000-000000000000",
"Type": "signingField",
"Location": {
"Page": 1,
"Top": 200,
"Left": 200
},
"Dimensions": {
"Width": 200,
"Height": 200
}
},
{
"Id": "00000000-0000-0000-0000-000000000001",
"ActorId": "00000000-0000-0000-0000-000000000000",
"Type": "TextBoxField",
"Name": "TextBox1",
"Label": "Empty textbox",
"IsRequired": false,
"IsMultiline": false,
"Value": null,
"DefaultValue": null,
"CharLimit": 115,
"Location": {
"Page": 1,
"Top": 200,
"Left": 200
},
"Dimensions": {
"Width": 200,
"Height": 200
},
"ExternalReference": "my_checkboxfield"
},
{
"Id": "00000000-0000-0000-0000-000000000002",
"ActorId": "00000000-0000-0000-0000-000000000000",
"Type": "CheckBoxField",
"Name": "CheckBox1",
"Label": "To be checked",
"IsRequired": true,
"Checked": null,
"DefaultValue": false,
"Location": {
"Page": 1,
"Top": 200,
"Left": 200
},
"Dimensions": {
"Width": 200,
"Height": 200
},
"ExternalReference": "my_checkboxfield"
}
][
{
"ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
"ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
}
]Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The target package's unique identifier A package's unique identifier
"00000000-0000-0000-0000-000000000000"
The target document's unique identifier A document's unique identifier
"00000000-0000-0000-0000-000000000000"
Response
OK
- Signing field
- Check box field
- Text box field
- Radio group
- Combo box field
A field that can be signed by an actor
The type of element - the discriminator across the element variants.
The ComboBoxField value is available as of NSEV v8.5.
SigningField, TextBoxField, CheckBoxField, RadioGroup, ComboBoxField An element's unique identifier
"00000000-0000-0000-0000-000000000000"
Is null when no actor has been assigned to this field yet
"00000000-0000-0000-0000-000000000000"
The status of a document element
Pending, InProgress, Rejected, Failed, Finished, Refused External reference to this resource set by the calling application. NSEV does not use this value itself. When filtering packages, this matches the package-level external reference only, not document or field references.
256where an element is placed
Show child attributes
Show child attributes
{ "Page": 2, "Top": 200, "Left": 200 }
The signingmethod that was used to sign this signingfield
An NSEV signing method
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The size of an element in points. The minimum width and height depend on the element type - a signing field must be at least 50 × 30, other elements at least 10 × 10. See the Field positioning guide.
Show child attributes
Show child attributes
{ "Width": 200, "Height": 200 }