The following sections list the SOAP parameters common to all SOAP requests and responses in xMatters web services. The listing for each web service operation identifies and defines the parameters specific to that operation.
Note that all of the provided sample SOAP requests and responses include these standard parameters.
The following parameters are required for all SOAP requests:
Name |
Description |
Type |
Optional |
user |
Web service User identifier |
string |
no |
password |
Web service User's password |
string |
no |
clientTimestamp |
Timestamp from the web service client in the following format dd/mm/yyyy h:mm:ss AM/PM
Note that if this parameter is not specified in GMT, the time reflected in the Audit Reports will be offset from this injected time by the time zone of the person viewing the report. |
string |
yes |
clientIP |
IP address of the web service client. |
string |
yes |
clientOSUser |
Operating system account under which the web service client runs |
string |
yes |
company |
Company within xMatters of the User that made the request |
string |
yes |
The following parameters are included in all SOAP responses:
Name |
Description |
Type |
serverTimestamp |
Time corresponding to the server time when the request was made (this should match the associated persisted audit event) |
string |
status |
Final status of the request. |
string |