Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
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" %) ... ... @@ -62,7 +62,7 @@ 62 62 (% lang="en-US" %)**GET /api/v3/auth/check** 63 63 ))) 64 64 65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).70 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 66 66 67 67 (% style="color:#000000" %)Метод запроса: **GET** 68 68 ... ... @@ -82,7 +82,7 @@ 82 82 **GET api/v3/agents/{id}** 83 83 ))) 84 84 85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):90 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 86 86 87 87 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 88 88 ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 - 97 97 { 98 - "agentId": "", (%style="color:#000000" %)~/~/ идентификатор клиента(%%)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" %) ... ... @@ -124,13 +124,13 @@ 124 124 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 125 125 ))) 126 126 127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):153 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 128 128 129 129 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 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" %) ... ... @@ -161,7 +161,7 @@ 161 161 **POST /api/v3/agents ** 162 162 ))) 163 163 164 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).198 +Метод позволяет добавить клиента, указанного в запросе. 165 165 166 166 Метод запроса: **POST** 167 167 ... ... @@ -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" %) ... ... @@ -224,7 +224,7 @@ 224 224 **PUT /api/v3/agents** 225 225 ))) 226 226 227 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).283 +Метод позволяет отредактировать клиента, указанного в запросе. 228 228 229 229 Метод запроса: **PUT** 230 230 ... ... @@ -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 { ... ... @@ -288,7 +288,7 @@ 288 288 **DELETE /api/v3/agents/{clientId}** 289 289 ))) 290 290 291 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).345 +Метод позволяет удалить клиента, указанного в строке запроса. 292 292 293 293 Метод запроса: **DELETE** 294 294 ... ... @@ -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" %)**Добавление пользователя**(%%) == ... ... @@ -309,7 +309,7 @@ 309 309 (% lang="en-US" %)**POST /api/v3/users** 310 310 ))) 311 311 312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).381 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 313 313 314 314 (% style="color:#000000" %)Метод запроса: **POST** 315 315 ... ... @@ -319,7 +319,8 @@ 319 319 320 320 (% style="color:#000000" %)Параметры в теле запроса (JSON): 321 321 322 -(% style="color:#000000" %){ 391 +(% style="color:#000000" %) 392 +{ 323 323 "lastName": "", ~/~/ фамилия 324 324 "firstName": "", ~/~/ имя 325 325 "position": "", ~/~/ должность ... ... @@ -328,17 +328,40 @@ 328 328 "login": "", ~/~/ логин (обязателен) 329 329 "password": "", ~/~/ пароль (обязателен) 330 330 "email": "", ~/~/ email (обязателен) 331 - "description": "", ~/~/ описание 332 - "isEnabled": "", ~/~/ признак включения 401 + "description": "string", ~/~/ Описание 402 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 403 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 404 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 333 333 "parentId": "", ~/~/ Guid родительского агента 334 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 335 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 336 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 337 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 338 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 339 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 406 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 407 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 408 + "doubleAuth": 409 + { 410 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 411 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 412 + }, 413 + "groups": 414 + [ 415 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 416 + ], 417 + "customGroups": 418 + [ 419 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 420 + ], 421 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 340 340 } 341 341 424 +{ 425 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 426 + "lastName": "string", 427 + "firstName": "string", 428 + "position": "string", 429 + "phone": "string", 430 + "organization": "string", 431 + "login": "string", 432 + "password": "string", 433 + "email": "string", 434 + 342 342 (% style="text-align:left" %) 343 343 (% style="color:#000000; font-weight:normal" %)Ответ: 344 344 ... ... @@ -367,6 +367,7 @@ 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)} 369 369 463 + 370 370 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 371 371 372 372 (% class="box infomessage" %) ... ... @@ -411,7 +411,7 @@ 411 411 "email": "" , ~/~/ E-mail 412 412 "sessionDuration":"", ~/~/ длительность сессии в минутах 413 413 "status": "1", ~/~/ статус пользователя 414 - "astLogged": "", ~/~/ дата/время последней авторизации 508 + "lastLogged": "", ~/~/ дата/время последней авторизации 415 415 416 416 (% style="color:#000000" %)} 417 417 ... ... @@ -449,9 +449,9 @@ 449 449 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 450 450 "description": "", ~/~/ Описание 451 451 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 452 - "doubleAuth": 546 + "doubleAuth": 453 453 { 454 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, true - включен,false - отключен548 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 455 455 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 456 456 }, 457 457 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен ... ... @@ -474,7 +474,7 @@ 474 474 (% lang="en-US" %)**PUT /api/v3/users** 475 475 ))) 476 476 477 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).571 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 478 478 479 479 (% style="color:#000000" %)Метод запроса: **PUT** 480 480 ... ... @@ -496,7 +496,9 @@ 496 496 "phone": "" , ~/~/ телефон 497 497 "organization": "" , ~/~/ организация 498 498 "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 499 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 593 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 594 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 595 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 500 500 "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 501 501 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 502 502 "isEnabled": "" , ~/~/ признак включения ... ... @@ -503,9 +503,12 @@ 503 503 "parentId": "" , ~/~/ Guid родительского агента 504 504 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 505 505 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 506 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 507 - "kind": "" , ~/~/ тип аутентификации 508 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 602 + "doubleAuth": 603 + { 604 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 605 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 606 + }, 607 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 509 509 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 510 510 511 511 (% lang="en-US" style="text-align:left" %) ... ... @@ -531,8 +531,12 @@ 531 531 "isEnabled": "" , ~/~/ признак включения 532 532 "parentId": "" , ~/~/ Guid родительского агента 533 533 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 534 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 535 - "kind": "" , ~/~/ тип аутентификации 633 + "doubleAuth": 634 + { 635 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 636 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 637 + }, 638 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 536 536 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 537 537 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 538 538 ... ... @@ -546,7 +546,7 @@ 546 546 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 547 547 ))) 548 548 549 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).652 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 550 550 551 551 (% style="color:#000000" %)Метод запроса: **PUT** 552 552 ... ... @@ -576,7 +576,7 @@ 576 576 **POST /api/v3/users/disable** 577 577 ))) 578 578 579 -Метода позволяет выполнить массовую блокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).682 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 580 580 581 581 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 582 582 ... ... @@ -598,7 +598,7 @@ 598 598 **POST /api/v3/users/enable** 599 599 ))) 600 600 601 -Метода позволяет выполнить массовую разблокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).704 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 602 602 603 603 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 604 604 ... ... @@ -635,7 +635,7 @@ 635 635 (% lang="en-US" %)**DELETE /api/v3/users/{id}** 636 636 ))) 637 637 638 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).741 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 639 639 640 640 (% style="color:#000000" %)Метод запроса: **DELETE** 641 641 ... ... @@ -648,6 +648,249 @@ 648 648 (% style="text-align:left" %) 649 649 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 650 650 754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 755 + 756 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 757 + 758 +(% class="box infomessage" %) 759 +((( 760 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 761 +))) 762 + 763 +Метод возвращает полную информацию о модели объекта. 764 + 765 +(% style="color:#000000" %)Метод запроса: **GET** 766 + 767 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 768 + 769 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 770 + 771 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 772 + 773 +(% style="color:#000000" %)Ответ: 774 + 775 +(% style="color:#000000" %){ 776 + "parentName": "string", 777 + "name": "string", 778 + "picture": "string", 779 + "minspeed": 0, 780 + "maxspeed": 0, 781 + "width": 0, 782 + "imbeddedtrailer": true, 783 + "hoppercapacity": 0, 784 + "hopperdischargespeed": 0, 785 + "modelType": 0, 786 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 787 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 788 + "deleted": true 789 +} 790 + 791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 792 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 793 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 794 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 795 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 796 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 797 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 798 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 799 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 800 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 801 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 802 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 803 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 804 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 805 + 806 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 807 + 808 +(% class="box successmessage" %) 809 +((( 810 +(% lang="en-US" %)**POST /api/v3/models/find** 811 +))) 812 + 813 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 814 + 815 +(% style="color:#000000" %)Метод запроса: **POST** 816 + 817 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 818 + 819 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 820 + 821 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 822 + 823 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 824 +} 825 + 826 +(% style="color:#000000" %)Ответ: 827 + 828 +(% style="color:#000000" %)[ 829 + { 830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 832 + "parentName": "string", 833 + "name": "string", 834 + "modelType": 0 835 + } 836 +] 837 + 838 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 839 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 840 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 842 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 843 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 844 + 845 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 846 + 847 +(% class="box successmessage" %) 848 +((( 849 +(% lang="en-US" %)**POST /api/v3/models** 850 +))) 851 + 852 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 853 + 854 +(% style="color:#000000" %)Метод запроса: **POST** 855 + 856 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 857 + 858 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 859 + 860 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 861 + 862 +{ 863 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 864 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 865 + "deleted": true, 866 + "extId": "string", 867 + "name": "string", 868 + "picture": "string", 869 + "minspeed": 0, 870 + "maxspeed": 0, 871 + "width": 0, 872 + "imbeddedtrailer": true, 873 + "fueloutlay": 0, 874 + "hoppercapacity": 0, 875 + "hopperdischargespeed": 0, 876 + "modelType": 0 877 +} 878 + 879 +Ответ: 880 + 881 +{ 882 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 883 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 884 + "deleted": true, 885 + "extId": "string", 886 + "name": "string", 887 + "picture": "string", 888 + "minspeed": 0, 889 + "maxspeed": 0, 890 + "width": 0, 891 + "imbeddedtrailer": true, 892 + "hoppercapacity": 0, 893 + "hopperdischargespeed": 0, 894 + "modelType": 0 895 +} 896 + 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 910 + 911 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 912 + 913 +(% class="box warningmessage" %) 914 +((( 915 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 916 +))) 917 + 918 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 919 + 920 +(% style="color:#000000" %)Метод запроса: **PUT** 921 + 922 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 923 + 924 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 925 + 926 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 927 + 928 +{ 929 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 931 + "deleted": true, 932 + "extId": "string", 933 + "name": "string", 934 + "picture": "string", 935 + "minspeed": 0, 936 + "maxspeed": 0, 937 + "width": 0, 938 + "imbeddedtrailer": true, 939 + "fueloutlay": 0, 940 + "hoppercapacity": 0, 941 + "hopperdischargespeed": 0, 942 + "modelType": 0 943 +} 944 + 945 +Ответ: 946 + 947 +{ 948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 949 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 950 + "deleted": true, 951 + "extId": "string", 952 + "name": "string", 953 + "picture": "string", 954 + "minspeed": 0, 955 + "maxspeed": 0, 956 + "width": 0, 957 + "imbeddedtrailer": true, 958 + "fueloutlay": 0, 959 + "hoppercapacity": 0, 960 + "hopperdischargespeed": 0, 961 + "modelType": 0 962 +} 963 + 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 + 978 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 979 + 980 +(% class="box errormessage" %) 981 +((( 982 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 983 +))) 984 + 985 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 986 + 987 +(% style="color:#000000" %)Метод запроса: **DELETE** 988 + 989 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 990 + 991 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 992 + 993 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 994 + 995 +Ответ: В случае успеха **Success 200** 996 + 651 651 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 652 652 653 653 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -659,7 +659,7 @@ 659 659 660 660 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 661 661 662 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):1008 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 663 663 664 664 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 665 665 ... ... @@ -667,9 +667,9 @@ 667 667 668 668 (% style="color:#000000" %)Метод запроса: **GET** 669 669 670 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %) <(% lang="en-US" %)v(%%)ehicleID>1016 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID} 671 671 672 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)1018 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 673 673 674 674 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 675 675 ... ... @@ -683,20 +683,148 @@ 683 683 "deviceTypeId": , ~/~/ ID типа устройства 684 684 "deviceTypeName": "", ~/~/ Название типа устройства 685 685 "sim1": "", ~/~/ Номер SIM1 686 - "parentId": "", Номер SIM2 687 - "parentName": "", Наименование клиента-родителя 688 - "modelId": "", ID модели объекта 689 - "modelName": "", Имя модели объекта 690 - "createdAt": "", Дата создания объекта 691 - "mileageCalcMethod": "", Выбранный метод расчета пробега 692 - "counters": { ~/~/ Нормы 693 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 694 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 695 - "mileage": "", ~/~/ Пробег по нормам в метрах 696 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 697 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 698 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 1032 + "sim2": "", ~/~/ Номер SIM2 1033 + 1034 + "parentId": "", ~/~/ ID клиента-родителя 1035 + "parentName": "", ~/~/ Наименование клиента-родителя 1036 + "modelId": "", ~/~/ ID модели объекта 1037 + "modelName": "", ~/~/ Имя модели объекта 1038 + 1039 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1040 + "unitName": "string", ~/~/ Наименование подразделения 1041 + "status": 0, ~/~/ Статус объекта 1042 + 1043 + "createdAt": "", ~/~/ Дата создания объекта 699 699 }, 1045 + 1046 +"customFields": [ ~/~/ Произвольные поля 1047 + { 1048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1049 + "name": "string", ~/~/ Имя поля 1050 + "value": "string", ~/~/ Значение поля 1051 + "forClient": true, ~/~/ Не используемая функция 1052 + "forTooltip": true, ~/~/ Отображать в подсказке 1053 + "forReport": true ~/~/ Отображать в отчете 1054 + } 1055 + 1056 +], ~/~/ Данные с вкладки нормы 1057 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1058 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1059 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1060 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1061 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1062 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1063 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1064 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1065 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1066 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1067 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1068 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1069 + 1070 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1071 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1072 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1073 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1074 + "counters": { ~/~/ Счетчики 1075 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1076 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1077 + "mileage": 0, ~/~/ Текущий пробег 1078 + "motohours": 0, ~/~/ Текущие моточасы 1079 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1080 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1081 + }, 1082 + 1083 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1084 + "id": "string", ~/~/ ID объекта 1085 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1086 + "host": "string", ~/~/ CMSV6 Web Host 1087 + "login": "string", ~/~/ CMSV6 Account 1088 + "password": "string" ~/~/ CMSV6 Password 1089 + }, 1090 + 1091 +"commandTemplates": [ ~/~/ Шаблоны команд 1092 + { 1093 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1094 + "name": "string", ~/~/ Наименование команды 1095 + "command": "string", ~/~/ Текст команды 1096 + "retries": 0 ~/~/ Количество попыток 1097 + } 1098 + ], 1099 + 1100 + "sensors": [ ~/~/ Датчики 1101 + { 1102 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1103 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1104 + "type": 0, ~/~/ Тип датчика 1105 + "name": "string", ~/~/ Имя датчика 1106 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1107 + "inputNumber": 0, ~/~/ Номер входа 1108 + "pseudonym": "string", ~/~/ Псевдоним 1109 + "medianDegree": 0, ~/~/ Медианная фильтрация 1110 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1111 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1112 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1113 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1114 + { 1115 + "grades": [ ~/~/ Таблица тарировки 1 1116 + { 1117 + "input": 0, ~/~/ Входящее значение 1118 + "output": 0 ~/~/ Выходящее значение 1119 + } 1120 + ], 1121 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1122 + } 1123 + ], 1124 + "showInTooltip": true, ~/~/ Отображать в подсказке 1125 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1126 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1127 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1128 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1129 + "expr": "string", ~/~/ Формула 1130 + "children": [ ~/~/ массив дочерних датчиков 1131 + "string" 1132 + ], 1133 + "customParams": { ~/~/ прочие произвольные параметры 1134 + "additionalProp1": "string", 1135 + "additionalProp2": "string", 1136 + "additionalProp3": "string" 1137 + }, 1138 + 1139 +~/~/ Характерные для произвольного: 1140 + 1141 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1142 + 1143 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1144 + 1145 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1146 + 1147 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1148 + 1149 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1150 + 1151 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1152 + 1153 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1154 + 1155 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1156 + 1157 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1158 + 1159 +~/~/ "ValueOn": "Вкл.", 1160 + 1161 +~/~/ "ValueOff": "Выкл." 1162 + "summaryMaxValue": 0 ~/~/ Макс. значение 1163 + } 1164 + 1165 + "drivers": [ ~/~/ Водители 1166 + { 1167 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1168 + "name": "string", ~/~/ Наименование 1169 + "description": "string", 1170 + "isDefault": true ~/~/ По умолчанию 1171 + } 1172 + ], 1173 + 700 700 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 701 701 { 702 702 "id": "", ~/~/ ID задания ... ... @@ -712,7 +712,17 @@ 712 712 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 713 713 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 714 714 } 715 - ] 1189 + ], 1190 + 1191 + "statusHistory": [ ~/~/ История статусов 1192 + { 1193 + "status": 0, 1194 + "date": "2023-05-22T09:57:39.562Z", 1195 + "description": "string", 1196 + "additionalInfo": "string" 1197 + } 1198 + ] 1199 + 716 716 } 717 717 ))) 718 718 ... ... @@ -729,7 +729,7 @@ 729 729 (% lang="en-US" %)**POST /api/v3/vehicles** 730 730 ))) 731 731 732 -(% style="color:#000000" %)Метод позволяет добавить объект . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).1216 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 733 733 734 734 (% style="color:#000000" %)Метод запроса: **POST** 735 735 ... ... @@ -761,6 +761,11 @@ 761 761 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 762 762 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 763 763 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1248 + 1249 + "mileageCalcMethod": 0, 1250 + "mileageCoeff": 0, 1251 + "locationByCellId": true, 1252 + "dottedLineTrackWhenNoCoords": true, 764 764 "counters": ~/~/ счетчики 765 765 { 766 766 "mileage": "" , ~/~/ пробег ... ... @@ -790,8 +790,98 @@ 790 790 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 791 791 } 792 792 793 -(% style="color:#000000" %) } 1282 +"drivers": [ ~/~/ Водители 1283 + { 1284 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1285 + "isDefault": true 1286 + } 1287 + ], 1288 + "commandTemplates": [ ~/~/ Шаблон команды 1289 + { 1290 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1291 + "name": "string", 1292 + "command": "string", 1293 + "retries": 0 1294 + } 1295 + ], 794 794 1297 + "sensors": [ ~/~/ Датчики 1298 + { 1299 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1300 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1301 + "type": 0, ~/~/ Тип датчика 1302 + "name": "string", ~/~/ Имя датчика 1303 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1304 + "inputNumber": 0, ~/~/ Номер входа 1305 + "pseudonym": "string", ~/~/ Псевдоним 1306 + "medianDegree": 0, ~/~/ Медианная фильтрация 1307 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1308 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1309 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1310 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1311 + { 1312 + "grades": [ ~/~/ Таблица тарировки 1 1313 + { 1314 + "input": 0, ~/~/ Входящее значение 1315 + "output": 0 ~/~/ Выходящее значение 1316 + } 1317 + ], 1318 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1319 + } 1320 + ], 1321 + "showInTooltip": true, ~/~/ Отображать в подсказке 1322 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1323 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1324 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1325 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1326 + "expr": "string", ~/~/ Формула 1327 + "children": [ ~/~/ массив дочерних датчиков 1328 + "string" 1329 + ], 1330 + "customParams": { ~/~/ прочие произвольные параметры 1331 + "additionalProp1": "string", 1332 + "additionalProp2": "string", 1333 + "additionalProp3": "string" 1334 + }, 1335 + 1336 +~/~/ Характерные для произвольного: 1337 + 1338 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1339 + 1340 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1341 + 1342 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1343 + 1344 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1345 + 1346 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1347 + 1348 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1349 + 1350 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1351 + 1352 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1353 + 1354 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1355 + 1356 +~/~/ "ValueOn": "Вкл.", 1357 + 1358 +~/~/ "ValueOff": "Выкл." 1359 + "summaryMaxValue": 0 ~/~/ Макс. значение 1360 + } 1361 + ], 1362 + "customFields": [ ~/~/ Произвольные поля 1363 + { 1364 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1365 + "name": "string", 1366 + "value": "string", 1367 + "forClient": true, 1368 + "forTooltip": true, 1369 + "forReport": true 1370 + } 1371 + ] 1372 +} 1373 + 795 795 (% style="color:#000000" %)Ответ: 796 796 797 797 (% style="color:#000000" %){ ... ... @@ -851,7 +851,7 @@ 851 851 852 852 (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 853 853 854 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):1433 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 855 855 856 856 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 857 857 ... ... @@ -931,7 +931,7 @@ 931 931 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 932 932 ))) 933 933 934 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1513 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 935 935 936 936 (% style="color:#000000" %)Метод запроса: **POST** 937 937 ... ... @@ -977,7 +977,7 @@ 977 977 (% lang="en-US" %)**PUT /api/v3/vehicles** 978 978 ))) 979 979 980 -(% style="color:#000000" %)Метод позволяет отредактировать объект . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1559 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 981 981 982 982 (% style="color:#000000" %)Метод запроса: **PUT** 983 983 ... ... @@ -987,18 +987,16 @@ 987 987 988 988 (% style="color:#000000" %)Параметры в теле запроса (JSON): 989 989 990 -(% style="color:#000000" %){ 991 - 992 -((( 993 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 994 - "parentId": "", ~/~/ ID клиента 995 - "name": "", ~/~/ имя ТС 996 - "imei": "", ~/~/ IMEI 997 - "deviceTypeId": "", ~/~/ ID типа устройства 998 - "modelId": "", ~/~/ , ID модели 999 - "unitId": "", ~/~/ подразделения 1000 - "sim1": "", ~/~/ SIM 1 1001 - "sim2": "", ~/~/ SIM2 (%%) 1569 +(% style="color:#000000" %){ 1570 + "vehicleId": , ~/~/ ID объекта 1571 + "parentId": "" , ~/~/ ID клиента 1572 + "name": "" , ~/~/ имя ТС 1573 + "imei": "" , ~/~/ IMEI 1574 + "deviceTypeId": "" , ~/~/ ID типа устройства 1575 + "modelId": "" , ~/~/ ID модели 1576 + "unitId": "" , ~/~/ ID подразделения 1577 + "sim1": "" , ~/~/ Номер SIM 1 1578 + "sim2": "" , ~/~/ Номер SIM2 1002 1002 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1003 1003 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1004 1004 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -1011,39 +1011,132 @@ 1011 1011 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1012 1012 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1013 1013 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1014 -(% style="color:#000000" %) "counters": 1015 - { 1016 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1017 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1018 - "mileage": "", ~/~/ пробег, в метрах 1019 - "motohours": "" ~/~/ моточасы, в секундах 1020 - } 1021 - "cmsv6Parameters": ~/~/ параметры CMSv6 1022 - { 1023 - "id": "", ~/~/ идентификатор 1024 - "enabled": true, ~/~/ флаг включения 1025 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1026 - "login": "", ~/~/ имя учетной записи 1027 - "password": "", ~/~/ пароль учетной записи 1028 - } 1029 - "inspectionTasks": ~/~/ задания на ТО 1030 - { 1031 - "id": "", ~/~/ ID задания 1032 - "enabled": false, ~/~/ Признак включения 1033 - "name": "", ~/~/ Имя задания 1034 - "description": "", ~/~/ Описание задания 1035 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1036 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1037 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1038 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1039 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1040 - "kind": "", ~/~/ Вид периодичности по времени 1041 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1042 - } 1043 -))) 1044 1044 1045 -(% style="color:#000000" %)} 1592 + "mileageCalcMethod": 0, 1593 + "mileageCoeff": 0, 1594 + "locationByCellId": true, 1595 + "dottedLineTrackWhenNoCoords": true, 1596 + "counters": ~/~/ счетчики 1597 + { 1598 + "mileage": "" , ~/~/ пробег 1599 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1600 + "motohours": "" , ~/~/ моточасы 1601 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1602 + }, 1603 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1604 + "enabled": true, ~/~/ флаг включения 1605 + "id": "" , ~/~/ идентификатор 1606 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1607 + "login": "" , ~/~/ имя учетной записи 1608 + "password": "" ~/~/ пароль учетной записи 1609 + }, 1610 + "inspectionTasks": ~/~/ задания на ТО 1611 + { 1612 + "enabled": "" , ~/~/ Признак включения 1613 + "name": "" , ~/~/ Имя задания 1614 + "description": "" , ~/~/ Описание задания 1615 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1616 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1617 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1618 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1619 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1620 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1621 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1622 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1623 + } 1046 1046 1625 +"drivers": [ ~/~/ Водители 1626 + { 1627 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1628 + "isDefault": true 1629 + } 1630 + ], 1631 + "commandTemplates": [ ~/~/ Шаблон команды 1632 + { 1633 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1634 + "name": "string", 1635 + "command": "string", 1636 + "retries": 0 1637 + } 1638 + ], 1639 + 1640 + "sensors": [ ~/~/ Датчики 1641 + { 1642 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1643 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1644 + "type": 0, ~/~/ Тип датчика 1645 + "name": "string", ~/~/ Имя датчика 1646 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1647 + "inputNumber": 0, ~/~/ Номер входа 1648 + "pseudonym": "string", ~/~/ Псевдоним 1649 + "medianDegree": 0, ~/~/ Медианная фильтрация 1650 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1651 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1652 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1653 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1654 + { 1655 + "grades": [ ~/~/ Таблица тарировки 1 1656 + { 1657 + "input": 0, ~/~/ Входящее значение 1658 + "output": 0 ~/~/ Выходящее значение 1659 + } 1660 + ], 1661 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1662 + } 1663 + ], 1664 + "showInTooltip": true, ~/~/ Отображать в подсказке 1665 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1666 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1667 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1668 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1669 + "expr": "string", ~/~/ Формула 1670 + "children": [ ~/~/ массив дочерних датчиков 1671 + "string" 1672 + ], 1673 + "customParams": { ~/~/ прочие произвольные параметры 1674 + "additionalProp1": "string", 1675 + "additionalProp2": "string", 1676 + "additionalProp3": "string" 1677 + }, 1678 + 1679 +~/~/ Характерные для произвольного: 1680 + 1681 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1682 + 1683 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1684 + 1685 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1686 + 1687 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1688 + 1689 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1690 + 1691 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1692 + 1693 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1694 + 1695 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1696 + 1697 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1698 + 1699 +~/~/ "ValueOn": "Вкл.", 1700 + 1701 +~/~/ "ValueOff": "Выкл." 1702 + "summaryMaxValue": 0 ~/~/ Макс. значение 1703 + } 1704 + ], 1705 + "customFields": [ ~/~/ Произвольные поля 1706 + { 1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1708 + "name": "string", 1709 + "value": "string", 1710 + "forClient": true, 1711 + "forTooltip": true, 1712 + "forReport": true 1713 + } 1714 + ] 1715 +} 1716 + 1047 1047 (% style="color:#000000" %)Ответ: 1048 1048 1049 1049 (% lang="en-US" style="text-align:left" %) ... ... @@ -1094,7 +1094,7 @@ 1094 1094 (% lang="en-US" style="text-align:left" %) 1095 1095 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1096 1096 1097 -** валидация:**1767 +**Валидация:** 1098 1098 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1099 1099 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1100 1100 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. ... ... @@ -1106,7 +1106,7 @@ 1106 1106 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1107 1107 ))) 1108 1108 1109 -(% style="color:#000000" %)Метод позволяет удалить объект . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1779 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1110 1110 1111 1111 (% style="color:#000000" %)Метод запроса: **DELETE** 1112 1112 ... ... @@ -1128,11 +1128,11 @@ 1128 1128 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1129 1129 ))) 1130 1130 1131 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1801 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1132 1132 1133 1133 (% style="color:#000000" %)Метод запроса: **GET** 1134 1134 1135 -(% 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]] 1136 1136 1137 1137 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1138 1138 ... ... @@ -1155,7 +1155,7 @@ 1155 1155 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1156 1156 ))) 1157 1157 1158 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1828 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1159 1159 1160 1160 (% style="color:#000000" %)Метод запроса: **GET** 1161 1161 ... ... @@ -1174,7 +1174,7 @@ 1174 1174 (% style="text-align:left" %) 1175 1175 (% style="color:#000000" %)} 1176 1176 1177 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **С татистика**(%%) =1847 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1178 1178 1179 1179 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1180 1180 ... ... @@ -1184,7 +1184,7 @@ 1184 1184 ))) 1185 1185 1186 1186 (% style="text-align: left;" %) 1187 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1857 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1188 1188 1189 1189 (% style="text-align: left;" %) 1190 1190 Метод запроса **POST** ... ... @@ -1215,7 +1215,2161 @@ 1215 1215 } 1216 1216 ] 1217 1217 1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1218 1218 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 + 1933 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1934 + 1935 +(% class="box infomessage" %) 1936 +((( 1937 +**POST /api/v3/terminalMessages** 1938 +))) 1939 + 1940 +Метод возвращает список сообщений терминала объекта за выбранный период. 1941 + 1942 +(% style="text-align: left;" %) 1943 +Метод запроса **POST** 1944 + 1945 +(% style="text-align: left;" %) 1946 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1947 + 1948 +(% style="text-align: left;" %) 1949 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1950 + 1951 +{ 1952 + "vehicleId": 0, ~/~/ id объекта 1953 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1954 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1955 +} 1956 + 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 + 1962 +Ответ: 1963 + 1964 +[ 1965 + { 1966 + "messages": [ 1967 + { 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": { 1978 + "additionalProp1": "string", 1979 + "additionalProp2": "string", 1980 + "additionalProp3": "string" 1981 + }, 1982 + "photoCount": 0, 1983 + "lbsCorrectedCoords": true, 1984 + "protocolType": 0 1985 + } 1986 + ] 1987 + } 1988 +] 1989 + 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 типа протокола 2004 + 2005 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2006 + 2007 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2008 + 2009 +(% class="box infomessage" %) 2010 +((( 2011 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2012 +))) 2013 + 2014 +(% style="color:#000000" %)Метод запроса: **POST** 2015 + 2016 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2017 + 2018 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2019 + 2020 +(% style="text-align:left" %) 2021 +Тело запроса: 2022 + 2023 +{ 2024 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2025 + "vehicleIds": [0], ~/~/ Список ID объектов 2026 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2027 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2028 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2029 +} 2030 + 2031 +Ответ: 2032 + 2033 +[ 2034 + { 2035 + "vehicleId": 0, ~/~/ ID объекта 2036 + "name": "string", ~/~/ Имя ТС 2037 + "periods": [ ~/~/ Периоды 2038 + { 2039 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2040 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2041 + "mileageBegin": 0, ~/~/ Пробег на начало периода 2042 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 2043 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2044 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2045 + } 2046 + ] 2047 + } 2048 +] 2049 + 2050 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2051 + 2052 +(% class="box infomessage" %) 2053 +((( 2054 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2055 +))) 2056 + 2057 +(% style="color:#000000" %)Метод запроса: **POST** 2058 + 2059 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2060 + 2061 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2062 + 2063 +(% style="text-align:left" %) 2064 +Тело запроса: 2065 + 2066 +{ 2067 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2068 + "vehicleIds": [0], ~/~/ Список ID объектов 2069 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2070 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2071 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2072 +} 2073 + 2074 +Ответ: 2075 + 2076 +[ 2077 + { 2078 + "vehicleId": 0, ~/~/ ID объекта 2079 + "name": "string", ~/~/ Имя ТС 2080 + "periods": [ ~/~/ Периоды 2081 + { 2082 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2083 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2084 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2085 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2086 + "fuelConsumption": 0, ~/~/ Расход топлива 2087 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2088 + } 2089 + ] 2090 + } 2091 +] 2092 + 2093 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2094 + 2095 +(% class="box infomessage" %) 2096 +((( 2097 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2098 +))) 2099 + 2100 +(% style="color:#000000" %)Метод запроса: **POST** 2101 + 2102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2103 + 2104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2105 + 2106 +(% style="text-align:left" %) 2107 +Тело запроса: 2108 + 2109 +{ 2110 + "vehicleIds": [0], ~/~/ Список ID объектов 2111 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2112 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2113 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2114 +} 2115 + 2116 +Ответ: 2117 + 2118 +[ 2119 + { 2120 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2121 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2122 + "vehicleId": 0, ~/~/ ID объекта 2123 + "name": "string", ~/~/ Имя объекта 2124 + "model": "string", ~/~/ Модель объекта 2125 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2126 + { 2127 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2128 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2129 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2130 + "valueFuel": 0, ~/~/ Количество 2131 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2132 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2133 + } 2134 + ] 2135 + } 2136 +] 2137 + 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 +В теле запроса перечисляете массив id объектов 2239 + 2240 +Ответ: 2241 + { 2242 + "vehicleId": 0, ~/~/Идентификатор объекта. 2243 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2244 + "vehicleNumber": "string",~/~/Номер объекта. 2245 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2246 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2247 + "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных. 2248 + "speed": 0,~/~/Скорость объекта. 2249 + "course": 0,~/~/Курс движения [0;360] 2250 + "latitude": 0,~/~/Широта [-90°;90°]. 2251 + "longitude": 0,~/~/Долгота [-180°;180°]. 2252 + "address": "string",~/~/Адрес. 2253 + "geozones": [ ~/~/Сведения по геозонам. 2254 + { 2255 + "id": 0, 2256 + "name": "string" 2257 + } 2258 + 2259 + 2260 + 2261 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2262 + 2263 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2264 + 2265 +(% class="box infomessage" %) 2266 +((( 2267 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2268 +))) 2269 + 2270 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2271 + 2272 +(% style="color:#000000" %)Метод запроса: **POST** 2273 + 2274 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2275 + 2276 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2277 + 2278 +(% style="text-align:left" %) 2279 +Тело запроса: 2280 + 2281 +(% style="text-align:left" %) 2282 +{ 2283 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2284 +} 2285 + 2286 +(% style="text-align:left" %) 2287 +Ответ: 2288 + 2289 +[ 2290 + { 2291 + "id": 0, ~/~/ Идентификатор объекта геозоны 2292 + "name": "string", ~/~/ Название объекта геозоны 2293 + "type": 0, ~/~/ Тип объекта геозоны 2294 + "fname": "string", ~/~/ Имя файла 2295 + "parentId": "string", ~/~/ Идентификатор клиента 2296 + "radius": 0, ~/~/ Радиус геообъекта 2297 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2298 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2299 + "description": "string", ~/~/ Описание 2300 + "area": 0, ~/~/ Площадь, м^^2^^ 2301 + "perimetr": 0, ~/~/ Периметр, м 2302 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2303 + } 2304 +] 2305 + 2306 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2307 + 2308 +(% class="box infomessage" %) 2309 +((( 2310 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2311 +))) 2312 + 2313 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2314 + 2315 +(% style="color:#000000" %)Метод запроса: **POST** 2316 + 2317 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2318 + 2319 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2320 + 2321 +(% style="text-align:left" %) 2322 +Тело запроса: 2323 + 2324 +{ 2325 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2326 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2327 + "ids": [ ], ~/~/ Массив id объектов 2328 + "byTime": 0, ~/~/ Объединение событий по времени 2329 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2330 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2331 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2332 +} 2333 + 2334 +Ответ: 2335 +[ 2336 + { 2337 + "geozoneId": 0, ~/~/ ID геообъекта 2338 + "geozoneName": "string", ~/~/ Название геообъекта 2339 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2340 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2341 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2342 + "vehicleId": 0, ~/~/ ID объекта 2343 + "vehicleName": "string" ~/~/ Имя объекта 2344 + } 2345 +] 2346 + 2347 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2348 + 2349 +(% class="box infomessage" %) 2350 +((( 2351 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2352 +))) 2353 + 2354 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2355 + 2356 +(% style="color:#000000" %)Метод запроса: **POST** 2357 + 2358 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2359 + 2360 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2361 + 2362 +(% style="text-align:left" %) 2363 +Тело запроса: 2364 + 2365 +{ 2366 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2367 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2368 + "ids": [ ], ~/~/ Массив id геообъектов 2369 + "byTime": 0, ~/~/ Объединение событий по времени 2370 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2371 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2372 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2373 +} 2374 + 2375 +Ответ: 2376 + 2377 +[ 2378 + { 2379 + "geozoneId": 0, ~/~/ ID геообъекта 2380 + "geozoneName": "string", ~/~/ Название геообъекта 2381 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2382 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2383 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2384 + "vehicleId": 0, ~/~/ ID объекта 2385 + "vehicleName": "string" ~/~/ Имя объекта 2386 + } 2387 +] 2388 + 2389 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2390 + 2391 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2392 + 2393 +(% class="box infomessage" %) 2394 +((( 2395 +**POST /api/v3/notifications/find** 2396 +))) 2397 + 2398 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2399 + 2400 +(% style="text-align: left;" %) 2401 +Метод запроса **POST** 2402 + 2403 +(% style="text-align: left;" %) 2404 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2405 + 2406 +(% style="text-align: left;" %) 2407 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2408 + 2409 +{ 2410 + "parentId": "" ~/~/ id клиента 2411 +} 2412 + 2413 +Ответ: 2414 + 2415 +[ 2416 + { 2417 + "id": 0, ~/~/ ID уведомления 2418 + "name": "string", ~/~/ Название уведомления 2419 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2420 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2421 + "userId": "", ~/~/ Пользователь, создавший уведомление 2422 + "parentId": "", ~/~/ Идентификатор клиента 2423 + "parentName": "string" ~/~/ Имя клиента 2424 + } 2425 +] 2426 + 2427 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2428 + 2429 +(% class="box infomessage" %) 2430 +((( 2431 +**GET /api/v3/notifications/{id}** 2432 +))) 2433 + 2434 +Метод возвращает данные правил формирования выбранного уведомления. 2435 + 2436 +(% style="text-align: left;" %) 2437 +Метод запроса **GET** 2438 + 2439 +(% style="text-align: left;" %) 2440 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2441 + 2442 +(% style="text-align: left;" %) 2443 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2444 + 2445 +(% style="text-align: left;" %) 2446 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2447 + 2448 +(% style="text-align: left;" %) 2449 +(% style="color:#000000" %)Ответ: 2450 + 2451 +(% style="text-align: left;" %) 2452 +(% style="color:#000000" %){ 2453 + "id": 0, ~/~/ (%%)id уведомления 2454 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2455 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2456 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2457 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2458 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2459 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2460 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2461 +(% style="color:#000000" %) 0 2462 + ], 2463 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2464 +(% style="color:#000000" %) 0 2465 + ], 2466 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2467 +(% style="color:#000000" %) 0 2468 + ], 2469 + "settings": { ~/~/ Список параметров уведомления 2470 + "additionalProp1": "string", 2471 + "additionalProp2": "string", 2472 + "additionalProp3": "string" 2473 + }, 2474 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2475 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2476 +(% style="color:#000000" %) "" 2477 + ], 2478 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2479 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2480 +(% style="color:#000000" %) "string" 2481 + ], 2482 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2483 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2484 +(% style="color:#000000" %) { 2485 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2486 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2487 +(% style="color:#000000" %) } 2488 + ], 2489 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2490 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2491 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2492 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2493 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2494 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2495 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2496 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2497 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2498 +(% style="color:#000000" %)} 2499 + 2500 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2501 + 2502 +(% class="box warningmessage" %) 2503 +((( 2504 +**PUT /api/v3/notifications/** 2505 +))) 2506 + 2507 +Метод позволяет отредактировать уведомление. 2508 + 2509 +Метод запроса **PUT** 2510 + 2511 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2512 + 2513 +В заголовках запроса: X-Auth: Токен авторизации 2514 + 2515 +Тело запроса: 2516 +{ 2517 + "id": 0, ~/~/ id уведомления 2518 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2519 + "userId": "", ~/~/ Пользователь, создавший уведомление 2520 + "parentId": "", ~/~/ Идентификатор клиента 2521 + "parentName": "string", ~/~/ Имя клиента 2522 + "name": "string", ~/~/ Название уведомления 2523 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2524 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2525 + 0 2526 + ], 2527 + "geoids": [ ~/~/ Список id геообъектов для анализа 2528 + 0 2529 + ], 2530 + "fieldids": [ ~/~/ Список id полей для анализа 2531 + 0 2532 + ], 2533 + "settings": { ~/~/ Список параметров уведомления 2534 + "additionalProp1": "string", 2535 + "additionalProp2": "string", 2536 + "additionalProp3": "string" 2537 + }, 2538 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2539 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2540 + "" 2541 + ], 2542 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2543 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2544 + "string" 2545 + ], 2546 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2547 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2548 + { 2549 + "id": 0, ~/~/ Идентификатор участника чата 2550 + "info": "string" ~/~/ Дополнительные сведения 2551 + } 2552 + ], 2553 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2554 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2555 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2556 + "kind": 0, ~/~/ Определяет вид уведомления 2557 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2558 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2559 + "timezone": 0, ~/~/ Сдвиг часового пояса 2560 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2561 + "autoProlongation": true ~/~/ Автопродление срока действия 2562 +} 2563 + 2564 +Ответ: 2565 + 2566 +Success 2567 + 2568 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2569 + 2570 +(% class="box errormessage" %) 2571 +((( 2572 +**DELETE /api/v3/notifications/{id}** 2573 +))) 2574 + 2575 +Метод позволяет удалить выбранное уведомление. 2576 + 2577 +Метод запроса **DELETE** 2578 + 2579 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2580 + 2581 +Передаваемый параметр: {id} - id уведомления 2582 + 2583 +В заголовках запроса: X-Auth: Токен авторизации 2584 + 2585 +Ответ: 2586 + 2587 +Success 2588 + 2589 + 2590 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2591 + 2592 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2593 + 2594 +(% class="box infomessage" %) 2595 +((( 2596 +**POST /api/v3/Drivers/find** 2597 +))) 2598 + 2599 +Передается параметр: parentId - ID клиента-родителя 2600 + 2601 +Ответ: 2602 + 2603 +[ 2604 + { 2605 + "name": "string", ~/~/ Определяет наименование 2606 + "description": "string", ~/~/ Определяет описание 2607 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2608 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2609 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2610 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2611 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2612 + "deleted": true ~/~/ Признак удаления 2613 + } 2614 +] 2615 + 2616 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2617 + 2618 +(% class="box infomessage" %) 2619 +((( 2620 +**GET /api/v3/Drivers/{driverGuid}** 2621 +))) 2622 + 2623 +Передается параметр: ID водителя 2624 + 2625 +Ответ: 2626 + 2627 +{ 2628 + "name": "string", ~/~/ Определяет наименование 2629 + "description": "string", ~/~/ Определяет описание 2630 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2631 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2632 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2633 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2634 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2635 + "deleted": true ~/~/ Признак удаления 2636 +} 2637 + 2638 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2639 + 2640 +(% class="box successmessage" %) 2641 +((( 2642 +**POST /api/v3/Drivers** 2643 +))) 2644 + 2645 +Запрос: 2646 + 2647 +{ 2648 + "name": "string", 2649 + "description": "string", 2650 + "hiredate": "2023-06-30T12:50:54.020Z", 2651 + "chopdate": "2023-06-30T12:50:54.020Z", 2652 + "exclusive": true, 2653 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2654 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2655 + "deleted": true 2656 +} 2657 + 2658 +Ответ: 2659 + 2660 +{ 2661 + "name": "string", 2662 + "description": "string", 2663 + "hiredate": "2023-06-30T12:50:54.051Z", 2664 + "chopdate": "2023-06-30T12:50:54.051Z", 2665 + "exclusive": true, 2666 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2667 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2668 + "deleted": true 2669 +} 2670 + 2671 + 2672 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2673 + 2674 +(% class="box warningmessage" %) 2675 +((( 2676 +**PUT /api/v3/Drivers** 2677 +))) 2678 + 2679 +Запрос: 2680 + 2681 +{ 2682 + "name": "string", 2683 + "description": "string", 2684 + "hiredate": "2023-06-30T12:50:27.910Z", 2685 + "chopdate": "2023-06-30T12:50:27.910Z", 2686 + "exclusive": true, 2687 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2688 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2689 + "deleted": true 2690 +} 2691 + 2692 +Ответ: 2693 + 2694 +{ 2695 + "name": "string", 2696 + "description": "string", 2697 + "hiredate": "2023-06-30T12:50:27.929Z", 2698 + "chopdate": "2023-06-30T12:50:27.929Z", 2699 + "exclusive": true, 2700 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2701 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2702 + "deleted": true 2703 +} 2704 + 2705 + 2706 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2707 + 2708 +(% class="box errormessage" %) 2709 +((( 2710 +**DELETE /api/v3/Drivers/{driverGuid}** 2711 +))) 2712 + 2713 +Передается параметр: ID водителя 2714 + 2715 +Ответ: 2716 + 2717 +Success 2718 + 2719 + 2720 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2721 + 2722 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2723 + 2724 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2725 + 2726 +(% class="box infomessage" %) 2727 +((( 2728 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2729 +))) 2730 + 2731 +Запрос: 2732 + 2733 +{ 2734 + "Ids": [ 2735 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2736 + ], 2737 + "BeginTime": "2023-06-30T12:49:04.365Z", 2738 + "EndTime": "2023-06-30T12:49:04.365Z" 2739 +} 2740 + 2741 +Ответ: 2742 + 2743 +[ 2744 + { 2745 + "VehicleId": 0, 2746 + "CreateTime": "2023-06-30T09:52:31.240Z", 2747 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2748 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2749 + "BeginTime": "2023-06-30T09:52:31.240Z", 2750 + "EndTime": "2023-06-30T09:52:31.240Z" 2751 + } 2752 +] 2753 + 2754 + 2755 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2756 + 2757 +(% class="box infomessage" %) 2758 +((( 2759 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2760 +))) 2761 + 2762 +Запрос: 2763 + 2764 +{ 2765 + "Ids": [ 2766 + 0 2767 + ], 2768 + "BeginTime": "2023-06-30T12:48:39.419Z", 2769 + "EndTime": "2023-06-30T12:48:39.419Z" 2770 +} 2771 + 2772 +Ответ: 2773 + 2774 +[ 2775 + { 2776 + "VehicleId": 0, 2777 + "CreateTime": "2023-06-30T09:54:01.631Z", 2778 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2779 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2780 + "BeginTime": "2023-06-30T09:54:01.631Z", 2781 + "EndTime": "2023-06-30T09:54:01.631Z" 2782 + } 2783 +] 2784 + 2785 + 2786 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2787 + 2788 +(% class="box successmessage" %) 2789 +((( 2790 +**POST /api/v3/DriversVehiclesAssignments** 2791 +))) 2792 + 2793 +Передается массив назначений 2794 + 2795 +Запрос: 2796 + 2797 +[ 2798 + { 2799 + "VehicleId": 0, ~/~/ Идентификатор объекта 2800 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2801 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2802 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2803 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2804 + } 2805 +] 2806 + 2807 +Ответ: 2808 + 2809 +[ 2810 + { 2811 + "VehicleId": 0, 2812 + "CreateTime": "2023-06-30T11:04:46.903Z", 2813 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2814 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2815 + "BeginTime": "2023-06-30T11:04:46.903Z", 2816 + "EndTime": "2023-06-30T11:04:46.903Z" 2817 + } 2818 +] 2819 + 2820 + 2821 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2822 + 2823 +(% class="box warningmessage" %) 2824 +((( 2825 +**PUT /api/v3/DriversVehiclesAssignments** 2826 +))) 2827 + 2828 +Запрос: 2829 + 2830 +[ 2831 + { 2832 + "VehicleId": 0, 2833 + "CreateTime": "2023-06-30T11:14:08.117Z", 2834 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2835 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2836 + "BeginTime": "2023-06-30T11:14:08.117Z", 2837 + "EndTime": "2023-06-30T11:14:08.117Z" 2838 + } 2839 +] 2840 + 2841 +Ответ: 2842 + 2843 +[ 2844 + { 2845 + "VehicleId": 0, 2846 + "CreateTime": "2023-06-30T11:14:53.349Z", 2847 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2848 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2849 + "BeginTime": "2023-06-30T11:14:53.349Z", 2850 + "EndTime": "2023-06-30T11:14:53.349Z" 2851 + } 2852 +] 2853 + 2854 + 2855 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2856 + 2857 +(% class="box errormessage" %) 2858 +((( 2859 +**DELETE /api/v3/DriversVehiclesAssignments** 2860 +))) 2861 + 2862 +Запрос: 2863 + 2864 +[ 2865 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2866 +] 2867 + 2868 +Ответ: 2869 + 2870 +Success 2871 + 2872 + 2873 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2874 + 2875 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2876 + 2877 +(% class="box infomessage" %) 2878 +((( 2879 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2880 +))) 2881 + 2882 +Запрос: 2883 + 2884 +{ 2885 + "Ids": [ 2886 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2887 + ], 2888 + "BeginTime": "2023-06-30T12:47:12.162Z", 2889 + "EndTime": "2023-06-30T12:47:12.162Z" 2890 +} 2891 + 2892 +Ответ: 2893 + 2894 +[ 2895 + { 2896 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2897 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2898 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2899 + "BeginTime": "2023-06-30T11:19:40.703Z", 2900 + "EndTime": "2023-06-30T11:19:40.703Z" 2901 + } 2902 +] 2903 + 2904 + 2905 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2906 + 2907 +(% class="box infomessage" %) 2908 +((( 2909 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2910 +))) 2911 + 2912 +Запрос: 2913 + 2914 +{ 2915 + "Ids": [ 2916 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2917 + ], 2918 + "BeginTime": "2023-06-30T12:47:12.162Z", 2919 + "EndTime": "2023-06-30T12:47:12.162Z" 2920 +} 2921 + 2922 +Ответ: 2923 + 2924 +[ 2925 + { 2926 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2927 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2928 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2929 + "BeginTime": "2023-06-30T11:19:40.703Z", 2930 + "EndTime": "2023-06-30T11:19:40.703Z" 2931 + } 2932 +] 2933 + 2934 + 2935 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2936 + 2937 +(% class="box successmessage" %) 2938 +((( 2939 +**POST /api/v3/DriversRfidsAssignments** 2940 +))) 2941 + 2942 +Запрос: 2943 + 2944 +[ 2945 + { 2946 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2947 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2948 + "BeginTime": "2023-06-30T11:27:08.635Z", 2949 + "EndTime": "2023-06-30T11:27:08.635Z" 2950 + } 2951 +] 2952 + 2953 +Ответ: 2954 + 2955 +[ 2956 + { 2957 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2958 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2959 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2960 + "BeginTime": "2023-06-30T11:27:08.677Z", 2961 + "EndTime": "2023-06-30T11:27:08.677Z" 2962 + } 2963 +] 2964 + 2965 + 2966 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2967 + 2968 +(% class="box warningmessage" %) 2969 +((( 2970 +**PUT /api/v3/DriversRfidsAssignments** 2971 +))) 2972 + 2973 +Запрос: 2974 + 2975 +[ 2976 + { 2977 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2978 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2979 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2980 + "BeginTime": "2023-06-30T11:28:43.330Z", 2981 + "EndTime": "2023-06-30T11:28:43.330Z" 2982 + } 2983 +] 2984 + 2985 +Ответ: 2986 + 2987 +[ 2988 + { 2989 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2990 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2991 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2992 + "BeginTime": "2023-06-30T11:28:43.331Z", 2993 + "EndTime": "2023-06-30T11:28:43.331Z" 2994 + } 2995 +] 2996 + 2997 + 2998 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2999 + 3000 +(% class="box errormessage" %) 3001 +((( 3002 +**DELETE /api/v3/DriversRfidsAssignments** 3003 +))) 3004 + 3005 +Запрос: 3006 + 3007 +[ 3008 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3009 +] 3010 + 3011 +Ответ: 3012 + 3013 +Success 3014 + 3015 + 3016 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3017 + 3018 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3019 + 3020 +(% class="box infomessage" %) 3021 +((( 3022 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3023 +))) 3024 + 3025 +Запрос: 3026 + 3027 +{ 3028 + "Ids": [ 3029 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3030 + ], 3031 + "BeginTime": "2023-06-30T12:45:10.852Z", 3032 + "EndTime": "2023-06-30T12:45:10.852Z" 3033 +} 3034 + 3035 +Ответ: 3036 + 3037 +[ 3038 + { 3039 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3040 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3041 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3042 + "BeginTime": "2023-06-30T11:58:04.695Z", 3043 + "EndTime": "2023-06-30T11:58:04.695Z" 3044 + } 3045 +] 3046 + 3047 + 3048 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3049 + 3050 +(% class="box infomessage" %) 3051 +((( 3052 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3053 +))) 3054 + 3055 +Запрос: 3056 + 3057 +{ 3058 + "Ids": [ 3059 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3060 + ], 3061 + "BeginTime": "2023-06-30T12:45:10.852Z", 3062 + "EndTime": "2023-06-30T12:45:10.852Z" 3063 +} 3064 + 3065 +Ответ: 3066 + 3067 +[ 3068 + { 3069 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3070 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3071 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3072 + "BeginTime": "2023-06-30T11:58:04.695Z", 3073 + "EndTime": "2023-06-30T11:58:04.695Z" 3074 + } 3075 +] 3076 + 3077 + 3078 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3079 + 3080 +(% class="box successmessage" %) 3081 +((( 3082 +**POST /api/v3/DriversFuelCardsAssignments** 3083 +))) 3084 + 3085 +Запрос: 3086 + 3087 +[ 3088 + { 3089 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3090 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3091 + "BeginTime": "2023-06-30T12:09:53.175Z", 3092 + "EndTime": "2023-06-30T12:09:53.175Z" 3093 + } 3094 +] 3095 + 3096 +Ответ: 3097 + 3098 +[ 3099 + { 3100 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3101 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3102 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3103 + "BeginTime": "2023-06-30T12:09:53.201Z", 3104 + "EndTime": "2023-06-30T12:09:53.201Z" 3105 + } 3106 +] 3107 + 3108 + 3109 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3110 + 3111 +(% class="box warningmessage" %) 3112 +((( 3113 +**PUT /api/v3/DriversFuelCardsAssignments** 3114 +))) 3115 + 3116 +Запрос: 3117 + 3118 +[ 3119 + { 3120 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3121 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3122 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3123 + "BeginTime": "2023-06-30T12:09:53.201Z", 3124 + "EndTime": "2023-06-30T12:09:53.201Z" 3125 + } 3126 +] 3127 + 3128 +Ответ: 3129 + 3130 +[ 3131 + { 3132 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3133 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3134 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3135 + "BeginTime": "2023-06-30T12:09:53.201Z", 3136 + "EndTime": "2023-06-30T12:09:53.201Z" 3137 + } 3138 +] 3139 + 3140 + 3141 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3142 + 3143 +(% class="box errormessage" %) 3144 +((( 3145 +**DELETE /api/v3/DriversFuelCardsAssignments** 3146 +))) 3147 + 3148 +Запрос: 3149 + 3150 +[ 3151 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3152 +] 3153 + 3154 +Ответ: 3155 + 3156 +Success 3157 + 3158 + 3159 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3160 + 3161 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3162 + 3163 +(% class="box infomessage" %) 3164 +((( 3165 +**POST /api/v3/Trailers** 3166 +))) 3167 + 3168 +Пример запроса: 3169 + 3170 +{ 3171 + "startDate": "2023-11-14T10:48:03.671Z", 3172 + "endDate": "2023-11-14T10:48:03.671Z", 3173 + "ids": [ 0 ], 3174 + "timezone": 0 3175 +} 3176 + 3177 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3178 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3179 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3180 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3181 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3182 + 3183 +Пример ответа: 3184 + 3185 +[ 3186 + { 3187 + "SD": "2023-11-14T10:48:03.717Z", 3188 + "ED": "2023-11-14T10:48:03.717Z", 3189 + "id": 0, 3190 + "SLat": 0, 3191 + "SLon": 0, 3192 + "ELat": 0, 3193 + "ELon": 0, 3194 + "mileage": 0 3195 + "Duration": 0 3196 + "Address": "string", 3197 + "Address2": "string", 3198 + "name": "string", 3199 + "rid": "string", 3200 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3201 + "trailer": { 3202 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3203 + "Number": "string", 3204 + "Description": "string", 3205 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3206 + "ExternalID": "string", 3207 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3208 + "CreateTime": "2023-11-14T10:48:03.717Z", 3209 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3210 + "IsDeleted": true 3211 + }, 3212 + "filesCount": 0, 3213 + } 3214 +] 3215 + 3216 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3217 +|SD|Дата и время начала события 3218 +|ED|Дата и время окончания события 3219 +|id|ID объекта 3220 +|SLat|Широта начальной координаты 3221 +|SLon|Долгота начальной координаты 3222 +|ELat|Широта конечной координаты 3223 +|ELon|Долгота конечной координаты 3224 +|mileage|Пробег 3225 +|Duration|Продолжительность 3226 +|Address|Адрес начального местоположения 3227 +|Address2|Адрес конечного местоположения 3228 +|name|Имя радиометки 3229 +|rid|Номер радиометки 3230 +|rguid|ID радиометки 3231 +|trailer|Информация об агрегате 3232 +|ModelGuid|ID агрегата 3233 +|Number|Название/номер агрегата 3234 +|Description|Текст примечания агрегата 3235 + 3236 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3237 + 3238 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3239 + 3240 +(% class="box infomessage" %) 3241 +((( 3242 +**POST /api/v3/Rfids/find** 3243 +))) 3244 + 3245 +Запрос: 3246 + 3247 +{ 3248 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3249 +} 3250 + 3251 +Ответ: 3252 + 3253 +[ 3254 + { 3255 + "name": "string", 3256 + "number": 0, 3257 + "period": 0, 3258 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3259 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3260 + } 3261 +] 3262 + 3263 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3264 +|parentId|ID клиента 3265 +|name|Название карты-метки 3266 +|number|Номер 3267 +|period|Период запросов в секундах (работает только для агрегатов) 3268 +|id|ID карты-метки 3269 + 3270 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3271 + 3272 +(% class="box infomessage" %) 3273 +((( 3274 +**GET /api/v3/Rfids/{rfidGuid}** 3275 +))) 3276 + 3277 +Передаем параметр rfidGuid - идентификатор карты-метки 3278 + 3279 +Ответ: 3280 + 3281 +[ 3282 + { 3283 + "name": "string", 3284 + "number": 0, 3285 + "period": 0, 3286 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3287 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3288 + } 3289 +] 3290 + 3291 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3292 +|name|Название карты-метки 3293 +|number|Номер 3294 +|period|Период запросов в секундах (работает только для агрегатов) 3295 +|id|ID карты-метки 3296 +|parentId|ID клиента 3297 + 3298 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3299 + 3300 +(% class="box successmessage" %) 3301 +((( 3302 +**POST /api/v3/Rfids** 3303 +))) 3304 + 3305 +Запрос: 3306 + 3307 +{ 3308 + "name": "string", 3309 + "number": 0, 3310 + "period": 0, 3311 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3312 +} 3313 + 3314 +Ответ: 3315 + 3316 +{ 3317 + "name": "string", 3318 + "number": 0, 3319 + "period": 0, 3320 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3321 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3322 +} 3323 + 3324 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3325 +|name|Название карты-метки 3326 +|number|Номер 3327 +|period|Период запросов в секундах (работает только для агрегатов) 3328 +|id|ID карты-метки 3329 +|parentId|ID клиента 3330 + 3331 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3332 + 3333 +(% class="box warningmessage" %) 3334 +((( 3335 +**PUT /api/v3/Rfids** 3336 +))) 3337 + 3338 +Запрос: 3339 + 3340 +{ 3341 + "name": "string", 3342 + "number": 0, 3343 + "period": 0, 3344 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3345 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3346 +} 3347 + 3348 +Ответ: 3349 + 3350 +{ 3351 + "name": "string", 3352 + "number": 0, 3353 + "period": 0, 3354 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3355 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3356 +} 3357 + 3358 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3359 +|name|Название карты-метки 3360 +|number|Номер 3361 +|period|Период запросов в секундах (работает только для агрегатов) 3362 +|id|ID карты-метки 3363 +|parentId|ID клиента 3364 + 3365 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3366 + 3367 +(% class="box errormessage" %) 3368 +((( 3369 +**DELETE /api/v3/Rfids/{rfidGuid}** 3370 +))) 3371 + 3372 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3373 + 3374 +Ответ: 3375 + 3376 +Success 3377 + 3378 + 3379 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3380 + 3381 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3382 + 3383 +(% class="box infomessage" %) 3384 +((( 3385 +**GET /api/v3/Billing/client/balance/{clientId}** 3386 +))) 3387 + 3388 +Параметр запроса: **clientId **- идентификатор клиента. 3389 + 3390 +Ответ: 3391 + 3392 +{ 3393 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3394 + "Balance": 0 3395 +} 3396 + 3397 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3398 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3399 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3400 + 3401 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3402 + 3403 +(% class="box infomessage" %) 3404 +((( 3405 +**GET /api/v3/Billing/client/constraint/{clientId}** 3406 +))) 3407 + 3408 +Параметр запроса: **clientId **- идентификатор клиента. 3409 + 3410 +Ответ: 3411 + 3412 +{ 3413 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3414 + "CalculationType": 0, 3415 + "PermissibleBalance": 0, 3416 + "DefermentDays": 0, 3417 + "SendUiNotifications": true, 3418 + "SendEmailNotifications": true, 3419 + "IsPrivate": true, 3420 +} 3421 + 3422 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3423 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3424 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3425 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3426 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3427 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3428 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3429 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3430 + 3431 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3432 + 3433 +(% class="box infomessage" %) 3434 +((( 3435 +**GET /api/v3/Billing/client/plan/{clientId}** 3436 +))) 3437 + 3438 +Параметры запроса: 3439 + 3440 +**clientId **- идентификатор клиента. 3441 + 3442 +**planId **- идентификатор тарифного плана. 3443 + 3444 +Ответ: 3445 + 3446 +{ 3447 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3448 + "Plan": { **~/~/ Описание тарифного плана** 3449 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3450 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3451 + "Name": "string", 3452 + "IsArchived": true, 3453 + "Constraint": { 3454 + "CalculationType": 0, 3455 + "PermissibleBalance": 0, 3456 + "DefermentDays": 0 3457 + }, 3458 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3459 + { 3460 + "Feature": "string", 3461 + "IsFactual": true, 3462 + "Limit": 0, 3463 + "Price": 0, 3464 + "PeriodValue": 0, 3465 + "PeriodType": 0 3466 + } 3467 + ] 3468 + }, 3469 + "DebitDate": "2023-10-18T12:46:24.213Z", 3470 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3471 + { 3472 + "Feature": "string", 3473 + "IsEnabled": true, 3474 + "IsPrivate": true, 3475 + "IsFactual": true, 3476 + "Limit": 0, 3477 + "Price": 0, 3478 + "DebitDate": "2023-10-18T12:46:24.213Z", 3479 + "PeriodValue": 0, 3480 + "PeriodType": 0 3481 + } 3482 + ] 3483 +} 3484 + 3485 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3486 +|ClientId|Идентификатор клиента 3487 +|Id|Идентификатор тарифного плана 3488 +|OwnerId|Идентификатор клиента-владельца 3489 +|Name|Наименование тарифного плана 3490 +|IsArchived|Признак, определяющий архивный тарифный план 3491 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3492 +|PermissibleBalance|Допустимый баланс 3493 +|DefermentDays|Отсрочка, количество дней 3494 +|Feature|Код услуги 3495 +|IsEnabled|Признак, определяющий активирована ли услуга 3496 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3497 +|IsFactual|Признак, определяющий расчёт по факту 3498 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3499 +|Price|Цена за единицу. 3500 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3501 +|PeriodValue|Значение периода. 3502 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3503 + 3504 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3505 + 3506 +(% class="box infomessage" %) 3507 +((( 3508 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3509 +))) 3510 + 3511 +Параметр запроса: **clientId **- идентификатор клиента. 3512 + 3513 +Ответ: 3514 + 3515 +[ 3516 + { 3517 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3518 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3519 + "Name": "string", 3520 + "IsArchived": true, 3521 + "Constraint": { 3522 + "CalculationType": 0, 3523 + "PermissibleBalance": 0, 3524 + "DefermentDays": 0 3525 + }, 3526 + "Features": [ 3527 + { 3528 + "Feature": "string", 3529 + "IsFactual": true, 3530 + "Limit": 0, 3531 + "Price": 0, 3532 + "PeriodValue": 0, 3533 + "PeriodType": 0 3534 + } 3535 + ] 3536 + } 3537 +] 3538 + 3539 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3540 +|ClientId|Идентификатор клиента 3541 +|Id|Идентификатор тарифного плана 3542 +|OwnerId|Идентификатор клиента-владельца 3543 +|Name|Наименование тарифного плана 3544 +|IsArchived|Признак, определяющий архивный тарифный план 3545 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3546 +|PermissibleBalance|Допустимый баланс 3547 +|DefermentDays|Отсрочка, количество дней 3548 +|Feature|Код услуги 3549 +|IsFactual|Признак, определяющий расчёт по факту 3550 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3551 +|Price|Цена за единицу. 3552 +|PeriodValue|Значение периода. 3553 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3554 + 3555 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3556 + 3557 +(% class="box infomessage" %) 3558 +((( 3559 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3560 +))) 3561 + 3562 +Параметр запроса: **clientId **- идентификатор клиента. 3563 + 3564 +Ответ: 3565 + 3566 +[ 3567 + { 3568 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3569 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3570 + "Name": "string", 3571 + "IsArchived": true, 3572 + "Constraint": { 3573 + "CalculationType": 0, 3574 + "PermissibleBalance": 0, 3575 + "DefermentDays": 0 3576 + }, 3577 + "Features": [ 3578 + { 3579 + "Feature": "string", 3580 + "IsFactual": true, 3581 + "Limit": 0, 3582 + "Price": 0, 3583 + "PeriodValue": 0, 3584 + "PeriodType": 0 3585 + } 3586 + ] 3587 + } 3588 +] 3589 + 3590 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3591 +|ClientId|Идентификатор клиента 3592 +|Id|Идентификатор тарифного плана 3593 +|OwnerId|Идентификатор клиента-владельца 3594 +|Name|Наименование тарифного плана 3595 +|IsArchived|Признак, определяющий архивный тарифный план 3596 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3597 +|PermissibleBalance|Допустимый баланс 3598 +|DefermentDays|Отсрочка, количество дней 3599 +|Feature|Код услуги 3600 +|IsFactual|Признак, определяющий расчёт по факту 3601 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3602 +|Price|Цена за единицу. 3603 +|PeriodValue|Значение периода. 3604 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3605 + 3606 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3607 + 3608 +(% class="box warningmessage" %) 3609 +((( 3610 +**PUT /api/v3/Billing/client/balance** 3611 +))) 3612 + 3613 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3614 + 3615 +Тело запроса: 3616 + 3617 +{ 3618 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3619 + "Balance": 0 3620 +} 3621 + 3622 +Ответ: Success 3623 + 3624 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3625 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3626 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3627 + 3628 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3629 + 3630 +(% class="box warningmessage" %) 3631 +((( 3632 +**PUT /api/v3/billing/client/balance/deposit** 3633 +))) 3634 + 3635 +Создает операцию **Пополнение **с указанной суммой 3636 + 3637 +Тело запроса: 3638 + 3639 +{ 3640 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3641 + "Balance": 0 3642 +} 3643 + 3644 +Ответ: Success 3645 + 3646 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3647 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3648 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3649 + 3650 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3651 + 3652 +Создает операцию **Списание **с указанной суммой 3653 + 3654 +(% class="box warningmessage" %) 3655 +((( 3656 +**PUT /api/v3/billing/client/balance/withdraw** 3657 +))) 3658 + 3659 +Тело запроса: 3660 + 3661 +{ 3662 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3663 + "Balance": 0 3664 +} 3665 + 3666 +Ответ: Success 3667 + 3668 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3669 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3670 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3671 + 3672 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3673 + 3674 +(% class="box warningmessage" %) 3675 +((( 3676 +**PUT /api/v3/Billing/client/constraint** 3677 +))) 3678 + 3679 +Тело запроса: 3680 + 3681 +{ 3682 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3683 + "CalculationType": 0, 3684 + "PermissibleBalance": 0, 3685 + "DefermentDays": 0, 3686 + "SendUiNotifications": true, 3687 + "SendEmailNotifications": true, 3688 + "IsPrivate": true, 3689 +} 3690 + 3691 +Ответ: Success 3692 + 3693 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3694 +|ClientId|Идентификатор клиента 3695 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3696 +|PermissibleBalance|Допустимый баланс 3697 +|DefermentDays|((( 3698 +Отсрочка, количество дней 3699 +))) 3700 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3701 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3702 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3703 + 3704 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3705 + 3706 +(% class="box warningmessage" %) 3707 +((( 3708 +**PUT /api/v3/Billing/client/plan** 3709 +))) 3710 + 3711 +Тело запроса: 3712 + 3713 +{ 3714 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3715 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3716 + "Features": [ 3717 + { 3718 + "Feature": "string", 3719 + "IsEnabled": true, 3720 + "IsFactual": true, 3721 + "Limit": 0, 3722 + "Price": 0, 3723 + "DebitDate": "2023-10-18T13:26:58.987Z", 3724 + "PeriodValue": 0, 3725 + "PeriodType": 0 3726 + } 3727 + ] 3728 +} 3729 + 3730 +Ответ: Success 3731 + 3732 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3733 +|ClientId|Идентификатор клиента 3734 +|PlanId|Идентификатор тарифного плана 3735 +|Feature|Код услуги 3736 +|IsEnabled|Признак, определяющий активирована ли услуга 3737 +|IsFactual|Признак, определяющий расчёт по факту 3738 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3739 +|Price|Цена за единицу. 3740 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3741 +|PeriodValue|Значение периода. 3742 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3743 + 3744 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3745 + 3746 +(% class="box warningmessage" %) 3747 +((( 3748 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3749 +))) 3750 + 3751 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3752 + 3753 +(% class="box infomessage" %) 3754 +((( 3755 +**POST /api/v3/vehicles/import/{agentId}** 3756 +))) 3757 + 3758 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3759 + 3760 +В пути указывается **agentId** - id клиента. 3761 + 3762 +**Заголовок** 3763 + 3764 +**X-Auth: [токен авторизации]** 3765 + 3766 +**Параметры** 3767 + 3768 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3769 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3770 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3771 + 3772 +В теле использовать тип **form-data,** тип значения** file** 3773 + 3774 +**Ключи** 3775 + 3776 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3777 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3778 +|csv|В значении передаем файл датчиков, формат **csv** 3779 + 3780 +Ответ: 3781 + 3782 +{ 3783 + "vehicleId": 0, 3784 + "name": "string", 3785 + "errors": ["string"] 3786 +} 3787 + 3788 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3789 +|vehicleId|ID созданного объекта 3790 +|name|Имя созданного объекта 3791 +|errors|Ошибки и их описание 3792 + 3793 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3794 + 3795 +(% class="box infomessage" %) 3796 +((( 3797 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3798 +))) 3799 + 3800 +(% class="wikigeneratedid" %) 3801 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3802 + 3803 +(% class="wikigeneratedid" %) 3804 +В пути указывается **vehicleId **- id объекта. 3805 + 3806 +**Заголовок** 3807 + 3808 +**X-Auth: [токен авторизации]** 3809 + 3810 +В теле использовать тип **form-data.** 3811 + 3812 +Ключи: 3813 + 3814 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3815 +|**history**|В значении передавать файл с историей 3816 + 3817 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3818 + 3819 +Ответ: 3820 + 3821 +{ 3822 + "results": [ 3823 + { 3824 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3825 + "vehicleId": 0, 3826 + "errors": [ 3827 + "string" 3828 + ], 3829 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3830 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3831 + "producedCount": 0, 3832 + "msgCount": 0 3833 + } 3834 + ] 3835 +} 3836 + 3837 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3838 +|results|Результаты импорта в разрезе ТС 3839 +|vehicleGuid|Guid ТС 3840 +|vehicleId|ID ТС 3841 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3842 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3843 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3844 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3845 +|msgCount|Кол-во обработанных сообщений всего 3846 + 3847 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3848 + 3849 +(% class="box infomessage" %) 3850 +((( 3851 +**GET /api/v3/vehicles/import/history/status** 3852 +))) 3853 + 3854 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3855 + 3856 +Ответ: 3857 + 3858 +{ 3859 + "activity": true, 3860 + "progress": 0, 3861 + "message": "string" 3862 +} 3863 + 3864 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3865 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3866 +|progress|Guid ТС 3867 + 3868 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3869 + 3870 +(% class="box infomessage" %) 3871 +((( 3872 +**POST /api/v3/vehicles/export** 3873 +))) 3874 + 3875 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3876 + 3877 +Тело запроса: 3878 + 3879 +[ 3880 + id 3881 +] 3882 + 3883 +Ответ: Success 200, получаете файлы с настройками. 3884 + 3885 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3886 + 3887 +(% class="box infomessage" %) 3888 +((( 3889 +**POST /api/v3/vehicles/export/history** 3890 +))) 3891 + 3892 +Метод возвращает список сообщений терминала объекта за выбранный период. 3893 + 3894 +Тело запроса: 3895 + 3896 +{ 3897 + "vehicleId": 0, 3898 + "asArchive": true, 3899 + "from": "2023-09-27T12:17:45.973Z", 3900 + "to": "2023-09-27T12:17:45.973Z" 3901 +} 3902 + 3903 +Ответ: 3904 + 3905 +Получаете файл. Сообщение: Code 200/Success 3906 + 3907 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3908 +|vehicleId|ID объекта 3909 +|asArchive|true - Архивировать файл, False - не архивировать 3910 +|from|Дата и время начала запроса 3911 +|to|Дата и время окончания запроса 3912 + 3913 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3914 + 3915 +(% class="box infomessage" %) 3916 +((( 3917 +**GET /api/v3/vehicles/export/history/status** 3918 +))) 3919 + 3920 +Метод возвращает список сообщений терминала объекта за выбранный период. 3921 + 3922 +Ответ: 3923 + 3924 +{ 3925 + "activity": true, 3926 + "progress": 0, 3927 + "message": "string" 3928 +} 3929 + 3930 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3931 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3932 +|progress|Прогресс экспорта, от 0 до 100% 3933 +|message|Текст описывающий статус 3934 + 3935 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3936 + 3937 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3938 + 3939 +(% class="box infomessage" %) 3940 +((( 3941 +**POST /api/v3/EcoDriving/rating** 3942 +))) 3943 + 3944 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3945 + 3946 +Тело запроса: 3947 + 3948 +{ 3949 + "vehicleIds": [vehicleId], 3950 + "from": "2023-11-22T09:29:48.051Z", 3951 + "to": "2023-11-22T09:29:48.051Z" 3952 +} 3953 + 3954 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3955 +|vehicleIds|Массив ID объектов 3956 +|from|Дата начала запроса 3957 +|to|Дата окончания запроса 3958 + 3959 +Ответ: 3960 + 3961 +{ 3962 + "items": [ 3963 + { 3964 + "from": "2023-11-22T09:29:48.052Z", 3965 + "to": "2023-11-22T09:29:48.052Z", 3966 + "vehicleId": 0, 3967 + "vehicleName": "string", 3968 + "vehicleModel": "string", 3969 + "penalty": 0, 3970 + "score": 0, 3971 + "totalViolations": 0, 3972 + "violationsByType": { 3973 + "overspeedingViolations": 0, 3974 + "accelerationViolations": 0, 3975 + "brakingViolations": 0, 3976 + "turningViolations": 0, 3977 + "dangerousDrivingViolations": 0, 3978 + "sensorViolations": 0 3979 + }, 3980 + "moveTime": 0, 3981 + "mileage": 0, 3982 + "tripsCount": 0, 3983 + "trips": [ 3984 + { 3985 + "penalty": 0, 3986 + "score": 0, 3987 + "violationsCount": 0, 3988 + "violationsByType": { 3989 + "overspeedingViolations": 0, 3990 + "accelerationViolations": 0, 3991 + "brakingViolations": 0, 3992 + "turningViolations": 0, 3993 + "dangerousDrivingViolations": 0, 3994 + "sensorViolations": 0 3995 + }, 3996 + "moveTime": 0, 3997 + "mileage": 0, 3998 + "motohours": 0, 3999 + "maxSpeed": 0, 4000 + "startAddress": "string", 4001 + "endAddress": "string", 4002 + "drivers": [ 4003 + { 4004 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4005 + "driverName": "string", 4006 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4007 + } 4008 + ] 4009 + } 4010 + ] 4011 + } 4012 + ] 4013 +} 4014 + 4015 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4016 +|from|Дата начала запроса 4017 +|to|Дата окончания 4018 +|vehicleId|ID объекта 4019 +|vehicleName|Имя объекта 4020 +|vehicleModel|Модель объекта 4021 +|penalty|Сумма штрафных баллов 4022 +|score|Оценка 4023 +|totalViolations|Суммарное количество нарушений 4024 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4025 +|overspeedingViolations|Превышение скорости 4026 +|accelerationViolations|Ускорение 4027 +|brakingViolations|Торможение 4028 +|turningViolations|Резкий поворот 4029 +|dangerousDrivingViolations|Резкое вождение 4030 +|sensorViolations|Нарушение по датчику 4031 +|moveTime|Время в движении 4032 +|mileage|Пробег 4033 +|tripsCount|Количество рейсов 4034 +|motohours|Моточасы 4035 +|maxSpeed|Максимальная скорость 4036 +|startAddress|Адрес начала рейса 4037 +|endAddress|Адрес окончания рейса 4038 +|drivers|Список водителей, которые были на объекте в течениии рейса 4039 +|driverGuid|Guid водителя 4040 +|driverName|Имя водителя 4041 +|driverRfid|Номер Карты-метки 4042 + 1219 1219 (% class="box" lang="en-US" style="text-align: center;" %) 1220 1220 ((( 1221 1221 (% 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