Collapse All Expand All

C#

Q-Pulse Web Services
IIncident..::..GetIncidentIDs Method
IIncident Interface See Also Send Feedback

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

Enables a user to search for an incident records. This method is an alternative to SearchIncdents(). Where SearchIncidents() returns full descriptions of found records, SearchIncidentsCompact() returns only the Incident Numbers. You can then retrieve the full details using GetIncident()

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

# Syntax

C#
    int[] GetIncidentIDs(
    	string token,
    	IncidentQuery query
    )

#### Parameters

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

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

#### Return Value

An Array of Occurrences

# Remarks

REST Availability: Supports HTTP POST

# Exceptions

Exception | Condition
--- | ---
ServiceFaultCode..::..ItemNotFoundInDatabase | An occurrence record with the requested number could not be found in the q-pulse database.
ServiceFaultCode..::..AuthenticationFailed | The token provided could not be authenticated.
ServiceFaultCode..::..SessionInvalid | The Q-Pulse session was invalid.

# See Also

IIncident Interface
QPulseWebServices.Contracts.Service Namespace