Accessing web services

You can access the xMatters web services at the following URL:

http://<xMatters URL>:8888/api/services/<WSDL Name>
 

Where "<xMatters URL>" is the IP address or hostname of the xMatters web server, and "<WSDL Name>" is the version of the xMatters WSDL specific to your deployment (as identified in the following section).

The schema name is also dependant on your version and patch level, and uses the following template:

xmlns:sch="http://www.xmatters.com/webservices/<schema>"
 

Where <schema> is the name of the web services schema identified in the following section.

Deployment-specific WSDL and Schema Names

The following table identifies the URL and schema name at which you can access the xMatters web services for your deployment's version and patch level. Note that each patch's WSDL includes all of the updates in the previous versions.

For a description of the changes between versions, see Web Services Version Comparison.

Deployment Patch Level

WSDL Name

Schema Name

All 4.0 deployments

All 4.1 deployments up to and including 4.1 patch 005, AND any deployments that have been upgraded to 4.1 patch 006 (or higher) but have text phone Devices that were created in the xMatters system prior to upgrading.

AlarmPointWebService

schema

4.1 patch 006 deployments that either have no text phone Devices, OR have text phone Devices that were created after upgrading.

xmatters-4.1.6

schema#4.1.6

4.1 patch 007

xmatters-4.1.7

schema#4.1.7

4.1 patch 008 and 4.1 patch 009

xmatters-4.1.8

schema#4.1.8

4.1 patch 010 xmatters-4.1.10 schema#4.1.10

5.0

xmatters-5.0

schema#5.0

For example, anyxMatters 4.1 patch 007 deployment can access the web services at:

http://localhost:8888/api/services/xmatters-4.1.7
 

To create an XML version of the Web Services Reference, navigate to the above URL in a browser, and append "?wsdl" to the WSDL name; for example:

http://localhost:8888/api/services/xmatters-4.1.7?wsdl
 

You can then save the resulting page as an XML file.

The schema for the same deployment would be recorded as xmlns:sch="http://www.xmatters.com/webservices/schema#4.1.7"

Connecting to Web Services using a SOAP interface

Use the following instructions to access and test your connection using a SOAP interface.

To set up a SOAP interface:
  1. In xMatters, create a Web Services User.
  2. Download and install your preferred third-party tool for SOAP interfacing.
  3. In your SOAP interface tool, create a new WSDL project and load it with the xMatters WSDL.
  4. To test the connection, select the FindWhoIsOnDuty operation in your SOAP tool.
  5. Replace all of the question marks with valid parameters.

All times in web service operations must be specified in GMT. For example, to set a start time of 9am Eastern for a new Coverage with the AddCoverage web service, you would enter "01:00" (1am) as the value for the startTime parameter.

  1. When you have finished populating the SOAP Request, send it using the SOAP interfacing tool.

Disabling the xMatters web service

Enabling Ping Service for Web Services

Standard SOAP Parameters

SOAP Response Status Messages

Disabling web services