Event Handling

getAllEvents

EventServiceResponse getAllEvents(filter, offset, number_of_rows,sort_by,desc_order)

• Description: Gets a list of Events along with a short version of the Event Details. It is also possible to get a range of event rows by specifying an offset and number of rows from that offset.

• Parameters:
  array $filter_array: Associated array where the key is the filter name and the value is the filter value integer $offset:
  integer $number_of_rows: Number of events to get
  string $sort_by: Value to sort by  
  $desc_order: Ascending order (false) or descending order (true). Default is descending order.

getTotalNumberOfEvents

ServiceResponse getTotalNumberOfEvents(filter)

• Description: Shows the total number of events according to the given filter. This function should be used along with the getAllEvents() function in order to get the total number of events matching a given filter and show these events by pages

• Parameters:
  array $filter_array: Associated array where the key is the filter name and the value is the filter value.

getEventData

EventServiceResponse getEventData(event_id)

• Description: Gets a specific event ID and returns all data available for the given event.

• Parameters:
  integer $event_id: The ID of the event you would like to get

getEventFilterNames

ServiceResponse getEventFilterNames()

• Description:

• Return Values: Returns a list (array inside a ServiceResponse) of all available filter names that can be used with the getAllEvents() function.

• Parameters: None

getEventFilterAvailableOptions

ServiceResponse getEventFilterAvailableOptions($filter_name)

• Description:

• Return Values: Returns all the possible options that the given filter name can accept (filter name is one of the elements returned by the getEventFilterNames() function.

• Parameters: string $filter_name:

getEventSortOptions

ServiceResponse getEventSortOptions()

• Description:

• Return Values: Returns all the possible sort options for events

• Parameters:

debugEvent

ServiceResponse debugEvent(event_id)

• Description: Starts a debug session while recreating the exact conditions that resulted in this event (same as the 'Debug' button in the 'Event Details' page).
  (This option works with Studio)

• Return Values: Will start a debug session

• Parameters:
  integer $event_id: The ID of the event you would like to debug.

profileEvent

ServiceResponse profileEvent(event_id)

• Description: Profiles the script that originated the given event (same as the 'Profile' button in the 'Event Details' page).

• Return Values: Will start profile session

• Parameters:
  integer $event_id: The ID of the event you would like to profile

deleteEvent

ServiceResponse deleteEvent(event_id)

• Description: Use this function to remove events from the Database (same as the 'Delete' button in the 'Event Details' page).

• Parameters:
  integer $event_id: The ID of the event you would like to delete.

ignoreEvent

ServiceResponse ignoreEvent(event_id)

• Description: Changes the Event's status to Ignored (same as the 'Ignore' button in the 'Event Details' page).

• Parameters:
  Integer $event_id: The ID of the event you would like to set as 'ignored'

closeEvent

ServiceResponse closeEvent(event_id)

• Description: Changes the Event's status to Closed (same as the 'Close' button in the 'Event Details' page).

• Parameters:
  integer $event_id: The ID of the event you would like to set as closed

preserveEvent

ServiceResponse preserveEvent(event_id)

• Description: Sets the Event's status to Preserved (same as the 'Preserve' checkbox in the 'Event Details' page).

• Parameters:
  integer $event_id: The ID of the event you would like to set to be preserved

unpreserveEvent

ServiceResponse unpreserveEvent(event_id)

• Description: Changes the status of a preserved so that it will be deleted in the next periodical Database cleanup.

• Parameters:
  integer $event_id: The ID of the event you would like to set to be un-preserved.