| Insert excerpt |
|---|
| Version 2 greenID API |
|---|
| Version 2 greenID API |
|---|
| nopanel | true |
|---|
|
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 give a brief description of the error. A detail element A detail element will include more details.
The most common type of error is likely to be validation errors. If 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 For example, a call 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 indicates a validation error, and names the field. The faultDetails object The faultDetails object indicates the exact error, i.e. a FieldValidationFault, and gives a readable message in the details element. If If more than one field fails validation, then the faulstring and details elements the faultstring and details elements will contain multiple errors in a list. For 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> |
...