Collapse All Expand All

C#

Q-Pulse Web Services
ICapa..::.GetCapaIDs Method
ICapa Interface See Also Send Feedback

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

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

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

# Syntax

C#
    int[] GetCapaIDs(
    	string token,
    	CapaQuery query
    )

#### Parameters

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

query
  Type: QPulseWebServices.Contracts.Data..::.CapaQuery
  The query against which to search for Capa records.

#### Return Value

An array of Capa record numbers

# Exceptions

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

# See Also

ICapa Interface
QPulseWebServices.Contracts.Service Namespace