Error responses which include a body will use this model to provide helpful information about the cause of the error. Not all errors will include a body. Refer to the section on Error Handling to see which errors will and will not include a body in the response.
|Error Codes||Short descriptive error code, suitable for use in conditional logic in your error handling procedures.|
|string||User-friendly description of the error which may be useful for troubleshooting.|
|array of Failed Validations||List of the validations that failed. This is only included in the response when appropriate.|
|Error Code||HTTP Status||Description|
|Something was wrong with the request. More details will be provided in the |
|An invalid username or password was used to create the authorization token. For more information, please refer to the section on Authentication.|
|Valid credentials were provided, but do not have the necessary permission to access the requested resource.|
The requested resource has not been defined. Example: request for
|The resource with the requested ID does not exist. Example: request for |
|The method (verb) is not allowed for the requested resource. Do not resend the request.|
|The method (verb) is not allowed for this resources unless you provide a valid identifier as a part of the URI. Do not resend the request without adding an identifier.|
|The request body cannot be successfully decoded based on the specified |
|The specified |
|The specified |
|The request body was successfully decoded, but could not be understood based on the |
|The data provided in the request body has failed validations. Additional details can be found in |
The validation model is used to return specific details about POST, PUT, and PATCH requests which fail due to violations of data validation. It will let you know specifically which fields failed validation and why.
The type of validation which failed. Valid types are listed below under Validations.
|dataElement||string||The name of the field from the data model which failed validation.|
|string||The value provided for the data element which failed validations. This will always be returned as a string regardless of the element's actual data type.|
This is a list of the validations that may be returned.
|The value being inserted or updated for the data element must be unique.|
|An otherwise unspecified validation has failed for the data element. Refer to the appropriate resource documentation for a description of valid values.|
|A value provided for a date element is using a proper format but represents an invalid date.|
|A value provided for a date or dateTime element does not match a valid format.|
|A value provided for a dateTime element is using a proper format but represents an invalid dateTime.|
|The value provided does not fall within an acceptable range. Refer to the appropriate resource documentation for a description of valid values.|
|A required value is missing from the request or was provided with an empty or null value.|
|Updates are not allowed to the data element.|
Document Revision History
Jan 16, 2019 17:56
Jan 14, 2019 19:36
Nov 30, 2018 16:20
Added section for Document Revision History
Nov 30, 2018 16:17
Added error code "identifier-required" and removed validation "insert-not-allowed".
Nov 21, 2018 15:47
Modified the failedValidations element and added to the list of validations.
Oct 03, 2018 21:53