GET api/Signing/SigningRooms/{signingRoomId}/ParticipantPreRequisites
Gets the SigningRoom participant prerequisites for the current signer user associated to the specified SigningRoom Id. The current user must be a participant in the specified SigningRoom.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| signingRoomId |
The id of the SigningRoom |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The SigningRoom participant prerequisites.
ESignSystems.SmartSAFE.Models.Signing.SigningRoomParticipantPrerequisitesModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ESignConsentRequired |
Gets or sets a value indicating whether the esign consent is required. |
boolean |
None. |
| FontSelectionRequired |
Gets or sets a value indicating whether font selection is required. |
boolean |
None. |
| PrerequisitesCompleted |
Gets a value indicating whether the participant has satisfied the prerequisites. |
boolean |
None. |
| FirstName |
Gets or sets the participant's first name. |
string |
None. |
| LastName |
Gets or sets the participant's last name. |
string |
None. |
| FullName |
Gets the participant's full name. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ESignConsentRequired": true,
"FontSelectionRequired": true,
"PrerequisitesCompleted": false,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"FullName": "sample string 3 sample string 4"
}
application/xml, text/xml
Sample:
<SigningRoomParticipantPrerequisitesModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing"> <ESignConsentRequired>true</ESignConsentRequired> <FirstName>sample string 3</FirstName> <FontSelectionRequired>true</FontSelectionRequired> <LastName>sample string 4</LastName> </SigningRoomParticipantPrerequisitesModel>