- Previous: Standards Documents
- Up: Standards Documents
- Next: Exception Standards
Error Response Codes
HTTP Error Responses
The table below indicates the HTTP error response and HTTP Error message. These are from the REST Services Standard v1.2.
Status Code | Reason Phrase | Usage/Scenarios |
---|---|---|
200 |
OK |
Used to indicate nonspecific success; it must not be used to communicate errors in the response body. |
201 |
Created |
Used to indicate successful resource creation. |
204 |
No Content |
Used when the response body is intentionally empty. For example, the response of PUT and DELETE. |
400 |
Bad Request |
Used to indicate nonspecific failure; used when no other 4xx error code is appropriate. For errors in the 4xx category, the response body will contain a document describing the client’s error (unless the request method is HEAD). The error document will also contain an error ID which is useful for finding the logged exception/error messages on server side. |
401 |
Unauthorized |
Used when there’s a problem with the client’s credentials. It indicates that client has provided the wrong credentials or none at all. |
404 |
Not Found |
Used when a client’s URI cannot be mapped to a resource. |
500 |
Internal Server Error |
Used to indicate REST API malfunction. |
Error Responses
Attribute |
Definition and Handling |
|
|
|
Error Id |
unique identifier for error instance (GUID) |
|
|
Error Timestamp |
UTC timestamp when error occurred |
|
|
Error Class |
“BusinessException” or “SystemException” |
|
|
Error Category |
one of agreed-upon list of error categories from Table 5 |
|
|
Error Code |
A code that consistently matches the error type. Suggested prefix + 4-digit code. (prefix=”SF”, “NS”, “ESB”,…) |
|
|
Error Message |
descriptive error message |
|
|
Error Retryable |
true or false – if known. This is to support automatic resubmission. |
|
|
Error Module |
module or subsystem in which error occurred |
|
|
Error Sub Module |
detailed sub module name, if applicable, in which error occurred |
|
|
Error Method |
method name in which error occurred |
|
|
Error Logged in User |
current username |
|
|
Related Record Id |
context related id from application |
- Previous: Standards Documents
- Up: Standards Documents
- Next: Exception Standards
Docs Navigation
- Compassion API Library
- Standards Documents
- Legacy APIs (Deprecating)
- Web Services Handshake (Legacy) - Notification and Command Messages
- Public API
- Private IPG APIs
- Private REST Services
- REST Get CDSP Implementor V1
- REST Get Child Case Study V1
- REST Get Child Exit Details V1
- REST Get Child Image V1
- REST Get Child Information V1
- REST Get Community V1
- REST Get Country V1
- REST Get CSP Implementor V1
- REST Get Local Church Partner V1
- REST Get Program Implementor V1
- REST Get Project Age Groups V1
- REST Get Child Image V1 - 2015/03
- Private Messaging APIs
- Quick Start Guide
- OffRamp Prerequisites and Setup
- IP OnRamp Service Configuration
- Available Message Types
- Message and Service Relationships
- Troubleshooting
- General Error Messages from Compass Party Host
- EsdMessageErrorMOE Sample
- Sample REST End-To-End Test Plan
- SOAP Wrapper Sample for Messages to GMC
- Allocate Child Message
- Cancel Commitment Message
- Commitment Canceled Message
- Commitment Created Message
- Constituent Created Message
- Constituent Updated Message
- Constituent Upserted Message
- Create Commitment Message
- Create Constituent Message
- Create Email Message
- Create Gift Message
- Deallocate Child Message
- Depart Child Message
- Email Created Message
- Email Updated Message
- Gift Created Message
- Update Child Message
- Update Constituent Message
- Update Email Message
- Upsert Constituent Message
- Update Project Message
- Private SOAP Services
- SOAP Get Child Exit Detail 201211
- SOAP Get Child Exit Detail 201310
- SOAP Get CDSP Implementor 201309
- SOAP Get Child Image 201211
- SOAP Get Child Case Study 201310
- SOAP Get Child Case Study 201412
- SOAP Get Child Information 201211
- SOAP Get Child Information 201310
- SOAP Get Community 201309
- SOAP Get Country Information 201104
- SOAP Get Local Church Partner 201309
- SOAP Get Program Implementor 201303
- SOAP Get Program Implementor 201309
- SOAP Get Project Age Group 201309
- Service Overview
- SOAP Get CSP Implementor 201309
- SOAP Get Child Image 201503
- Private USA APIs
- Private USA Web APIs
- private cornerstone connect messaging
- private cornerstone test
- public api
0 Comments
New comments are not being accepted at this time.