Web Service Operations

The following table lists the web service operations supported in xMatters web services. The Availability column indicates the first release or patch version of xMatters in which the operation became available; unless otherwise indicated, the operation is available in all subsequent releases of xMatters.

All examples provided in this documentation use SOAP 1.2 bindings.

Operation Description Availability

AddCompanyCustomAttributes

Adds a new custom attribute category and new custom attributes to an existing Company.

xMatters 4.0

AddCoverage

Adds a Coverage to an existing Group.

xMatters 3.2.1

AddCustomHoliday Adds a new custom Company holiday.

xMatters 4.0

AddDevice

Creates a Device based on the passed parameters.

xMatters 3.1 Web Services Update 2

Updated for xmatters-4.1.6 WSDL.

AddDeviceTimeframe

Adds a Device Timeframe.

xMatters 3.1 Web Services Update 2

AddDynamicTeam

Adds a new Dynamic Team

xMatters 4.0

AddEvent

Creates an event based on the supplied parameters. An xMatters event is used to initiate notifications from external integration points.

xMatters 3.1

AddGroup

Adds a Group.

xMatters 3.2.1

AddSubscription

Creates the specified subscription.

xMatters 3.1 Web Services Update 4

AddTeam

Adds a Team to a specified Group.

xMatters 3.2.1

AddTemporaryReplacement

Schedules a Temporary Replacement.

xMatters 3.1 Web Services Update 1

AddUser

Adds a User.

xMatters 3.2.1

DeleteCoverage

Deletes a specified Group Coverage.

xMatters 3.2.1

CheckInScriptItem

Used by the Developer IDE to access and manage the scripts. INTERNAL USE ONLY

Can only be used with the AlarmPointWebService WSDL.

xMatters Internal Only

CheckOutScriptItem

Used by the Developer IDE to access and manage the scripts. INTERNAL USE ONLY

Can only be used with the AlarmPointWebService WSDL.

xMatters Internal Only

DeleteCompanyCustomAttributes

Deletes a category and related attributes xMatters 4.0

DeleteCustomHoliday

Deletes a custom holiday from a Company

xMatters 4.0

DeleteDevice

Deletes a Device.

xMatters 3.1 Web Services Update 2

DeleteDeviceTimeframe

Deletes a Device Timeframe.

xMatters 3.1 Web Services Update 2

DeleteDynamicTeam

Deletes a Dynamic Team xMatters 4.0

DeleteEvent

Terminates a previously created xMatters event. Event termination results in termination of all notifications associated with the event. All subsequent responses associated with the event are ignored.

xMatters 3.1

DeleteGroup

Deletes a specified Group.

xMatters 3.2.1

DeleteIncident

Terminates all events associated with an incident. Event termination results in termination of all notifications associated with the event. All subsequent responses associated with the event are ignored.

xMatters 3.1

DeleteScriptItem

Used by the Developer IDE to access and manage the scripts. INTERNAL USE ONLY

Can only be used with the AlarmPointWebService WSDL.

xMatters Internal Only

DeleteSubscription

Deletes the specified subscription.

xMatters 3.1 Web Services Update 4

DeleteTeam

Deletes a specified Team from a Group.

xMatters 3.2.1

DeleteTemporaryReplacement

Deletes a Temporary Replacement.

xMatters 3.1 Web Services Update 1

DeleteUser

Deletes a specified User.

xMatters 3.2.1

FindActiveUserNotifications Searches for active notifications for a specific User xMatters 4.0 patch 013, 4.1 patch 005

FindCompanyDeviceNames

Returns a list of available Device names for a specified Device type.

xMatters 3.1 Web Services Update 2

FindCompanyDeviceTypes

Returns a list of active Device types.

xMatters 3.1 Web Services Update 2

FindCountries

Returns a list of active countries configured in xMatters.

xMatters 3.1 Web Services Update 2

FindDeviceNotifications

Returns a list of Device notifications that entered a specific state during a specified time range.

xMatters 3.2.1 patch 011 and xMatters 4.0 patch 005

FindDevices

Returns a list of Devices based on specified search criteria.

xMatters 3.1 Web Services Update 2

Updated for xmatters-4.1.6 WSDL.

FindDeviceTimeframe

Returns a list of Device Timeframes based on specified search criteria.

xMatters 3.1 Web Services Update 2

FindEvents

Returns a list of events based on the specified search criteria.

xMatters 3.2.1

FindGroups

Returns a list of Groups based on the specified search criteria.

xMatters 3.2.1

FindPersonNotifications

Returns a list of all User notifications created within a specific time frame.

xMatters 3.2.1 patch 011 and xMatters 4.0 patch 005

FindPersons

Returns a list of xMatters Users based on specified search criteria.

xMatters 3.1

FindPhoneLogin

Returns phone login information for the specified User.

xMatters 3.1 Web Services Update 3

FindPriorityThresholds

Returns a list of valid Priority Thresholds for a Device.

xMatters 3.1 Web Services Update 2

FindResponses

Searches for User responses created during a specified time frame.

xMatters 3.2.1 patch 011 and xMatters 4.0 patch 005

FindSubscriptions

Returns a list of Subscriptions according to the specified search parameters.

xMatters 3.1

FindTemporaryReplacements

Returns a list of Temporary Replacements for a User.

xMatters 3.1 Web Services Update 1

FindUpdatedEvents

Searches for events that were updated during a specified time frame.

xMatters 3.2.1 patch 011 and xMatters 4.0 patch 005

FindUserServiceProvider

Returns a list of User Service Providers based on specified search criteria.

xMatters 3.1 Web Services Update 2

FindWhoIsOnDuty

Generates a list of who is on duty for the specified Group and Timeframe (note that all schedule times are based on the Group’s Time Zone).

xMatters 3.1 Web Services Update 4   

Updated for xmatters-4.1.6 WSDL.

InitiateDeviceValidation

Initiates a Device validation notification.

xMatters 3.1 Web Services Update 2

ListGroupMembers

Returns a list of Members in a specified xMatters Group.

xMatters 3.1

ListScriptItems

Used by the Developer IDE to access and manage the scripts. INTERNAL USE ONLY

Can only be used with the AlarmPointWebService WSDL.

xMatters Internal Only

OrderDevices

Orders a User’s Devices.

xMatters 3.1 Web Services Update 2

QueryEvent

Returns the status of a specified xMatters event. The statuses of all notifications associated with the event are also returned.

xMatters 3.1

QueryEventAuditTrail

Returns the audit details for a specified event.

xMatters 3.2.1

QueryGroup

Returns the details for a specified Group.

xMatters 3.2.1

QueryIncident

Returns a list of all events associated with the specified xMatters incident, and the status of each event.

xMatters 3.1

QuerySubscription

Finds subscriptions based on the specified search criteria.

xMatters 3.1 Web Services Update 4

QueryUser

Returns the details for a specified User.

xMatters 3.2.1

Updated for xmatters-4.1.7 WSDL.

ResumeEvent

Updates the status of an event to ACTIVE is if is currently SUSPENDED.

xMatters 4.0

SuspendEvent

Updates the status of an event to SUSPENDED if it is currently ACTIVE.

xMatters 4.0

UpdateCoverage

Updates the details for a specified Group Coverage.

xMatters 3.2.1

UpdateDevice

Updates a User’s Device based on the passed parameters.

xMatters 3.1 Web Services Update 2

Updated for xmatters-4.1.6 WSDL.

UpdateDeviceTimeframe

Updates a Timeframe for a specified Device.

xMatters 3.1 Web Services Update 2

UpdateGroup

Updates the details for a specified Group.

xMatters 3.2.1

UpdatePhoneCredentials

Updates the specified User’s phone credentials.

xMatters 3.1 Web Services Update 3

UpdateSubscription

Updates the specified subscription.

xMatters 3.1 Web Services Update 4

UpdateTeam

Updates the details for a specified Team.

xMatters 3.2.1

UpdateTemporaryReplacement

Updates a previously scheduled Temporary Replacement.

xMatters 3.1 Web Services Update 1

UpdateUser

Updates the details for a specified User.

xMatters 3.2.1

ValidateDevice

Validates a specified Device.

xMatters 3.1 Web Services Update 2

Standard SOAP Parameters

SOAP Response Status Messages

Data Structure Reference