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 <People> <Error>ERROR CODE GOES HERE</ph:Error> <ph:ErrorMessage>ERROR<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 |
| Authentication Failure | 4005 | Invalid Credentials, please check your username and password. Username Sent: | Mistyped username or password. |
| Layer7 Gateway Issue | 4006 | An issue has occurred at the gateway. Please check your request, any parameters, and your authentication. If problem persists, contact the Data Services team. | You may be violating policy standards. |
| Invalid Page Number | 4007 | Invalid page number. Allowed values (Any positive integer) | You may have entered -1 or the word form of a page number. Ex "One" |
| Invalid Records Per Page Number | 4008 | Invalid value for records per page. Allowed values (any positive integer) | You may have entered -1 or the word form of a page number. Ex "One" |
| Invalid Date Value | 4009 | Invalid value for "type of date" start date. Allowed values (any valid date) | You may have entered an invalid date or a date in the wrong 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.
| Code | Message | Example of Issue |
|---|---|---|
| 5000 | No Data Found- Request provided no results, check request and security settings. | This points to a null data set being returned by the service. |
| 5001 | Connection to PeopleHub failed, try again, check ITS status page for outages | This occurs when there is a failure of the tMSSQLConnection component in Talend. The authentication in AD went successful, but the database could not be reached. |
| 5002 | The server is sending a java error. Please contact the web services support team for assistance. Detailed Java Error: (Detail of Error) | Any java error passed by Talend. Improper values, extra characters that cant be parsed, timeout failures. |
| 5003 | There is an issue with your service accounts security access. Please contact web services support team for assistance. | This is returned when there is an authentication failure when calling the database. This means your security is incorrect in the PeopleHub, but that you sent the correct username/password. |