[This is preliminary documentation and is subject to change.]
Enables a user to search for Document records by workload e.g. outstanding distribution acknowledge ments.
Namespace: QPulseWebServices.Contracts.ServiceAssembly: QPulseWebServices.Contracts (in QPulseWebServices.Contracts.dll) Version: 2.100.591.48
Syntax
| C# |
|---|
Document[] GetDocumentsByWorkload( string token, DocumentWorkloadType workload ) |
Parameters
- token
- Type: System..::..String
An authentication token previously requested from the Core service.
- workload
- Type: QPulseWebServices.Contracts.Data..::..DocumentWorkloadType
The type of workload against which to search for Document records.
Return Value
An array of Document records
Exceptions
| Exception | Condition |
|---|---|
| ServiceFaultCode..::..AuthenticationFailed | The token provided could not be authenticated. |
| ServiceFaultCode..::..SessionInvalid | The Q-Pulse session was invalid. |