[This is preliminary documentation and is subject to change.]
Enables a user to retrieve their Document folders by FolderCategory.
Namespace: QPulseWebServices.Contracts.ServiceAssembly: QPulseWebServices.Contracts (in QPulseWebServices.Contracts.dll) Version: 2.100.591.48
Syntax
| C# |
|---|
DocumentFolder[] GetDocumentFoldersByCategory( string token, FolderType type, int categoryID ) |
Parameters
- token
- Type: System..::..String
An authentication token previously requested from the Core service.
- type
- Type: QPulseWebServices.Contracts.Data..::..FolderType
The folder type to retrieve.
- categoryID
- Type: System..::..Int32
The ID of the folder category to retrieve Document Folders from.
Return Value
An array of DocumentFolder records
Exceptions
| Exception | Condition |
|---|---|
| ServiceFaultCode..::..AuthenticationFailed | The token provided could not be authenticated. |
| ServiceFaultCode..::..SessionInvalid | The Q-Pulse session was invalid. |