GET api/Folders/{folderId}

Gets the folder.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
folderId

The folder identifier.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The folder model.

ESignSystems.SmartSAFE.Models.Folders.FolderModel
NameDescriptionTypeAdditional information
FolderId

Gets or sets the folder identifier.

 integer

None.
ParentFolderId

Gets or sets the parent folder identifier.

 integer

None.
ClientId

Gets or sets the client identifier.

 integer

None.
Name

Gets the name.

 string

Required

Max length: 300
CreatedDate

Gets or sets the created date.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "FolderId": 1,
  "ParentFolderId": 1,
  "ClientId": 1,
  "Name": "sample string 1",
  "CreatedDate": "2024-11-26T17:36:47.828265-05:00"
}

application/xml, text/xml

Sample: 
<FolderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Folders">
  <ClientId>1</ClientId>
  <CreatedDate>2024-11-26T17:36:47.828265-05:00</CreatedDate>
  <FolderId>1</FolderId>
  <Name>sample string 1</Name>
  <ParentFolderId>1</ParentFolderId>
</FolderModel>