Some xMatters integrations need to monitor the web services to ensure that they are available. This is usually accomplished by requesting the WSDL, but this can cause an unnecessary load on the server. To avoid this load, you can monitor for web service availability using the ping service for web services.
The pinging capability is implemented as a module, which can be engaged by services to enable pinging. The response will contain a list identifying each web service operation, and a status code of one of the following:
The ping service is enabled by default on xMatters 4.0; the following instruction apply to xMatters 3.2.1 (and 4.0 deployments where the ping service has been disabled).
<xMHOME>/webserver/webapps/axis2/WEB-INF/services/services.xml
file.<module ref="ping" />
The ping operation can be accessed by appending pingService to the main URL. Ffor example:
http://my.company.com:8888/api/services/AlarmPointWebService/pingService
This will return XML that resembles the following:
<pingResponse>
<operationStatus axis2ns65:name="UpdateTeam">
<status>1</status>
</operationStatus>