GET api/Admin/LockedDocuments

Allows a SAFEAdmin to search the locked documents.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The list of all locked documents in the system.

Collection of ESignSystems.SmartSAFE.Models.Admin.LockedDocumentModel

Name	Description	Type	Additional information
DocumentId	Gets or sets the document identifier.	integer	None.
ClientName	Gets or sets the name of the client associated to the document.	string	None.
DocumentName	Gets or sets the document name.	string	None.
DocumentType	Gets or sets the document type.	string	None.
LockedDate	Gets or sets the date and time when the document was locked.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentId": 1,
    "ClientName": "sample string 2",
    "DocumentName": "sample string 3",
    "DocumentType": "sample string 4",
    "LockedDate": "2024-11-26T17:29:48.5733243-05:00"
  },
  {
    "DocumentId": 1,
    "ClientName": "sample string 2",
    "DocumentName": "sample string 3",
    "DocumentType": "sample string 4",
    "LockedDate": "2024-11-26T17:29:48.5733243-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfLockedDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Admin">
  <LockedDocumentModel>
    <ClientName>sample string 2</ClientName>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 3</DocumentName>
    <DocumentType>sample string 4</DocumentType>
    <LockedDate>2024-11-26T17:29:48.5733243-05:00</LockedDate>
  </LockedDocumentModel>
  <LockedDocumentModel>
    <ClientName>sample string 2</ClientName>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 3</DocumentName>
    <DocumentType>sample string 4</DocumentType>
    <LockedDate>2024-11-26T17:29:48.5733243-05:00</LockedDate>
  </LockedDocumentModel>
</ArrayOfLockedDocumentModel>