Request and Response

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json, except for the media service, where the content type for requests may be multipart/form-data.

Response format

{
  "success": boolean,  // True if the details provided could be processed and no errors were encountered while processing
  "message": string, // Explains why success is true or false, do not use for your checks
  "data": object    // contains actionable result of processing if present
}

For paginated response, there is response format is slightly different

{
  "success": boolean, // True if the details provided could be processed and no errors were encountered while processing
  "message": string, // Explains why success is true or false, do not use for your checks
  "data": {
    "items": array, // contains actionable result of processing if present
    "meta": {
      "total": number, // total number of items
      "page": number, // number of items per page
      "limit": number, // number of items per page
    }
  }
}

While we generally recommend that developers use HTTP status codes to determine the result of an API call, we have provided a handy success key to let you know upfront if the request was successful or not.

Response Codes

Below are the common HTTP response types returned by Primus API:

500, 502, 503 Request could not be fulfilled due to an error on Primus's end. This shouldn't happen so please report as soon as you encounter any instance of this.