Описание 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.