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
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - 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 infomessage" %)23 +(% class="box successmessage" %) 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,7 +40,6 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -55,6 +55,12 @@ 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 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 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 97 97 { 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" ~/~/ Корр. счет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" 118 118 } 119 119 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 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 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 - Отказ) 174 + "agentId": "",(% style="color:#000000" %) (%%) 175 + "parentId": "", 176 + "name": "string", 177 + "fullName": "string", 178 + "agentInfoType": 0, 179 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 182 + 183 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 184 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 185 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 186 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 187 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 188 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 189 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 190 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 209 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 254 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 255 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 256 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 257 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 258 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 259 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 260 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 261 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 262 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 263 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 264 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 265 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 266 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 267 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 268 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 269 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 270 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 271 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 272 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 273 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 274 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 275 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 357 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 358 + 359 +(% class="box warningmessage" %) 360 +((( 361 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 362 +))) 363 + 364 +Метод позволяет изменить статус клиента, указанного в запросе. 365 + 366 +В пути указывается GUID клиента и статус клиента. 367 + 368 +**status **- значение 0 - заблокирован, 1 - активен. 369 + 370 +Ответ: Code 204 371 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -363,7 +363,6 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 369 ... ... @@ -392,6 +392,7 @@ 392 392 (% style="text-align:left" %) 393 393 (% style="color:#000000; font-weight:normal" %)} 394 394 463 + 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 397 397 (% class="box infomessage" %) ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 800 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 898 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 901 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 902 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 903 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 904 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 905 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 906 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 907 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 908 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 909 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 965 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 968 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 969 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 970 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 971 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 972 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 973 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 974 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 975 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 976 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 977 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -1709,7 +1709,7 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]1805 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 ... ... @@ -1792,6 +1792,51 @@ 1792 1792 } 1793 1793 ] 1794 1794 1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1889 + 1890 +(% class="box infomessage" style="text-align: left;" %) 1891 +((( 1892 +**POST /api/v3/terminalMessages/mapping** 1893 +))) 1894 + 1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1896 + 1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1898 + 1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1900 + 1901 +{ 1902 + "protocolType": 0, 1903 + "params": ["string"] 1904 +} 1905 + 1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1907 +|protocolType|ID типа протокола 1908 +|params|((( 1909 +Массив наименований параметров в сообщении 1910 +))) 1911 + 1912 +Ответ: 1913 + 1914 +{ 1915 + "protocolType": 0, 1916 + "mapping": { 1917 + "additionalProp1": { 1918 + "inputType": 0, 1919 + "inputNumber": 0 1920 + }, 1921 + "additionalProp2": { 1922 + "inputType": 0, 1923 + "inputNumber": 0 1924 + } 1925 + } 1926 +} 1927 + 1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1929 +|protocolType|Тип протокола 1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1931 +|inputNumber|Номер входа 1932 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1958 +|vehicleId|ID объекта 1959 +|from|Дата и время начала периода запроса 1960 +|to|Дата и время окончания периода запроса 1961 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1968 + "deviceTime": "2023-11-29T07:40:44.052Z", 1969 + "serverTime": "2023-11-29T07:40:44.052Z", 1970 + "speed": 0, 1971 + "altitude": 0, 1972 + "latitude": 0, 1973 + "longitude": 0, 1974 + "satellites": 0, 1975 + "course": 0, 1976 + "voltage": 0, 1977 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 1982 + "photoCount": 0, 1983 + "lbsCorrectedCoords": true, 1984 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1991 +|deviceTime|Время сообщения терминала 1992 +|serverTime|Время когда сообщение поступило на сервер 1993 +|speed|Скорость 1994 +|altitude|Высота над уровнем моря 1995 +|latitude|Широта 1996 +|longitude|Долгота 1997 +|satellites|Кол-во спутников 1998 +|course|Курс 1999 +|voltage|Бортовое напряжение 2000 +|parameters|Список параметров и их значений 2001 +|photoCount|Количество фото 2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2003 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2029,6 +2029,142 @@ 2029 2029 } 2030 2030 ] 2031 2031 2138 + 2139 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2140 + 2141 +(% class="box infomessage" %) 2142 +((( 2143 +**POST /api/v3/vehicles/moveStop** 2144 +))) 2145 + 2146 +Метод запроса: **POST** 2147 + 2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2149 + 2150 +В заголовках запроса: X-Auth: Токен авторизации 2151 + 2152 + 2153 +Тело запроса: 2154 + 2155 +{ 2156 + 2157 + "vehicleIds": [ ], ~/~/ Список ID объектов 2158 + 2159 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2160 + 2161 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2162 + 2163 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2164 + 2165 +} 2166 + 2167 +Ответ: 2168 + 2169 +[ 2170 + 2171 + { 2172 + 2173 + "vehicleId": 0, ~/~/ ID объекта 2174 + 2175 + "vehicleName": "string", ~/~/ Имя объекта 2176 + 2177 + "moves": [ ~/~/ Событие движения 2178 + 2179 + { 2180 + 2181 + "mileage": 0, ~/~/ Пробег, км 2182 + 2183 + "eventId": 0, ~/~/ Идентификатор события 2184 + 2185 + "eventName": "string", ~/~/ Название события 2186 + 2187 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2188 + 2189 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2190 + 2191 + "duration": 0 ~/~/ Продолжительность события, секунд 2192 + 2193 + } 2194 + 2195 + ], 2196 + 2197 + "stops": [ ~/~/ События стоянок 2198 + 2199 + { 2200 + 2201 + "address": "string", ~/~/ Адрес события 2202 + 2203 + "eventId": 0, ~/~/ Идентификатор события 2204 + 2205 + "eventName": "string", ~/~/ Название события 2206 + 2207 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2208 + 2209 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2210 + 2211 + "duration": 0 ~/~/ Продолжительность события, секунд 2212 + 2213 + 2214 + } 2215 + 2216 + ] 2217 + 2218 + } 2219 + 2220 +] 2221 + 2222 + 2223 + 2224 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2225 + 2226 +(% class="box infomessage" %) 2227 +((( 2228 +**POST /api/v3/vehicles/getlastdata** 2229 +))) 2230 + 2231 +Метод запроса: **POST** 2232 + 2233 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2234 + 2235 +В заголовках запроса: X-Auth: Токен авторизации 2236 + 2237 + 2238 +Тело запроса: 2239 + 2240 +{ 2241 + 2242 + "vehicleIds": [ ], ~/~/ Список ID машины 2243 + 2244 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2245 + 2246 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2247 + 2248 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2249 + 2250 +} 2251 + 2252 + 2253 +Ответ: 2254 + { 2255 + "vehicleId": 0, ~/~/Идентификатор объекта. 2256 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2257 + "vehicleNumber": "string",~/~/Номер объекта. 2258 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2259 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на траспортном средстве. 2260 + "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных. 2261 + "speed": 0,~/~/Скорость объекта. 2262 + "course": 0,~/~/Курс движения [0;360] 2263 + "latitude": 0,~/~/Широта [-90°;90°]. 2264 + "longitude": 0,~/~/Долгота [-180°;180°]. 2265 + "address": "string",~/~/Адрес. 2266 + "geozones": [ ~/~/Сведения по геозонам. 2267 + { 2268 + "id": 0, 2269 + "name": "string" 2270 + } 2271 + 2272 + 2273 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3172 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3173 + 3174 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3175 + 3176 +(% class="box infomessage" %) 3177 +((( 3178 +**POST /api/v3/Trailers** 3179 +))) 3180 + 3181 +Пример запроса: 3182 + 3183 +{ 3184 + "startDate": "2023-11-14T10:48:03.671Z", 3185 + "endDate": "2023-11-14T10:48:03.671Z", 3186 + "ids": [ 0 ], 3187 + "timezone": 0 3188 +} 3189 + 3190 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3191 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3192 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3193 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3194 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3195 + 3196 +Пример ответа: 3197 + 3198 +[ 3199 + { 3200 + "SD": "2023-11-14T10:48:03.717Z", 3201 + "ED": "2023-11-14T10:48:03.717Z", 3202 + "id": 0, 3203 + "SLat": 0, 3204 + "SLon": 0, 3205 + "ELat": 0, 3206 + "ELon": 0, 3207 + "mileage": 0 3208 + "Duration": 0 3209 + "Address": "string", 3210 + "Address2": "string", 3211 + "name": "string", 3212 + "rid": "string", 3213 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3214 + "trailer": { 3215 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3216 + "Number": "string", 3217 + "Description": "string", 3218 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3219 + "ExternalID": "string", 3220 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3221 + "CreateTime": "2023-11-14T10:48:03.717Z", 3222 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3223 + "IsDeleted": true 3224 + }, 3225 + "filesCount": 0, 3226 + } 3227 +] 3228 + 3229 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3230 +|SD|Дата и время начала события 3231 +|ED|Дата и время окончания события 3232 +|id|ID объекта 3233 +|SLat|Широта начальной координаты 3234 +|SLon|Долгота начальной координаты 3235 +|ELat|Широта конечной координаты 3236 +|ELon|Долгота конечной координаты 3237 +|mileage|Пробег 3238 +|Duration|Продолжительность 3239 +|Address|Адрес начального местоположения 3240 +|Address2|Адрес конечного местоположения 3241 +|name|Имя радиометки 3242 +|rid|Номер радиометки 3243 +|rguid|ID радиометки 3244 +|trailer|Информация об агрегате 3245 +|ModelGuid|ID агрегата 3246 +|Number|Название/номер агрегата 3247 +|Description|Текст примечания агрегата 3248 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,19 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3270 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3276 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3277 +|parentId|ID клиента 3278 +|name|Название карты-метки 3279 +|number|Номер 3280 +|period|Период запросов в секундах (работает только для агрегатов) 3281 +|id|ID карты-метки 3282 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -2970,13 +2970,18 @@ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки3298 + "period": 0, 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 - "deleted": true 2977 2977 } 2978 2978 ] 2979 2979 3304 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3305 +|name|Название карты-метки 3306 +|number|Номер 3307 +|period|Период запросов в секундах (работает только для агрегатов) 3308 +|id|ID карты-метки 3309 +|parentId|ID клиента 2980 2980 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 ... ... @@ -2992,7 +2992,6 @@ 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 - "deleted": true 2996 2996 } 2997 2997 2998 2998 Ответ: ... ... @@ -3003,9 +3003,15 @@ 3003 3003 "period": 0, 3004 3004 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 - "deleted": true 3007 3007 } 3008 3008 3337 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3338 +|name|Название карты-метки 3339 +|number|Номер 3340 +|period|Период запросов в секундах (работает только для агрегатов) 3341 +|id|ID карты-метки 3342 +|parentId|ID клиента 3343 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3021,7 +3021,6 @@ 3021 3021 "period": 0, 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 - "deleted": true 3025 3025 } 3026 3026 3027 3027 Ответ: ... ... @@ -3032,9 +3032,15 @@ 3032 3032 "period": 0, 3033 3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 - "deleted": true 3036 3036 } 3037 3037 3371 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3372 +|name|Название карты-метки 3373 +|number|Номер 3374 +|period|Период запросов в секундах (работает только для агрегатов) 3375 +|id|ID карты-метки 3376 +|parentId|ID клиента 3377 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3042,7 +3042,7 @@ 3042 3042 **DELETE /api/v3/Rfids/{rfidGuid}** 3043 3043 ))) 3044 3044 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3385 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3283,6 +3283,8 @@ 3283 3283 **PUT /api/v3/Billing/client/balance** 3284 3284 ))) 3285 3285 3626 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3627 + 3286 3286 Тело запроса: 3287 3287 3288 3288 { ... ... @@ -3296,6 +3296,50 @@ 3296 3296 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 3297 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 3298 3641 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3642 + 3643 +(% class="box warningmessage" %) 3644 +((( 3645 +**PUT /api/v3/billing/client/balance/deposit** 3646 +))) 3647 + 3648 +Создает операцию **Пополнение **с указанной суммой 3649 + 3650 +Тело запроса: 3651 + 3652 +{ 3653 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3654 + "Balance": 0 3655 +} 3656 + 3657 +Ответ: Success 3658 + 3659 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3660 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3661 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3662 + 3663 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3664 + 3665 +Создает операцию **Списание **с указанной суммой 3666 + 3667 +(% class="box warningmessage" %) 3668 +((( 3669 +**PUT /api/v3/billing/client/balance/withdraw** 3670 +))) 3671 + 3672 +Тело запроса: 3673 + 3674 +{ 3675 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3676 + "Balance": 0 3677 +} 3678 + 3679 +Ответ: Success 3680 + 3681 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3682 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3683 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3684 + 3299 3299 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 3300 3301 3301 (% class="box warningmessage" %) ... ... @@ -3358,6 +3358,7 @@ 3358 3358 3359 3359 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3360 3360 |ClientId|Идентификатор клиента 3747 +|PlanId|Идентификатор тарифного плана 3361 3361 |Feature|Код услуги 3362 3362 |IsEnabled|Признак, определяющий активирована ли услуга 3363 3363 |IsFactual|Признак, определяющий расчёт по факту ... ... @@ -3367,6 +3367,305 @@ 3367 3367 |PeriodValue|Значение периода. 3368 3368 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3369 3369 3757 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3758 + 3759 +(% class="box warningmessage" %) 3760 +((( 3761 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3762 +))) 3763 + 3764 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3765 + 3766 +(% class="box infomessage" %) 3767 +((( 3768 +**POST /api/v3/vehicles/import/{agentId}** 3769 +))) 3770 + 3771 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3772 + 3773 +В пути указывается **agentId** - id клиента. 3774 + 3775 +**Заголовок** 3776 + 3777 +**X-Auth: [токен авторизации]** 3778 + 3779 +**Параметры** 3780 + 3781 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3782 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3783 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3784 + 3785 +В теле использовать тип **form-data,** тип значения** file** 3786 + 3787 +**Ключи** 3788 + 3789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3790 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3791 +|csv|В значении передаем файл датчиков, формат **csv** 3792 + 3793 +Ответ: 3794 + 3795 +{ 3796 + "vehicleId": 0, 3797 + "name": "string", 3798 + "errors": ["string"] 3799 +} 3800 + 3801 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3802 +|vehicleId|ID созданного объекта 3803 +|name|Имя созданного объекта 3804 +|errors|Ошибки и их описание 3805 + 3806 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3807 + 3808 +(% class="box infomessage" %) 3809 +((( 3810 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3811 +))) 3812 + 3813 +(% class="wikigeneratedid" %) 3814 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3815 + 3816 +(% class="wikigeneratedid" %) 3817 +В пути указывается **vehicleId **- id объекта. 3818 + 3819 +**Заголовок** 3820 + 3821 +**X-Auth: [токен авторизации]** 3822 + 3823 +В теле использовать тип **form-data.** 3824 + 3825 +Ключи: 3826 + 3827 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3828 +|**history**|В значении передавать файл с историей 3829 + 3830 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3831 + 3832 +Ответ: 3833 + 3834 +{ 3835 + "results": [ 3836 + { 3837 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3838 + "vehicleId": 0, 3839 + "errors": [ 3840 + "string" 3841 + ], 3842 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3843 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3844 + "producedCount": 0, 3845 + "msgCount": 0 3846 + } 3847 + ] 3848 +} 3849 + 3850 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3851 +|results|Результаты импорта в разрезе ТС 3852 +|vehicleGuid|Guid ТС 3853 +|vehicleId|ID ТС 3854 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3855 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3856 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3857 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3858 +|msgCount|Кол-во обработанных сообщений всего 3859 + 3860 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3861 + 3862 +(% class="box infomessage" %) 3863 +((( 3864 +**GET /api/v3/vehicles/import/history/status** 3865 +))) 3866 + 3867 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3868 + 3869 +Ответ: 3870 + 3871 +{ 3872 + "activity": true, 3873 + "progress": 0, 3874 + "message": "string" 3875 +} 3876 + 3877 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3878 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3879 +|progress|Guid ТС 3880 + 3881 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3882 + 3883 +(% class="box infomessage" %) 3884 +((( 3885 +**POST /api/v3/vehicles/export** 3886 +))) 3887 + 3888 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3889 + 3890 +Тело запроса: 3891 + 3892 +[ 3893 + id 3894 +] 3895 + 3896 +Ответ: Success 200, получаете файлы с настройками. 3897 + 3898 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3899 + 3900 +(% class="box infomessage" %) 3901 +((( 3902 +**POST /api/v3/vehicles/export/history** 3903 +))) 3904 + 3905 +Метод возвращает список сообщений терминала объекта за выбранный период. 3906 + 3907 +Тело запроса: 3908 + 3909 +{ 3910 + "vehicleId": 0, 3911 + "asArchive": true, 3912 + "from": "2023-09-27T12:17:45.973Z", 3913 + "to": "2023-09-27T12:17:45.973Z" 3914 +} 3915 + 3916 +Ответ: 3917 + 3918 +Получаете файл. Сообщение: Code 200/Success 3919 + 3920 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3921 +|vehicleId|ID объекта 3922 +|asArchive|true - Архивировать файл, False - не архивировать 3923 +|from|Дата и время начала запроса 3924 +|to|Дата и время окончания запроса 3925 + 3926 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3927 + 3928 +(% class="box infomessage" %) 3929 +((( 3930 +**GET /api/v3/vehicles/export/history/status** 3931 +))) 3932 + 3933 +Метод возвращает список сообщений терминала объекта за выбранный период. 3934 + 3935 +Ответ: 3936 + 3937 +{ 3938 + "activity": true, 3939 + "progress": 0, 3940 + "message": "string" 3941 +} 3942 + 3943 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3944 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3945 +|progress|Прогресс экспорта, от 0 до 100% 3946 +|message|Текст описывающий статус 3947 + 3948 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3949 + 3950 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3951 + 3952 +(% class="box infomessage" %) 3953 +((( 3954 +**POST /api/v3/EcoDriving/rating** 3955 +))) 3956 + 3957 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3958 + 3959 +Тело запроса: 3960 + 3961 +{ 3962 + "vehicleIds": [vehicleId], 3963 + "from": "2023-11-22T09:29:48.051Z", 3964 + "to": "2023-11-22T09:29:48.051Z" 3965 +} 3966 + 3967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3968 +|vehicleIds|Массив ID объектов 3969 +|from|Дата начала запроса 3970 +|to|Дата окончания запроса 3971 + 3972 +Ответ: 3973 + 3974 +{ 3975 + "items": [ 3976 + { 3977 + "from": "2023-11-22T09:29:48.052Z", 3978 + "to": "2023-11-22T09:29:48.052Z", 3979 + "vehicleId": 0, 3980 + "vehicleName": "string", 3981 + "vehicleModel": "string", 3982 + "penalty": 0, 3983 + "score": 0, 3984 + "totalViolations": 0, 3985 + "violationsByType": { 3986 + "overspeedingViolations": 0, 3987 + "accelerationViolations": 0, 3988 + "brakingViolations": 0, 3989 + "turningViolations": 0, 3990 + "dangerousDrivingViolations": 0, 3991 + "sensorViolations": 0 3992 + }, 3993 + "moveTime": 0, 3994 + "mileage": 0, 3995 + "tripsCount": 0, 3996 + "trips": [ 3997 + { 3998 + "penalty": 0, 3999 + "score": 0, 4000 + "violationsCount": 0, 4001 + "violationsByType": { 4002 + "overspeedingViolations": 0, 4003 + "accelerationViolations": 0, 4004 + "brakingViolations": 0, 4005 + "turningViolations": 0, 4006 + "dangerousDrivingViolations": 0, 4007 + "sensorViolations": 0 4008 + }, 4009 + "moveTime": 0, 4010 + "mileage": 0, 4011 + "motohours": 0, 4012 + "maxSpeed": 0, 4013 + "startAddress": "string", 4014 + "endAddress": "string", 4015 + "drivers": [ 4016 + { 4017 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4018 + "driverName": "string", 4019 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4020 + } 4021 + ] 4022 + } 4023 + ] 4024 + } 4025 + ] 4026 +} 4027 + 4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4029 +|from|Дата начала запроса 4030 +|to|Дата окончания 4031 +|vehicleId|ID объекта 4032 +|vehicleName|Имя объекта 4033 +|vehicleModel|Модель объекта 4034 +|penalty|Сумма штрафных баллов 4035 +|score|Оценка 4036 +|totalViolations|Суммарное количество нарушений 4037 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4038 +|overspeedingViolations|Превышение скорости 4039 +|accelerationViolations|Ускорение 4040 +|brakingViolations|Торможение 4041 +|turningViolations|Резкий поворот 4042 +|dangerousDrivingViolations|Резкое вождение 4043 +|sensorViolations|Нарушение по датчику 4044 +|moveTime|Время в движении 4045 +|mileage|Пробег 4046 +|tripsCount|Количество рейсов 4047 +|motohours|Моточасы 4048 +|maxSpeed|Максимальная скорость 4049 +|startAddress|Адрес начала рейса 4050 +|endAddress|Адрес окончания рейса 4051 +|drivers|Список водителей, которые были на объекте в течениии рейса 4052 +|driverGuid|Guid водителя 4053 +|driverName|Имя водителя 4054 +|driverRfid|Номер Карты-метки 4055 + 3370 3370 (% class="box" lang="en-US" style="text-align: center;" %) 3371 3371 ((( 3372 3372 (% 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,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB -
Content