POST api/Reports/ProductUsagePeriod/Search
Gets a list of Product
Request Information
URI Parameters
None.
Body Parameters
The search criteria.
ESignSystems.SmartSAFE.Models.Reports.ProductUsagePeriodSearchCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate |
Gets or sets the start date. |
date |
Required |
| EndDate |
Gets or sets the end date. |
date |
Required |
| PageSize |
Gets or sets the number of rows in the page. |
integer |
Range: inclusive between 1 and 2147483647 |
| PageOffset |
Gets or sets the offset page to return. |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"StartDate": "2025-12-12T21:10:05.9793342-05:00",
"EndDate": "2025-12-12T21:10:05.9793342-05:00",
"PageSize": 1,
"PageOffset": 1
}
application/xml, text/xml
Sample:
<ProductUsagePeriodSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports"> <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageOffset> <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize> <EndDate>2025-12-12T21:10:05.9793342-05:00</EndDate> <StartDate>2025-12-12T21:10:05.9793342-05:00</StartDate> </ProductUsagePeriodSearchCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The list of product usage period models.
Collection of ESignSystems.SmartSAFE.Models.ProductUsage.ProductUsagePeriodModel| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate |
Gets or sets the start date for the period. |
date |
None. |
| EndDate |
Gets or sets the end date for the period. |
date |
None. |
| ActiveSigningRoomCount |
Gets or sets the active SigningRoom count for the period. |
integer |
None. |
| UploadedDocumentCount |
Gets or sets the uploaded document count for the period. |
integer |
None. |
| UpdatedBy |
Gets or sets the name of the user that updated the model. |
string |
None. |
| UpdatedDate |
Gets or sets the date an time that the model was updated. |
date |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"StartDate": "2025-12-12T21:10:05.9949578-05:00",
"EndDate": "2025-12-12T21:10:05.9949578-05:00",
"ActiveSigningRoomCount": 2,
"UploadedDocumentCount": 3,
"UpdatedBy": "sample string 4",
"UpdatedDate": "2025-12-12T21:10:05.9949578-05:00"
},
{
"StartDate": "2025-12-12T21:10:05.9949578-05:00",
"EndDate": "2025-12-12T21:10:05.9949578-05:00",
"ActiveSigningRoomCount": 2,
"UploadedDocumentCount": 3,
"UpdatedBy": "sample string 4",
"UpdatedDate": "2025-12-12T21:10:05.9949578-05:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfProductUsagePeriodModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.ProductUsage">
<ProductUsagePeriodModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 4</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2025-12-12T21:10:05.9949578-05:00</UpdatedDate>
<ActiveSigningRoomCount>2</ActiveSigningRoomCount>
<EndDate>2025-12-12T21:10:05.9949578-05:00</EndDate>
<StartDate>2025-12-12T21:10:05.9949578-05:00</StartDate>
<UploadedDocumentCount>3</UploadedDocumentCount>
</ProductUsagePeriodModel>
<ProductUsagePeriodModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 4</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2025-12-12T21:10:05.9949578-05:00</UpdatedDate>
<ActiveSigningRoomCount>2</ActiveSigningRoomCount>
<EndDate>2025-12-12T21:10:05.9949578-05:00</EndDate>
<StartDate>2025-12-12T21:10:05.9949578-05:00</StartDate>
<UploadedDocumentCount>3</UploadedDocumentCount>
</ProductUsagePeriodModel>
</ArrayOfProductUsagePeriodModel>