Collapse All Expand All

C#

Q-Pulse Web Services
IOccurrence..::..GetOccurrenceIDs Method
IOccurrence Interface See Also Send Feedback

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

Enables a user to search for occurrences. This method is an alternative to GetOccurrences(). Where GetOccurrences() returns full descriptions of found records, GetOccurrenceIDs() returns only the Occurrence Numbers. You can then retrieve the full details using GetOccurrence()

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

# Syntax

C#
    int[] GetOccurrenceIDs(
    	string token,
    	OccurrenceQuery query
    )

#### Parameters

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

query
  Type: QPulseWebServices.Contracts.Data..::..OccurrenceQuery
  The query against which to search for occurrences.

#### Return Value

An Array of Occurrences

# Remarks

REST Availability: Supports HTTP POST

# Exceptions

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

# See Also

IOccurrence Interface
QPulseWebServices.Contracts.Service Namespace