Важные замечания:

• Некоторые интерфейсы доступны только после входа в систему.
• Если в ответе от интерфейса есть код ошибки 10001, это означает, что пользователь не вошёл в систему, необходимо сначала вызвать интерфейс входа.

Примечание:

• Интерфейс: название интерфейса.
• Ссылка: адрес интерфейса.
• Завершение написания интерфейса: статус завершения разработки интерфейса.
• Реализация на стороне сервера: наличие реализации интерфейса на сервере.
• Реализация на стороне клиента: наличие реализации интерфейса на клиенте.
• Прохождение тестирования: результат тестирования интерфейса. |данные|набор данных результата|необязательный| |---|---|---| |тип|это набор данных, который может быть представлен в виде числового значения JSON или объекта JSON. Это необязательное поле, которое может возвращать значение null или не возвращать это поле.|

Пример:

{
  "код": 0,
  "сообщение": "запрос выполнен успешно",
  "данные":"dfgdfgdfhdhdffghfgh"
}

или

{
  "код": 10001,
  "сообщение": «срок действия логина истёк, пожалуйста, войдите снова»
}

Если страница не найдена, возвращается следующее:

{
  "код": -404,
  "сообщение": "запрошенный интерфейс не существует"
}

Структура данных ответа для интерфейса с разбивкой на страницы:

{
  "код": 0,
  "сообщение": "запрос выполнен успешно",
  "данные": {
    "номер_страницы": 1,
    "размер_страницы": 2,
    "общее_количество_страниц": 3,
    "общий_счётчик": 99,
    "есть_следующая_страница": true,
    "список": [
      {
        "идентификатор": 123,
        "имя": "lany"
      },
      {
        "идентификатор": 123,
        "имя": "lany"
      },
      {
        "идентификатор": 123,
        "имя": "lany"
      }
    ]
  }
}

Описание структуры данных ответа для интерфейса с разбивкой на страницы:

Другие примечания:

• Возвращаемые данные должны быть стандартными данными JSON и не могут содержать строки JSON, которые необходимо проанализировать дважды.
• Не допускается использование escape-символов.
• Все пользовательские интерфейсы запросов содержат параметры user_uid и user_token.
• Если запрос является запросом с разбиением на страницы, все интерфейсы будут содержать параметр page_no.