Web Service Response Codes:
Error Response Formatting:
| Code Block | ||
|---|---|---|
| ||
<ph:People targetNamespace="urn:edu.yale/people" xmlns:ph="urn:edu.yale/people"> <ph:Error>ERROR CODE GOES HERE</ph:Error> <ph:ErrorMessage>ERROR RESPONSE MESSAGE</ph:ErrorMessage> </ph:People> |
400 Series codes: (Responses from 400 codes still WIP)
- Layer7 setup to give 400 response
- Still working on standardizing layer7 based response codes
...
| Request Point of Failure | Code | Message | Example of Issue |
|---|---|---|---|
| XML Schema: Comparator | 4001 | Entered Invalid XML Request: (Pass detail of validation error) | Entered "NOT EQUALS" as the comparison. Valid values are listed in the XSD and Error Response Message. |
| XML Schema: PopulationFilter | 4001 | Entered Invalid XML Request: (Pass detail of validation error) | Entered "Affiliation" as a Population filter field. Valid values are listed in the XSD and Error Response Message. |
| XML Schema: AttributeFilter | 4001 | Entered Invalid XML Request: (Pass detail of validation error) | Entered "NY" instead of "Y" or "N". Valid values are listed in the XSD and Error Response Message. |
| XML Schema: Operator | 4001 | Entered Invalid XML Request: (Pass detail of validation error) | Entered "JOIN" instead of "AND" or "OR". |
| XML Schema: Primary_EDU_Person_Affiliation | 4001 | Entered Invalid XML Request: (Pass detail of validation error) | Entered "ALUMNI" instead of "ALUM". Valid values are listed in the XSD and Error Response Message. |
| XML Schema: Worker_Status | 4001 | Entered Invalid XML Request: (Pass detail of validation error) | Entered "Leave" instead of "On Leave". Valid values are listed in the XSD and Error Response Message. |
| XML Schema: Student_Status | 4001 | Entered Invalid XML Request: (Pass detail of validation error) | Entered "F" instead of "A". Valid values are listed in the XSD and Error Response Message. |
| Content Type (header) | 4002 | Invalid Content Type Header: (Pass content type sent and detail) | Did not pass content-type header/ |
| JSON Schema | 4003 | Entered invalid JSON request - (Pass detail of validation error) | WIP |
| OutputFormat | 4004 | Entered invalid output format: (Pass format sent), Valid Values: xml, json | sent "csv" as a format |
500 Series Codes: (Some still WIP)
- All codes from Talend will give a status code of "500" and a detail code in the response message.
...