Aventus Platform Documentation

Welcome to the Aventus Platform documentation site.

In order to use any of the services or functionality documented please contact us by emailing [email protected]

API Responses

Response Envelope

{
    "data":{},
    "time":50,
    "error":-1,
    "error_description":null,
    "successful":true,
    "validationErrors": []
}

All API responses, including errors, shall be wrapped with the following response envelope unless otherwise stated.

Key

DataType

Description

data

object

The response data

time

init

the time, in milliseconds, for the server to process the request

error

int

The error code, if the request was unsuccessful.
For a successful response the error will always be -1

error_description

string

Human-readable description of the error.

successful

boolean

true if a successful request, otherwise false.

validationErrors

ValidationError Array

Array of validations (if any)

Errors

The API returns standard HTTP status codes.

Updated 2 years ago

API Responses


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.