Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Просмотреть отметки "Нравится"
Change comment:
There is no comment for this version
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -14,13 +14,13 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При **редактировании**необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 21 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 22 23 -(% class="box successmessage" %)23 +(% class="box infomessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,6 +40,7 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 + 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) ... ... @@ -54,12 +54,6 @@ 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 56 56 57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 - 63 63 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 64 64 65 65 (% class="box infomessage" %) ... ... @@ -98,51 +98,30 @@ 98 98 Запрос должен содержать данные параметра "**agentId**" 99 99 100 100 (% style="color:#000000" %)Ответ: 96 +А 101 101 { 102 - "agentId": "", (%%) 103 - "parentId": "", 104 - "parentName": "string", 105 - "name": "string", 106 - "fullName": "string", 107 - "agentInfoType": 0, 108 - "isForeign": true/false, 109 - "district": "string", 110 - "region": "string", 111 - "city": "string", 112 - "inn": "string", 113 - "kpp": "string", 114 - "address": "string", 115 - "addressFact": "string", 116 - "email": "string", 117 - "director": "string", 118 - "bankName": "string", 119 - "bankBIK": "string", 120 - "bankRS": "string", 121 - "bankKS": "string" 98 + "agentId": "", ~/~/ идентификатор клиента (%%) 99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 + "isForeign": true/false, ~/~/ Иностранный контрагент 105 + "district": "string", ~/~/ округ 106 + "region": "string", ~/~/ регион 107 + "city": "string", ~/~/ город 108 + "inn": "string", ~/~/ ИНН клиента 109 + "kpp": "string", ~/~/ КПП клиента 110 + "address": "string", ~/~/ юридический адрес 111 + "addressFact": "string", ~/~/ фактический адрес 112 + "email": "string", ~/~/ почта 113 + "director": "string", ~/~/ ФИО руководителя 114 + "bankName": "string", ~/~/ Банк 115 + "bankBIK": "string", ~/~/ БИК 116 + "bankRS": "string", ~/~/ Номер счета 117 + "bankKS": "string" ~/~/ Корр. счет 122 122 } 123 123 124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 125 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 126 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 127 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 128 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 129 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 130 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 131 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 132 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 133 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 134 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 135 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 136 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 137 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 138 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 139 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 140 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 141 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 142 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 143 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 144 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 145 - 146 146 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 147 147 148 148 (% class="box infomessage" %) ... ... @@ -156,7 +156,7 @@ 156 156 157 157 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 158 158 159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 160 160 161 161 (% style="color:#000000" %)Метод запроса: **POST** 162 162 ... ... @@ -171,25 +171,15 @@ 171 171 (% style="color:#000000" %)Ответ: 172 172 173 173 { 174 - "agentId": "",(% style="color:#000000" %) (%%) 175 - "parentId": "", 176 - "parentName": "string", 177 - "name": "string", 178 - "fullName": "string", 179 - "agentInfoType": 0, 180 - (%style="color:#000000"%)148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 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 - Отказ) 181 181 } 182 182 183 - 184 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 185 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 186 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 188 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 189 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 190 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 191 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 192 - 193 193 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 194 194 195 195 (% class="box successmessage" %) ... ... @@ -208,7 +208,7 @@ 208 208 Параметры в теле запроса (JSON): 209 209 210 210 { 211 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 212 212 "name": "string", ~/~/ имя 213 213 "fullName": "string", ~/~/ полное наименование 214 214 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -253,28 +253,6 @@ 253 253 "bankKS": "string" ~/~/ корр. счёт 254 254 } 255 255 256 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 257 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 258 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 259 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 260 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 261 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 262 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 263 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 264 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 265 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 266 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 267 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 268 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 269 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 270 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 271 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 272 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 273 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 274 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 275 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 276 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 277 - 278 278 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 279 279 280 280 (% class="box warningmessage" %) ... ... @@ -290,6 +290,7 @@ 290 290 291 291 В заголовках запроса: X-Auth: Токен авторизации 292 292 235 + 293 293 Параметры в теле запроса (JSON): 294 294 295 295 { ... ... @@ -314,6 +314,7 @@ 314 314 "bankKS": "string" ~/~/ корр. счёт 315 315 } 316 316 260 + 317 317 Ответ: 318 318 319 319 { ... ... @@ -419,6 +419,7 @@ 419 419 "password": "string", 420 420 "email": "string", 421 421 366 + 422 422 (% style="text-align:left" %) 423 423 (% style="color:#000000; font-weight:normal" %)Ответ: 424 424 ... ... @@ -447,7 +447,6 @@ 447 447 (% style="text-align:left" %) 448 448 (% style="color:#000000; font-weight:normal" %)} 449 449 450 - 451 451 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 452 452 453 453 (% class="box infomessage" %) ... ... @@ -738,249 +738,6 @@ 738 738 (% style="text-align:left" %) 739 739 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 740 740 741 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 742 - 743 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 744 - 745 -(% class="box infomessage" %) 746 -((( 747 -(% lang="en-US" %)**GET /api/v3/models/{Id}** 748 -))) 749 - 750 -Метод возвращает полную информацию о модели объекта. 751 - 752 -(% style="color:#000000" %)Метод запроса: **GET** 753 - 754 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 755 - 756 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 757 - 758 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 759 - 760 -(% style="color:#000000" %)Ответ: 761 - 762 -(% style="color:#000000" %){ 763 - "parentName": "string", 764 - "name": "string", 765 - "picture": "string", 766 - "minspeed": 0, 767 - "maxspeed": 0, 768 - "width": 0, 769 - "imbeddedtrailer": true, 770 - "hoppercapacity": 0, 771 - "hopperdischargespeed": 0, 772 - "modelType": 0, 773 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 774 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 775 - "deleted": true 776 -} 777 - 778 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 779 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 780 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 781 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 782 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 783 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 784 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 785 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 786 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 787 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 788 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 789 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 790 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 791 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 792 - 793 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 794 - 795 -(% class="box successmessage" %) 796 -((( 797 -(% lang="en-US" %)**POST /api/v3/models/find** 798 -))) 799 - 800 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 801 - 802 -(% style="color:#000000" %)Метод запроса: **POST** 803 - 804 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 805 - 806 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 807 - 808 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 809 - 810 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 811 -} 812 - 813 -(% style="color:#000000" %)Ответ: 814 - 815 -(% style="color:#000000" %)[ 816 - { 817 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 818 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 819 - "parentName": "string", 820 - "name": "string", 821 - "modelType": 0 822 - } 823 -] 824 - 825 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 826 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 827 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 828 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 829 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 830 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 831 - 832 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 833 - 834 -(% class="box successmessage" %) 835 -((( 836 -(% lang="en-US" %)**POST /api/v3/models** 837 -))) 838 - 839 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 840 - 841 -(% style="color:#000000" %)Метод запроса: **POST** 842 - 843 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 844 - 845 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 846 - 847 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 848 - 849 -{ 850 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 851 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 852 - "deleted": true, 853 - "extId": "string", 854 - "name": "string", 855 - "picture": "string", 856 - "minspeed": 0, 857 - "maxspeed": 0, 858 - "width": 0, 859 - "imbeddedtrailer": true, 860 - "fueloutlay": 0, 861 - "hoppercapacity": 0, 862 - "hopperdischargespeed": 0, 863 - "modelType": 0 864 -} 865 - 866 -Ответ: 867 - 868 -{ 869 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 871 - "deleted": true, 872 - "extId": "string", 873 - "name": "string", 874 - "picture": "string", 875 - "minspeed": 0, 876 - "maxspeed": 0, 877 - "width": 0, 878 - "imbeddedtrailer": true, 879 - "hoppercapacity": 0, 880 - "hopperdischargespeed": 0, 881 - "modelType": 0 882 -} 883 - 884 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 885 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 886 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 887 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 888 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 889 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 890 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 891 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 892 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 893 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 894 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 895 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 896 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 897 - 898 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 899 - 900 -(% class="box warningmessage" %) 901 -((( 902 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 903 -))) 904 - 905 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 906 - 907 -(% style="color:#000000" %)Метод запроса: **PUT** 908 - 909 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 910 - 911 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 912 - 913 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 914 - 915 -{ 916 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 917 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 918 - "deleted": true, 919 - "extId": "string", 920 - "name": "string", 921 - "picture": "string", 922 - "minspeed": 0, 923 - "maxspeed": 0, 924 - "width": 0, 925 - "imbeddedtrailer": true, 926 - "fueloutlay": 0, 927 - "hoppercapacity": 0, 928 - "hopperdischargespeed": 0, 929 - "modelType": 0 930 -} 931 - 932 -Ответ: 933 - 934 -{ 935 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 936 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 937 - "deleted": true, 938 - "extId": "string", 939 - "name": "string", 940 - "picture": "string", 941 - "minspeed": 0, 942 - "maxspeed": 0, 943 - "width": 0, 944 - "imbeddedtrailer": true, 945 - "fueloutlay": 0, 946 - "hoppercapacity": 0, 947 - "hopperdischargespeed": 0, 948 - "modelType": 0 949 -} 950 - 951 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 952 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 953 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 954 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 955 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 956 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 957 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 958 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 959 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 960 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 961 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 962 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 963 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 964 - 965 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 966 - 967 -(% class="box errormessage" %) 968 -((( 969 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 970 -))) 971 - 972 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 973 - 974 -(% style="color:#000000" %)Метод запроса: **DELETE** 975 - 976 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 977 - 978 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 979 - 980 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 981 - 982 -Ответ: В случае успеха **Success 200** 983 - 984 984 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 985 985 986 986 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -1803,136 +1803,22 @@ 1803 1803 (% style="text-align:left" %) 1804 1804 (% style="color:#000000" %)} 1805 1805 1806 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1807 1807 1808 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1809 - 1810 -(% class="box infomessage" %) 1811 -((( 1812 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1813 -))) 1814 - 1815 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1816 - 1817 -(% style="color:#000000" %)Метод запроса: **GET** 1818 - 1819 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1820 - 1821 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1822 - 1823 -(% style="color:#000000" %)Ответ: 1824 - 1825 -(% style="color:#000000" %){ 1826 - 1827 - "id": "", ~/~/ ID типа датчика 1828 - "name": "", ~/~/ Название 1829 - "description": "", ~/~/ Описание 1830 - 1831 1831 (% style="text-align:left" %) 1832 -(% style="color:#000000" %) }1509 +(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов** 1833 1833 1834 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел:**Сообщения**(%%) =1511 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1835 1835 1836 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1837 - 1838 -(% class="box infomessage" style="text-align: left;" %) 1839 -((( 1840 -**POST /api/v3/terminalMessages/count** 1841 -))) 1842 - 1843 -(% style="text-align: left;" %) 1844 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1845 - 1846 -(% style="text-align: left;" %) 1847 -Метод запроса **POST** 1848 - 1849 -(% style="text-align: left;" %) 1850 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1851 - 1852 -(% style="text-align: left;" %) 1853 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1854 - 1855 -(% style="text-align: left;" %) 1856 -{ 1857 - "vehicleIds": [ 1858 - id ~/~/ здесь передается список идентификаторов объектов 1859 - ], 1860 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1861 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1862 -} 1863 - 1864 -(% style="text-align: left;" %) 1865 -Ответ: 1866 - 1867 -(% style="text-align: left;" %) 1868 -[ 1869 - { 1870 - "vehicleId": 0, ~/~/ идентификатор объекта 1871 - "count": 0 ~/~/ количество сообщений за период 1872 - } 1873 -] 1874 - 1875 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1876 - 1877 1877 (% class="box infomessage" %) 1878 1878 ((( 1879 -**POST /api/v3/ terminalMessages**1515 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1880 1880 ))) 1881 1881 1882 -Метод возвращает списоксообщенийтерминала объектазавыбранныйпериод.1518 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1883 1883 1884 -(% style="text-align: left;" %) 1885 -Метод запроса **POST** 1886 - 1887 -(% style="text-align: left;" %) 1888 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1889 - 1890 -(% style="text-align: left;" %) 1891 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1892 - 1893 -{ 1894 - "vehicleId": 0, ~/~/ id объекта 1895 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1896 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1897 -} 1898 - 1899 -Ответ: 1900 - 1901 -[ 1902 - { 1903 - "messages": [ 1904 - { 1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1907 - "speed": 0, ~/~/ Скорость, км/ч 1908 - "altitude": 0, ~/~/ Высота, м 1909 - "latitude": 0, ~/~/ Широта [-90°;90°] 1910 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1911 - "satellites": 0, ~/~/ Кол-во спутников 1912 - "voltage": 0, ~/~/ Напряжение 1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1914 - "additionalProp1": "string", 1915 - "additionalProp2": "string", 1916 - "additionalProp3": "string" 1917 - }, 1918 - "photoCount": 0 ~/~/ Кол-во фото 1919 - } 1920 - ] 1921 - } 1922 -] 1923 - 1924 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1925 - 1926 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1927 - 1928 -(% class="box infomessage" %) 1929 -((( 1930 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1931 -))) 1932 - 1933 1933 (% style="color:#000000" %)Метод запроса: **POST** 1934 1934 1935 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/mileageAndMotohours1522 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find 1936 1936 1937 1937 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1938 1938 ... ... @@ -1939,43 +1939,43 @@ 1939 1939 (% style="text-align:left" %) 1940 1940 Тело запроса: 1941 1941 1529 +(% style="text-align:left" %) 1942 1942 { 1943 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1944 - "vehicleIds": [0], ~/~/ Список ID объектов 1945 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1946 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1947 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1531 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1948 1948 } 1949 1949 1534 +(% style="text-align:left" %) 1950 1950 Ответ: 1951 1951 1952 1952 [ 1953 1953 { 1954 - " vehicleId": 0, ~/~/IDобъекта1955 - "name": "string", ~/~/ ИмяТС1956 - "pe riods":[~/~/Периоды1957 - {1958 - start": "2023-08-09T14:23:14.574Z", ~/~/Начало1959 - end":"2023-08-09T14:23:14.574Z", ~/~/Окончание1960 - mileageBegin": 0, ~/~/Пробег на началопериода1961 - mileageEnd": 0, ~/~/Пробег на окончаниепериода1962 - motohoursBegin":0, ~/~/Моточасы наачало периода1963 - motohoursEnd": 0 ~/~/Моточасы на окончание периода1964 - }1965 - ]1539 + "id": 0, ~/~/ Идентификатор объекта геозоны 1540 + "name": "string", ~/~/ Название объекта геозоны 1541 + "type": 0, ~/~/ Тип объекта геозоны 1542 + "fname": "string", ~/~/ Имя файла 1543 + "parentId": "string", ~/~/ Идентификатор клиента 1544 + "radius": 0, ~/~/ Радиус геообъекта 1545 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 1546 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 1547 + "description": "string", ~/~/ Описание 1548 + "area": 0, ~/~/ Площадь, м^^2^^ 1549 + "perimetr": 0, ~/~/ Периметр, м 1550 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 1966 1966 } 1967 1967 ] 1968 1968 1969 -== (% style="color:#000000; font-size:16px" %)** Получение данныхо расходетранспортногосредства**(%%) ==1554 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 1970 1970 1971 1971 (% class="box infomessage" %) 1972 1972 ((( 1973 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/ vehicles/fuelConsumption**1558 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 1974 1974 ))) 1975 1975 1561 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1562 + 1976 1976 (% style="color:#000000" %)Метод запроса: **POST** 1977 1977 1978 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/fuelConsumption1565 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1979 1979 1980 1980 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1981 1981 ... ... @@ -1983,42 +1983,40 @@ 1983 1983 Тело запроса: 1984 1984 1985 1985 { 1986 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1987 - "vehicleIds": [0], ~/~/ Список ID объектов 1988 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1989 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1990 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1573 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1574 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1575 + "ids": [ ], ~/~/ Массив id объектов 1576 + "byTime": 0, ~/~/ Настройки фильтрации по времени 1577 + "byDist": 0, ~/~/ 1578 + "filterByTime": 0, ~/~/ 1579 + "filterByHalfPerimeter": true ~/~/ 1991 1991 } 1992 1992 1993 1993 Ответ: 1994 - 1995 1995 [ 1996 1996 { 1997 - "vehicleId": 0, ~/~/ ID объекта 1998 - "name": "string", ~/~/ Имя ТС 1999 - "periods": [ ~/~/ Периоды 2000 - { 2001 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2002 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2003 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2004 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2005 - "fuelConsumption": 0, ~/~/ Расход топлива 2006 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2007 - } 2008 - ] 1585 + "geozoneId": 0, 1586 + "geozoneName": "string", 1587 + "startDate": "2023-08-02T06:13:18.554Z", 1588 + "endDate": "2023-08-02T06:13:18.554Z", 1589 + "duration": 0, 1590 + "vehicleId": 0, 1591 + "vehicleName": "string" 2009 2009 } 2010 2010 ] 2011 2011 2012 -== (% style="color:#000000; font-size:16px" %)** Получение данныхозаправках исливахтранспортногосредства**(%%) ==1595 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2013 2013 2014 2014 (% class="box infomessage" %) 2015 2015 ((( 2016 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/ vehicles/fuelInOut**1599 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2017 2017 ))) 2018 2018 1602 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1603 + 2019 2019 (% style="color:#000000" %)Метод запроса: **POST** 2020 2020 2021 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/fuelInOut1606 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2022 2022 2023 2023 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2024 2024 ... ... @@ -2026,10 +2026,15 @@ 2026 2026 Тело запроса: 2027 2027 2028 2028 { 2029 - "vehicleIds": [0], ~/~/ Список ID объектов 2030 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2031 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2032 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1614 + "startDate": "2023-08-03T14:20:03.439Z", 1615 + "endDate": "2023-08-03T14:20:03.439Z", 1616 + "ids": [ 1617 + 0 1618 + ], 1619 + "byTime": 0, 1620 + "byDist": 0, 1621 + "filterByTime": 0, 1622 + "filterByHalfPerimeter": true 2033 2033 } 2034 2034 2035 2035 Ответ: ... ... @@ -2036,136 +2036,110 @@ 2036 2036 2037 2037 [ 2038 2038 { 2039 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2040 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2041 - "vehicleId": 0, ~/~/ ID объекта 2042 - "name": "string", ~/~/ Имя объекта 2043 - "model": "string", ~/~/ Модель объекта 2044 - "fuels": [ ~/~/ Массив данным по заправкам и сливам 2045 - { 2046 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2047 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2048 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2049 - "valueFuel": 0, ~/~/ Количество 2050 - "fuelStart": 0, ~/~/ Уровень топлива на начало события 2051 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2052 - } 2053 - ] 1629 + "geozoneId": 0, 1630 + "geozoneName": "string", 1631 + "startDate": "2023-08-02T06:13:18.554Z", 1632 + "endDate": "2023-08-02T06:13:18.554Z", 1633 + "duration": 0, 1634 + "vehicleId": 0, 1635 + "vehicleName": "string" 2054 2054 } 2055 2055 ] 2056 2056 2057 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2058 2058 2059 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2060 2060 1641 + 1642 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1643 + 1644 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1645 + 2061 2061 (% class="box infomessage" %) 2062 2062 ((( 2063 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)** POST**(%%)**/api/v3/gis/find**1648 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 2064 2064 ))) 2065 2065 2066 -(% style="color:#000000" %)Метод позволяет получить список геообъектовклиента.Возвращает массивгеообъектов совсейинформациейоних.1651 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 2067 2067 2068 -(% style="color:#000000" %)Метод запроса: ** POST**1653 +(% style="color:#000000" %)Метод запроса: **GET** 2069 2069 2070 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ gis/find1655 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 2071 2071 2072 2072 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2073 2073 2074 -(% style="text-align:left" %) 2075 -Тело запроса: 1659 +(% style="color:#000000" %)Ответ: 2076 2076 2077 -(% style="text-align:left" %) 2078 -{ 2079 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2080 -} 1661 +(% style="color:#000000" %){ 2081 2081 1663 + "id": "", ~/~/ ID типа датчика 1664 + "name": "", ~/~/ Название 1665 + "description": "", ~/~/ Описание 1666 + 2082 2082 (% style="text-align:left" %) 2083 - Ответ:1668 +(% style="color:#000000" %)} 2084 2084 2085 -[ 2086 - { 2087 - "id": 0, ~/~/ Идентификатор объекта геозоны 2088 - "name": "string", ~/~/ Название объекта геозоны 2089 - "type": 0, ~/~/ Тип объекта геозоны 2090 - "fname": "string", ~/~/ Имя файла 2091 - "parentId": "string", ~/~/ Идентификатор клиента 2092 - "radius": 0, ~/~/ Радиус геообъекта 2093 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2094 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2095 - "description": "string", ~/~/ Описание 2096 - "area": 0, ~/~/ Площадь, м^^2^^ 2097 - "perimetr": 0, ~/~/ Периметр, м 2098 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2099 - } 2100 -] 1670 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 2101 2101 2102 -== (% style="color:#000000; font-size:16px" %)** Запроспересеченийпообъектам**(%%) ==1672 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 2103 2103 2104 -(% class="box infomessage" %) 1674 +(% class="box infomessage" style="text-align: left;" %) 2105 2105 ((( 2106 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/vehicles**1676 +**POST /api/v3/terminalMessages/count** 2107 2107 ))) 2108 2108 2109 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1679 +(% style="text-align: left;" %) 1680 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 2110 2110 2111 -(% style="color:#000000" %)Метод запроса: **POST** 1682 +(% style="text-align: left;" %) 1683 +Метод запроса **POST** 2112 2112 2113 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1685 +(% style="text-align: left;" %) 1686 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 2114 2114 1688 +(% style="text-align: left;" %) 2115 2115 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2116 2116 2117 -(% style="text-align:left" %) 2118 -Тело запроса: 2119 - 1691 +(% style="text-align: left;" %) 2120 2120 { 2121 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2122 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2123 - "ids": [ ], ~/~/ Массив id объектов 2124 - "byTime": 0, ~/~/ Объединение событий по времени 2125 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2126 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2127 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1693 + "vehicleIds": [ 1694 + id ~/~/ здесь передается список идентификаторов объектов 1695 + ], 1696 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1697 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 2128 2128 } 2129 2129 1700 +(% style="text-align: left;" %) 2130 2130 Ответ: 1702 + 1703 +(% style="text-align: left;" %) 2131 2131 [ 2132 2132 { 2133 - "geozoneId": 0, ~/~/ ID геообъекта 2134 - "geozoneName": "string", ~/~/ Название геообъекта 2135 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2136 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2137 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2138 - "vehicleId": 0, ~/~/ ID объекта 2139 - "vehicleName": "string" ~/~/ Имя объекта 1706 + "vehicleId": 0, ~/~/ идентификатор объекта 1707 + "count": 0 ~/~/ количество сообщений за период 2140 2140 } 2141 2141 ] 2142 2142 2143 -== (% style="color:#000000; font-size:16px" %)**Запрос пересеченийпогеообъектам**(%%) ==1711 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 2144 2144 2145 2145 (% class="box infomessage" %) 2146 2146 ((( 2147 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/geozones**1715 +**POST /api/v3/terminalMessages** 2148 2148 ))) 2149 2149 2150 - (% style="color:#000000" %)Методпозволяетполучитьсписокпересеченийвыбранных геообъектов со всеми объектамиза выбранный период.1718 +Метод возвращает список сообщений терминала объекта за выбранный период. 2151 2151 2152 -(% style="color:#000000" %)Метод запроса: **POST** 1720 +(% style="text-align: left;" %) 1721 +Метод запроса **POST** 2153 2153 2154 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1723 +(% style="text-align: left;" %) 1724 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2155 2155 1726 +(% style="text-align: left;" %) 2156 2156 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2157 2157 2158 -(% style="text-align:left" %) 2159 -Тело запроса: 2160 - 2161 2161 { 2162 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2163 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2164 - "ids": [ ], ~/~/ Массив id геообъектов 2165 - "byTime": 0, ~/~/ Объединение событий по времени 2166 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2167 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2168 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1730 + "vehicleId": 0, ~/~/ id объекта 1731 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1732 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2169 2169 } 2170 2170 2171 2171 Ответ: ... ... @@ -2172,13 +2172,24 @@ 2172 2172 2173 2173 [ 2174 2174 { 2175 - "geozoneId": 0, ~/~/ ID геообъекта 2176 - "geozoneName": "string", ~/~/ Название геообъекта 2177 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2178 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2179 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2180 - "vehicleId": 0, ~/~/ ID объекта 2181 - "vehicleName": "string" ~/~/ Имя объекта 1739 + "messages": [ 1740 + { 1741 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1742 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1743 + "speed": 0, ~/~/ Скорость, км/ч 1744 + "altitude": 0, ~/~/ Высота, м 1745 + "latitude": 0, ~/~/ Широта [-90°;90°] 1746 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1747 + "satellites": 0, ~/~/ Кол-во спутников 1748 + "voltage": 0, ~/~/ Напряжение 1749 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1750 + "additionalProp1": "string", 1751 + "additionalProp2": "string", 1752 + "additionalProp3": "string" 1753 + }, 1754 + "photoCount": 0 ~/~/ Кол-во фото 1755 + } 1756 + ] 2182 2182 } 2183 2183 ] 2184 2184 ... ... @@ -2952,83 +2952,6 @@ 2952 2952 Success 2953 2953 2954 2954 2955 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 2956 - 2957 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 2958 - 2959 -(% class="box infomessage" %) 2960 -((( 2961 -**POST /api/v3/Trailers** 2962 -))) 2963 - 2964 -Пример запроса: 2965 - 2966 -{ 2967 - "startDate": "2023-11-14T10:48:03.671Z", 2968 - "endDate": "2023-11-14T10:48:03.671Z", 2969 - "ids": [ 0 ], 2970 - "timezone": 0 2971 -} 2972 - 2973 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2974 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 2975 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 2976 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 2977 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 2978 - 2979 -Пример ответа: 2980 - 2981 -[ 2982 - { 2983 - "SD": "2023-11-14T10:48:03.717Z", 2984 - "ED": "2023-11-14T10:48:03.717Z", 2985 - "id": 0, 2986 - "SLat": 0, 2987 - "SLon": 0, 2988 - "ELat": 0, 2989 - "ELon": 0, 2990 - "mileage": 0 2991 - "Duration": 0 2992 - "Address": "string", 2993 - "Address2": "string", 2994 - "name": "string", 2995 - "rid": "string", 2996 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2997 - "trailer": { 2998 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2999 - "Number": "string", 3000 - "Description": "string", 3001 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3002 - "ExternalID": "string", 3003 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3004 - "CreateTime": "2023-11-14T10:48:03.717Z", 3005 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3006 - "IsDeleted": true 3007 - }, 3008 - "filesCount": 0, 3009 - } 3010 -] 3011 - 3012 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3013 -|SD|Дата и время начала события 3014 -|ED|Дата и время окончания события 3015 -|id|ID объекта 3016 -|SLat|Широта начальной координаты 3017 -|SLon|Долгота начальной координаты 3018 -|ELat|Широта конечной координаты 3019 -|ELon|Долгота конечной координаты 3020 -|mileage|Пробег 3021 -|Duration|Продолжительность 3022 -|Address|Адрес начального местоположения 3023 -|Address2|Адрес конечного местоположения 3024 -|name|Имя радиометки 3025 -|rid|Номер радиометки 3026 -|rguid|ID радиометки 3027 -|trailer|Информация об агрегате 3028 -|ModelGuid|ID агрегата 3029 -|Number|Название/номер агрегата 3030 -|Description|Текст примечания агрегата 3031 - 3032 3032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3033 3033 3034 3034 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -3050,18 +3050,13 @@ 3050 3050 { 3051 3051 "name": "string", 3052 3052 "number": 0, 3053 - "period": 0, 2551 + "period": 0, ~/~/ Частота трансляции радиометки 3054 3054 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3055 3055 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2554 + "deleted": true 3056 3056 } 3057 3057 ] 3058 3058 3059 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3060 -|parentId|ID клиента 3061 -|name|Название карты-метки 3062 -|number|Номер 3063 -|period|Период запросов в секундах (работает только для агрегатов) 3064 -|id|ID карты-метки 3065 3065 3066 3066 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3067 3067 ... ... @@ -3078,18 +3078,13 @@ 3078 3078 { 3079 3079 "name": "string", 3080 3080 "number": 0, 3081 - "period": 0, 2574 + "period": 0, ~/~/ Частота трансляции радиометки 3082 3082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3083 3083 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2577 + "deleted": true 3084 3084 } 3085 3085 ] 3086 3086 3087 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3088 -|name|Название карты-метки 3089 -|number|Номер 3090 -|period|Период запросов в секундах (работает только для агрегатов) 3091 -|id|ID карты-метки 3092 -|parentId|ID клиента 3093 3093 3094 3094 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3095 3095 ... ... @@ -3105,6 +3105,7 @@ 3105 3105 "number": 0, 3106 3106 "period": 0, 3107 3107 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2596 + "deleted": true 3108 3108 } 3109 3109 3110 3110 Ответ: ... ... @@ -3115,14 +3115,9 @@ 3115 3115 "period": 0, 3116 3116 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3117 3117 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2607 + "deleted": true 3118 3118 } 3119 3119 3120 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3121 -|name|Название карты-метки 3122 -|number|Номер 3123 -|period|Период запросов в секундах (работает только для агрегатов) 3124 -|id|ID карты-метки 3125 -|parentId|ID клиента 3126 3126 3127 3127 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3128 3128 ... ... @@ -3139,6 +3139,7 @@ 3139 3139 "period": 0, 3140 3140 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3141 3141 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2626 + "deleted": true 3142 3142 } 3143 3143 3144 3144 Ответ: ... ... @@ -3149,14 +3149,9 @@ 3149 3149 "period": 0, 3150 3150 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3151 3151 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2637 + "deleted": true 3152 3152 } 3153 3153 3154 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3155 -|name|Название карты-метки 3156 -|number|Номер 3157 -|period|Период запросов в секундах (работает только для агрегатов) 3158 -|id|ID карты-метки 3159 -|parentId|ID клиента 3160 3160 3161 3161 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3162 3162 ... ... @@ -3165,7 +3165,7 @@ 3165 3165 **DELETE /api/v3/Rfids/{rfidGuid}** 3166 3166 ))) 3167 3167 3168 -Передаем параметр **rfidGuid**- идентификатор карты-метки2648 +Передаем параметр rfidGuid - идентификатор карты-метки 3169 3169 3170 3170 Ответ: 3171 3171 ... ... @@ -3172,670 +3172,6 @@ 3172 3172 Success 3173 3173 3174 3174 3175 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3176 - 3177 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3178 - 3179 -(% class="box infomessage" %) 3180 -((( 3181 -**GET /api/v3/Billing/client/balance/{clientId}** 3182 -))) 3183 - 3184 -Параметр запроса: **clientId **- идентификатор клиента. 3185 - 3186 -Ответ: 3187 - 3188 -{ 3189 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3190 - "Balance": 0 3191 -} 3192 - 3193 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3194 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3195 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3196 - 3197 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3198 - 3199 -(% class="box infomessage" %) 3200 -((( 3201 -**GET /api/v3/Billing/client/constraint/{clientId}** 3202 -))) 3203 - 3204 -Параметр запроса: **clientId **- идентификатор клиента. 3205 - 3206 -Ответ: 3207 - 3208 -{ 3209 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3210 - "CalculationType": 0, 3211 - "PermissibleBalance": 0, 3212 - "DefermentDays": 0, 3213 - "SendUiNotifications": true, 3214 - "SendEmailNotifications": true, 3215 - "IsPrivate": true, 3216 -} 3217 - 3218 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3219 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3220 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3221 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3222 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3223 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3224 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3225 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3226 - 3227 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3228 - 3229 -(% class="box infomessage" %) 3230 -((( 3231 -**GET /api/v3/Billing/client/plan/{clientId}** 3232 -))) 3233 - 3234 -Параметры запроса: 3235 - 3236 -**clientId **- идентификатор клиента. 3237 - 3238 -**planId **- идентификатор тарифного плана. 3239 - 3240 -Ответ: 3241 - 3242 -{ 3243 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3244 - "Plan": { **~/~/ Описание тарифного плана** 3245 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3246 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3247 - "Name": "string", 3248 - "IsArchived": true, 3249 - "Constraint": { 3250 - "CalculationType": 0, 3251 - "PermissibleBalance": 0, 3252 - "DefermentDays": 0 3253 - }, 3254 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3255 - { 3256 - "Feature": "string", 3257 - "IsFactual": true, 3258 - "Limit": 0, 3259 - "Price": 0, 3260 - "PeriodValue": 0, 3261 - "PeriodType": 0 3262 - } 3263 - ] 3264 - }, 3265 - "DebitDate": "2023-10-18T12:46:24.213Z", 3266 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3267 - { 3268 - "Feature": "string", 3269 - "IsEnabled": true, 3270 - "IsPrivate": true, 3271 - "IsFactual": true, 3272 - "Limit": 0, 3273 - "Price": 0, 3274 - "DebitDate": "2023-10-18T12:46:24.213Z", 3275 - "PeriodValue": 0, 3276 - "PeriodType": 0 3277 - } 3278 - ] 3279 -} 3280 - 3281 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3282 -|ClientId|Идентификатор клиента 3283 -|Id|Идентификатор тарифного плана 3284 -|OwnerId|Идентификатор клиента-владельца 3285 -|Name|Наименование тарифного плана 3286 -|IsArchived|Признак, определяющий архивный тарифный план 3287 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3288 -|PermissibleBalance|Допустимый баланс 3289 -|DefermentDays|Отсрочка, количество дней 3290 -|Feature|Код услуги 3291 -|IsEnabled|Признак, определяющий активирована ли услуга 3292 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3293 -|IsFactual|Признак, определяющий расчёт по факту 3294 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3295 -|Price|Цена за единицу. 3296 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3297 -|PeriodValue|Значение периода. 3298 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3299 - 3300 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3301 - 3302 -(% class="box infomessage" %) 3303 -((( 3304 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3305 -))) 3306 - 3307 -Параметр запроса: **clientId **- идентификатор клиента. 3308 - 3309 -Ответ: 3310 - 3311 -[ 3312 - { 3313 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3314 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3315 - "Name": "string", 3316 - "IsArchived": true, 3317 - "Constraint": { 3318 - "CalculationType": 0, 3319 - "PermissibleBalance": 0, 3320 - "DefermentDays": 0 3321 - }, 3322 - "Features": [ 3323 - { 3324 - "Feature": "string", 3325 - "IsFactual": true, 3326 - "Limit": 0, 3327 - "Price": 0, 3328 - "PeriodValue": 0, 3329 - "PeriodType": 0 3330 - } 3331 - ] 3332 - } 3333 -] 3334 - 3335 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3336 -|ClientId|Идентификатор клиента 3337 -|Id|Идентификатор тарифного плана 3338 -|OwnerId|Идентификатор клиента-владельца 3339 -|Name|Наименование тарифного плана 3340 -|IsArchived|Признак, определяющий архивный тарифный план 3341 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3342 -|PermissibleBalance|Допустимый баланс 3343 -|DefermentDays|Отсрочка, количество дней 3344 -|Feature|Код услуги 3345 -|IsFactual|Признак, определяющий расчёт по факту 3346 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3347 -|Price|Цена за единицу. 3348 -|PeriodValue|Значение периода. 3349 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3350 - 3351 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3352 - 3353 -(% class="box infomessage" %) 3354 -((( 3355 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3356 -))) 3357 - 3358 -Параметр запроса: **clientId **- идентификатор клиента. 3359 - 3360 -Ответ: 3361 - 3362 -[ 3363 - { 3364 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3365 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3366 - "Name": "string", 3367 - "IsArchived": true, 3368 - "Constraint": { 3369 - "CalculationType": 0, 3370 - "PermissibleBalance": 0, 3371 - "DefermentDays": 0 3372 - }, 3373 - "Features": [ 3374 - { 3375 - "Feature": "string", 3376 - "IsFactual": true, 3377 - "Limit": 0, 3378 - "Price": 0, 3379 - "PeriodValue": 0, 3380 - "PeriodType": 0 3381 - } 3382 - ] 3383 - } 3384 -] 3385 - 3386 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3387 -|ClientId|Идентификатор клиента 3388 -|Id|Идентификатор тарифного плана 3389 -|OwnerId|Идентификатор клиента-владельца 3390 -|Name|Наименование тарифного плана 3391 -|IsArchived|Признак, определяющий архивный тарифный план 3392 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3393 -|PermissibleBalance|Допустимый баланс 3394 -|DefermentDays|Отсрочка, количество дней 3395 -|Feature|Код услуги 3396 -|IsFactual|Признак, определяющий расчёт по факту 3397 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3398 -|Price|Цена за единицу. 3399 -|PeriodValue|Значение периода. 3400 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3401 - 3402 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3403 - 3404 -(% class="box warningmessage" %) 3405 -((( 3406 -**PUT /api/v3/Billing/client/balance** 3407 -))) 3408 - 3409 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3410 - 3411 -Тело запроса: 3412 - 3413 -{ 3414 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3415 - "Balance": 0 3416 -} 3417 - 3418 -Ответ: Success 3419 - 3420 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3421 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3422 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3423 - 3424 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3425 - 3426 -(% class="box warningmessage" %) 3427 -((( 3428 -**PUT /api/v3/billing/client/balance/deposit** 3429 -))) 3430 - 3431 -Создает операцию **Пополнение **с указанной суммой 3432 - 3433 -Тело запроса: 3434 - 3435 -{ 3436 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3437 - "Balance": 0 3438 -} 3439 - 3440 -Ответ: Success 3441 - 3442 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3443 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3444 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3445 - 3446 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3447 - 3448 -Создает операцию **Списание **с указанной суммой 3449 - 3450 -(% class="box warningmessage" %) 3451 -((( 3452 -**PUT /api/v3/billing/client/balance/withdraw** 3453 -))) 3454 - 3455 -Тело запроса: 3456 - 3457 -{ 3458 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3459 - "Balance": 0 3460 -} 3461 - 3462 -Ответ: Success 3463 - 3464 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3465 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3466 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3467 - 3468 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3469 - 3470 -(% class="box warningmessage" %) 3471 -((( 3472 -**PUT /api/v3/Billing/client/constraint** 3473 -))) 3474 - 3475 -Тело запроса: 3476 - 3477 -{ 3478 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3479 - "CalculationType": 0, 3480 - "PermissibleBalance": 0, 3481 - "DefermentDays": 0, 3482 - "SendUiNotifications": true, 3483 - "SendEmailNotifications": true, 3484 - "IsPrivate": true, 3485 -} 3486 - 3487 -Ответ: Success 3488 - 3489 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3490 -|ClientId|Идентификатор клиента 3491 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3492 -|PermissibleBalance|Допустимый баланс 3493 -|DefermentDays|((( 3494 -Отсрочка, количество дней 3495 -))) 3496 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3497 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3498 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3499 - 3500 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3501 - 3502 -(% class="box warningmessage" %) 3503 -((( 3504 -**PUT /api/v3/Billing/client/plan** 3505 -))) 3506 - 3507 -Тело запроса: 3508 - 3509 -{ 3510 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3511 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3512 - "Features": [ 3513 - { 3514 - "Feature": "string", 3515 - "IsEnabled": true, 3516 - "IsFactual": true, 3517 - "Limit": 0, 3518 - "Price": 0, 3519 - "DebitDate": "2023-10-18T13:26:58.987Z", 3520 - "PeriodValue": 0, 3521 - "PeriodType": 0 3522 - } 3523 - ] 3524 -} 3525 - 3526 -Ответ: Success 3527 - 3528 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3529 -|ClientId|Идентификатор клиента 3530 -|PlanId|Идентификатор тарифного плана 3531 -|Feature|Код услуги 3532 -|IsEnabled|Признак, определяющий активирована ли услуга 3533 -|IsFactual|Признак, определяющий расчёт по факту 3534 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3535 -|Price|Цена за единицу. 3536 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3537 -|PeriodValue|Значение периода. 3538 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3539 - 3540 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3541 - 3542 -(% class="box warningmessage" %) 3543 -((( 3544 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3545 -))) 3546 - 3547 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3548 - 3549 -(% class="box infomessage" %) 3550 -((( 3551 -**POST /api/v3/vehicles/import/{agentId}** 3552 -))) 3553 - 3554 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3555 - 3556 -В пути указывается **agentId** - id клиента. 3557 - 3558 -**Заголовок** 3559 - 3560 -**X-Auth: [токен авторизации]** 3561 - 3562 -**Параметры** 3563 - 3564 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3565 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3566 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3567 - 3568 -В теле использовать тип **form-data,** тип значения** file** 3569 - 3570 -**Ключи** 3571 - 3572 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3573 -|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3574 -|csv|В значении передаем файл датчиков, формат **csv** 3575 - 3576 -Ответ: 3577 - 3578 -{ 3579 - "vehicleId": 0, 3580 - "name": "string", 3581 - "errors": ["string"] 3582 -} 3583 - 3584 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3585 -|vehicleId|ID созданного объекта 3586 -|name|Имя созданного объекта 3587 -|errors|Ошибки и их описание 3588 - 3589 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3590 - 3591 -(% class="box infomessage" %) 3592 -((( 3593 -**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3594 -))) 3595 - 3596 -(% class="wikigeneratedid" %) 3597 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3598 - 3599 -(% class="wikigeneratedid" %) 3600 -В пути указывается **vehicleId **- id объекта. 3601 - 3602 -**Заголовок** 3603 - 3604 -**X-Auth: [токен авторизации]** 3605 - 3606 -В теле использовать тип **form-data.** 3607 - 3608 -Ключи: 3609 - 3610 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3611 -|**history**|В значении передавать файл с историей 3612 - 3613 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3614 - 3615 -Ответ: 3616 - 3617 -{ 3618 - "results": [ 3619 - { 3620 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3621 - "vehicleId": 0, 3622 - "errors": [ 3623 - "string" 3624 - ], 3625 - "firstMessageDate": "2023-11-28T09:27:58.949Z", 3626 - "lastMessageDate": "2023-11-28T09:27:58.949Z", 3627 - "producedCount": 0, 3628 - "msgCount": 0 3629 - } 3630 - ] 3631 -} 3632 - 3633 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3634 -|results|Результаты импорта в разрезе ТС 3635 -|vehicleGuid|Guid ТС 3636 -|vehicleId|ID ТС 3637 -|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3638 -|firstMessageDate|Дата первого импортированного сообщения (UTC) 3639 -|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3640 -|producedCount|Кол-во успешно отправленных в шину данных сообщений 3641 -|msgCount|Кол-во обработанных сообщений всего 3642 - 3643 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3644 - 3645 -(% class="box infomessage" %) 3646 -((( 3647 -**GET /api/v3/vehicles/import/history/status** 3648 -))) 3649 - 3650 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3651 - 3652 -Ответ: 3653 - 3654 -{ 3655 - "activity": true, 3656 - "progress": 0, 3657 - "message": "string" 3658 -} 3659 - 3660 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3661 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3662 -|progress|Guid ТС 3663 - 3664 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3665 - 3666 -(% class="box infomessage" %) 3667 -((( 3668 -**POST /api/v3/vehicles/export** 3669 -))) 3670 - 3671 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3672 - 3673 -Тело запроса: 3674 - 3675 -[ 3676 - id 3677 -] 3678 - 3679 -Ответ: Success 200, получаете файлы с настройками. 3680 - 3681 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3682 - 3683 -(% class="box infomessage" %) 3684 -((( 3685 -**POST /api/v3/vehicles/export/history** 3686 -))) 3687 - 3688 -Метод возвращает список сообщений терминала объекта за выбранный период. 3689 - 3690 -Тело запроса: 3691 - 3692 -{ 3693 - "vehicleId": 0, 3694 - "asArchive": true, 3695 - "from": "2023-09-27T12:17:45.973Z", 3696 - "to": "2023-09-27T12:17:45.973Z" 3697 -} 3698 - 3699 -Ответ: 3700 - 3701 -Получаете файл. Сообщение: Code 200/Success 3702 - 3703 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3704 -|vehicleId|ID объекта 3705 -|asArchive|true - Архивировать файл, False - не архивировать 3706 -|from|Дата и время начала запроса 3707 -|to|Дата и время окончания запроса 3708 - 3709 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3710 - 3711 -(% class="box infomessage" %) 3712 -((( 3713 -**GET /api/v3/vehicles/export/history/status** 3714 -))) 3715 - 3716 -Метод возвращает список сообщений терминала объекта за выбранный период. 3717 - 3718 -Ответ: 3719 - 3720 -{ 3721 - "activity": true, 3722 - "progress": 0, 3723 - "message": "string" 3724 -} 3725 - 3726 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3727 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3728 -|progress|Прогресс экспорта, от 0 до 100% 3729 -|message|Текст описывающий статус 3730 - 3731 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3732 - 3733 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) == 3734 - 3735 -(% class="box infomessage" %) 3736 -((( 3737 -**POST /api/v3/EcoDriving/rating** 3738 -))) 3739 - 3740 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3741 - 3742 -Тело запроса: 3743 - 3744 -{ 3745 - "vehicleIds": [vehicleId], 3746 - "from": "2023-11-22T09:29:48.051Z", 3747 - "to": "2023-11-22T09:29:48.051Z" 3748 -} 3749 - 3750 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3751 -|vehicleIds|Массив ID объектов 3752 -|from|Дата начала запроса 3753 -|to|Дата окончания запроса 3754 - 3755 -Ответ: 3756 - 3757 -{ 3758 - "items": [ 3759 - { 3760 - "from": "2023-11-22T09:29:48.052Z", 3761 - "to": "2023-11-22T09:29:48.052Z", 3762 - "vehicleId": 0, 3763 - "vehicleName": "string", 3764 - "vehicleModel": "string", 3765 - "penalty": 0, 3766 - "score": 0, 3767 - "totalViolations": 0, 3768 - "violationsByType": { 3769 - "overspeedingViolations": 0, 3770 - "accelerationViolations": 0, 3771 - "brakingViolations": 0, 3772 - "turningViolations": 0, 3773 - "dangerousDrivingViolations": 0, 3774 - "sensorViolations": 0 3775 - }, 3776 - "moveTime": 0, 3777 - "mileage": 0, 3778 - "tripsCount": 0, 3779 - "trips": [ 3780 - { 3781 - "penalty": 0, 3782 - "score": 0, 3783 - "violationsCount": 0, 3784 - "violationsByType": { 3785 - "overspeedingViolations": 0, 3786 - "accelerationViolations": 0, 3787 - "brakingViolations": 0, 3788 - "turningViolations": 0, 3789 - "dangerousDrivingViolations": 0, 3790 - "sensorViolations": 0 3791 - }, 3792 - "moveTime": 0, 3793 - "mileage": 0, 3794 - "motohours": 0, 3795 - "maxSpeed": 0, 3796 - "startAddress": "string", 3797 - "endAddress": "string", 3798 - "drivers": [ 3799 - { 3800 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3801 - "driverName": "string", 3802 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3803 - } 3804 - ] 3805 - } 3806 - ] 3807 - } 3808 - ] 3809 -} 3810 - 3811 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3812 -|from|Дата начала запроса 3813 -|to|Дата окончания 3814 -|vehicleId|ID объекта 3815 -|vehicleName|Имя объекта 3816 -|vehicleModel|Модель объекта 3817 -|penalty|Сумма штрафных баллов 3818 -|score|Оценка 3819 -|totalViolations|Суммарное количество нарушений 3820 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3821 -|overspeedingViolations|Превышение скорости 3822 -|accelerationViolations|Ускорение 3823 -|brakingViolations|Торможение 3824 -|turningViolations|Резкий поворот 3825 -|dangerousDrivingViolations|Резкое вождение 3826 -|sensorViolations|Нарушение по датчику 3827 -|moveTime|Время в движении 3828 -|mileage|Пробег 3829 -|tripsCount|Количество рейсов 3830 -|motohours|Моточасы 3831 -|maxSpeed|Максимальная скорость 3832 -|startAddress|Адрес начала рейса 3833 -|endAddress|Адрес окончания рейса 3834 -|drivers|Список водителей, которые были на объекте в течениии рейса 3835 -|driverGuid|Guid водителя 3836 -|driverName|Имя водителя 3837 -|driverRfid|Номер Карты-метки 3838 - 3839 3839 (% class="box" lang="en-US" style="text-align: center;" %) 3840 3840 ((( 3841 3841 (% 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]] **
-
image-20231020124453-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.krainovim - Size
-
... ... @@ -1,1 +1,0 @@ 1 -268.0 KB -
Content