GET api/Document/GetFolderDetails/{apiClientID}/{folderID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| apiClientID | string |
Required |
|
| folderID | string |
Required |
Body Parameters
None.
Response Information
Resource Description
FolderDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| apiClientID | string |
None. |
|
| FolderID | string |
None. |
|
| FolderType | string |
None. |
|
| FolderTypeName | string |
None. |
|
| FolderCode | string |
None. |
|
| FolderName | string |
None. |
|
| OrganisationID | integer |
None. |
|
| Public | boolean |
None. |
|
| AdministratorID | string |
None. |
|
| FolderStatus | string |
None. |
|
| FolderDueDate | date |
None. |
|
| FolderEntityType | string |
None. |
|
| FolderEntityCode | string |
None. |
|
| FolderEntityName | string |
None. |
|
| ClassificationTypeCode | string |
None. |
|
| ClassificationCode | string |
None. |
|
| ClassificationName | string |
None. |
|
| FolderExpirationDate | date |
None. |
|
| Description | string |
None. |
|
| FolderCreator | string |
None. |
|
| FolderCreationDate | date |
None. |
|
| FolderCredentials | FolderCredentials |
None. |
|
| Comments | FolderComments |
None. |
Response Formats
application/xml, text/xml
Sample:
<FolderDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<apiClientID>sample string 1</apiClientID>
<FolderID>sample string 2</FolderID>
<FolderType>sample string 3</FolderType>
<FolderTypeName>sample string 4</FolderTypeName>
<FolderCode>sample string 5</FolderCode>
<FolderName>sample string 6</FolderName>
<OrganisationID>7</OrganisationID>
<Public>true</Public>
<AdministratorID>sample string 9</AdministratorID>
<FolderStatus>sample string 10</FolderStatus>
<FolderDueDate>2024-11-21T14:48:37.5663317+01:00</FolderDueDate>
<FolderEntityType>sample string 11</FolderEntityType>
<FolderEntityCode>sample string 12</FolderEntityCode>
<FolderEntityName>sample string 13</FolderEntityName>
<ClassificationTypeCode>sample string 14</ClassificationTypeCode>
<ClassificationCode>sample string 15</ClassificationCode>
<ClassificationName>sample string 16</ClassificationName>
<FolderExpirationDate>2024-11-21T14:48:37.5663317+01:00</FolderExpirationDate>
<Description>sample string 17</Description>
<FolderCreator>sample string 18</FolderCreator>
<FolderCreationDate>2024-11-21T14:48:37.5663317+01:00</FolderCreationDate>
<FolderCredentials>
<FolderCredential>
<AuthorizedUserID>sample string 1</AuthorizedUserID>
<ReadAllDocuments>2</ReadAllDocuments>
<AuthorizedBy>sample string 3</AuthorizedBy>
<AuthorizationTime>2024-11-21T14:48:37.5673316+01:00</AuthorizationTime>
</FolderCredential>
<FolderCredential>
<AuthorizedUserID>sample string 1</AuthorizedUserID>
<ReadAllDocuments>2</ReadAllDocuments>
<AuthorizedBy>sample string 3</AuthorizedBy>
<AuthorizationTime>2024-11-21T14:48:37.5673316+01:00</AuthorizationTime>
</FolderCredential>
</FolderCredentials>
<Comments>
<Comment>
<CommentTime>2024-11-21T14:48:37.5673316+01:00</CommentTime>
<Commenter>sample string 2</Commenter>
<CommentBody>sample string 3</CommentBody>
</Comment>
<Comment>
<CommentTime>2024-11-21T14:48:37.5673316+01:00</CommentTime>
<Commenter>sample string 2</Commenter>
<CommentBody>sample string 3</CommentBody>
</Comment>
</Comments>
</FolderDetails>