GET api/documentfolders

Request Information

URI Parameters

Name	Description	Type	Additional information
Name	The folder name.	string	Invalid Chars: \/:*?<>\|" Max length: 50
Links	Gets the links.	Collection of LinkModel	None.

Name

Description

Type

Additional information

Name

The folder name.

string

Invalid Chars: \/:*?<>|"

Max length: 50

Links

Gets the links.

Collection of LinkModel

None.

Body Parameters

None.

Response Information

Resource Description

Collection of DocumentFolderViewModel

Name	Description	Type	Additional information
Id		integer	Read-only
Name	The folder name.	string	Required Invalid Chars: \/:*?<>\|" Max length: 50
SiteId	The folder's site. When creating a folder, set this to null to create on all sites.	integer	None.
FolderType	The folder type, System or User. System folders cannot be modified or deleted.	DocumentFolderType	Read-only
Links	Gets the links.	Collection of LinkModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "siteId": 1,
    "folderType": 0
  },
  {
    "id": 1,
    "name": "sample string 2",
    "siteId": 1,
    "folderType": 0
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocumentFolderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TelogWebAPI.Models">
  <DocumentFolderViewModel>
    <FolderType>System</FolderType>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <SiteId>1</SiteId>
  </DocumentFolderViewModel>
  <DocumentFolderViewModel>
    <FolderType>System</FolderType>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <SiteId>1</SiteId>
  </DocumentFolderViewModel>
</ArrayOfDocumentFolderViewModel>