Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

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

Code Block
{
    "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. Включає назву поля в запиті і помилки які потрібно виправити

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

Code Block
{
    "state": false
}

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

Поле

Опис

state

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

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

Code Block
{
    "cursor": Cursor,
    "collection": Object[]
}

 

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

Поле

Опис

cursor

Об'єкт типу Cursor

collection

Масив запитуваних об'єктів

 

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

 

Code Block
{...}