Web Service Integration - Standard Response

Introduction

All SaferWatch web service calls will include a <ResponseDO> tag in the response. This response will tell you the success or failure of the web service call. The absence of this ResponseDO is a system error and should be reported to SaferWatch.

Example ResponseDO:

<ResponseDO>
<status>APPROVED</status>
<action>OK</action>
<code>SFW00389</code>
<displayMsg/>
<techMsg/>
</ResponseDO>

Response fields values:

status:
APPROVED: Everything worked as expected.
DENIED: The request was denied for reasons specified in the displayMsg. Often times, the user can correct this issue on their own.
ERROR: The request was denied for reasons specified in the techMsg. Upon error, the displayMsg most often tells the user to contact technical support.

action: This field further defines that status. See the specific web service request documentation to see the status/action pairs that are possible.
code: A unique response code for each web service response.
displayMsg: Response message that is intended for end user.
techMsg: Response message that is intended for technical support or programmer.