Collapse All Expand All

C#

Q-Pulse Web Services
IDocument..::..GetDocumentIDs Method
IDocument Interface See Also Send Feedback

[This is preliminary documentation and is subject to change.]

Enables a user to search for Document records. This method is an alternative to GetDocuments(). Where GetDocuments() returns full descriptions of found records, GetDocumentIDs() returns only the Document record numbers. You can then retrieve the full details using GetDocument()

Namespace: QPulseWebServices.Contracts.Service
Assembly: QPulseWebServices (in QPulseWebServices.dll) Version: 2.0.2.70

# Syntax

C#
    int[] GetDocumentIDs(
    	string token,
    	DocumentQuery query
    )

#### Parameters

token
  Type: System..::..String
  An authentication token previously requested from the Core service.

query
  Type: QPulseWebServices.Contracts.Data..::..DocumentQuery
  The query against which to search for Document records.

#### Return Value

An array of Document record numbers

# Exceptions

Exception | Condition
--- | ---
ServiceFaultCode..::..AuthenticationFailed | The token provided could not be authenticated.
ServiceFaultCode..::..SessionInvalid | The Q-Pulse session was invalid.

# See Also

IDocument Interface
QPulseWebServices.Contracts.Service Namespace