Различия

Здесь показаны различия между двумя версиями данной страницы.

--- xhr_api [2021/03/12 04:18]
a1 [user]
+++ xhr_api [2021/03/23 15:58] (текущий)
a1 [usersFilter]
@@ Строка 233: / Строка 233: @@
 |region|incorrect|Регион указан некорректно|
 |locality|incorrect|Населенный пункт указан некорректно|
-=== Результат  ===
-|user|Основные данные пользователя|[[xhr_api#user|объект User]]|
-===== userinfo =====
-//имя сайта///?option=com_wmartalpha&task=api.**userinfo**
-Получение информации о текущем пользователе
 === Результат  ===
@@ Строка 256: / Строка 247: @@
 === Запрос  ===
 |reference|Алиас справочника (доступны: subjects,country,region,locality)|string|
-|parent_id|id родительского значения из связанного справочника (например: отношение населенных пунктов к региону)|?int|
+|parentId|id родительского значения из связанного справочника (например: отношение населенных пунктов к региону)|?int|
 |start|Отступ выбираемых элементов|?int|
 |limit|Количество выбираемых элементов|?int|
@@ Строка 270: / Строка 261: @@
 |reference|incorrect|Справочник не существует|
-====== Списки объектов ======
+====== Пользователи ======
 ===== 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]]|
+=== Ошибки  ===
+|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]]|
 === Ошибки  ===
@@ Строка 289: / Строка 313: @@
 ====== Описание объектов ======
-===== propQuery =====
-Запрос свойств. Планируется, что структура объекта будет общая для всех фильтрующихся элементов.
-Выборка может осуществляется как по id свойства, так и по алиасу.
-|?id|id свойства|int|
+===== OAuthRequest =====
-|?alias|Алиас свойства|string|
+Объект, описывающий OAuth запрос
-|?count|Подсчет количества элементов по свойству|bool|
-|?format|формат значений. Доступно: list. Если не указан - значения свойства не возвращаются |string|
+|url|url запроса|string|
+|method|Метод|string|
+|params|Передаваемые переменные|{}|
 <code javascript>
-{
+  {
-  ?id: int,
+    url: string,
-  ?alias: string,
+    method: string,
-  ?count: bool,
+    params: {
-  ?format: string,
+      param1: value1,
-}
+      param2: value2,
+      ...
+    }
+  }
 </code>
 ===== props =====
@@ Строка 336: / Строка 363: @@
 }
 </code>
-===== OAuthRequest =====
-Объект, описывающий OAuth запрос
-|url|url запроса|string|
+===== filterQuery =====
-|method|Метод|string|
+Запрос свойств. Планируется, что структура объекта будет общая для всех фильтрующихся элементов.
-|params|Передаваемые переменные|{}|
+Для свойства необходимо указать id либо алиас.
+|?id|id свойства|int|
+|?alias|Алиас свойства|string|
+|?count|Подсчет количества элементов по свойству|bool|
+|?format|формат значений. Доступно: list. Если не указан - значения свойства не возвращаются |string|
+<code javascript>
+{
+  ?id: int,
+  ?alias: string,
+  ?count: bool,
+  ?format: string,
+}
+</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>
+===== user =====
+Информация о пользователе
+|id|id пользователя|int|
+|registered|пользователь зарегистрирован|bool|
+|login|Проритетный логин|string|
+|firstname|Имя|string|
+|lastname|Фамилия|string|
+|fullname|Полное имя|string|
+|sex|Пол (1-мужской, 2 - женский)|int|
+|description|Описание|string|
+|subjects|Массив объектов свойства-справочника Тематика|[{referenceId: int,value: string}, ...]|
+|orgINN|ИНН организации|string|
+|orgTitle|Название организации|string|
+|country|Объект свойства-справочника страна|{referenceId: int,value: string}|
+|region|Объект свойства-справочника регион|{referenceId: int,value: string}|
+|locality|Объект свойства-справочника населенный пункт|{referenceId: int,value: string}|
+|loginData|Массив данных авторизации пользователя|[]|
+|loginData.type|тип логина|string|
+|loginData.login|Массив данных авторизации пользователя|string|
 <code javascript>
   {
-    url: string,
+    id: int,
-    method: string,
+    registered: bool,
-    params: {
+    ?login: string,
-      param1: value1,
+    ?firstname: string,
-      param2: value2,
+    ?lastname: string,
+    ?fullname: string,
+    ?sex: int,
+    ?description: string,
+    ?subjects: [
+      {
+        referenceId: int,
+        value: string
+      },
       ...
-    }
+    ],
+    ?orgINN: string,
+    ?orgTitle: string,
+    ?country: {
+      referenceId: int,
+      value: string
+    },
+    ?region: {
+      referenceId: int,
+      value: string
+    },
+    ?locality: {
+      referenceId: int,
+      value: string
+    },
+    loginData: [
+      {
+        type: string,
+        login: string
+      },
+      ...
+    ],
   }
 </code>

Документация

Инструменты пользователя

Инструменты сайта

Различия

Инструменты страницы