Опис API

На даний момент доступні такі endpoints:

Основні типи відповідей
Помилка. Ви отримаєте наступний формат відповіді:

{
    "error": {
        "code": 404,
        "message": "Not found"
    }
}

{
    "error": {
        "code": 422,
        "description": {
            "limitation": [
                "Limitation for page is missing"
            ],
            "page": [
                "Page is missing"
            ]
        },
        "message": "Unprocessable entity"
    }
}

Опис відповіді:

Поле	Опис

Поле	Опис
error.code	HTTP код
error.message	Опис помилки
error.description	З'являється виключно при статусі 422. Включає назву поля в запиті і помилки які потрібно виправити

Оновлення. Ви отримаєте наступний формат відповіді:

{
    "state": false
}

Опис відповіді:

Поле	Опис

Поле	Опис
state	Статус операції. Може набувати значення Boolean. Поверне false у разі неуспішного виконання або true в іншому випадку

Читання. Ви отримаєте наступний формат відповіді:

Опис відповіді:

Поле	Опис

Поле	Опис
cursor	Об'єкт типу Cursor
collection	Масив запитуваних об'єктів

Створення/Отримання. Після виконання цих операцій ви отримаєте запитаний/створений об'єкт noWrap.