Knowledge Base Tip
Review the Badge API Specifications article prior to utilizing HelioCampus Badge API Endpoints. For more information on Badge and Assertion endpoints, the following articles can be reviewed.
All Badge and Assertion endpoints behave similarly in terms of response and use the standard HTTP status codes. Below are the possible status codes and responses that can be received from endpoints.
|
HTTP REQUEST |
RESULT |
STATUS CODE |
RESPONSE BODY |
|
GET |
Success |
200 (OK) |
The JSON resource |
|
GET |
Not found |
404 (Not Found) |
{ message: "Resource not found." } |
|
POST |
Success |
201 (Created) |
The JSON resource with its URL in the Location header |
|
PUT |
Success |
200 (OK) |
The JSON resource |
|
PATCH |
Success |
200 (OK) |
The JSON resource |
|
POST/PUT/PATCH |
Missing required parameter |
400 (Bad Request) |
{ message: "Missing required parameter: email" } |
|
POST/PUT/PATCH |
Validation failed |
422 (Unprocessable Entity) |
{ message: "Email address is invalid" } |
|
Any |
Unexpected error |
500 (Internal Server Error) |
{ message: "Something went wrong, no details at this time." } |