Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/20 09:52
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -93,9 +93,9 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 - А96 + 97 97 { 98 - "agentId": "", ~/~/ идентификатор клиента (%%) 98 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 99 99 "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 100 "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 101 "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) ... ... @@ -150,9 +150,22 @@ 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 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 155 -} 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 + } 156 156 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 ... ... @@ -175,7 +175,6 @@ 175 175 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 179 179 "isForeign": true, ~/~/ иностранный контрагент 180 180 "district": "string", ~/~/ округ 181 181 "region": "string", ~/~/ регион ... ... @@ -200,7 +200,6 @@ 200 200 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 201 201 "name": "string", ~/~/ имя 202 202 "fullName": "string", ~/~/ полное наименование 203 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 204 204 "isForeign": true, ~/~/ иностранный контрагент 205 205 "district": "string", ~/~/ округ 206 206 "region": "string", ~/~/ регион ... ... @@ -240,7 +240,6 @@ 240 240 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 241 241 "name": "string", ~/~/ имя 242 242 "fullName": "string", ~/~/ полное наименование 243 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 244 244 "isForeign": true, ~/~/ иностранный контрагент 245 245 "district": "string", ~/~/ округ 246 246 "region": "string", ~/~/ регион ... ... @@ -319,8 +319,7 @@ 319 319 320 320 (% style="color:#000000" %)Параметры в теле запроса (JSON): 321 321 322 -(% style="color:#000000" %) 323 -{ 332 +(% style="color:#000000" %){ 324 324 "lastName": "", ~/~/ фамилия 325 325 "firstName": "", ~/~/ имя 326 326 "position": "", ~/~/ должность ... ... @@ -329,41 +329,17 @@ 329 329 "login": "", ~/~/ логин (обязателен) 330 330 "password": "", ~/~/ пароль (обязателен) 331 331 "email": "", ~/~/ email (обязателен) 332 - "description": "string", ~/~/ Описание 333 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 341 + "description": "", ~/~/ описание 342 + "isEnabled": "", ~/~/ признак включения 336 336 "parentId": "", ~/~/ Guid родительского агента 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 - Азербайджанский 344 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 345 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 346 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 347 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 348 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 349 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 353 353 } 354 354 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 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 369 ... ... @@ -394,7 +394,7 @@ 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 397 -(% class="box infomessage" %)382 +(% class="box successmessage" %) 398 398 ((( 399 399 (% lang="en-US" %)**POST /api/v3/users/find** 400 400 ))) ... ... @@ -474,11 +474,8 @@ 474 474 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 475 475 "description": "", ~/~/ Описание 476 476 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 477 - "doubleAuth": 478 - { 479 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 - }, 462 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 463 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 482 482 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 483 483 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 484 484 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован ... ... @@ -521,9 +521,7 @@ 521 521 "phone": "" , ~/~/ телефон 522 522 "organization": "" , ~/~/ организация 523 523 "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 524 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 525 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 526 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 506 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 527 527 "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 528 528 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 529 529 "isEnabled": "" , ~/~/ признак включения ... ... @@ -530,12 +530,9 @@ 530 530 "parentId": "" , ~/~/ Guid родительского агента 531 531 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 532 532 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 533 - "doubleAuth": 534 - { 535 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 - }, 538 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 513 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 514 + "kind": "" , ~/~/ тип аутентификации 515 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 539 539 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 540 541 541 (% lang="en-US" style="text-align:left" %) ... ... @@ -561,12 +561,8 @@ 561 561 "isEnabled": "" , ~/~/ признак включения 562 562 "parentId": "" , ~/~/ Guid родительского агента 563 563 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 564 - "doubleAuth": 565 - { 566 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 - }, 569 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 541 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 542 + "kind": "" , ~/~/ тип аутентификации 570 570 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 571 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 572 572 ... ... @@ -728,8 +728,6 @@ 728 728 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 729 729 "mileage": "", ~/~/ Пробег по нормам в метрах 730 730 "motohours": "" ~/~/ Моточасы по нормам, в секундах 731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 733 733 }, 734 734 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 735 735 { ... ... @@ -878,7 +878,7 @@ 878 878 879 879 == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 880 880 881 -(% class="box infomessage" %)852 +(% class="box successmessage" %) 882 882 ((( 883 883 (% lang="en-US" %)**POST /api/v3/vehicles/find** 884 884 ))) ... ... @@ -1208,7 +1208,7 @@ 1208 1208 (% style="text-align:left" %) 1209 1209 (% style="color:#000000" %)} 1210 1210 1211 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **С ообщения**(%%) =1182 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) = 1212 1212 1213 1213 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1214 1214 ... ... @@ -1231,7 +1231,7 @@ 1231 1231 1232 1232 (% style="text-align: left;" %) 1233 1233 { 1234 - " vehicleIds": [1205 + "objectIds": [ 1235 1235 id ~/~/ здесь передается список идентификаторов объектов 1236 1236 ], 1237 1237 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос ... ... @@ -1244,61 +1244,12 @@ 1244 1244 (% style="text-align: left;" %) 1245 1245 [ 1246 1246 { 1247 - " vehicleId": 0, ~/~/ идентификатор объекта1218 + "id": 0, ~/~/ идентификатор объекта 1248 1248 "count": 0 ~/~/ количество сообщений за период 1249 1249 } 1250 1250 ] 1251 1251 1252 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1253 1253 1254 -(% class="box infomessage" %) 1255 -((( 1256 -**POST /api/v3/terminalMessages** 1257 -))) 1258 - 1259 -Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1260 - 1261 -(% style="text-align: left;" %) 1262 -Метод запроса **POST** 1263 - 1264 -(% style="text-align: left;" %) 1265 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1266 - 1267 -(% style="text-align: left;" %) 1268 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1269 - 1270 -{ 1271 - "vehicleId": 0, ~/~/ id объекта 1272 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1273 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1274 -} 1275 - 1276 -Ответ: 1277 - 1278 -[ 1279 - { 1280 - "messages": [ 1281 - { 1282 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1283 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1284 - "speed": 0, ~/~/ Скорость, км/ч 1285 - "altitude": 0, ~/~/ Высота, м 1286 - "latitude": 0, ~/~/ Широта [-90°;90°] 1287 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1288 - "satellites": 0, ~/~/ Кол-во спутников 1289 - "voltage": 0, ~/~/ Напряжение 1290 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1291 - "additionalProp1": "string", 1292 - "additionalProp2": "string", 1293 - "additionalProp3": "string" 1294 - }, 1295 - "photoCount": 0 ~/~/ Кол-во фото 1296 - } 1297 - ] 1298 - } 1299 -] 1300 - 1301 - 1302 1302 (% class="box" lang="en-US" style="text-align: center;" %) 1303 1303 ((( 1304 1304 (% 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]] **