Errors encountered during a web service call are passed back as a SOAP Fault. The faultcode will The faultcode will be "env:Server" and the faultstring will 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 a faultDetails object nested inside it which contains details of the validation error. For example, a call to setFields for the medicaredvs source to setFields for the medicaredvs source with an invalid Medicare number would give the following response:
| Code Block | ||
|---|---|---|
| ||
<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> |
The faultstring element The faultstring element indicates a validation error, and names the field. The faultDetails object The faultDetails object indicates the exact error, i.e. a FieldValidationFaulta FieldValidationFault, and gives a readable message in the details element. If more than one field fails validation, then the faulstring and details elements the faulstring and details elements will contain multiple errors in a list. For example:
| Code Block | ||
|---|---|---|
| ||
<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 expiry date, medicare card number</faultstring>
<detail>
<ns2:faultDetails xmlns:ns2="http://dynamicform.services.registrations.edentiti.com/">
<code>FieldValidationFault</code>
<details>Medicare card expiry date is not formatted correctly.
Medicare card number is not a valid Medicare number.</details>
</ns2:faultDetails>
</detail>
</env:Fault>
</env:Body>
</env:Envelope> |
In this example, both the Medicare card number and expiry date failed validation.
A list of fault codes is given in the table below.
| Fault code | Description |
|---|---|
FieldValidationFault | One or more input fields failed validation. |
InvalidAccountIdFault, InvalidCustomerIdFaultThe accountId was InvalidCustomerIdFault | The accountId was not recognised. |
InvalidCertificateFault | The client certificate presented for mutual authentication did not pass the certificate checking process. |
InvalidIPFault | The IP address of the client is not permitted to call the web service. |
InvalidPasswordFault | The password supplied did not match the accountIdThe accountId and password could not be matched. |
InvalidRuleIdFault | The ruleId element The ruleId element was not recognised. |
InvalidSourceIdFault | The sourceId element The sourceId element was not recognised. |
InvalidTokenFault | The verificationToken The verificationToken (also referred to as a userTokena userToken) supplied was not recognised. |
SystemFault | There was an unexpected error during the web service call. This is an internal error for greenID. |
TokenTimeoutFault | The verificationToken The verificationToken (userToken) supplied has expired. |
VerificationIdNotFoundFault | One of the API methods other than registerVerification was than registerVerification was called with a verificationId that was not recognised. |
VerificationFault | There was an unexpected error during the verification process. |