DocCloud API

GetFolderQuery

The following routes are available for this service:
GET	/folder/{Id}	Get folder by it's id.

**GetFolderQuery** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	ulong	No

**BaseSingleResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	T	No

**FolderDto** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Index	form	int	No
IsSystem	form	bool	No
TypeId	form	int	No
TypeName	form	string	No
Path	form	string	No
FolderSize	form	string	No
ParentFolderId	form	ulong?	No
MainFolderId	form	ulong?	No
FilesCount	form	ulong?	No
FilesNotBookedCount	form	ulong?	No

**BaseKeyLongDto** Parameters:
Name	Parameter	Data Type	Required
CreatedById	form	uint	No
ModifiedById	form	uint	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Id	form	ulong	No

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetFolderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Folder.Query">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Folder.Model" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.GlobalDto.Base">
    <CreatedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</CreatedById>
    <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</CreatedDate>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</Id>
    <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</ModifiedById>
    <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</ModifiedDate>
    <d2p1:FilesCount>0</d2p1:FilesCount>
    <d2p1:FilesNotBookedCount>0</d2p1:FilesNotBookedCount>
    <d2p1:FolderSize>String</d2p1:FolderSize>
    <d2p1:Index>0</d2p1:Index>
    <d2p1:IsSystem>false</d2p1:IsSystem>
    <d2p1:MainFolderId>0</d2p1:MainFolderId>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ParentFolderId>0</d2p1:ParentFolderId>
    <d2p1:Path>String</d2p1:Path>
    <d2p1:TypeId>0</d2p1:TypeId>
    <d2p1:TypeName>String</d2p1:TypeName>
  </Result>
</GetFolderResponse>