Инструменты пользователя
xhr_api
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
xhr_api [2021/03/13 02:11] a1 [user] |
xhr_api [2021/03/23 15:58] (текущий) a1 [usersFilter] |
||
|---|---|---|---|
| Строка 233: | Строка 233: | ||
| |region|incorrect|Регион указан некорректно| | |region|incorrect|Регион указан некорректно| | ||
| |locality|incorrect|Населенный пункт указан некорректно| | |locality|incorrect|Населенный пункт указан некорректно| | ||
| - | |||
| - | === Результат === | ||
| - | |user|Основные данные пользователя|[[xhr_api#user|объект User]]| | ||
| - | |||
| - | ===== userinfo ===== | ||
| - | |||
| - | //имя сайта///?option=com_wmartalpha&task=api.**userinfo** | ||
| - | |||
| - | Получение информации о текущем пользователе | ||
| === Результат === | === Результат === | ||
| Строка 270: | Строка 261: | ||
| |reference|incorrect|Справочник не существует| | |reference|incorrect|Справочник не существует| | ||
| - | ====== Списки объектов ====== | + | ====== Пользователи ====== |
| ===== usersFilter ===== | ===== usersFilter ===== | ||
| Строка 279: | Строка 270: | ||
| === Запрос === | === Запрос === | ||
| - | |propQuery|Запрос свойств|Массив объектов [[xhr_api#propQuery|propQuery]]| | + | |filterQuery|Запрос свойств|Массив объектов [[xhr_api#filterQuery|filterQuery]]| |
| + | |?listQuery|Запрос элементов|объект [[xhr_api#listQuery|listQuery]]| | ||
| === Результат === | === Результат === | ||
| |props|Cвойствa и значения|Массив объектов [[xhr_api#props|props]]| | |props|Cвойствa и значения|Массив объектов [[xhr_api#props|props]]| | ||
| + | |||
| + | === Ошибки === | ||
| + | |property|incorrect|Свойство не существует| | ||
| + | |||
| + | ===== userinfo ===== | ||
| + | |||
| + | //имя сайта///?option=com_wmartalpha&task=api.**userinfo** | ||
| + | |||
| + | Получение информации о пользователе. Если id не указан, возвращается информация о текущем пользователе | ||
| + | |||
| + | === Запрос === | ||
| + | |?id|id пользователя|int| | ||
| + | |||
| + | === Результат === | ||
| + | |user|Основные данные пользователя|[[xhr_api#user|объект User]]| | ||
| + | |||
| + | === Ошибки === | ||
| + | |user|incorrect|Пользователь не существует| | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ===== usersList ===== | ||
| + | |||
| + | //имя сайта///?option=com_wmartalpha&task=api.**usersList** | ||
| + | |||
| + | Получить свойства и значения для фильтрации | ||
| + | |||
| + | === Запрос === | ||
| + | |listQuery|Запрос элементов|объект [[xhr_api#listQuery|listQuery]]| | ||
| + | |||
| + | === Результат === | ||
| + | |users|Выбранные пользователи|Массив объектов [[xhr_api#user]]| | ||
| === Ошибки === | === Ошибки === | ||
| Строка 340: | Строка 364: | ||
| </code> | </code> | ||
| - | ===== propQuery ===== | + | ===== filterQuery ===== |
| Запрос свойств. Планируется, что структура объекта будет общая для всех фильтрующихся элементов. | Запрос свойств. Планируется, что структура объекта будет общая для всех фильтрующихся элементов. | ||
| - | Выборка может осуществляется как по id свойства, так и по алиасу. | + | Для свойства необходимо указать id либо алиас. |
| |?id|id свойства|int| | |?id|id свойства|int| | ||
| Строка 357: | Строка 381: | ||
| } | } | ||
| </code> | </code> | ||
| + | |||
| + | ===== listQuery ===== | ||
| + | Запрос выборки по элементам. Для свойства необходимо указать id или алиас. | ||
| + | |||
| + | |?props|Массив выбранных свойств|string| | ||
| + | |props ?id|id свойства|string| | ||
| + | |props ?alias|Алиас свойства|string| | ||
| + | |props ?min|min значение для свойств типа число и дата|float/datetime| | ||
| + | |props ?max|max значение для свойств типа число и дата|float/datetime| | ||
| + | |props ?valueId|массив id значений|[]| | ||
| + | |props ?valueAlias|массив алиасов значений|[]| | ||
| + | |props ?search|Строка для поиска по свойству|string| | ||
| + | |?search|Строка для поиска по основным свойствам|string| | ||
| + | |?start|Отступ выбираемых элементов|bool| | ||
| + | |?limit|Количество выбираемых элементов|bool| | ||
| + | |?sort|Порядок сортировки|string| | ||
| + | |?direction|Направление сортировки asc или desc|string| | ||
| + | |||
| + | <code javascript> | ||
| + | { | ||
| + | ?props: { | ||
| + | { | ||
| + | ?id: int, | ||
| + | ?alias: string, | ||
| + | ?min: float/datetime, | ||
| + | ?max: float/datetime, | ||
| + | ?search: string, | ||
| + | ?valueId: [int, ...], | ||
| + | ?valueAlias: [string, ...], | ||
| + | }, | ||
| + | ... | ||
| + | } | ||
| + | ?search: string, | ||
| + | ?limit: int, | ||
| + | ?start: int, | ||
| + | ?sort: string, | ||
| + | ?direction: string, | ||
| + | } | ||
| + | </code> | ||
| + | |||
xhr_api.1615590671.txt.gz · Последние изменения: 2021/03/13 02:11 — a1
Инструменты страницы
Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
