Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Errors encountered during a web service call are passed back as a SOAP Fault.  The faultcode will be "env:Server" and the faultstring will give a brief description of the error.  A detail element will include more details.

The most common type of error is likely to be validation errors.  If one of the parameters passed does not meet the validation requirements, then a SOAP Fault will be returned, with a faultDetails object nested inside it which contains details of the validation error.  For example, a call to setFieldsV2 for to setFields for the medicaredvs source with an invalid Medicare number would give the following response:

Code Block
languagexml
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      <env:Fault>
         <faultcode>env:Server</faultcode>
         <faultstring>Invalid input field(s) - medicare card number</faultstring>
         <detail>
            <ns2:faultDetails xmlns:ns2="http://dynamicform.services.registrations.edentiti.com/">
               <code>FieldValidationFault</code>
               <details>Medicare card number is not a valid Medicare number.</details>
            </ns2:faultDetails>
         </detail>
      </env:Fault>
   </env:Body>
</env:Envelope>

 

...