GET api/SigningRoomManager/SigningRooms/{signingRoomId}/signingroomdocumentsummary

Gets document summary information for the documents associated with 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 document summary information.

Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomDocumentSummaryModel

Name	Description	Type	Additional information
DocumentName	Gets or sets the document name.	string	None.
RequiredSigners	Gets or sets the names of the required signers.	Collection of string	None.
RemainingSigners	Gets or sets the names of the remaining signers.	Collection of string	None.
SignedBy	Gets or sets the names of the persons who signed the document.	Collection of string	None.
RequiredReviewers	Gets or sets the names of the required reviwers.	Collection of string	None.
RemainingReviewers	Gets or sets the names of the remaining reviewers.	Collection of string	None.
ReviewedBy	Gets or sets the names of the persons who reviewed the document.	Collection of string	None.
Complete	Gets or sets whether the document is complete.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentName": "sample string 1",
    "RequiredSigners": [
      "sample string 1",
      "sample string 2"
    ],
    "RemainingSigners": [
      "sample string 1",
      "sample string 2"
    ],
    "SignedBy": [
      "sample string 1",
      "sample string 2"
    ],
    "RequiredReviewers": [
      "sample string 1",
      "sample string 2"
    ],
    "RemainingReviewers": [
      "sample string 1",
      "sample string 2"
    ],
    "ReviewedBy": [
      "sample string 1",
      "sample string 2"
    ],
    "Complete": true
  },
  {
    "DocumentName": "sample string 1",
    "RequiredSigners": [
      "sample string 1",
      "sample string 2"
    ],
    "RemainingSigners": [
      "sample string 1",
      "sample string 2"
    ],
    "SignedBy": [
      "sample string 1",
      "sample string 2"
    ],
    "RequiredReviewers": [
      "sample string 1",
      "sample string 2"
    ],
    "RemainingReviewers": [
      "sample string 1",
      "sample string 2"
    ],
    "ReviewedBy": [
      "sample string 1",
      "sample string 2"
    ],
    "Complete": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfSigningRoomDocumentSummaryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
  <SigningRoomDocumentSummaryModel>
    <Complete>true</Complete>
    <DocumentName>sample string 1</DocumentName>
    <RemainingReviewers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RemainingReviewers>
    <RemainingSigners xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RemainingSigners>
    <RequiredReviewers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RequiredReviewers>
    <RequiredSigners xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RequiredSigners>
    <ReviewedBy xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ReviewedBy>
    <SignedBy xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SignedBy>
  </SigningRoomDocumentSummaryModel>
  <SigningRoomDocumentSummaryModel>
    <Complete>true</Complete>
    <DocumentName>sample string 1</DocumentName>
    <RemainingReviewers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RemainingReviewers>
    <RemainingSigners xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RemainingSigners>
    <RequiredReviewers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RequiredReviewers>
    <RequiredSigners xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RequiredSigners>
    <ReviewedBy xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ReviewedBy>
    <SignedBy xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SignedBy>
  </SigningRoomDocumentSummaryModel>
</ArrayOfSigningRoomDocumentSummaryModel>