GET api/SigningRoomManager/SigningRooms/{signingRoomId}/signingroomsummary
Gets a status summary of the SigningRoom.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| signingRoomId |
The SigningRoom id. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The SigningRoom status summary.
ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomSummaryModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Status |
Gets or sets the status of the SigningRoom. |
string |
None. |
| ReviewableDocumentCount |
Gets or sets the count of documents that are reviewable. |
integer |
None. |
| ReviewedDocumentCount |
Gets or sets the count of documents that have been reviewed. |
integer |
None. |
| SignableDocumentCount |
Gets or sets the count of documents that are signable. |
integer |
None. |
| SignedDocumentCount |
Gets or sets the count of documents that are signed. |
integer |
None. |
| IncompleteENotaryDocumentCount |
Gets or sets the count of eNotary documents that are incomplete. |
integer |
None. |
| CompleteEnotaryDocumentCount |
Gets or sets the count of eNotary documents that are complete. |
integer |
None. |
| IncompletePrintAndSignDocumentCount |
Gets or sets the count of print and sign documents that are incomplete. |
integer |
None. |
| CompletePrintAndSignDocumentCount |
Gets or sets the count of print and sign documents that are complete. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": "sample string 1",
"ReviewableDocumentCount": 2,
"ReviewedDocumentCount": 3,
"SignableDocumentCount": 4,
"SignedDocumentCount": 5,
"IncompleteENotaryDocumentCount": 6,
"CompleteEnotaryDocumentCount": 7,
"IncompletePrintAndSignDocumentCount": 8,
"CompletePrintAndSignDocumentCount": 9
}
application/xml, text/xml
Sample:
<SigningRoomSummaryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager"> <CompleteEnotaryDocumentCount>7</CompleteEnotaryDocumentCount> <CompletePrintAndSignDocumentCount>9</CompletePrintAndSignDocumentCount> <IncompleteENotaryDocumentCount>6</IncompleteENotaryDocumentCount> <IncompletePrintAndSignDocumentCount>8</IncompletePrintAndSignDocumentCount> <ReviewableDocumentCount>2</ReviewableDocumentCount> <ReviewedDocumentCount>3</ReviewedDocumentCount> <SignableDocumentCount>4</SignableDocumentCount> <SignedDocumentCount>5</SignedDocumentCount> <Status>sample string 1</Status> </SigningRoomSummaryModel>