Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/28 11:43
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.SupportZhuchkov - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,39 +1,45 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 3 - 4 -== == 5 - 6 -(% class="box" style="text-align: center;" %) 7 7 ((( 8 - (% style="color:#000000; font-size:18.6667px" %)**Действующиеограничения**3 +**Содержание страницы:** 9 9 ))) 10 10 11 - (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).6 +{{toc/}} 12 12 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 14 14 9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 + 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 + 13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 + 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 - 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 22 22 23 -(% class="box infomessage" %) 19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 + 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 + 23 +(% class="box successmessage" %) 24 24 ((( 25 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) 28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %)Метод запроса: ** GET**30 +(% style="color:#000000" %)Метод запроса: **POST** 31 31 32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login ?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 -(% lang="en-US" %) 36 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 37 + 38 +(% style="color:#000000" %){ 39 + "login": "testuser", 40 + "password": "testuser" 41 +} 42 + 37 37 (% style="color:#000000" %)**Ответ:** 38 38 39 39 (% lang="en-US" %) ... ... @@ -40,21 +40,28 @@ 40 40 (% style="color:#000000" %){ 41 41 42 42 (% lang="en-US" %) 43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 - "User": "" , ~/~/ имя пользователя 49 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 50 + "User": "testuser" , ~/~/ имя пользователя 45 45 46 46 (% lang="en-US" %) 47 - 53 +} 48 48 49 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 50 50 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" %)Логин пользователя 51 51 63 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 64 + 52 52 (% class="box infomessage" %) 53 53 ((( 54 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**67 +(% lang="en-US" %)**GET /api/v3/auth/check** 55 55 ))) 56 56 57 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).70 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 58 58 59 59 (% style="color:#000000" %)Метод запроса: **GET** 60 60 ... ... @@ -65,59 +65,307 @@ 65 65 (% lang="en-US" %) 66 66 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 67 67 81 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 68 68 69 -(% class="box" style="text-align: center;" %) 83 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 84 + 85 +(% class="box infomessage" %) 70 70 ((( 71 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**87 +**GET api/v3/agents/{id}** 72 72 ))) 73 73 90 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 91 + 92 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 93 + 94 +(% style="color:#000000" %)Метод запроса: **GET** 95 + 96 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 97 + 98 +Запрос должен содержать данные параметра "**agentId**" 99 + 100 +(% style="color:#000000" %)Ответ: 101 +{ 102 + "agentId": "", (%%) 103 + "parentId": "", 104 + "parentName": "string", 105 + "name": "string", 106 + "fullName": "string", 107 + "agentInfoType": 0, 108 + "isForeign": true/false, 109 + "district": "string", 110 + "region": "string", 111 + "city": "string", 112 + "inn": "string", 113 + "kpp": "string", 114 + "address": "string", 115 + "addressFact": "string", 116 + "email": "string", 117 + "director": "string", 118 + "bankName": "string", 119 + "bankBIK": "string", 120 + "bankRS": "string", 121 + "bankKS": "string" 122 + } 123 + 124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 145 + 146 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 147 + 74 74 (% class="box infomessage" %) 75 75 ((( 76 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**150 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 77 77 ))) 78 78 79 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):153 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 80 80 81 81 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 82 82 83 83 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 84 84 85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 86 86 87 -(% style="color:#000000" %)Метод запроса: ** GET**161 +(% style="color:#000000" %)Метод запроса: **POST** 88 88 89 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>163 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 90 90 91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)165 +(% style="color:#000000" %)Параметр запроса: 92 92 93 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 167 +(% style="color:#000000" %){ 168 + "parentId": "string" 169 +} 94 94 95 95 (% style="color:#000000" %)Ответ: 96 96 97 - (% style="color:#000000" %){98 - "agentId": ~/~/идентификатор клиента99 - "parentId": ~/~/ идентификатор клиента-родителя100 - "name": ~/~/ наименование клиента101 - "fullName": ~/~/ полное наименование клиента102 - "agentInfoType": "",~/~/ тип клиента1103 - "status": "", ~/~/ статус клиента104 - 173 +{ 174 + "agentId": "",(% style="color:#000000" %) (%%) 175 + "parentId": "", 176 + "name": "string", 177 + "fullName": "string", 178 + "agentInfoType": 0, 179 +(% style="color:#000000" %) "status": "", 180 +} 105 105 106 106 107 -(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 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 - Активен 108 108 191 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 109 109 110 -(% class="box "style="text-align: center;" %)193 +(% class="box successmessage" %) 111 111 ((( 112 - (%style="color:#000000; font-size:14pt"%)**Раздел Пользователи**195 +**POST /api/v3/agents ** 113 113 ))) 114 114 198 +Метод позволяет добавить клиента, указанного в запросе. 199 + 200 +Метод запроса: **POST** 201 + 202 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 203 + 204 +В заголовках запроса: X-Auth: Токен авторизации 205 + 206 +Параметры в теле запроса (JSON): 207 + 208 +{ 209 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 210 + "name": "string", ~/~/ имя 211 + "fullName": "string", ~/~/ полное наименование 212 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 213 + "isForeign": true, ~/~/ иностранный контрагент 214 + "district": "string", ~/~/ округ 215 + "region": "string", ~/~/ регион 216 + "city": "string", ~/~/ город 217 + "inn": "string", ~/~/ ИНН 218 + "kpp": "string", ~/~/ КПП 219 + "address": "string", ~/~/ юридический адрес 220 + "addressFact": "string", ~/~/ фактический адрес 221 + "email": "string", ~/~/ email 222 + "director": "string", ~/~/ ФИО руководителя 223 + "bankName": "string", ~/~/ банк 224 + "bankBIK": "string", ~/~/ БИК 225 + "bankRS": "string", ~/~/ номер счёта 226 + "bankKS": "string" ~/~/ корр. счёт 227 +} 228 + 229 + 230 +Ответ: 231 + 232 +{ 233 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 234 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 235 + "name": "string", ~/~/ имя 236 + "fullName": "string", ~/~/ полное наименование 237 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 238 + "isForeign": true, ~/~/ иностранный контрагент 239 + "district": "string", ~/~/ округ 240 + "region": "string", ~/~/ регион 241 + "city": "string", ~/~/ город 242 + "inn": "string", ~/~/ ИНН 243 + "kpp": "string", ~/~/ КПП 244 + "address": "string", ~/~/ юридический адрес 245 + "addressFact": "string", ~/~/ фактический адрес 246 + "email": "string", ~/~/ email 247 + "director": "string", ~/~/ ФИО руководителя 248 + "bankName": "string", ~/~/ банк 249 + "bankBIK": "string", ~/~/ БИК 250 + "bankRS": "string", ~/~/ номер счёта 251 + "bankKS": "string" ~/~/ корр. счёт 252 +} 253 + 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 + 276 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 277 + 278 +(% class="box warningmessage" %) 279 +((( 280 +**PUT /api/v3/agents** 281 +))) 282 + 283 +Метод позволяет отредактировать клиента, указанного в запросе. 284 + 285 +Метод запроса: **PUT** 286 + 287 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 288 + 289 +В заголовках запроса: X-Auth: Токен авторизации 290 + 291 +Параметры в теле запроса (JSON): 292 + 293 +{ 294 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 295 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 296 + "name": "string", ~/~/ имя 297 + "fullName": "string", ~/~/ полное наименование 298 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 299 + "isForeign": true, ~/~/ иностранный контрагент 300 + "district": "string", ~/~/ округ 301 + "region": "string", ~/~/ регион 302 + "city": "string", ~/~/ город 303 + "inn": "string", ~/~/ ИНН 304 + "kpp": "string", ~/~/ КПП 305 + "address": "string", ~/~/ юридический адрес 306 + "addressFact": "string", ~/~/ фактический адрес 307 + "email": "string", ~/~/ email 308 + "director": "string", ~/~/ ФИО руководителя 309 + "bankName": "string", ~/~/ банк 310 + "bankBIK": "string", ~/~/ БИК 311 + "bankRS": "string", ~/~/ номер счёта 312 + "bankKS": "string" ~/~/ корр. счёт 313 +} 314 + 315 +Ответ: 316 + 317 +{ 318 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 319 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 320 + "name": "string", ~/~/ имя 321 + "fullName": "string", ~/~/ полное наименование 322 + "isForeign": true, ~/~/ иностранный контрагент 323 + "district": "string", ~/~/ округ 324 + "region": "string", ~/~/ регион 325 + "city": "string", ~/~/ город 326 + "inn": "string", ~/~/ ИНН 327 + "kpp": "string", ~/~/ КПП 328 + "address": "string", ~/~/ юридический адрес 329 + "addressFact": "string", ~/~/ фактический адрес 330 + "email": "string", ~/~/ email 331 + "director": "string", ~/~/ ФИО руководителя 332 + "bankName": "string", ~/~/ банк 333 + "bankBIK": "string", ~/~/ БИК 334 + "bankRS": "string", ~/~/ номер счёта 335 + "bankKS": "string" ~/~/ корр. счёт 336 +} 337 + 338 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 339 + 340 +(% class="box errormessage" %) 341 +((( 342 +**DELETE /api/v3/agents/{clientId}** 343 +))) 344 + 345 +Метод позволяет удалить клиента, указанного в строке запроса. 346 + 347 +Метод запроса: **DELETE** 348 + 349 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 350 + 351 +Параметр запроса: **{clientId}** - Guid пользователя 352 + 353 +В заголовках запроса: X-Auth: Токен авторизации 354 + 355 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 356 + 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 + 372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 373 + 374 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 375 + 115 115 (% class="box successmessage" %) 116 116 ((( 117 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**378 +(% lang="en-US" %)**POST /api/v3/users** 118 118 ))) 119 119 120 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).381 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 121 121 122 122 (% style="color:#000000" %)Метод запроса: **POST** 123 123 ... ... @@ -127,31 +127,55 @@ 127 127 128 128 (% style="color:#000000" %)Параметры в теле запроса (JSON): 129 129 130 -(% style="color:#000000" %){ 391 +(% style="color:#000000" %) 392 +{ 131 131 "lastName": "", ~/~/ фамилия 132 132 "firstName": "", ~/~/ имя 133 133 "position": "", ~/~/ должность 134 134 "phone": "", ~/~/ телефон 135 135 "organization": "", ~/~/ организация 136 - "login": "", ~/~/ логин 137 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 138 - "email": "", ~/~/ email 139 - "description": "", ~/~/ описание 140 - "isEnabled": "", ~/~/ признак включения 398 + "login": "", ~/~/ логин (обязателен) 399 + "password": "", ~/~/ пароль (обязателен) 400 + "email": "", ~/~/ email (обязателен) 401 + "description": "string", ~/~/ Описание 402 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 403 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 404 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 141 141 "parentId": "", ~/~/ Guid родительского агента 142 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 143 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 144 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 145 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 - "groups": "" , ~/~/ группы пользователя, названия групп 148 - } 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 - Азербайджанский 422 +} 149 149 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 + 150 150 (% style="text-align:left" %) 151 151 (% style="color:#000000; font-weight:normal" %)Ответ: 152 152 153 153 (% style="text-align:left" %) 154 -(% style="color:#000000; font-weight:normal" %){ 439 +(% style="color:#000000; font-weight:normal" %){ 155 155 156 156 (% style="text-align:left" %) 157 157 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -170,27 +170,31 @@ 170 170 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 171 171 "kind": "" , ~/~/ тип аутентификации 172 172 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 173 - "groups": группы пользователя,«user»названия группыпользователя458 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 174 174 175 175 (% style="text-align:left" %) 176 -(% style="color:#000000; font-weight:normal" %) 461 +(% style="color:#000000; font-weight:normal" %)} 177 177 178 178 179 -(% class="box successmessage" %) 464 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 465 + 466 +(% class="box infomessage" %) 180 180 ((( 181 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**468 +(% lang="en-US" %)**POST /api/v3/users/find** 182 182 ))) 183 183 184 -(% style="color:#000000" %) 471 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 185 185 186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 473 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 187 187 188 188 (% style="color:#000000" %)Метод запроса: **POST** 189 189 190 190 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 191 191 192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):479 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 193 193 481 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 482 + 194 194 (% style="color:#000000" %){ 195 195 196 196 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента ... ... @@ -198,11 +198,11 @@ 198 198 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 199 199 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 200 200 201 -(% style="color:#000000" %) 490 +(% style="color:#000000" %)} 202 202 203 203 (% style="color:#000000" %)Ответ: 204 204 205 -(% style="color:#000000" %){ 494 +(% style="color:#000000" %){ (%%) 206 206 207 207 "id": "" , ~/~/ идентификатор пользователя 208 208 "lastName": "" , ~/~/ фамилия ... ... @@ -216,17 +216,70 @@ 216 216 "email": "" , ~/~/ E-mail 217 217 "sessionDuration":"", ~/~/ длительность сессии в минутах 218 218 "status": "1", ~/~/ статус пользователя 219 - "astLogged": "", ~/~/ дата/время последней авторизации 508 + "lastLogged": "", ~/~/ дата/время последней авторизации 220 220 221 -(% style="color:#000000" %) 510 +(% style="color:#000000" %)} 222 222 512 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 223 223 514 +(% class="box infomessage" %) 515 +((( 516 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 517 +))) 518 + 519 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 520 + 521 +(% style="color:#000000" %)Метод запроса: **GET** 522 + 523 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 524 + 525 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 526 + 527 +(% style="color:#000000" %)Ответ: 528 + 529 +((( 530 +((( 531 +{ 532 + "id": "", ~/~/ GUID пользователя 533 + "lastName": "", ~/~/ Фамилия 534 + "firstName": "", ~/~/ Имя 535 + "position": "", ~/~/ Должность 536 + "phone": "", ~/~/ Номер телефона 537 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 538 + "parentName": "", Наименование клиента, которому принадлежит пользователь 539 + "organization": "", ~/~/ Организация 540 + "login": "", ~/~/ Логин пользователя 541 + "email": "", ~/~/ Адрес электронной почты 542 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 543 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 544 + "description": "", ~/~/ Описание 545 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 546 + "doubleAuth": 547 + { 548 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 549 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 550 + }, 551 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 552 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 553 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 554 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 555 + "groups": [], ~/~/ Список ролей пользователя 556 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 557 + "authDevices": [ ], ~/~/ Список авторизованных устройств 558 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 559 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 560 +} 561 +))) 562 +))) 563 + 564 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 565 + 224 224 (% class="box warningmessage" %) 225 225 ((( 226 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**568 +(% lang="en-US" %)**PUT /api/v3/users** 227 227 ))) 228 228 229 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).571 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 230 230 231 231 (% style="color:#000000" %)Метод запроса: **PUT** 232 232 ... ... @@ -238,7 +238,7 @@ 238 238 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 239 239 240 240 (% lang="en-US" style="text-align:left" %) 241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 583 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 242 242 243 243 (% lang="en-US" style="text-align:left" %) 244 244 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -247,30 +247,35 @@ 247 247 "position": "" , ~/~/ должность 248 248 "phone": "" , ~/~/ телефон 249 249 "organization": "" , ~/~/ организация 250 - "login": "" , ~/~/ логин 251 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 252 - "email": "" , ~/~/ email 253 - "description": "" , ~/~/ описание 592 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 593 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 594 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 595 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 596 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 597 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 254 254 "isEnabled": "" , ~/~/ признак включения 255 255 "parentId": "" , ~/~/ Guid родительского агента 256 256 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 257 257 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 258 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 259 - "kind": "" , ~/~/ тип аутентификации 260 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 602 + "doubleAuth": 603 + { 604 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 605 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 606 + }, 607 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 261 261 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 262 262 263 263 (% lang="en-US" style="text-align:left" %) 264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) // //__}__611 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 265 265 266 266 (% lang="en-US" style="text-align:left" %) 267 267 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 268 268 269 269 (% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) //{//617 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 271 271 272 272 (% lang="en-US" style="text-align:left" %) 273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) //"id": "" , ~/~/ идентификатор пользователя620 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 274 274 "lastName": "" , ~/~/ фамилия 275 275 "firstName": "" , ~/~/ имя 276 276 "position": "" , ~/~/ должность ... ... @@ -283,27 +283,32 @@ 283 283 "isEnabled": "" , ~/~/ признак включения 284 284 "parentId": "" , ~/~/ Guid родительского агента 285 285 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 286 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 287 - "kind": "" , ~/~/ тип аутентификации 633 + "doubleAuth": 634 + { 635 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 636 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 637 + }, 638 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 288 288 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя //640 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 290 290 291 291 (% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) // //}643 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 293 293 645 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 294 294 295 295 (% class="box warningmessage" %) 296 296 ((( 297 -(% style="color:#000000" %) **Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**649 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 298 298 ))) 299 299 300 -(% style="color:#000000" %) . Метод позволяет изменить статус пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).652 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 301 301 302 302 (% style="color:#000000" %)Метод запроса: **PUT** 303 303 304 304 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 305 305 306 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 658 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 307 307 308 308 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 309 309 ... ... @@ -315,78 +315,539 @@ 315 315 "description": "" , ~/~/ описание 316 316 "data": "" , ~/~/ данные, связанные со сменой статуса 317 317 318 - 670 +(% style="color:#000000" %)} 319 319 320 320 (% style="text-align:left" %) 321 321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 322 322 675 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 323 323 677 +(% class="box warningmessage" %) 678 +((( 679 +**POST /api/v3/users/disable** 680 +))) 681 + 682 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 683 + 684 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 685 + 686 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 687 + 688 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 689 + 690 + [ 691 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 692 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 693 + ] 694 + 695 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 696 + 697 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 698 + 699 +(% class="box warningmessage" %) 700 +((( 701 +**POST /api/v3/users/enable** 702 +))) 703 + 704 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 705 + 706 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 707 + 708 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 709 + 710 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 711 + 712 + [ 713 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 714 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 715 + ] 716 + 717 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 718 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 719 + 720 +((( 721 +В теле ответа: 722 +{ 723 + "errorMessages": [ 724 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 725 + ], 726 + "users": [ 727 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 728 + ] 729 +} 730 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 731 +"users" - массив id пользователей, которых не удалось включить или отключить. 732 +))) 733 + 734 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 735 + 324 324 (% class="box errormessage" %) 325 325 ((( 326 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**738 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 327 327 ))) 328 328 329 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).741 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 330 330 331 331 (% style="color:#000000" %)Метод запроса: **DELETE** 332 332 333 333 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 334 334 335 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации747 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 336 336 749 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 750 + 337 337 (% style="text-align:left" %) 338 338 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 339 339 754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 340 340 341 -(% class="box" style="text-align: center;" %) 756 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 757 + 758 +(% class="box infomessage" %) 342 342 ((( 343 -(% style="color:#000000; font-size:14pt" %)**РазделТранспортные средства**760 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 344 344 ))) 345 345 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 + 997 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 998 + 999 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 1000 + 346 346 (% class="box infomessage" %) 347 347 ((( 348 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**1003 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 349 349 ))) 350 350 351 -(% style="color:#000000" %) 1006 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 352 352 353 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):1008 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 354 354 355 355 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 356 356 357 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 1012 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 358 358 359 359 (% style="color:#000000" %)Метод запроса: **GET** 360 360 361 -(% 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} 362 362 363 -(% style="color:#000000" %)Параметр запроса: <vehicleid>- идентификатор объекта (опционально)1018 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 364 364 365 365 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 366 366 367 367 (% style="color:#000000" %)Ответ: 368 368 369 -(% style="color:#000000" %){ 1024 +((( 1025 +{ 1026 + "vehicleId": "", ~/~/ ID объекта 1027 + "name": "", ~/~/ Имя объекта 1028 + "imei": "", ~/~/ IMEI объекта 1029 + "deviceTypeId": , ~/~/ ID типа устройства 1030 + "deviceTypeName": "", ~/~/ Название типа устройства 1031 + "sim1": "", ~/~/ Номер SIM1 1032 + "sim2": "", ~/~/ Номер SIM2 370 370 371 -(% class="western" %) 372 -{{{ "vehicleId": “”, // идентификатор объекта 373 - "name": "", // имя объекта 374 - "imei": "", // IMEI объекта 375 - "deviceTypeId": “”, // идентификатор устройства объекта 376 - "deviceTypeName": "" // наименование устройства объекта 377 - "parentId": "", // идентификатор клиента-родителя 378 - "parentName": "" // наименование клиента-родителя, 379 - "modelId": "", // идентификатор модели объекта 380 - "modelName": "" // наименование модели объекта, 381 - "unitId": "", // идентификатор подразделения 382 - "unitName": "", // наименование подразделения 383 - "status": “”, // статус объекта 384 - ... 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": "", ~/~/ Дата создания объекта 1044 + }, 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" ~/~/ Дата пересчета последних моточасов 385 385 }, 386 - ...}}} 387 387 388 -(% style="color:#000000" %)} 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 + }, 389 389 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 + 1174 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1175 + { 1176 + "id": "", ~/~/ ID задания 1177 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 1178 + "name": "", ~/~/ Наименование задания 1179 + "description": "", ~/~/ Описание задания 1180 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1181 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1182 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1183 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1184 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1185 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1186 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 1187 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1188 + } 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 + 1200 +} 1201 +))) 1202 + 390 390 (% style="text-align:left" %) 391 391 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 392 392 ... ... @@ -393,13 +393,14 @@ 393 393 (% style="text-align:left" %) 394 394 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 395 395 1209 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 396 396 397 397 (% class="box successmessage" %) 398 398 ((( 399 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**1213 +(% lang="en-US" %)**POST /api/v3/vehicles** 400 400 ))) 401 401 402 -(% style="color:#000000" %) . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).1216 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 403 403 404 404 (% style="color:#000000" %)Метод запроса: **POST** 405 405 ... ... @@ -407,118 +407,226 @@ 407 407 408 408 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 409 409 410 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {1224 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 411 411 412 -(% class="western" %) 413 -{{{ "parentId": "", // ID клиента 414 - "name": "", // имя ТС 415 - "imei": "", // IMEI 416 - "deviceTypeId": "",// ID типа устройства 417 - "modelId": "", 418 - "unitId": "", // ID подразделения 419 - "sim1": "", // Номер SIM 1 420 - "sim2": "", // Номер SIM2 421 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 422 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 423 - "consumptionIdle": "",// Расход топлива на холостом ходу 424 - "counters": { 425 - "mileage": "", // пробег 426 - "mileageEnabled": true, // флаг активности счётчика "пробег" 427 - "motohours":"", // моточасы 428 - "motohoursEnabled": true // флаг активности счётчика "моточасы" 429 - }, 430 - "cmsv6Parameters": { // параметры CMSv6 431 - "enabled": true, // флаг включения 432 - //"id": "", // идентификатор 433 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 434 - "login": "", // имя учетной записи 435 - "password": "" // пароль учетной записи 1226 +(% style="color:#000000" %){ 1227 + 1228 + "parentId": "" , ~/~/ ID клиента 1229 + "name": "" , ~/~/ имя ТС 1230 + "imei": "" , ~/~/ IMEI 1231 + "deviceTypeId": "" , ~/~/ ID типа устройства 1232 + "modelId": "" , ~/~/ ID модели 1233 + "unitId": "" , ~/~/ ID подразделения 1234 + "sim1": "" , ~/~/ Номер SIM 1 1235 + "sim2": "" , ~/~/ Номер SIM2 1236 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1237 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1238 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1239 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1240 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1241 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1242 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1243 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1244 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1245 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1246 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1247 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1248 + 1249 + "mileageCalcMethod": 0, 1250 + "mileageCoeff": 0, 1251 + "locationByCellId": true, 1252 + "dottedLineTrackWhenNoCoords": true, 1253 + "counters": ~/~/ счетчики 1254 + { 1255 + "mileage": "" , ~/~/ пробег 1256 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1257 + "motohours": "" , ~/~/ моточасы 1258 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 436 436 }, 437 - "inspectionTasks": [ // задания на ТО 1260 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1261 + "enabled": true, ~/~/ флаг включения 1262 + "id": "" , ~/~/ идентификатор 1263 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1264 + "login": "" , ~/~/ имя учетной записи 1265 + "password": "" ~/~/ пароль учетной записи 1266 + }, 1267 + "inspectionTasks": ~/~/ задания на ТО 438 438 { 439 - "enabled": "", // Признак включения 440 - "name": "", // Имя задания 441 - "description": "", // Описание задания 442 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 443 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 444 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 445 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 446 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 447 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 448 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 449 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 1269 + "enabled": "" , ~/~/ Признак включения 1270 + "name": "" , ~/~/ Имя задания 1271 + "description": "" , ~/~/ Описание задания 1272 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1273 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1274 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1275 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1276 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1277 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1278 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1279 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1280 + } 1281 + 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 + ], 1296 + 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" 450 450 }, 451 - ]}}} 452 452 453 - (%style="color:#000000"%)…}1336 +~/~/ Характерные для произвольного: 454 454 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 + 455 455 (% style="color:#000000" %)Ответ: 456 456 457 457 (% style="color:#000000" %){ 458 458 459 -(% class="western" %) 460 -{{{ "vehicleId": "", //ID ТС 461 - "parentId": "", //Guid владельца ТС 462 - "name": "", //Имя объекта 463 - "imei": "", //IMEI 464 - "deviceTypeId": "", //ID типа устройства 465 - "modelId": "", //ID модели 466 - "unitId": "", //ID подразделения 467 - "sim1": "", //SIM1 468 - "sim2": "", //SIM2 469 - "consumptionPer100Km": "", //Расход топлива на 100 км 470 - "consumptionIdle": "", //Расход топлива на холостом ходу 471 - "counters": { //Счётчики 472 - "mileageEnabled": true, 473 - "motohoursEnabled": true, 474 - "mileage": "", 475 - "motohours": 345.0 476 - }, 477 - "cmsv6Parameters": { //Параметры CmsV6 478 - "id": null, 479 - "enabled": true, //флаг включения 480 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 481 - "login": "", // имя учетной записи 482 - "password": "" // пароль учетной записи 483 - }, 484 - "inspectionTasks": [ // задания на ТО 485 - { 486 - "id": "", // ID задачи 487 - "enabled": false, // Признак включения 488 - "name": "", // Имя задания 489 - "description": "", // Описание задания 490 - "mileageCondition": "", // Условие по пробегу 491 - "lastMileage": "", // Пробег (в метрах) 492 - "motohoursCondition": "", // Условие по моточасам 493 - "lastMotohours": "", // Моточасы 494 - "periodicCondition": "", // Условие периодичности по времени 495 - "kind": "", // Вид периодичности по времени 496 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 497 - } 498 - ]}}} 1378 + "vehicleId": "", ~/~/ID ТС 1379 + "parentId": "", ~/~/Guid владельца ТС 1380 + "name": "", ~/~/Имя объекта 1381 + "imei": "", ~/~/IMEI 1382 + "deviceTypeId": "", ~/~/ID типа устройства 1383 + "modelId": "", ~/~/ID модели 1384 + "unitId": "", ~/~/ID подразделения 1385 + "sim1": "", ~/~/SIM1 1386 + "sim2": "", ~/~/SIM2 1387 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1388 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1389 + "counters": { ~/~/Счётчики 1390 + "mileageEnabled": true, 1391 + "motohoursEnabled": true, 1392 + "mileage": "", 1393 + "motohours": 345.0 1394 + }, 1395 + "cmsv6Parameters": { ~/~/Параметры CmsV6 1396 + "id": null, 1397 + "enabled": true, ~/~/флаг включения 1398 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1399 + "login": "", ~/~/ имя учетной записи 1400 + "password": "" ~/~/ пароль учетной записи 1401 + }, 1402 + "inspectionTasks": { ~/~/ задания на ТО 1403 + "id": "", ~/~/ ID задачи 1404 + "enabled": false, ~/~/ Признак включения 1405 + "name": "", ~/~/ Имя задания 1406 + "description": "", ~/~/ Описание задания 1407 + "mileageCondition": "", ~/~/ Условие по пробегу 1408 + "lastMileage": "", ~/~/ Пробег (в метрах) 1409 + "motohoursCondition": "", ~/~/ Условие по моточасам 1410 + "lastMotohours": "", ~/~/ Моточасы 1411 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1412 + "kind": "", ~/~/ Вид периодичности по времени 1413 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1414 + } 499 499 500 500 (% style="text-align:left" %) 501 501 (% style="color:#000000" %)} 502 502 1419 +**Валидация:** 1420 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1421 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1422 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 503 503 504 -(% class="box successmessage" %) 1424 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1425 + 1426 +(% class="box infomessage" %) 505 505 ((( 506 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**1428 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 507 507 ))) 508 508 509 -(% style="color:#000000" %) 1431 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 510 510 511 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):1433 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 512 512 513 513 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 514 514 515 515 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 516 516 517 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 1439 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 518 518 519 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 1441 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 520 520 521 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 1443 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 522 522 523 523 (% style="color:#000000" %)Метод запроса: **POST** 524 524 ... ... @@ -526,78 +526,115 @@ 526 526 527 527 (% style="color:#000000" %)В заголовках запроса: 528 528 529 -(% style="color:#000000" %)− Content-Type: application/json 1451 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 530 530 531 531 (% style="color:#000000" %)− X-Auth: Токен авторизации 532 532 533 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):1455 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 534 534 535 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ ИмяТС(string,опционально)"imei":null,~/~/"710179307",##1457 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 536 536 537 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 1459 +{ 1460 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1461 + "name": null, ~/~/ Имя ТС (string, опционально) 1462 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1463 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1464 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1465 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 1466 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1467 + "customFields": null ~/~/ значение любого из произвольных полей ТС 1468 +} 538 538 539 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства(short,опционально)"parentId":null,~/~/IDклиента(Guid,опционально)"unitId":null##1470 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 540 540 541 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}1472 +(% style="color:#000000" %)Ответ: 542 542 543 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».1474 +(% style="color:#000000" %){ 544 544 545 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 1476 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1477 + "name": "" ~/~/ наименование объекта 1478 + "imei": "" ~/~/ IMEI объекта 1479 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 1480 + "deviceTypeName": "" ~/~/ наименование типа устройства 1481 + "sim1": "" ~/~/ первый номер телефона 1482 + "sim2": "" ~/~/ второй номер телефона 1483 + "parentId": "" ~/~/ идентификатор клиента-родителя 1484 + "parentName": "" ~/~/ наименование клиента-родителя 1485 + "modelId": "" ~/~/ идентификатор модели объекта 1486 + "modelName": "" ~/~/ наименование модели объекта 1487 + "unitId": "" ~/~/ идентификатор подразделения 1488 + "unitName": "" ~/~/ наименование подразделения 1489 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1490 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1491 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1492 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1493 + "customFields": [ 1494 + { 1495 + "id": "", ~/~/ идентификатор произвольного поля 1496 + "name": "", ~/~/ имя произвольного поля 1497 + "value": "", ~/~/ значение произвольного поля 1498 + "forClient": true, ~/~/ право на отображение у клиента 1499 + "forTooltip": false, ~/~/ право на отображение в подсказке 1500 + "forReport": false ~/~/ право на отображение в отчетах 1501 + }(%%) 1502 +(% style="color:#000000" %)} 546 546 547 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:1504 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 548 548 549 - 0-«Блокировка»1- «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис»,6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан»,11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».1506 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 550 550 551 - 552 552 (% class="box successmessage" %) 553 553 ((( 554 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**1510 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 555 555 ))) 556 556 557 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1513 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 558 558 559 559 (% style="color:#000000" %)Метод запроса: **POST** 560 560 561 561 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId} 562 562 563 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 1519 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 564 564 565 565 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 566 566 567 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {1523 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 568 568 569 -(% class="western" %) 570 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 571 - // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 572 - // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 573 - "date": "", // Дата смены статуса (null если сменить немедленно) 574 - "description": "", // Описание 575 - "data": "", // Данные 576 - "overwrite": false, // Флаг перезаписи 577 - "stage": "", // Состояние, может быть null}}} 1525 +(% style="color:#000000" %){ 578 578 1527 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1528 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1529 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1530 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1531 + "description": "", ~/~/ Описание 1532 + "data": "", ~/~/ Данные 1533 + "overwrite": false, ~/~/ Флаг перезаписи 1534 + "stage": "", ~/~/ Состояние, может быть null 1535 + 579 579 (% style="color:#000000" %)} 580 580 581 -(% style="color:#000000" %)Ответ: {1538 +(% style="color:#000000" %)Ответ: 582 582 583 -(% class="western" %) 584 -{{{ "status": "", // значение статуса 585 - "date": "", // Дата смены статуса 586 - "description": "", // Описание 587 - "data": "", // Данные 588 - "overwrite": false, // Флаг перезаписи 589 - "stage": "", // Состояние}}} 1540 +(% style="color:#000000" %){ 590 590 1542 + "status": "", ~/~/ значение статуса 1543 + "date": "", ~/~/ Дата смены статуса 1544 + "description": "", ~/~/ Описание 1545 + "data": "", ~/~/ Данные 1546 + "overwrite": false, ~/~/ Флаг перезаписи 1547 + "stage": "", ~/~/ Состояние 1548 + 591 591 (% style="text-align:left" %) 592 -(% style="color:#000000" %)} 1550 +(% style="color:#000000" %) } 593 593 1552 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 594 594 595 595 (% class="box warningmessage" %) 596 596 ((( 597 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**1556 +(% lang="en-US" %)**PUT /api/v3/vehicles** 598 598 ))) 599 599 600 -(% style="color:#000000" %) . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1559 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 601 601 602 602 (% style="color:#000000" %)Метод запроса: **PUT** 603 603 ... ... @@ -607,26 +607,223 @@ 607 607 608 608 (% style="color:#000000" %)Параметры в теле запроса (JSON): 609 609 610 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 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 1579 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1580 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1581 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1582 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1583 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1584 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1585 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1586 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1587 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1588 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1589 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1590 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 611 611 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 + } 1624 + 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 + 612 612 (% style="color:#000000" %)Ответ: 613 613 614 614 (% lang="en-US" style="text-align:left" %) 615 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»:«», //ID ТС «parentId»:«», //ID клиента «name»:«», //имя ТС «imei»:«»,//IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }1720 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 616 616 1722 +(% lang="en-US" style="text-align:left" %) 1723 + "vehicleId": "", ~/~/ ID ТС 1724 + "parentId": "", ~/~/ ID клиента 1725 + "name": "", ~/~/ имя ТС 1726 + "imei": "", ~/~/ IMEI 1727 + "deviceTypeId": "", ~/~/ типа устройства 1728 + "modelId": "", ~/~/ ID модели 1729 + "unitId": "", ~/~/ ID подразделения 1730 + "sim1": "", ~/~/ SIM 1 1731 + "sim2": "", ~/~/ SIM2 1732 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1733 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1734 + "counters": 1735 + { 1736 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1737 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1738 + "mileage": "", ~/~/ пробег 1739 + "motohours": "", ~/~/ моточасы 1740 + } 1741 + "cmsv6Parameters": ~/~/ параметры CMSv6 1742 + { 1743 + "id": ~/~/ идентификатор 1744 + "enabled": true, ~/~/ флаг включения 1745 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1746 + "login": "", ~/~/ имя учетной записи 1747 + "password": "", ~/~/ пароль учетной записи 1748 + } 1749 + "inspectionTasks": ~/~/ задания на ТО 1750 + { 1751 + "id": "", ~/~/ ID задания 1752 + "enabled": false, ~/~/ Признак включения 1753 + "name": "", ~/~/ Имя задания 1754 + "description": "", ~/~/ Описание задания 1755 + "mileageCondition": "", ~/~/ Условие по пробегу 1756 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1757 + "motohoursCondition": "", ~/~/ Условие по моточасам 1758 + "lastMotohours": "", ~/~/ Моточасы 1759 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1760 + "kind": "", ~/~/ Вид периодичности по времени 1761 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1762 + } 617 617 1764 +(% lang="en-US" style="text-align:left" %) 1765 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1766 + 1767 +**Валидация:** 1768 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1769 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1770 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1771 + 1772 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1773 + 618 618 (% class="box errormessage" %) 619 619 ((( 620 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1776 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 621 621 ))) 622 622 623 -(% style="color:#000000" %) . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1779 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 624 624 625 625 (% style="color:#000000" %)Метод запроса: **DELETE** 626 626 627 627 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 628 628 629 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 1785 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 630 630 631 631 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 632 632 ... ... @@ -633,70 +633,2134 @@ 633 633 (% style="text-align:left" %) 634 634 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 635 635 1792 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 636 636 637 -(% class="box" lang="en-US" style="text-align: center;" %) 1794 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1795 + 1796 +(% class="box infomessage" %) 638 638 ((( 639 -(% style="color:#000000; font-size:14pt" %)**РазделУстройства**1798 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 640 640 ))) 641 641 1801 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1802 + 1803 +(% style="color:#000000" %)Метод запроса: **GET** 1804 + 1805 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1806 + 1807 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1808 + 1809 +(% style="color:#000000" %)Ответ: 1810 + 1811 +(% style="color:#000000" %){ 1812 + 1813 + "deviceTypeId" : "", ~/~/ ID типа устройства 1814 + "deviceTypeName" : "" ~/~/ Название типа устройства 1815 + 1816 +(% style="text-align:left" %) 1817 +(% style="color:#000000" %)} 1818 + 1819 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1820 + 1821 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1822 + 642 642 (% class="box infomessage" %) 643 643 ((( 644 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов устройств**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**1825 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 645 645 ))) 646 646 647 -(% style="color:#000000" %) устройств. Метод возвращает информацию о типахустройств с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1828 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 648 648 649 649 (% style="color:#000000" %)Метод запроса: **GET** 650 650 651 -(% 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]]1832 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 652 652 653 653 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 654 654 655 -(% style="color:#000000" %)Ответ: [1836 +(% style="color:#000000" %)Ответ: 656 656 657 -(% class="western" %) 658 -{{{ { 659 - "deviceTypeId" : "", // ID типа устройства 660 - "deviceTypeName" : "" // Название типа устройства 661 - },}}} 1838 +(% style="color:#000000" %){ 662 662 1840 + "id": "", ~/~/ ID типа датчика 1841 + "name": "", ~/~/ Название 1842 + "description": "", ~/~/ Описание 1843 + 663 663 (% style="text-align:left" %) 664 -(% style="color:#000000" %) …** **]1845 +(% style="color:#000000" %)} 665 665 1847 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 666 666 667 -(% class="box" style="text-align: center;" %) 1849 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1850 + 1851 +(% class="box infomessage" style="text-align: left;" %) 668 668 ((( 669 - (%style="color:#000000; font-size:14pt" %)**Раздел Датчики**1853 +**POST /api/v3/terminalMessages/count** 670 670 ))) 671 671 1856 +(% style="text-align: left;" %) 1857 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1858 + 1859 +(% style="text-align: left;" %) 1860 +Метод запроса **POST** 1861 + 1862 +(% style="text-align: left;" %) 1863 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1864 + 1865 +(% style="text-align: left;" %) 1866 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1867 + 1868 +(% style="text-align: left;" %) 1869 +{ 1870 + "vehicleIds": [ 1871 + id ~/~/ здесь передается список идентификаторов объектов 1872 + ], 1873 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1874 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1875 +} 1876 + 1877 +(% style="text-align: left;" %) 1878 +Ответ: 1879 + 1880 +(% style="text-align: left;" %) 1881 +[ 1882 + { 1883 + "vehicleId": 0, ~/~/ идентификатор объекта 1884 + "count": 0 ~/~/ количество сообщений за период 1885 + } 1886 +] 1887 + 1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1889 + 1890 +(% class="box infomessage" style="text-align: left;" %) 1891 +((( 1892 +**POST /api/v3/terminalMessages/mapping** 1893 +))) 1894 + 1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1896 + 1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1898 + 1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1900 + 1901 +{ 1902 + "protocolType": 0, 1903 + "params": ["string"] 1904 +} 1905 + 1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1907 +|protocolType|ID типа протокола 1908 +|params|((( 1909 +Массив наименований параметров в сообщении 1910 +))) 1911 + 1912 +Ответ: 1913 + 1914 +{ 1915 + "protocolType": 0, 1916 + "mapping": { 1917 + "additionalProp1": { 1918 + "inputType": 0, 1919 + "inputNumber": 0 1920 + }, 1921 + "additionalProp2": { 1922 + "inputType": 0, 1923 + "inputNumber": 0 1924 + } 1925 + } 1926 +} 1927 + 1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1929 +|protocolType|Тип протокола 1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1931 +|inputNumber|Номер входа 1932 + 1933 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1934 + 672 672 (% class="box infomessage" %) 673 673 ((( 674 - (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GETsensors/types**1937 +**POST /api/v3/terminalMessages** 675 675 ))) 676 676 677 - (% style="color:#000000" %)Методпозволяетполучитьсписоктипов датчиков. Метод возвращает информациюотипах датчиков с учетомстроекавторизованногопользователя, указанноговзапросе(обязательный параметрв заголовках запроса - токен авторизации **«X-Auth»**).1940 +Метод возвращает список сообщений терминала объекта за выбранный период. 678 678 679 -(% style="color:#000000" %)Метод запроса: **GET** 1942 +(% style="text-align: left;" %) 1943 +Метод запроса **POST** 680 680 681 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1945 +(% style="text-align: left;" %) 1946 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 682 682 683 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1948 +(% style="text-align: left;" %) 1949 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 684 684 685 -(% style="color:#000000" %)Ответ: [ 1951 +{ 1952 + "vehicleId": 0, ~/~/ id объекта 1953 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1954 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1955 +} 686 686 687 -(% class="western" style="margin-bottom:19px" %) 688 -{{{ {}}} 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|Дата и время окончания периода запроса 689 689 690 - (% style="color:#000000" %)«id»: «», //IDтипа датчика «name»: «», //Название1962 +Ответ: 691 691 692 -(% class="western" %) 693 -{{{ "description": "" // Описание 694 - },}}} 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 +] 695 695 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 + 696 696 (% style="text-align:left" %) 697 - (%style="color:#000000" %)… ]2021 +Тело запроса: 698 698 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 +} 699 699 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 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2139 + 2140 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2141 + 2142 +(% class="box infomessage" %) 2143 +((( 2144 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2145 +))) 2146 + 2147 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2148 + 2149 +(% style="color:#000000" %)Метод запроса: **POST** 2150 + 2151 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2152 + 2153 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2154 + 2155 +(% style="text-align:left" %) 2156 +Тело запроса: 2157 + 2158 +(% style="text-align:left" %) 2159 +{ 2160 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2161 +} 2162 + 2163 +(% style="text-align:left" %) 2164 +Ответ: 2165 + 2166 +[ 2167 + { 2168 + "id": 0, ~/~/ Идентификатор объекта геозоны 2169 + "name": "string", ~/~/ Название объекта геозоны 2170 + "type": 0, ~/~/ Тип объекта геозоны 2171 + "fname": "string", ~/~/ Имя файла 2172 + "parentId": "string", ~/~/ Идентификатор клиента 2173 + "radius": 0, ~/~/ Радиус геообъекта 2174 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2175 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2176 + "description": "string", ~/~/ Описание 2177 + "area": 0, ~/~/ Площадь, м^^2^^ 2178 + "perimetr": 0, ~/~/ Периметр, м 2179 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2180 + } 2181 +] 2182 + 2183 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2184 + 2185 +(% class="box infomessage" %) 2186 +((( 2187 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2188 +))) 2189 + 2190 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2191 + 2192 +(% style="color:#000000" %)Метод запроса: **POST** 2193 + 2194 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2195 + 2196 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2197 + 2198 +(% style="text-align:left" %) 2199 +Тело запроса: 2200 + 2201 +{ 2202 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2203 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2204 + "ids": [ ], ~/~/ Массив id объектов 2205 + "byTime": 0, ~/~/ Объединение событий по времени 2206 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2207 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2208 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2209 +} 2210 + 2211 +Ответ: 2212 +[ 2213 + { 2214 + "geozoneId": 0, ~/~/ ID геообъекта 2215 + "geozoneName": "string", ~/~/ Название геообъекта 2216 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2217 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2218 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2219 + "vehicleId": 0, ~/~/ ID объекта 2220 + "vehicleName": "string" ~/~/ Имя объекта 2221 + } 2222 +] 2223 + 2224 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2225 + 2226 +(% class="box infomessage" %) 2227 +((( 2228 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2229 +))) 2230 + 2231 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2232 + 2233 +(% style="color:#000000" %)Метод запроса: **POST** 2234 + 2235 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2236 + 2237 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2238 + 2239 +(% style="text-align:left" %) 2240 +Тело запроса: 2241 + 2242 +{ 2243 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2244 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2245 + "ids": [ ], ~/~/ Массив id геообъектов 2246 + "byTime": 0, ~/~/ Объединение событий по времени 2247 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2248 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2249 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2250 +} 2251 + 2252 +Ответ: 2253 + 2254 +[ 2255 + { 2256 + "geozoneId": 0, ~/~/ ID геообъекта 2257 + "geozoneName": "string", ~/~/ Название геообъекта 2258 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2259 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2260 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2261 + "vehicleId": 0, ~/~/ ID объекта 2262 + "vehicleName": "string" ~/~/ Имя объекта 2263 + } 2264 +] 2265 + 2266 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2267 + 2268 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2269 + 2270 +(% class="box infomessage" %) 2271 +((( 2272 +**POST /api/v3/notifications/find** 2273 +))) 2274 + 2275 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2276 + 2277 +(% style="text-align: left;" %) 2278 +Метод запроса **POST** 2279 + 2280 +(% style="text-align: left;" %) 2281 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2282 + 2283 +(% style="text-align: left;" %) 2284 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2285 + 2286 +{ 2287 + "parentId": "" ~/~/ id клиента 2288 +} 2289 + 2290 +Ответ: 2291 + 2292 +[ 2293 + { 2294 + "id": 0, ~/~/ ID уведомления 2295 + "name": "string", ~/~/ Название уведомления 2296 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2297 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2298 + "userId": "", ~/~/ Пользователь, создавший уведомление 2299 + "parentId": "", ~/~/ Идентификатор клиента 2300 + "parentName": "string" ~/~/ Имя клиента 2301 + } 2302 +] 2303 + 2304 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2305 + 2306 +(% class="box infomessage" %) 2307 +((( 2308 +**GET /api/v3/notifications/{id}** 2309 +))) 2310 + 2311 +Метод возвращает данные правил формирования выбранного уведомления. 2312 + 2313 +(% style="text-align: left;" %) 2314 +Метод запроса **GET** 2315 + 2316 +(% style="text-align: left;" %) 2317 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2318 + 2319 +(% style="text-align: left;" %) 2320 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2321 + 2322 +(% style="text-align: left;" %) 2323 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2324 + 2325 +(% style="text-align: left;" %) 2326 +(% style="color:#000000" %)Ответ: 2327 + 2328 +(% style="text-align: left;" %) 2329 +(% style="color:#000000" %){ 2330 + "id": 0, ~/~/ (%%)id уведомления 2331 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2332 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2333 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2334 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2335 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2336 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2337 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2338 +(% style="color:#000000" %) 0 2339 + ], 2340 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2341 +(% style="color:#000000" %) 0 2342 + ], 2343 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2344 +(% style="color:#000000" %) 0 2345 + ], 2346 + "settings": { ~/~/ Список параметров уведомления 2347 + "additionalProp1": "string", 2348 + "additionalProp2": "string", 2349 + "additionalProp3": "string" 2350 + }, 2351 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2352 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2353 +(% style="color:#000000" %) "" 2354 + ], 2355 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2356 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2357 +(% style="color:#000000" %) "string" 2358 + ], 2359 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2360 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2361 +(% style="color:#000000" %) { 2362 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2363 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2364 +(% style="color:#000000" %) } 2365 + ], 2366 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2367 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2368 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2369 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2370 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2371 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2372 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2373 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2374 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2375 +(% style="color:#000000" %)} 2376 + 2377 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2378 + 2379 +(% class="box warningmessage" %) 2380 +((( 2381 +**PUT /api/v3/notifications/** 2382 +))) 2383 + 2384 +Метод позволяет отредактировать уведомление. 2385 + 2386 +Метод запроса **PUT** 2387 + 2388 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2389 + 2390 +В заголовках запроса: X-Auth: Токен авторизации 2391 + 2392 +Тело запроса: 2393 +{ 2394 + "id": 0, ~/~/ id уведомления 2395 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2396 + "userId": "", ~/~/ Пользователь, создавший уведомление 2397 + "parentId": "", ~/~/ Идентификатор клиента 2398 + "parentName": "string", ~/~/ Имя клиента 2399 + "name": "string", ~/~/ Название уведомления 2400 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2401 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2402 + 0 2403 + ], 2404 + "geoids": [ ~/~/ Список id геообъектов для анализа 2405 + 0 2406 + ], 2407 + "fieldids": [ ~/~/ Список id полей для анализа 2408 + 0 2409 + ], 2410 + "settings": { ~/~/ Список параметров уведомления 2411 + "additionalProp1": "string", 2412 + "additionalProp2": "string", 2413 + "additionalProp3": "string" 2414 + }, 2415 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2416 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2417 + "" 2418 + ], 2419 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2420 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2421 + "string" 2422 + ], 2423 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2424 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2425 + { 2426 + "id": 0, ~/~/ Идентификатор участника чата 2427 + "info": "string" ~/~/ Дополнительные сведения 2428 + } 2429 + ], 2430 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2431 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2432 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2433 + "kind": 0, ~/~/ Определяет вид уведомления 2434 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2435 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2436 + "timezone": 0, ~/~/ Сдвиг часового пояса 2437 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2438 + "autoProlongation": true ~/~/ Автопродление срока действия 2439 +} 2440 + 2441 +Ответ: 2442 + 2443 +Success 2444 + 2445 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2446 + 2447 +(% class="box errormessage" %) 2448 +((( 2449 +**DELETE /api/v3/notifications/{id}** 2450 +))) 2451 + 2452 +Метод позволяет удалить выбранное уведомление. 2453 + 2454 +Метод запроса **DELETE** 2455 + 2456 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2457 + 2458 +Передаваемый параметр: {id} - id уведомления 2459 + 2460 +В заголовках запроса: X-Auth: Токен авторизации 2461 + 2462 +Ответ: 2463 + 2464 +Success 2465 + 2466 + 2467 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2468 + 2469 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2470 + 2471 +(% class="box infomessage" %) 2472 +((( 2473 +**POST /api/v3/Drivers/find** 2474 +))) 2475 + 2476 +Передается параметр: parentId - ID клиента-родителя 2477 + 2478 +Ответ: 2479 + 2480 +[ 2481 + { 2482 + "name": "string", ~/~/ Определяет наименование 2483 + "description": "string", ~/~/ Определяет описание 2484 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2485 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2486 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2487 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2488 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2489 + "deleted": true ~/~/ Признак удаления 2490 + } 2491 +] 2492 + 2493 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2494 + 2495 +(% class="box infomessage" %) 2496 +((( 2497 +**GET /api/v3/Drivers/{driverGuid}** 2498 +))) 2499 + 2500 +Передается параметр: ID водителя 2501 + 2502 +Ответ: 2503 + 2504 +{ 2505 + "name": "string", ~/~/ Определяет наименование 2506 + "description": "string", ~/~/ Определяет описание 2507 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2508 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2509 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2510 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2511 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2512 + "deleted": true ~/~/ Признак удаления 2513 +} 2514 + 2515 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2516 + 2517 +(% class="box successmessage" %) 2518 +((( 2519 +**POST /api/v3/Drivers** 2520 +))) 2521 + 2522 +Запрос: 2523 + 2524 +{ 2525 + "name": "string", 2526 + "description": "string", 2527 + "hiredate": "2023-06-30T12:50:54.020Z", 2528 + "chopdate": "2023-06-30T12:50:54.020Z", 2529 + "exclusive": true, 2530 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2531 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2532 + "deleted": true 2533 +} 2534 + 2535 +Ответ: 2536 + 2537 +{ 2538 + "name": "string", 2539 + "description": "string", 2540 + "hiredate": "2023-06-30T12:50:54.051Z", 2541 + "chopdate": "2023-06-30T12:50:54.051Z", 2542 + "exclusive": true, 2543 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2544 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2545 + "deleted": true 2546 +} 2547 + 2548 + 2549 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2550 + 2551 +(% class="box warningmessage" %) 2552 +((( 2553 +**PUT /api/v3/Drivers** 2554 +))) 2555 + 2556 +Запрос: 2557 + 2558 +{ 2559 + "name": "string", 2560 + "description": "string", 2561 + "hiredate": "2023-06-30T12:50:27.910Z", 2562 + "chopdate": "2023-06-30T12:50:27.910Z", 2563 + "exclusive": true, 2564 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2565 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2566 + "deleted": true 2567 +} 2568 + 2569 +Ответ: 2570 + 2571 +{ 2572 + "name": "string", 2573 + "description": "string", 2574 + "hiredate": "2023-06-30T12:50:27.929Z", 2575 + "chopdate": "2023-06-30T12:50:27.929Z", 2576 + "exclusive": true, 2577 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2578 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2579 + "deleted": true 2580 +} 2581 + 2582 + 2583 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2584 + 2585 +(% class="box errormessage" %) 2586 +((( 2587 +**DELETE /api/v3/Drivers/{driverGuid}** 2588 +))) 2589 + 2590 +Передается параметр: ID водителя 2591 + 2592 +Ответ: 2593 + 2594 +Success 2595 + 2596 + 2597 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2598 + 2599 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2600 + 2601 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2602 + 2603 +(% class="box infomessage" %) 2604 +((( 2605 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2606 +))) 2607 + 2608 +Запрос: 2609 + 2610 +{ 2611 + "Ids": [ 2612 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2613 + ], 2614 + "BeginTime": "2023-06-30T12:49:04.365Z", 2615 + "EndTime": "2023-06-30T12:49:04.365Z" 2616 +} 2617 + 2618 +Ответ: 2619 + 2620 +[ 2621 + { 2622 + "VehicleId": 0, 2623 + "CreateTime": "2023-06-30T09:52:31.240Z", 2624 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2625 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2626 + "BeginTime": "2023-06-30T09:52:31.240Z", 2627 + "EndTime": "2023-06-30T09:52:31.240Z" 2628 + } 2629 +] 2630 + 2631 + 2632 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2633 + 2634 +(% class="box infomessage" %) 2635 +((( 2636 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2637 +))) 2638 + 2639 +Запрос: 2640 + 2641 +{ 2642 + "Ids": [ 2643 + 0 2644 + ], 2645 + "BeginTime": "2023-06-30T12:48:39.419Z", 2646 + "EndTime": "2023-06-30T12:48:39.419Z" 2647 +} 2648 + 2649 +Ответ: 2650 + 2651 +[ 2652 + { 2653 + "VehicleId": 0, 2654 + "CreateTime": "2023-06-30T09:54:01.631Z", 2655 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2656 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2657 + "BeginTime": "2023-06-30T09:54:01.631Z", 2658 + "EndTime": "2023-06-30T09:54:01.631Z" 2659 + } 2660 +] 2661 + 2662 + 2663 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2664 + 2665 +(% class="box successmessage" %) 2666 +((( 2667 +**POST /api/v3/DriversVehiclesAssignments** 2668 +))) 2669 + 2670 +Передается массив назначений 2671 + 2672 +Запрос: 2673 + 2674 +[ 2675 + { 2676 + "VehicleId": 0, ~/~/ Идентификатор объекта 2677 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2678 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2679 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2680 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2681 + } 2682 +] 2683 + 2684 +Ответ: 2685 + 2686 +[ 2687 + { 2688 + "VehicleId": 0, 2689 + "CreateTime": "2023-06-30T11:04:46.903Z", 2690 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2691 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2692 + "BeginTime": "2023-06-30T11:04:46.903Z", 2693 + "EndTime": "2023-06-30T11:04:46.903Z" 2694 + } 2695 +] 2696 + 2697 + 2698 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2699 + 2700 +(% class="box warningmessage" %) 2701 +((( 2702 +**PUT /api/v3/DriversVehiclesAssignments** 2703 +))) 2704 + 2705 +Запрос: 2706 + 2707 +[ 2708 + { 2709 + "VehicleId": 0, 2710 + "CreateTime": "2023-06-30T11:14:08.117Z", 2711 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2712 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2713 + "BeginTime": "2023-06-30T11:14:08.117Z", 2714 + "EndTime": "2023-06-30T11:14:08.117Z" 2715 + } 2716 +] 2717 + 2718 +Ответ: 2719 + 2720 +[ 2721 + { 2722 + "VehicleId": 0, 2723 + "CreateTime": "2023-06-30T11:14:53.349Z", 2724 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2725 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2726 + "BeginTime": "2023-06-30T11:14:53.349Z", 2727 + "EndTime": "2023-06-30T11:14:53.349Z" 2728 + } 2729 +] 2730 + 2731 + 2732 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2733 + 2734 +(% class="box errormessage" %) 2735 +((( 2736 +**DELETE /api/v3/DriversVehiclesAssignments** 2737 +))) 2738 + 2739 +Запрос: 2740 + 2741 +[ 2742 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2743 +] 2744 + 2745 +Ответ: 2746 + 2747 +Success 2748 + 2749 + 2750 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2751 + 2752 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2753 + 2754 +(% class="box infomessage" %) 2755 +((( 2756 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2757 +))) 2758 + 2759 +Запрос: 2760 + 2761 +{ 2762 + "Ids": [ 2763 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2764 + ], 2765 + "BeginTime": "2023-06-30T12:47:12.162Z", 2766 + "EndTime": "2023-06-30T12:47:12.162Z" 2767 +} 2768 + 2769 +Ответ: 2770 + 2771 +[ 2772 + { 2773 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2774 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2775 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2776 + "BeginTime": "2023-06-30T11:19:40.703Z", 2777 + "EndTime": "2023-06-30T11:19:40.703Z" 2778 + } 2779 +] 2780 + 2781 + 2782 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2783 + 2784 +(% class="box infomessage" %) 2785 +((( 2786 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2787 +))) 2788 + 2789 +Запрос: 2790 + 2791 +{ 2792 + "Ids": [ 2793 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2794 + ], 2795 + "BeginTime": "2023-06-30T12:47:12.162Z", 2796 + "EndTime": "2023-06-30T12:47:12.162Z" 2797 +} 2798 + 2799 +Ответ: 2800 + 2801 +[ 2802 + { 2803 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2804 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2805 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2806 + "BeginTime": "2023-06-30T11:19:40.703Z", 2807 + "EndTime": "2023-06-30T11:19:40.703Z" 2808 + } 2809 +] 2810 + 2811 + 2812 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2813 + 2814 +(% class="box successmessage" %) 2815 +((( 2816 +**POST /api/v3/DriversRfidsAssignments** 2817 +))) 2818 + 2819 +Запрос: 2820 + 2821 +[ 2822 + { 2823 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2824 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2825 + "BeginTime": "2023-06-30T11:27:08.635Z", 2826 + "EndTime": "2023-06-30T11:27:08.635Z" 2827 + } 2828 +] 2829 + 2830 +Ответ: 2831 + 2832 +[ 2833 + { 2834 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2835 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2836 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2837 + "BeginTime": "2023-06-30T11:27:08.677Z", 2838 + "EndTime": "2023-06-30T11:27:08.677Z" 2839 + } 2840 +] 2841 + 2842 + 2843 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2844 + 2845 +(% class="box warningmessage" %) 2846 +((( 2847 +**PUT /api/v3/DriversRfidsAssignments** 2848 +))) 2849 + 2850 +Запрос: 2851 + 2852 +[ 2853 + { 2854 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2855 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2856 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2857 + "BeginTime": "2023-06-30T11:28:43.330Z", 2858 + "EndTime": "2023-06-30T11:28:43.330Z" 2859 + } 2860 +] 2861 + 2862 +Ответ: 2863 + 2864 +[ 2865 + { 2866 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2867 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2868 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2869 + "BeginTime": "2023-06-30T11:28:43.331Z", 2870 + "EndTime": "2023-06-30T11:28:43.331Z" 2871 + } 2872 +] 2873 + 2874 + 2875 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2876 + 2877 +(% class="box errormessage" %) 2878 +((( 2879 +**DELETE /api/v3/DriversRfidsAssignments** 2880 +))) 2881 + 2882 +Запрос: 2883 + 2884 +[ 2885 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2886 +] 2887 + 2888 +Ответ: 2889 + 2890 +Success 2891 + 2892 + 2893 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 2894 + 2895 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2896 + 2897 +(% class="box infomessage" %) 2898 +((( 2899 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2900 +))) 2901 + 2902 +Запрос: 2903 + 2904 +{ 2905 + "Ids": [ 2906 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2907 + ], 2908 + "BeginTime": "2023-06-30T12:45:10.852Z", 2909 + "EndTime": "2023-06-30T12:45:10.852Z" 2910 +} 2911 + 2912 +Ответ: 2913 + 2914 +[ 2915 + { 2916 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2917 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2918 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2919 + "BeginTime": "2023-06-30T11:58:04.695Z", 2920 + "EndTime": "2023-06-30T11:58:04.695Z" 2921 + } 2922 +] 2923 + 2924 + 2925 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2926 + 2927 +(% class="box infomessage" %) 2928 +((( 2929 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 2930 +))) 2931 + 2932 +Запрос: 2933 + 2934 +{ 2935 + "Ids": [ 2936 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2937 + ], 2938 + "BeginTime": "2023-06-30T12:45:10.852Z", 2939 + "EndTime": "2023-06-30T12:45:10.852Z" 2940 +} 2941 + 2942 +Ответ: 2943 + 2944 +[ 2945 + { 2946 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2947 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2948 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2949 + "BeginTime": "2023-06-30T11:58:04.695Z", 2950 + "EndTime": "2023-06-30T11:58:04.695Z" 2951 + } 2952 +] 2953 + 2954 + 2955 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2956 + 2957 +(% class="box successmessage" %) 2958 +((( 2959 +**POST /api/v3/DriversFuelCardsAssignments** 2960 +))) 2961 + 2962 +Запрос: 2963 + 2964 +[ 2965 + { 2966 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2967 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2968 + "BeginTime": "2023-06-30T12:09:53.175Z", 2969 + "EndTime": "2023-06-30T12:09:53.175Z" 2970 + } 2971 +] 2972 + 2973 +Ответ: 2974 + 2975 +[ 2976 + { 2977 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2978 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2979 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2980 + "BeginTime": "2023-06-30T12:09:53.201Z", 2981 + "EndTime": "2023-06-30T12:09:53.201Z" 2982 + } 2983 +] 2984 + 2985 + 2986 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2987 + 2988 +(% class="box warningmessage" %) 2989 +((( 2990 +**PUT /api/v3/DriversFuelCardsAssignments** 2991 +))) 2992 + 2993 +Запрос: 2994 + 2995 +[ 2996 + { 2997 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2998 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2999 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3000 + "BeginTime": "2023-06-30T12:09:53.201Z", 3001 + "EndTime": "2023-06-30T12:09:53.201Z" 3002 + } 3003 +] 3004 + 3005 +Ответ: 3006 + 3007 +[ 3008 + { 3009 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3010 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3011 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3012 + "BeginTime": "2023-06-30T12:09:53.201Z", 3013 + "EndTime": "2023-06-30T12:09:53.201Z" 3014 + } 3015 +] 3016 + 3017 + 3018 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3019 + 3020 +(% class="box errormessage" %) 3021 +((( 3022 +**DELETE /api/v3/DriversFuelCardsAssignments** 3023 +))) 3024 + 3025 +Запрос: 3026 + 3027 +[ 3028 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3029 +] 3030 + 3031 +Ответ: 3032 + 3033 +Success 3034 + 3035 + 3036 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3037 + 3038 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3039 + 3040 +(% class="box infomessage" %) 3041 +((( 3042 +**POST /api/v3/Trailers** 3043 +))) 3044 + 3045 +Пример запроса: 3046 + 3047 +{ 3048 + "startDate": "2023-11-14T10:48:03.671Z", 3049 + "endDate": "2023-11-14T10:48:03.671Z", 3050 + "ids": [ 0 ], 3051 + "timezone": 0 3052 +} 3053 + 3054 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3055 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3056 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3057 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3058 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3059 + 3060 +Пример ответа: 3061 + 3062 +[ 3063 + { 3064 + "SD": "2023-11-14T10:48:03.717Z", 3065 + "ED": "2023-11-14T10:48:03.717Z", 3066 + "id": 0, 3067 + "SLat": 0, 3068 + "SLon": 0, 3069 + "ELat": 0, 3070 + "ELon": 0, 3071 + "mileage": 0 3072 + "Duration": 0 3073 + "Address": "string", 3074 + "Address2": "string", 3075 + "name": "string", 3076 + "rid": "string", 3077 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3078 + "trailer": { 3079 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3080 + "Number": "string", 3081 + "Description": "string", 3082 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3083 + "ExternalID": "string", 3084 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3085 + "CreateTime": "2023-11-14T10:48:03.717Z", 3086 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3087 + "IsDeleted": true 3088 + }, 3089 + "filesCount": 0, 3090 + } 3091 +] 3092 + 3093 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3094 +|SD|Дата и время начала события 3095 +|ED|Дата и время окончания события 3096 +|id|ID объекта 3097 +|SLat|Широта начальной координаты 3098 +|SLon|Долгота начальной координаты 3099 +|ELat|Широта конечной координаты 3100 +|ELon|Долгота конечной координаты 3101 +|mileage|Пробег 3102 +|Duration|Продолжительность 3103 +|Address|Адрес начального местоположения 3104 +|Address2|Адрес конечного местоположения 3105 +|name|Имя радиометки 3106 +|rid|Номер радиометки 3107 +|rguid|ID радиометки 3108 +|trailer|Информация об агрегате 3109 +|ModelGuid|ID агрегата 3110 +|Number|Название/номер агрегата 3111 +|Description|Текст примечания агрегата 3112 + 3113 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3114 + 3115 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3116 + 3117 +(% class="box infomessage" %) 3118 +((( 3119 +**POST /api/v3/Rfids/find** 3120 +))) 3121 + 3122 +Запрос: 3123 + 3124 +{ 3125 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3126 +} 3127 + 3128 +Ответ: 3129 + 3130 +[ 3131 + { 3132 + "name": "string", 3133 + "number": 0, 3134 + "period": 0, 3135 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3136 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3137 + } 3138 +] 3139 + 3140 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3141 +|parentId|ID клиента 3142 +|name|Название карты-метки 3143 +|number|Номер 3144 +|period|Период запросов в секундах (работает только для агрегатов) 3145 +|id|ID карты-метки 3146 + 3147 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3148 + 3149 +(% class="box infomessage" %) 3150 +((( 3151 +**GET /api/v3/Rfids/{rfidGuid}** 3152 +))) 3153 + 3154 +Передаем параметр rfidGuid - идентификатор карты-метки 3155 + 3156 +Ответ: 3157 + 3158 +[ 3159 + { 3160 + "name": "string", 3161 + "number": 0, 3162 + "period": 0, 3163 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3164 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3165 + } 3166 +] 3167 + 3168 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3169 +|name|Название карты-метки 3170 +|number|Номер 3171 +|period|Период запросов в секундах (работает только для агрегатов) 3172 +|id|ID карты-метки 3173 +|parentId|ID клиента 3174 + 3175 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3176 + 3177 +(% class="box successmessage" %) 3178 +((( 3179 +**POST /api/v3/Rfids** 3180 +))) 3181 + 3182 +Запрос: 3183 + 3184 +{ 3185 + "name": "string", 3186 + "number": 0, 3187 + "period": 0, 3188 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3189 +} 3190 + 3191 +Ответ: 3192 + 3193 +{ 3194 + "name": "string", 3195 + "number": 0, 3196 + "period": 0, 3197 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3198 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3199 +} 3200 + 3201 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3202 +|name|Название карты-метки 3203 +|number|Номер 3204 +|period|Период запросов в секундах (работает только для агрегатов) 3205 +|id|ID карты-метки 3206 +|parentId|ID клиента 3207 + 3208 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3209 + 3210 +(% class="box warningmessage" %) 3211 +((( 3212 +**PUT /api/v3/Rfids** 3213 +))) 3214 + 3215 +Запрос: 3216 + 3217 +{ 3218 + "name": "string", 3219 + "number": 0, 3220 + "period": 0, 3221 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3222 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3223 +} 3224 + 3225 +Ответ: 3226 + 3227 +{ 3228 + "name": "string", 3229 + "number": 0, 3230 + "period": 0, 3231 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3232 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3233 +} 3234 + 3235 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3236 +|name|Название карты-метки 3237 +|number|Номер 3238 +|period|Период запросов в секундах (работает только для агрегатов) 3239 +|id|ID карты-метки 3240 +|parentId|ID клиента 3241 + 3242 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3243 + 3244 +(% class="box errormessage" %) 3245 +((( 3246 +**DELETE /api/v3/Rfids/{rfidGuid}** 3247 +))) 3248 + 3249 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3250 + 3251 +Ответ: 3252 + 3253 +Success 3254 + 3255 + 3256 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3257 + 3258 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3259 + 3260 +(% class="box infomessage" %) 3261 +((( 3262 +**GET /api/v3/Billing/client/balance/{clientId}** 3263 +))) 3264 + 3265 +Параметр запроса: **clientId **- идентификатор клиента. 3266 + 3267 +Ответ: 3268 + 3269 +{ 3270 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3271 + "Balance": 0 3272 +} 3273 + 3274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3275 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3276 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3277 + 3278 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3279 + 3280 +(% class="box infomessage" %) 3281 +((( 3282 +**GET /api/v3/Billing/client/constraint/{clientId}** 3283 +))) 3284 + 3285 +Параметр запроса: **clientId **- идентификатор клиента. 3286 + 3287 +Ответ: 3288 + 3289 +{ 3290 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3291 + "CalculationType": 0, 3292 + "PermissibleBalance": 0, 3293 + "DefermentDays": 0, 3294 + "SendUiNotifications": true, 3295 + "SendEmailNotifications": true, 3296 + "IsPrivate": true, 3297 +} 3298 + 3299 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3300 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3301 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3302 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3303 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3304 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3305 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3306 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3307 + 3308 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3309 + 3310 +(% class="box infomessage" %) 3311 +((( 3312 +**GET /api/v3/Billing/client/plan/{clientId}** 3313 +))) 3314 + 3315 +Параметры запроса: 3316 + 3317 +**clientId **- идентификатор клиента. 3318 + 3319 +**planId **- идентификатор тарифного плана. 3320 + 3321 +Ответ: 3322 + 3323 +{ 3324 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3325 + "Plan": { **~/~/ Описание тарифного плана** 3326 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3327 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3328 + "Name": "string", 3329 + "IsArchived": true, 3330 + "Constraint": { 3331 + "CalculationType": 0, 3332 + "PermissibleBalance": 0, 3333 + "DefermentDays": 0 3334 + }, 3335 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3336 + { 3337 + "Feature": "string", 3338 + "IsFactual": true, 3339 + "Limit": 0, 3340 + "Price": 0, 3341 + "PeriodValue": 0, 3342 + "PeriodType": 0 3343 + } 3344 + ] 3345 + }, 3346 + "DebitDate": "2023-10-18T12:46:24.213Z", 3347 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3348 + { 3349 + "Feature": "string", 3350 + "IsEnabled": true, 3351 + "IsPrivate": true, 3352 + "IsFactual": true, 3353 + "Limit": 0, 3354 + "Price": 0, 3355 + "DebitDate": "2023-10-18T12:46:24.213Z", 3356 + "PeriodValue": 0, 3357 + "PeriodType": 0 3358 + } 3359 + ] 3360 +} 3361 + 3362 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3363 +|ClientId|Идентификатор клиента 3364 +|Id|Идентификатор тарифного плана 3365 +|OwnerId|Идентификатор клиента-владельца 3366 +|Name|Наименование тарифного плана 3367 +|IsArchived|Признак, определяющий архивный тарифный план 3368 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3369 +|PermissibleBalance|Допустимый баланс 3370 +|DefermentDays|Отсрочка, количество дней 3371 +|Feature|Код услуги 3372 +|IsEnabled|Признак, определяющий активирована ли услуга 3373 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3374 +|IsFactual|Признак, определяющий расчёт по факту 3375 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3376 +|Price|Цена за единицу. 3377 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3378 +|PeriodValue|Значение периода. 3379 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3380 + 3381 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3382 + 3383 +(% class="box infomessage" %) 3384 +((( 3385 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3386 +))) 3387 + 3388 +Параметр запроса: **clientId **- идентификатор клиента. 3389 + 3390 +Ответ: 3391 + 3392 +[ 3393 + { 3394 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3395 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3396 + "Name": "string", 3397 + "IsArchived": true, 3398 + "Constraint": { 3399 + "CalculationType": 0, 3400 + "PermissibleBalance": 0, 3401 + "DefermentDays": 0 3402 + }, 3403 + "Features": [ 3404 + { 3405 + "Feature": "string", 3406 + "IsFactual": true, 3407 + "Limit": 0, 3408 + "Price": 0, 3409 + "PeriodValue": 0, 3410 + "PeriodType": 0 3411 + } 3412 + ] 3413 + } 3414 +] 3415 + 3416 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3417 +|ClientId|Идентификатор клиента 3418 +|Id|Идентификатор тарифного плана 3419 +|OwnerId|Идентификатор клиента-владельца 3420 +|Name|Наименование тарифного плана 3421 +|IsArchived|Признак, определяющий архивный тарифный план 3422 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3423 +|PermissibleBalance|Допустимый баланс 3424 +|DefermentDays|Отсрочка, количество дней 3425 +|Feature|Код услуги 3426 +|IsFactual|Признак, определяющий расчёт по факту 3427 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3428 +|Price|Цена за единицу. 3429 +|PeriodValue|Значение периода. 3430 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3431 + 3432 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3433 + 3434 +(% class="box infomessage" %) 3435 +((( 3436 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3437 +))) 3438 + 3439 +Параметр запроса: **clientId **- идентификатор клиента. 3440 + 3441 +Ответ: 3442 + 3443 +[ 3444 + { 3445 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3446 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3447 + "Name": "string", 3448 + "IsArchived": true, 3449 + "Constraint": { 3450 + "CalculationType": 0, 3451 + "PermissibleBalance": 0, 3452 + "DefermentDays": 0 3453 + }, 3454 + "Features": [ 3455 + { 3456 + "Feature": "string", 3457 + "IsFactual": true, 3458 + "Limit": 0, 3459 + "Price": 0, 3460 + "PeriodValue": 0, 3461 + "PeriodType": 0 3462 + } 3463 + ] 3464 + } 3465 +] 3466 + 3467 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3468 +|ClientId|Идентификатор клиента 3469 +|Id|Идентификатор тарифного плана 3470 +|OwnerId|Идентификатор клиента-владельца 3471 +|Name|Наименование тарифного плана 3472 +|IsArchived|Признак, определяющий архивный тарифный план 3473 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3474 +|PermissibleBalance|Допустимый баланс 3475 +|DefermentDays|Отсрочка, количество дней 3476 +|Feature|Код услуги 3477 +|IsFactual|Признак, определяющий расчёт по факту 3478 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3479 +|Price|Цена за единицу. 3480 +|PeriodValue|Значение периода. 3481 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3482 + 3483 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3484 + 3485 +(% class="box warningmessage" %) 3486 +((( 3487 +**PUT /api/v3/Billing/client/balance** 3488 +))) 3489 + 3490 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3491 + 3492 +Тело запроса: 3493 + 3494 +{ 3495 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3496 + "Balance": 0 3497 +} 3498 + 3499 +Ответ: Success 3500 + 3501 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3502 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3503 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3504 + 3505 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3506 + 3507 +(% class="box warningmessage" %) 3508 +((( 3509 +**PUT /api/v3/billing/client/balance/deposit** 3510 +))) 3511 + 3512 +Создает операцию **Пополнение **с указанной суммой 3513 + 3514 +Тело запроса: 3515 + 3516 +{ 3517 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3518 + "Balance": 0 3519 +} 3520 + 3521 +Ответ: Success 3522 + 3523 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3524 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3525 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3526 + 3527 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3528 + 3529 +Создает операцию **Списание **с указанной суммой 3530 + 3531 +(% class="box warningmessage" %) 3532 +((( 3533 +**PUT /api/v3/billing/client/balance/withdraw** 3534 +))) 3535 + 3536 +Тело запроса: 3537 + 3538 +{ 3539 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3540 + "Balance": 0 3541 +} 3542 + 3543 +Ответ: Success 3544 + 3545 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3546 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3547 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3548 + 3549 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3550 + 3551 +(% class="box warningmessage" %) 3552 +((( 3553 +**PUT /api/v3/Billing/client/constraint** 3554 +))) 3555 + 3556 +Тело запроса: 3557 + 3558 +{ 3559 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3560 + "CalculationType": 0, 3561 + "PermissibleBalance": 0, 3562 + "DefermentDays": 0, 3563 + "SendUiNotifications": true, 3564 + "SendEmailNotifications": true, 3565 + "IsPrivate": true, 3566 +} 3567 + 3568 +Ответ: Success 3569 + 3570 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3571 +|ClientId|Идентификатор клиента 3572 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3573 +|PermissibleBalance|Допустимый баланс 3574 +|DefermentDays|((( 3575 +Отсрочка, количество дней 3576 +))) 3577 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3578 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3579 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3580 + 3581 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3582 + 3583 +(% class="box warningmessage" %) 3584 +((( 3585 +**PUT /api/v3/Billing/client/plan** 3586 +))) 3587 + 3588 +Тело запроса: 3589 + 3590 +{ 3591 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3592 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3593 + "Features": [ 3594 + { 3595 + "Feature": "string", 3596 + "IsEnabled": true, 3597 + "IsFactual": true, 3598 + "Limit": 0, 3599 + "Price": 0, 3600 + "DebitDate": "2023-10-18T13:26:58.987Z", 3601 + "PeriodValue": 0, 3602 + "PeriodType": 0 3603 + } 3604 + ] 3605 +} 3606 + 3607 +Ответ: Success 3608 + 3609 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3610 +|ClientId|Идентификатор клиента 3611 +|PlanId|Идентификатор тарифного плана 3612 +|Feature|Код услуги 3613 +|IsEnabled|Признак, определяющий активирована ли услуга 3614 +|IsFactual|Признак, определяющий расчёт по факту 3615 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3616 +|Price|Цена за единицу. 3617 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3618 +|PeriodValue|Значение периода. 3619 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3620 + 3621 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3622 + 3623 +(% class="box warningmessage" %) 3624 +((( 3625 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3626 +))) 3627 + 3628 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3629 + 3630 +(% class="box infomessage" %) 3631 +((( 3632 +**POST /api/v3/vehicles/import/{agentId}** 3633 +))) 3634 + 3635 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3636 + 3637 +В пути указывается **agentId** - id клиента. 3638 + 3639 +**Заголовок** 3640 + 3641 +**X-Auth: [токен авторизации]** 3642 + 3643 +**Параметры** 3644 + 3645 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3646 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3647 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3648 + 3649 +В теле использовать тип **form-data,** тип значения** file** 3650 + 3651 +**Ключи** 3652 + 3653 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3654 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3655 +|csv|В значении передаем файл датчиков, формат **csv** 3656 + 3657 +Ответ: 3658 + 3659 +{ 3660 + "vehicleId": 0, 3661 + "name": "string", 3662 + "errors": ["string"] 3663 +} 3664 + 3665 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3666 +|vehicleId|ID созданного объекта 3667 +|name|Имя созданного объекта 3668 +|errors|Ошибки и их описание 3669 + 3670 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3671 + 3672 +(% class="box infomessage" %) 3673 +((( 3674 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3675 +))) 3676 + 3677 +(% class="wikigeneratedid" %) 3678 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3679 + 3680 +(% class="wikigeneratedid" %) 3681 +В пути указывается **vehicleId **- id объекта. 3682 + 3683 +**Заголовок** 3684 + 3685 +**X-Auth: [токен авторизации]** 3686 + 3687 +В теле использовать тип **form-data.** 3688 + 3689 +Ключи: 3690 + 3691 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3692 +|**history**|В значении передавать файл с историей 3693 + 3694 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3695 + 3696 +Ответ: 3697 + 3698 +{ 3699 + "results": [ 3700 + { 3701 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3702 + "vehicleId": 0, 3703 + "errors": [ 3704 + "string" 3705 + ], 3706 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3707 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3708 + "producedCount": 0, 3709 + "msgCount": 0 3710 + } 3711 + ] 3712 +} 3713 + 3714 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3715 +|results|Результаты импорта в разрезе ТС 3716 +|vehicleGuid|Guid ТС 3717 +|vehicleId|ID ТС 3718 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3719 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3720 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3721 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3722 +|msgCount|Кол-во обработанных сообщений всего 3723 + 3724 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3725 + 3726 +(% class="box infomessage" %) 3727 +((( 3728 +**GET /api/v3/vehicles/import/history/status** 3729 +))) 3730 + 3731 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3732 + 3733 +Ответ: 3734 + 3735 +{ 3736 + "activity": true, 3737 + "progress": 0, 3738 + "message": "string" 3739 +} 3740 + 3741 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3742 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3743 +|progress|Guid ТС 3744 + 3745 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3746 + 3747 +(% class="box infomessage" %) 3748 +((( 3749 +**POST /api/v3/vehicles/export** 3750 +))) 3751 + 3752 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3753 + 3754 +Тело запроса: 3755 + 3756 +[ 3757 + id 3758 +] 3759 + 3760 +Ответ: Success 200, получаете файлы с настройками. 3761 + 3762 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3763 + 3764 +(% class="box infomessage" %) 3765 +((( 3766 +**POST /api/v3/vehicles/export/history** 3767 +))) 3768 + 3769 +Метод возвращает список сообщений терминала объекта за выбранный период. 3770 + 3771 +Тело запроса: 3772 + 3773 +{ 3774 + "vehicleId": 0, 3775 + "asArchive": true, 3776 + "from": "2023-09-27T12:17:45.973Z", 3777 + "to": "2023-09-27T12:17:45.973Z" 3778 +} 3779 + 3780 +Ответ: 3781 + 3782 +Получаете файл. Сообщение: Code 200/Success 3783 + 3784 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3785 +|vehicleId|ID объекта 3786 +|asArchive|true - Архивировать файл, False - не архивировать 3787 +|from|Дата и время начала запроса 3788 +|to|Дата и время окончания запроса 3789 + 3790 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3791 + 3792 +(% class="box infomessage" %) 3793 +((( 3794 +**GET /api/v3/vehicles/export/history/status** 3795 +))) 3796 + 3797 +Метод возвращает список сообщений терминала объекта за выбранный период. 3798 + 3799 +Ответ: 3800 + 3801 +{ 3802 + "activity": true, 3803 + "progress": 0, 3804 + "message": "string" 3805 +} 3806 + 3807 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3808 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3809 +|progress|Прогресс экспорта, от 0 до 100% 3810 +|message|Текст описывающий статус 3811 + 3812 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3813 + 3814 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3815 + 3816 +(% class="box infomessage" %) 3817 +((( 3818 +**POST /api/v3/EcoDriving/rating** 3819 +))) 3820 + 3821 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3822 + 3823 +Тело запроса: 3824 + 3825 +{ 3826 + "vehicleIds": [vehicleId], 3827 + "from": "2023-11-22T09:29:48.051Z", 3828 + "to": "2023-11-22T09:29:48.051Z" 3829 +} 3830 + 3831 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3832 +|vehicleIds|Массив ID объектов 3833 +|from|Дата начала запроса 3834 +|to|Дата окончания запроса 3835 + 3836 +Ответ: 3837 + 3838 +{ 3839 + "items": [ 3840 + { 3841 + "from": "2023-11-22T09:29:48.052Z", 3842 + "to": "2023-11-22T09:29:48.052Z", 3843 + "vehicleId": 0, 3844 + "vehicleName": "string", 3845 + "vehicleModel": "string", 3846 + "penalty": 0, 3847 + "score": 0, 3848 + "totalViolations": 0, 3849 + "violationsByType": { 3850 + "overspeedingViolations": 0, 3851 + "accelerationViolations": 0, 3852 + "brakingViolations": 0, 3853 + "turningViolations": 0, 3854 + "dangerousDrivingViolations": 0, 3855 + "sensorViolations": 0 3856 + }, 3857 + "moveTime": 0, 3858 + "mileage": 0, 3859 + "tripsCount": 0, 3860 + "trips": [ 3861 + { 3862 + "penalty": 0, 3863 + "score": 0, 3864 + "violationsCount": 0, 3865 + "violationsByType": { 3866 + "overspeedingViolations": 0, 3867 + "accelerationViolations": 0, 3868 + "brakingViolations": 0, 3869 + "turningViolations": 0, 3870 + "dangerousDrivingViolations": 0, 3871 + "sensorViolations": 0 3872 + }, 3873 + "moveTime": 0, 3874 + "mileage": 0, 3875 + "motohours": 0, 3876 + "maxSpeed": 0, 3877 + "startAddress": "string", 3878 + "endAddress": "string", 3879 + "drivers": [ 3880 + { 3881 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3882 + "driverName": "string", 3883 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3884 + } 3885 + ] 3886 + } 3887 + ] 3888 + } 3889 + ] 3890 +} 3891 + 3892 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3893 +|from|Дата начала запроса 3894 +|to|Дата окончания 3895 +|vehicleId|ID объекта 3896 +|vehicleName|Имя объекта 3897 +|vehicleModel|Модель объекта 3898 +|penalty|Сумма штрафных баллов 3899 +|score|Оценка 3900 +|totalViolations|Суммарное количество нарушений 3901 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3902 +|overspeedingViolations|Превышение скорости 3903 +|accelerationViolations|Ускорение 3904 +|brakingViolations|Торможение 3905 +|turningViolations|Резкий поворот 3906 +|dangerousDrivingViolations|Резкое вождение 3907 +|sensorViolations|Нарушение по датчику 3908 +|moveTime|Время в движении 3909 +|mileage|Пробег 3910 +|tripsCount|Количество рейсов 3911 +|motohours|Моточасы 3912 +|maxSpeed|Максимальная скорость 3913 +|startAddress|Адрес начала рейса 3914 +|endAddress|Адрес окончания рейса 3915 +|drivers|Список водителей, которые были на объекте в течениии рейса 3916 +|driverGuid|Guid водителя 3917 +|driverName|Имя водителя 3918 +|driverRfid|Номер Карты-метки 3919 + 700 700 (% class="box" lang="en-US" style="text-align: center;" %) 701 701 ((( 702 702 (% 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