Standard Requests and Responses
Principa Cloud APIs confirm to standardised request and response models.
Requests
All requests to be made using application/json media type.
In addition, all operations (except for Authentication) requires a Header attribute to be supplied:
| Header | Value | Description |
|---|---|---|
| Authorization | Bearer [accessToken] |
Where [accessToken] is the token returned by Authentication operation. |
A 401 Unauthorized HTTP response will be returned if a malformed authorisation header is supplied (empty, invalid, or expired).
Responses
Principa Cloud APIs use standard HTTP status codes to indicate success or failure. The following table summarises common HTTP status codes:
| Status | Meaning |
|---|---|
| 2xx | 2xx range of HTTP response codes indicate a success. |
| 400 | Validation error or malformed request |
| 401 | Missing/invalid or expired Bearer token |
| 404 | No record matching the supplied keys |
| 500 | Internal server error |
Date and Time
All timestamps are ISO-8601 in UTC.
Continue: Authentication >>