GET api/Reports/SigningRoomMetrics

Gets the metrics of the signing rooms for the current client.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Model class with the count of signing rooms in different states.

ESignSystems.SmartSAFE.Models.Reports.SigningRoomMetricsModel
NameDescriptionTypeAdditional information
OpenCount

Gets or sets the count of open signing rooms.

integer

None.

CompletedCount

Gets or sets the count of completed signing rooms.

integer

None.

ExpiredCount

Gets or sets the count of expired signing rooms.

integer

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.

Response Formats

application/json, text/json

Sample:
{
  "OpenCount": 1,
  "CompletedCount": 2,
  "ExpiredCount": 3,
  "ReviewableDocumentCount": 4,
  "ReviewedDocumentCount": 5,
  "SignableDocumentCount": 6,
  "SignedDocumentCount": 7
}

application/xml, text/xml

Sample:
<SigningRoomMetricsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports">
  <CompletedCount>2</CompletedCount>
  <ExpiredCount>3</ExpiredCount>
  <OpenCount>1</OpenCount>
  <ReviewableDocumentCount>4</ReviewableDocumentCount>
  <ReviewedDocumentCount>5</ReviewedDocumentCount>
  <SignableDocumentCount>6</SignableDocumentCount>
  <SignedDocumentCount>7</SignedDocumentCount>
</SigningRoomMetricsModel>