Response codes
Sitecore CDP services follow standard RESTful conventions for response codes under both normal and error conditions.
The following are response codes for create operations and update operations:
| Response code | Description |
|---|---|
201 CREATED | The request was successful, a new resource was created, and the response body contains the representation. The href field contains the new resources canonical URI. |
400 BAD REQUEST | The data that was sent failed validation. Inspect the response body for details. |
401 UNAUTHORIZED | The authorization details were incorrect. |
404 NOT FOUND | The resource was not found. |
415 UNSUPPORTED MEDIA TYPE | The media type specified is not supported. |
500 SERVER ERROR | We could not create or update the resource. Please try again. Make sure to specify Content-Type: application/json in the header. |
503 SERVICE UNAVAILABLE | Server serving request temporarily down. Try again immediately as servers are clustered. |
The following are response codes for delete operations:
| Response code | Description |
|---|---|
200 OK | The request was successful. The resource was successfully deleted. |
400 BAD REQUEST | Bad request. Inspect the response body for details. |
401 UNAUTHORIZED | The authorization details were incorrect. |
404 NOT FOUND | The resource was not found. |
415 UNSUPPORTED MEDIA TYPE | The media type specified is not supported. |
500 SERVER ERROR | We could not delete the resource. Please try again. Make sure to specify Content-Type: application/json in the header. |
503 SERVICE UNAVAILABLE | Server serving request temporarily down. Try again immediately as servers are clustered. |
The following are response codes for locate operations:
| Response code | Description |
|---|---|
200 OK | The request was successful, and the response body contains the list. |
400 BAD REQUEST | The data that was sent failed validation. Inspect the response body for details. |
401 UNAUTHORIZED | The authorization details were incorrect. |
404 NOT FOUND | The resource was not found. |
415 UNSUPPORTED MEDIA TYPE | The media type specified is not supported. |
500 SERVER ERROR | We could not fetch the resource. Please try again. Make sure to specify Content-Type: application/json in the header. |
503 SERVICE UNAVAILABLE | Server serving request temporarily down. Try again immediately as servers are clustered. |
The following are the attributes contained in the response:
| Attribute | Description |
|---|---|
status | The corresponding HTTP status code. |
code | An error code that can be used to obtain more information. |
message | A simple, easy to understand message that you can show directly to your application end-user. |
developerMessage | A clear, plain-text explanation with technical details that assists a developer calling the APIs. |
moreInfo | A fully qualified URL that might be accessed to obtain more information about the error. |
If you have suggestions for improving this article, let us know!