DocCloud API

<back to all web services

GetFolderQuery

Requires Authentication
The following routes are available for this service:
GET/folder/{Id}Get folder by it's id.
GetFolderQuery Parameters:
NameParameterData TypeRequiredDescription
IdpathulongNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
FolderDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IndexformintNo
IsSystemformboolNo
TypeIdformintNo
TypeNameformstringNo
PathformstringNo
FolderSizeformstringNo
ParentFolderIdformulong?No
MainFolderIdformulong?No
FilesCountformulong?No
FilesNotBookedCountformulong?No
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /folder/{Id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		name: String,
		index: 0,
		isSystem: False,
		typeId: 0,
		typeName: String,
		path: String,
		folderSize: String,
		parentFolderId: 0,
		mainFolderId: 0,
		filesCount: 0,
		filesNotBookedCount: 0,
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}