Last modified by Андрей Калиновский on 2025/02/20 09:52
<
From version < 76.1 >
edited by Илья Крайнов
on 2023/03/14 11:30
To version < 79.1 >
edited by Илья Крайнов
on 2023/03/29 12:22
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -93,9 +93,9 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -
96 +А
97 97  {
98 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 99   "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 100   "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 101   "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
... ... @@ -150,22 +150,9 @@
150 150   "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 151   "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 152   "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
154 - "isForeign": true/false, ~/~/ Иностранный контрагент
155 - "district": "string", ~/~/ округ
156 - "region": "string", ~/~/ регион
157 - "city": "string", ~/~/ город
158 - "inn": "string", ~/~/ ИНН клиента
159 - "kpp": "string", ~/~/ КПП клиента
160 - "address": "string", ~/~/ юридический адрес
161 - "addressFact": "string", ~/~/ фактический адрес
162 - "email": "string", ~/~/ почта
163 - "director": "string", ~/~/ ФИО руководителя
164 - "bankName": "string", ~/~/ Банк
165 - "bankBIK": "string", ~/~/ БИК
166 - "bankRS": "string", ~/~/ Номер счета
167 - "bankKS": "string" ~/~/ Корр. счет
168 - }
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
155 +}
169 169  
170 170  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
171 171  
... ... @@ -188,6 +188,7 @@
188 188   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
189 189   "name": "string", ~/~/ имя
190 190   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
191 191   "isForeign": true, ~/~/ иностранный контрагент
192 192   "district": "string", ~/~/ округ
193 193   "region": "string", ~/~/ регион
... ... @@ -212,6 +212,7 @@
212 212   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
213 213   "name": "string", ~/~/ имя
214 214   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
215 215   "isForeign": true, ~/~/ иностранный контрагент
216 216   "district": "string", ~/~/ округ
217 217   "region": "string", ~/~/ регион
... ... @@ -251,6 +251,7 @@
251 251   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
252 252   "name": "string", ~/~/ имя
253 253   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
254 254   "isForeign": true, ~/~/ иностранный контрагент
255 255   "district": "string", ~/~/ округ
256 256   "region": "string", ~/~/ регион
... ... @@ -329,7 +329,8 @@
329 329  
330 330  (% style="color:#000000" %)Параметры в теле запроса (JSON):
331 331  
332 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
333 333   "lastName": "", ~/~/ фамилия
334 334   "firstName": "", ~/~/ имя
335 335   "position": "", ~/~/ должность
... ... @@ -338,17 +338,41 @@
338 338   "login": "", ~/~/ логин (обязателен)
339 339   "password": "", ~/~/ пароль (обязателен)
340 340   "email": "", ~/~/ email (обязателен)
341 - "description": "", ~/~/ описание
342 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
343 343   "parentId": "", ~/~/ Guid родительского агента
344 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
345 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
346 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
347 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
348 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
349 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
339 + "doubleAuth":
340 + {
341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
343 + },
344 + "groups":
345 + [
346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
347 + ],
348 + "customGroups":
349 + [
350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 + ],
352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
350 350  }
351 351  
355 +{
356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 + "lastName": "string",
358 + "firstName": "string",
359 + "position": "string",
360 + "phone": "string",
361 + "organization": "string",
362 + "login": "string",
363 + "password": "string",
364 + "email": "string",
365 +
366 +
352 352  (% style="text-align:left" %)
353 353  (% style="color:#000000; font-weight:normal" %)Ответ:
354 354  
... ... @@ -459,8 +459,11 @@
459 459   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
460 460   "description": "", ~/~/ Описание
461 461   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
462 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
463 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
464 464   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
465 465   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
466 466   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -503,7 +503,9 @@
503 503   "phone": "" , ~/~/ телефон
504 504   "organization": "" , ~/~/ организация
505 505   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
506 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
507 507   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
508 508  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
509 509   "isEnabled": "" , ~/~/ признак включения
... ... @@ -510,9 +510,12 @@
510 510   "parentId": "" , ~/~/ Guid родительского агента
511 511   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
512 512   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
513 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
514 - "kind": "" , ~/~/ тип аутентификации
515 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
516 516   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
517 517  
518 518  (% lang="en-US" style="text-align:left" %)
... ... @@ -538,8 +538,12 @@
538 538   "isEnabled": "" , ~/~/ признак включения
539 539   "parentId": "" , ~/~/ Guid родительского агента
540 540   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
541 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
542 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
543 543   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
544 544   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
545 545  
... ... @@ -701,6 +701,8 @@
701 701   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
702 702   "mileage": "", ~/~/ Пробег по нормам в метрах
703 703   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
704 704   },
705 705   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
706 706   {
... ... @@ -1179,7 +1179,7 @@
1179 1179  (% style="text-align:left" %)
1180 1180  (% style="color:#000000" %)}
1181 1181  
1182 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1183 1183  
1184 1184  == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1185 1185  
... ... @@ -1202,7 +1202,7 @@
1202 1202  
1203 1203  (% style="text-align: left;" %)
1204 1204  {
1205 - "objectIds": [
1234 + "vehicleIds": [
1206 1206   id ~/~/ здесь передается список идентификаторов объектов
1207 1207   ],
1208 1208   "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
... ... @@ -1215,12 +1215,63 @@
1215 1215  (% style="text-align: left;" %)
1216 1216  [
1217 1217   {
1218 - "id": 0, ~/~/ идентификатор объекта
1247 + "vehicleId": 0, ~/~/ идентификатор объекта
1219 1219   "count": 0 ~/~/ количество сообщений за период
1220 1220   }
1221 1221  ]
1222 1222  
1223 1223  
1253 +(% style="text-align: left;" %)
1254 +(% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**
1255 +
1256 +(% class="box infomessage" %)
1257 +(((
1258 +**POST /api/v3/terminalMessages**
1259 +)))
1260 +
1261 +Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1262 +
1263 +(% style="text-align: left;" %)
1264 +Метод запроса **POST**
1265 +
1266 +(% style="text-align: left;" %)
1267 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1268 +
1269 +(% style="text-align: left;" %)
1270 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1271 +
1272 +{
1273 + "vehicleId": 0, ~/~/ id объекта
1274 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1275 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1276 +}
1277 +
1278 +Ответ:
1279 +
1280 +[
1281 + {
1282 + "messages": [
1283 + {
1284 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1285 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1286 + "speed": 0, ~/~/ Скорость, км/ч
1287 + "altitude": 0, ~/~/ Высота, м
1288 + "latitude": 0, ~/~/ Широта [-90°;90°]
1289 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1290 + "satellites": 0, ~/~/ Кол-во спутников
1291 + "voltage": 0, ~/~/ Напряжение
1292 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1293 + "additionalProp1": "string",
1294 + "additionalProp2": "string",
1295 + "additionalProp3": "string"
1296 + },
1297 + "photoCount": 0 ~/~/ Кол-во фото
1298 + }
1299 + ]
1300 + }
1301 +]
1302 +
1303 +
1224 1224  (% class="box" lang="en-US" style="text-align: center;" %)
1225 1225  (((
1226 1226  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

ГЛОНАССSoft wiki - 2024 г.