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.krainovim - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,39 +1,46 @@ 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 19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 + 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 + 23 23 (% class="box infomessage" %) 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 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 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 + 43 + 37 37 (% style="color:#000000" %)**Ответ:** 38 38 39 39 (% lang="en-US" %) ... ... @@ -40,21 +40,22 @@ 40 40 (% style="color:#000000" %){ 41 41 42 42 (% lang="en-US" %) 43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 - "User": "" , ~/~/ имя пользователя 50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 + "User": "testuser" , ~/~/ имя пользователя 45 45 46 46 (% lang="en-US" %) 47 - 54 +} 48 48 49 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 50 50 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 51 51 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**62 +(% lang="en-US" %)**GET /api/v3/auth/check** 55 55 ))) 56 56 57 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 58 58 59 59 (% style="color:#000000" %)Метод запроса: **GET** 60 60 ... ... @@ -65,59 +65,243 @@ 65 65 (% lang="en-US" %) 66 66 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 67 67 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 68 68 69 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 70 70 ((( 71 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 72 72 ))) 73 73 85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 86 + 87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 88 + 89 +(% style="color:#000000" %)Метод запроса: **GET** 90 + 91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 92 + 93 +Запрос должен содержать данные параметра "**agentId**" 94 + 95 +(% style="color:#000000" %)Ответ: 96 +А 97 +{ 98 + "agentId": "", ~/~/ идентификатор клиента (%%) 99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 + "isForeign": true/false, ~/~/ Иностранный контрагент 105 + "district": "string", ~/~/ округ 106 + "region": "string", ~/~/ регион 107 + "city": "string", ~/~/ город 108 + "inn": "string", ~/~/ ИНН клиента 109 + "kpp": "string", ~/~/ КПП клиента 110 + "address": "string", ~/~/ юридический адрес 111 + "addressFact": "string", ~/~/ фактический адрес 112 + "email": "string", ~/~/ почта 113 + "director": "string", ~/~/ ФИО руководителя 114 + "bankName": "string", ~/~/ Банк 115 + "bankBIK": "string", ~/~/ БИК 116 + "bankRS": "string", ~/~/ Номер счета 117 + "bankKS": "string" ~/~/ Корр. счет 118 + } 119 + 120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 + 74 74 (% class="box infomessage" %) 75 75 ((( 76 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 77 77 ))) 78 78 79 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 80 80 81 81 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 82 82 83 83 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 84 84 85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 86 86 87 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% 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>137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 90 90 91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 92 92 93 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 94 94 95 95 (% style="color:#000000" %)Ответ: 96 96 97 -(% style="color:#000000" %){ 98 - "agentId": "", ~/~/ идентификатор клиента 99 - "parentId": "", ~/~/ идентификатор клиента-родителя 100 - "name": "", ~/~/ наименование клиента 101 - "fullName": "", ~/~/ полное наименование клиента 102 - "agentInfoType": "", ~/~/ тип клиента1 103 - "status": "", ~/~/ статус клиента 104 - } 147 +{ 148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 155 +} 105 105 157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 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" %)] 159 +(% class="box successmessage" %) 160 +((( 161 +**POST /api/v3/agents ** 162 +))) 108 108 164 +Метод позволяет добавить клиента, указанного в запросе. 109 109 110 -(% class="box" style="text-align: center;" %) 166 +Метод запроса: **POST** 167 + 168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 169 + 170 +В заголовках запроса: X-Auth: Токен авторизации 171 + 172 +Параметры в теле запроса (JSON): 173 + 174 +{ 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 + "name": "string", ~/~/ имя 177 + "fullName": "string", ~/~/ полное наименование 178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 179 + "isForeign": true, ~/~/ иностранный контрагент 180 + "district": "string", ~/~/ округ 181 + "region": "string", ~/~/ регион 182 + "city": "string", ~/~/ город 183 + "inn": "string", ~/~/ ИНН 184 + "kpp": "string", ~/~/ КПП 185 + "address": "string", ~/~/ юридический адрес 186 + "addressFact": "string", ~/~/ фактический адрес 187 + "email": "string", ~/~/ email 188 + "director": "string", ~/~/ ФИО руководителя 189 + "bankName": "string", ~/~/ банк 190 + "bankBIK": "string", ~/~/ БИК 191 + "bankRS": "string", ~/~/ номер счёта 192 + "bankKS": "string" ~/~/ корр. счёт 193 +} 194 + 195 + 196 +Ответ: 197 + 198 +{ 199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 201 + "name": "string", ~/~/ имя 202 + "fullName": "string", ~/~/ полное наименование 203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 204 + "isForeign": true, ~/~/ иностранный контрагент 205 + "district": "string", ~/~/ округ 206 + "region": "string", ~/~/ регион 207 + "city": "string", ~/~/ город 208 + "inn": "string", ~/~/ ИНН 209 + "kpp": "string", ~/~/ КПП 210 + "address": "string", ~/~/ юридический адрес 211 + "addressFact": "string", ~/~/ фактический адрес 212 + "email": "string", ~/~/ email 213 + "director": "string", ~/~/ ФИО руководителя 214 + "bankName": "string", ~/~/ банк 215 + "bankBIK": "string", ~/~/ БИК 216 + "bankRS": "string", ~/~/ номер счёта 217 + "bankKS": "string" ~/~/ корр. счёт 218 +} 219 + 220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 + 222 +(% class="box warningmessage" %) 111 111 ((( 112 - (%style="color:#000000; font-size:14pt" %)**Раздел Пользователи**224 +**PUT /api/v3/agents** 113 113 ))) 114 114 227 +Метод позволяет отредактировать клиента, указанного в запросе. 228 + 229 +Метод запроса: **PUT** 230 + 231 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 232 + 233 +В заголовках запроса: X-Auth: Токен авторизации 234 + 235 + 236 +Параметры в теле запроса (JSON): 237 + 238 +{ 239 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 240 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 241 + "name": "string", ~/~/ имя 242 + "fullName": "string", ~/~/ полное наименование 243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 244 + "isForeign": true, ~/~/ иностранный контрагент 245 + "district": "string", ~/~/ округ 246 + "region": "string", ~/~/ регион 247 + "city": "string", ~/~/ город 248 + "inn": "string", ~/~/ ИНН 249 + "kpp": "string", ~/~/ КПП 250 + "address": "string", ~/~/ юридический адрес 251 + "addressFact": "string", ~/~/ фактический адрес 252 + "email": "string", ~/~/ email 253 + "director": "string", ~/~/ ФИО руководителя 254 + "bankName": "string", ~/~/ банк 255 + "bankBIK": "string", ~/~/ БИК 256 + "bankRS": "string", ~/~/ номер счёта 257 + "bankKS": "string" ~/~/ корр. счёт 258 +} 259 + 260 + 261 +Ответ: 262 + 263 +{ 264 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 265 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 266 + "name": "string", ~/~/ имя 267 + "fullName": "string", ~/~/ полное наименование 268 + "isForeign": true, ~/~/ иностранный контрагент 269 + "district": "string", ~/~/ округ 270 + "region": "string", ~/~/ регион 271 + "city": "string", ~/~/ город 272 + "inn": "string", ~/~/ ИНН 273 + "kpp": "string", ~/~/ КПП 274 + "address": "string", ~/~/ юридический адрес 275 + "addressFact": "string", ~/~/ фактический адрес 276 + "email": "string", ~/~/ email 277 + "director": "string", ~/~/ ФИО руководителя 278 + "bankName": "string", ~/~/ банк 279 + "bankBIK": "string", ~/~/ БИК 280 + "bankRS": "string", ~/~/ номер счёта 281 + "bankKS": "string" ~/~/ корр. счёт 282 +} 283 + 284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 285 + 286 +(% class="box errormessage" %) 287 +((( 288 +**DELETE /api/v3/agents/{clientId}** 289 +))) 290 + 291 +Метод позволяет удалить клиента, указанного в строке запроса. 292 + 293 +Метод запроса: **DELETE** 294 + 295 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 296 + 297 +Параметр запроса: **{clientId}** - Guid пользователя 298 + 299 +В заголовках запроса: X-Auth: Токен авторизации 300 + 301 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 + 303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 + 305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 306 + 115 115 (% class="box successmessage" %) 116 116 ((( 117 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 118 118 ))) 119 119 120 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 121 121 122 122 (% style="color:#000000" %)Метод запроса: **POST** 123 123 ... ... @@ -127,31 +127,56 @@ 127 127 128 128 (% style="color:#000000" %)Параметры в теле запроса (JSON): 129 129 130 -(% style="color:#000000" %){ 322 +(% style="color:#000000" %) 323 +{ 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": "", ~/~/ признак включения 329 + "login": "", ~/~/ логин (обязателен) 330 + "password": "", ~/~/ пароль (обязателен) 331 + "email": "", ~/~/ email (обязателен) 332 + "description": "string", ~/~/ Описание 333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 + "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 - } 337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 339 + "doubleAuth": 340 + { 341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 343 + }, 344 + "groups": 345 + [ 346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 347 + ], 348 + "customGroups": 349 + [ 350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 + ], 352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 +} 149 149 355 +{ 356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 + "lastName": "string", 358 + "firstName": "string", 359 + "position": "string", 360 + "phone": "string", 361 + "organization": "string", 362 + "login": "string", 363 + "password": "string", 364 + "email": "string", 365 + 366 + 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" %){ 371 +(% 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,30 @@ 170 170 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 171 171 "kind": "" , ~/~/ тип аутентификации 172 172 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 173 - "groups": группы пользователя,«user»названия группыпользователя390 + "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" %) 393 +(% style="color:#000000; font-weight:normal" %)} 177 177 395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 178 178 179 -(% class="box successmessage" %)397 +(% class="box infomessage" %) 180 180 ((( 181 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**399 +(% lang="en-US" %)**POST /api/v3/users/find** 182 182 ))) 183 183 184 -(% style="color:#000000" %) 402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 185 185 186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 404 +(% 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):410 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 193 193 412 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 413 + 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" %) 421 +(% style="color:#000000" %)} 202 202 203 203 (% style="color:#000000" %)Ответ: 204 204 205 -(% style="color:#000000" %){ 425 +(% 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": "", ~/~/ дата/время последней авторизации 439 + "lastLogged": "", ~/~/ дата/время последней авторизации 220 220 221 -(% style="color:#000000" %) 441 +(% style="color:#000000" %)} 222 222 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 223 223 445 +(% class="box infomessage" %) 446 +((( 447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 448 +))) 449 + 450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 451 + 452 +(% style="color:#000000" %)Метод запроса: **GET** 453 + 454 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 455 + 456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 457 + 458 +(% style="color:#000000" %)Ответ: 459 + 460 +((( 461 +((( 462 +{ 463 + "id": "", ~/~/ GUID пользователя 464 + "lastName": "", ~/~/ Фамилия 465 + "firstName": "", ~/~/ Имя 466 + "position": "", ~/~/ Должность 467 + "phone": "", ~/~/ Номер телефона 468 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 469 + "parentName": "", Наименование клиента, которому принадлежит пользователь 470 + "organization": "", ~/~/ Организация 471 + "login": "", ~/~/ Логин пользователя 472 + "email": "", ~/~/ Адрес электронной почты 473 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 474 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 475 + "description": "", ~/~/ Описание 476 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 477 + "doubleAuth": 478 + { 479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 + }, 482 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 483 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 484 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 485 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 486 + "groups": [], ~/~/ Список ролей пользователя 487 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 488 + "authDevices": [ ], ~/~/ Список авторизованных устройств 489 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 490 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 491 +} 492 +))) 493 +))) 494 + 495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 496 + 224 224 (% class="box warningmessage" %) 225 225 ((( 226 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**499 +(% lang="en-US" %)**PUT /api/v3/users** 227 227 ))) 228 228 229 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).502 +(% 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" %){ 514 +(% 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": "" , ~/~/ описание 523 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 527 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 528 +(% 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-адрес 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "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" %) // //__}__542 +(% 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" %) //{//548 +(% 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": "" , ~/~/ идентификатор пользователя551 +(% 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": "" , ~/~/ тип аутентификации 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 288 288 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя //571 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 290 290 291 291 (% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) // //}574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 293 293 576 +== (% 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}**580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 298 298 ))) 299 299 300 -(% style="color:#000000" %) . Метод позволяет изменить статус пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).583 +(% 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 пользователя 589 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 307 307 308 308 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 309 309 ... ... @@ -315,78 +315,296 @@ 315 315 "description": "" , ~/~/ описание 316 316 "data": "" , ~/~/ данные, связанные со сменой статуса 317 317 318 - 601 +(% style="color:#000000" %)} 319 319 320 320 (% style="text-align:left" %) 321 321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 322 322 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 323 323 608 +(% class="box warningmessage" %) 609 +((( 610 +**POST /api/v3/users/disable** 611 +))) 612 + 613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 614 + 615 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 616 + 617 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 618 + 619 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 + 621 + [ 622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 + ] 625 + 626 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 627 + 628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 629 + 630 +(% class="box warningmessage" %) 631 +((( 632 +**POST /api/v3/users/enable** 633 +))) 634 + 635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 636 + 637 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 638 + 639 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 640 + 641 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 642 + 643 + [ 644 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 645 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 646 + ] 647 + 648 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 649 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 650 + 651 +((( 652 +В теле ответа: 653 +{ 654 + "errorMessages": [ 655 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 656 + ], 657 + "users": [ 658 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 659 + ] 660 +} 661 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 662 +"users" - массив id пользователей, которых не удалось включить или отключить. 663 +))) 664 + 665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 + 324 324 (% class="box errormessage" %) 325 325 ((( 326 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 327 327 ))) 328 328 329 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).672 +(% 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: Токен авторизации678 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 336 336 680 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 681 + 337 337 (% style="text-align:left" %) 338 338 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 339 339 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 340 340 341 -(% class="box" style="text-align: center;" %) 342 -((( 343 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 344 -))) 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 345 345 346 346 (% class="box infomessage" %) 347 347 ((( 348 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 349 349 ))) 350 350 351 -(% style="color:#000000" %) 694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 352 352 353 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 354 354 355 355 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 356 356 357 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 700 +(% 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>704 +(% 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>- идентификатор объекта (опционально)706 +(% 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" %){ 712 +((( 713 +{ 714 + "vehicleId": "", ~/~/ ID объекта 715 + "name": "", ~/~/ Имя объекта 716 + "imei": "", ~/~/ IMEI объекта 717 + "deviceTypeId": , ~/~/ ID типа устройства 718 + "deviceTypeName": "", ~/~/ Название типа устройства 719 + "sim1": "", ~/~/ Номер SIM1 720 + "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 - ... 722 + "parentId": "", ~/~/ ID клиента-родителя 723 + "parentName": "", ~/~/ Наименование клиента-родителя 724 + "modelId": "", ~/~/ ID модели объекта 725 + "modelName": "", ~/~/ Имя модели объекта 726 + 727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 + "unitName": "string", ~/~/ Наименование подразделения 729 + "status": 0, ~/~/ Статус объекта 730 + 731 + "createdAt": "", ~/~/ Дата создания объекта 732 + }, 733 + 734 +"customFields": [ ~/~/ Произвольные поля 735 + { 736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 737 + "name": "string", ~/~/ Имя поля 738 + "value": "string", ~/~/ Значение поля 739 + "forClient": true, ~/~/ Не используемая функция 740 + "forTooltip": true, ~/~/ Отображать в подсказке 741 + "forReport": true ~/~/ Отображать в отчете 742 + } 743 + 744 +], ~/~/ Данные с вкладки нормы 745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 + 758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 + "mileageCoeff": 0, ~/~/ коэффициент пробега 760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 762 + "counters": { ~/~/ Счетчики 763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 765 + "mileage": 0, ~/~/ Текущий пробег 766 + "motohours": 0, ~/~/ Текущие моточасы 767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 385 385 }, 386 - ...}}} 387 387 388 -(% style="color:#000000" %)} 771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 772 + "id": "string", ~/~/ ID объекта 773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 774 + "host": "string", ~/~/ CMSV6 Web Host 775 + "login": "string", ~/~/ CMSV6 Account 776 + "password": "string" ~/~/ CMSV6 Password 777 + }, 389 389 779 +"commandTemplates": [ ~/~/ Шаблоны команд 780 + { 781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 782 + "name": "string", ~/~/ Наименование команды 783 + "command": "string", ~/~/ Текст команды 784 + "retries": 0 ~/~/ Количество попыток 785 + } 786 + ], 787 + 788 + "sensors": [ ~/~/ Датчики 789 + { 790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 791 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 792 + "type": 0, ~/~/ Тип датчика 793 + "name": "string", ~/~/ Имя датчика 794 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 795 + "inputNumber": 0, ~/~/ Номер входа 796 + "pseudonym": "string", ~/~/ Псевдоним 797 + "medianDegree": 0, ~/~/ Медианная фильтрация 798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 800 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 801 + "gradesTables": [ ~/~/ Массив таблиц тарировки 802 + { 803 + "grades": [ ~/~/ Таблица тарировки 1 804 + { 805 + "input": 0, ~/~/ Входящее значение 806 + "output": 0 ~/~/ Выходящее значение 807 + } 808 + ], 809 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 810 + } 811 + ], 812 + "showInTooltip": true, ~/~/ Отображать в подсказке 813 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 814 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 815 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 816 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 817 + "expr": "string", ~/~/ Формула 818 + "children": [ ~/~/ массив дочерних датчиков 819 + "string" 820 + ], 821 + "customParams": { ~/~/ прочие произвольные параметры 822 + "additionalProp1": "string", 823 + "additionalProp2": "string", 824 + "additionalProp3": "string" 825 + }, 826 + 827 +~/~/ Характерные для произвольного: 828 + 829 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 830 + 831 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 832 + 833 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 834 + 835 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 836 + 837 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 838 + 839 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 840 + 841 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 842 + 843 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 844 + 845 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 846 + 847 +~/~/ "ValueOn": "Вкл.", 848 + 849 +~/~/ "ValueOff": "Выкл." 850 + "summaryMaxValue": 0 ~/~/ Макс. значение 851 + } 852 + 853 + "drivers": [ ~/~/ Водители 854 + { 855 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 856 + "name": "string", ~/~/ Наименование 857 + "description": "string", 858 + "isDefault": true ~/~/ По умолчанию 859 + } 860 + ], 861 + 862 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 863 + { 864 + "id": "", ~/~/ ID задания 865 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 866 + "name": "", ~/~/ Наименование задания 867 + "description": "", ~/~/ Описание задания 868 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 869 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 870 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 871 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 872 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 873 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 874 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 875 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 876 + } 877 + ], 878 + 879 + "statusHistory": [ ~/~/ История статусов 880 + { 881 + "status": 0, 882 + "date": "2023-05-22T09:57:39.562Z", 883 + "description": "string", 884 + "additionalInfo": "string" 885 + } 886 + ] 887 + 888 +} 889 +))) 890 + 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 897 +== (% 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**901 +(% lang="en-US" %)**POST /api/v3/vehicles** 400 400 ))) 401 401 402 -(% style="color:#000000" %) . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).904 +(% 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 {912 +(% 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": "" // пароль учетной записи 914 +(% style="color:#000000" %){ 915 + 916 + "parentId": "" , ~/~/ ID клиента 917 + "name": "" , ~/~/ имя ТС 918 + "imei": "" , ~/~/ IMEI 919 + "deviceTypeId": "" , ~/~/ ID типа устройства 920 + "modelId": "" , ~/~/ ID модели 921 + "unitId": "" , ~/~/ ID подразделения 922 + "sim1": "" , ~/~/ Номер SIM 1 923 + "sim2": "" , ~/~/ Номер SIM2 924 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 925 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 926 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 927 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 928 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 929 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 930 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 931 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 932 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 933 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 934 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 935 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 936 + 937 + "mileageCalcMethod": 0, 938 + "mileageCoeff": 0, 939 + "locationByCellId": true, 940 + "dottedLineTrackWhenNoCoords": true, 941 + "counters": ~/~/ счетчики 942 + { 943 + "mileage": "" , ~/~/ пробег 944 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 945 + "motohours": "" , ~/~/ моточасы 946 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 436 436 }, 437 - "inspectionTasks": [ // задания на ТО 948 + "cmsv6Parameters": { ~/~/ параметры CMSv6 949 + "enabled": true, ~/~/ флаг включения 950 + "id": "" , ~/~/ идентификатор 951 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 952 + "login": "" , ~/~/ имя учетной записи 953 + "password": "" ~/~/ пароль учетной записи 954 + }, 955 + "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 - однократно) 957 + "enabled": "" , ~/~/ Признак включения 958 + "name": "" , ~/~/ Имя задания 959 + "description": "" , ~/~/ Описание задания 960 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 961 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 962 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 963 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 964 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 965 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 966 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 967 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 968 + } 969 + 970 +"drivers": [ ~/~/ Водители 971 + { 972 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 973 + "isDefault": true 974 + } 975 + ], 976 + "commandTemplates": [ ~/~/ Шаблон команды 977 + { 978 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 979 + "name": "string", 980 + "command": "string", 981 + "retries": 0 982 + } 983 + ], 984 + 985 + "sensors": [ ~/~/ Датчики 986 + { 987 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 988 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 989 + "type": 0, ~/~/ Тип датчика 990 + "name": "string", ~/~/ Имя датчика 991 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 992 + "inputNumber": 0, ~/~/ Номер входа 993 + "pseudonym": "string", ~/~/ Псевдоним 994 + "medianDegree": 0, ~/~/ Медианная фильтрация 995 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 996 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 997 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 998 + "gradesTables": [ ~/~/ Массив таблиц тарировки 999 + { 1000 + "grades": [ ~/~/ Таблица тарировки 1 1001 + { 1002 + "input": 0, ~/~/ Входящее значение 1003 + "output": 0 ~/~/ Выходящее значение 1004 + } 1005 + ], 1006 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1007 + } 1008 + ], 1009 + "showInTooltip": true, ~/~/ Отображать в подсказке 1010 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1011 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1012 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1013 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1014 + "expr": "string", ~/~/ Формула 1015 + "children": [ ~/~/ массив дочерних датчиков 1016 + "string" 1017 + ], 1018 + "customParams": { ~/~/ прочие произвольные параметры 1019 + "additionalProp1": "string", 1020 + "additionalProp2": "string", 1021 + "additionalProp3": "string" 450 450 }, 451 - ]}}} 452 452 453 - (%style="color:#000000"%)…}1024 +~/~/ Характерные для произвольного: 454 454 1026 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1027 + 1028 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1029 + 1030 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1031 + 1032 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1033 + 1034 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1035 + 1036 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1037 + 1038 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1039 + 1040 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1041 + 1042 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1043 + 1044 +~/~/ "ValueOn": "Вкл.", 1045 + 1046 +~/~/ "ValueOff": "Выкл." 1047 + "summaryMaxValue": 0 ~/~/ Макс. значение 1048 + } 1049 + ], 1050 + "customFields": [ ~/~/ Произвольные поля 1051 + { 1052 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1053 + "name": "string", 1054 + "value": "string", 1055 + "forClient": true, 1056 + "forTooltip": true, 1057 + "forReport": true 1058 + } 1059 + ] 1060 +} 1061 + 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 - ]}}} 1066 + "vehicleId": "", ~/~/ID ТС 1067 + "parentId": "", ~/~/Guid владельца ТС 1068 + "name": "", ~/~/Имя объекта 1069 + "imei": "", ~/~/IMEI 1070 + "deviceTypeId": "", ~/~/ID типа устройства 1071 + "modelId": "", ~/~/ID модели 1072 + "unitId": "", ~/~/ID подразделения 1073 + "sim1": "", ~/~/SIM1 1074 + "sim2": "", ~/~/SIM2 1075 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1076 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1077 + "counters": { ~/~/Счётчики 1078 + "mileageEnabled": true, 1079 + "motohoursEnabled": true, 1080 + "mileage": "", 1081 + "motohours": 345.0 1082 + }, 1083 + "cmsv6Parameters": { ~/~/Параметры CmsV6 1084 + "id": null, 1085 + "enabled": true, ~/~/флаг включения 1086 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1087 + "login": "", ~/~/ имя учетной записи 1088 + "password": "" ~/~/ пароль учетной записи 1089 + }, 1090 + "inspectionTasks": { ~/~/ задания на ТО 1091 + "id": "", ~/~/ ID задачи 1092 + "enabled": false, ~/~/ Признак включения 1093 + "name": "", ~/~/ Имя задания 1094 + "description": "", ~/~/ Описание задания 1095 + "mileageCondition": "", ~/~/ Условие по пробегу 1096 + "lastMileage": "", ~/~/ Пробег (в метрах) 1097 + "motohoursCondition": "", ~/~/ Условие по моточасам 1098 + "lastMotohours": "", ~/~/ Моточасы 1099 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1100 + "kind": "", ~/~/ Вид периодичности по времени 1101 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1102 + } 499 499 500 500 (% style="text-align:left" %) 501 501 (% style="color:#000000" %)} 502 502 1107 +**Валидация:** 1108 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1109 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1110 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 503 503 504 -(% class="box successmessage" %) 1112 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1113 + 1114 +(% class="box infomessage" %) 505 505 ((( 506 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**1116 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 507 507 ))) 508 508 509 -(% style="color:#000000" %) 1119 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 510 510 511 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):1121 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 512 512 513 513 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 514 514 515 515 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 516 516 517 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 1127 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 518 518 519 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 1129 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 520 520 521 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 1131 +(% 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 1139 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 530 530 531 531 (% style="color:#000000" %)− X-Auth: Токен авторизации 532 532 533 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):1143 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 534 534 535 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ ИмяТС(string,опционально)"imei":null,~/~/"710179307",##1145 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 536 536 537 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 1147 +{ 1148 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1149 + "name": null, ~/~/ Имя ТС (string, опционально) 1150 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1151 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1152 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1153 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 1154 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1155 + "customFields": null ~/~/ значение любого из произвольных полей ТС 1156 +} 538 538 539 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства(short,опционально)"parentId":null,~/~/IDклиента(Guid,опционально)"unitId":null##1158 +(% 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" %)}1160 +(% style="color:#000000" %)Ответ: 542 542 543 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».1162 +(% 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//»: «» дата создания объектов //}, … ] 1164 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1165 + "name": "" ~/~/ наименование объекта 1166 + "imei": "" ~/~/ IMEI объекта 1167 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 1168 + "deviceTypeName": "" ~/~/ наименование типа устройства 1169 + "sim1": "" ~/~/ первый номер телефона 1170 + "sim2": "" ~/~/ второй номер телефона 1171 + "parentId": "" ~/~/ идентификатор клиента-родителя 1172 + "parentName": "" ~/~/ наименование клиента-родителя 1173 + "modelId": "" ~/~/ идентификатор модели объекта 1174 + "modelName": "" ~/~/ наименование модели объекта 1175 + "unitId": "" ~/~/ идентификатор подразделения 1176 + "unitName": "" ~/~/ наименование подразделения 1177 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1178 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1179 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1180 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1181 + "customFields": [ 1182 + { 1183 + "id": "", ~/~/ идентификатор произвольного поля 1184 + "name": "", ~/~/ имя произвольного поля 1185 + "value": "", ~/~/ значение произвольного поля 1186 + "forClient": true, ~/~/ право на отображение у клиента 1187 + "forTooltip": false, ~/~/ право на отображение в подсказке 1188 + "forReport": false ~/~/ право на отображение в отчетах 1189 + }(%%) 1190 +(% style="color:#000000" %)} 546 546 547 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:1192 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 548 548 549 - 0-«Блокировка»1- «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис»,6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан»,11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».1194 +== (% 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}**1198 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 555 555 ))) 556 556 557 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1201 +(% 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 ТС 1207 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 564 564 565 565 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 566 566 567 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {1211 +(% 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}}} 1213 +(% style="color:#000000" %){ 578 578 1215 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1216 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1217 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1218 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1219 + "description": "", ~/~/ Описание 1220 + "data": "", ~/~/ Данные 1221 + "overwrite": false, ~/~/ Флаг перезаписи 1222 + "stage": "", ~/~/ Состояние, может быть null 1223 + 579 579 (% style="color:#000000" %)} 580 580 581 -(% style="color:#000000" %)Ответ: {1226 +(% style="color:#000000" %)Ответ: 582 582 583 -(% class="western" %) 584 -{{{ "status": "", // значение статуса 585 - "date": "", // Дата смены статуса 586 - "description": "", // Описание 587 - "data": "", // Данные 588 - "overwrite": false, // Флаг перезаписи 589 - "stage": "", // Состояние}}} 1228 +(% style="color:#000000" %){ 590 590 1230 + "status": "", ~/~/ значение статуса 1231 + "date": "", ~/~/ Дата смены статуса 1232 + "description": "", ~/~/ Описание 1233 + "data": "", ~/~/ Данные 1234 + "overwrite": false, ~/~/ Флаг перезаписи 1235 + "stage": "", ~/~/ Состояние 1236 + 591 591 (% style="text-align:left" %) 592 -(% style="color:#000000" %)} 1238 +(% style="color:#000000" %) } 593 593 1240 +== (% 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**1244 +(% lang="en-US" %)**PUT /api/v3/vehicles** 598 598 ))) 599 599 600 -(% style="color:#000000" %) . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1247 +(% 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»: «» //Сколько раз выполнить задание } ] } 1257 +(% style="color:#000000" %){ 1258 + "vehicleId": , ~/~/ ID объекта 1259 + "parentId": "" , ~/~/ ID клиента 1260 + "name": "" , ~/~/ имя ТС 1261 + "imei": "" , ~/~/ IMEI 1262 + "deviceTypeId": "" , ~/~/ ID типа устройства 1263 + "modelId": "" , ~/~/ ID модели 1264 + "unitId": "" , ~/~/ ID подразделения 1265 + "sim1": "" , ~/~/ Номер SIM 1 1266 + "sim2": "" , ~/~/ Номер SIM2 1267 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1268 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1269 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1270 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1271 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1272 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1273 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1274 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1275 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1276 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1277 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1278 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 611 611 1280 + "mileageCalcMethod": 0, 1281 + "mileageCoeff": 0, 1282 + "locationByCellId": true, 1283 + "dottedLineTrackWhenNoCoords": true, 1284 + "counters": ~/~/ счетчики 1285 + { 1286 + "mileage": "" , ~/~/ пробег 1287 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1288 + "motohours": "" , ~/~/ моточасы 1289 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1290 + }, 1291 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1292 + "enabled": true, ~/~/ флаг включения 1293 + "id": "" , ~/~/ идентификатор 1294 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1295 + "login": "" , ~/~/ имя учетной записи 1296 + "password": "" ~/~/ пароль учетной записи 1297 + }, 1298 + "inspectionTasks": ~/~/ задания на ТО 1299 + { 1300 + "enabled": "" , ~/~/ Признак включения 1301 + "name": "" , ~/~/ Имя задания 1302 + "description": "" , ~/~/ Описание задания 1303 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1304 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1305 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1306 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1307 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1308 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1309 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1310 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1311 + } 1312 + 1313 +"drivers": [ ~/~/ Водители 1314 + { 1315 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1316 + "isDefault": true 1317 + } 1318 + ], 1319 + "commandTemplates": [ ~/~/ Шаблон команды 1320 + { 1321 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1322 + "name": "string", 1323 + "command": "string", 1324 + "retries": 0 1325 + } 1326 + ], 1327 + 1328 + "sensors": [ ~/~/ Датчики 1329 + { 1330 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1331 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1332 + "type": 0, ~/~/ Тип датчика 1333 + "name": "string", ~/~/ Имя датчика 1334 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1335 + "inputNumber": 0, ~/~/ Номер входа 1336 + "pseudonym": "string", ~/~/ Псевдоним 1337 + "medianDegree": 0, ~/~/ Медианная фильтрация 1338 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1339 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1340 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1341 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1342 + { 1343 + "grades": [ ~/~/ Таблица тарировки 1 1344 + { 1345 + "input": 0, ~/~/ Входящее значение 1346 + "output": 0 ~/~/ Выходящее значение 1347 + } 1348 + ], 1349 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1350 + } 1351 + ], 1352 + "showInTooltip": true, ~/~/ Отображать в подсказке 1353 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1354 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1355 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1356 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1357 + "expr": "string", ~/~/ Формула 1358 + "children": [ ~/~/ массив дочерних датчиков 1359 + "string" 1360 + ], 1361 + "customParams": { ~/~/ прочие произвольные параметры 1362 + "additionalProp1": "string", 1363 + "additionalProp2": "string", 1364 + "additionalProp3": "string" 1365 + }, 1366 + 1367 +~/~/ Характерные для произвольного: 1368 + 1369 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1370 + 1371 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1372 + 1373 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1374 + 1375 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1376 + 1377 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1378 + 1379 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1380 + 1381 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1382 + 1383 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1384 + 1385 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1386 + 1387 +~/~/ "ValueOn": "Вкл.", 1388 + 1389 +~/~/ "ValueOff": "Выкл." 1390 + "summaryMaxValue": 0 ~/~/ Макс. значение 1391 + } 1392 + ], 1393 + "customFields": [ ~/~/ Произвольные поля 1394 + { 1395 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1396 + "name": "string", 1397 + "value": "string", 1398 + "forClient": true, 1399 + "forTooltip": true, 1400 + "forReport": true 1401 + } 1402 + ] 1403 +} 1404 + 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»: «» //Сколько раз выполнить задание } ] }1408 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 616 616 1410 +(% lang="en-US" style="text-align:left" %) 1411 + "vehicleId": "", ~/~/ ID ТС 1412 + "parentId": "", ~/~/ ID клиента 1413 + "name": "", ~/~/ имя ТС 1414 + "imei": "", ~/~/ IMEI 1415 + "deviceTypeId": "", ~/~/ типа устройства 1416 + "modelId": "", ~/~/ ID модели 1417 + "unitId": "", ~/~/ ID подразделения 1418 + "sim1": "", ~/~/ SIM 1 1419 + "sim2": "", ~/~/ SIM2 1420 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1421 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1422 + "counters": 1423 + { 1424 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1425 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1426 + "mileage": "", ~/~/ пробег 1427 + "motohours": "", ~/~/ моточасы 1428 + } 1429 + "cmsv6Parameters": ~/~/ параметры CMSv6 1430 + { 1431 + "id": ~/~/ идентификатор 1432 + "enabled": true, ~/~/ флаг включения 1433 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1434 + "login": "", ~/~/ имя учетной записи 1435 + "password": "", ~/~/ пароль учетной записи 1436 + } 1437 + "inspectionTasks": ~/~/ задания на ТО 1438 + { 1439 + "id": "", ~/~/ ID задания 1440 + "enabled": false, ~/~/ Признак включения 1441 + "name": "", ~/~/ Имя задания 1442 + "description": "", ~/~/ Описание задания 1443 + "mileageCondition": "", ~/~/ Условие по пробегу 1444 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1445 + "motohoursCondition": "", ~/~/ Условие по моточасам 1446 + "lastMotohours": "", ~/~/ Моточасы 1447 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1448 + "kind": "", ~/~/ Вид периодичности по времени 1449 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1450 + } 617 617 1452 +(% lang="en-US" style="text-align:left" %) 1453 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1454 + 1455 +**Валидация:** 1456 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1457 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1458 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1459 + 1460 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1461 + 618 618 (% class="box errormessage" %) 619 619 ((( 620 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1464 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 621 621 ))) 622 622 623 -(% style="color:#000000" %) . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1467 +(% 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 объекта 1473 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 630 630 631 631 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 632 632 ... ... @@ -633,70 +633,1307 @@ 633 633 (% style="text-align:left" %) 634 634 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 635 635 1480 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 636 636 637 -(% class="box" lang="en-US" style="text-align: center;" %) 1482 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1483 + 1484 +(% class="box infomessage" %) 638 638 ((( 639 -(% style="color:#000000; font-size:14pt" %)**РазделУстройства**1486 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 640 640 ))) 641 641 1489 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1490 + 1491 +(% style="color:#000000" %)Метод запроса: **GET** 1492 + 1493 +(% 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]] 1494 + 1495 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1496 + 1497 +(% style="color:#000000" %)Ответ: 1498 + 1499 +(% style="color:#000000" %){ 1500 + 1501 + "deviceTypeId" : "", ~/~/ ID типа устройства 1502 + "deviceTypeName" : "" ~/~/ Название типа устройства 1503 + 1504 +(% style="text-align:left" %) 1505 +(% style="color:#000000" %)} 1506 + 1507 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1508 + 1509 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1510 + 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**1513 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 645 645 ))) 646 646 647 -(% style="color:#000000" %) устройств. Метод возвращает информацию о типахустройств с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1516 +(% 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]]1520 +(% 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" %)Ответ: [1524 +(% style="color:#000000" %)Ответ: 656 656 657 -(% class="western" %) 658 -{{{ { 659 - "deviceTypeId" : "", // ID типа устройства 660 - "deviceTypeName" : "" // Название типа устройства 661 - },}}} 1526 +(% style="color:#000000" %){ 662 662 1528 + "id": "", ~/~/ ID типа датчика 1529 + "name": "", ~/~/ Название 1530 + "description": "", ~/~/ Описание 1531 + 663 663 (% style="text-align:left" %) 664 -(% style="color:#000000" %) …** **]1533 +(% style="color:#000000" %)} 665 665 1535 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 666 666 667 -(% class="box" style="text-align: center;" %) 1537 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1538 + 1539 +(% class="box infomessage" style="text-align: left;" %) 668 668 ((( 669 - (%style="color:#000000; font-size:14pt" %)**Раздел Датчики**1541 +**POST /api/v3/terminalMessages/count** 670 670 ))) 671 671 1544 +(% style="text-align: left;" %) 1545 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1546 + 1547 +(% style="text-align: left;" %) 1548 +Метод запроса **POST** 1549 + 1550 +(% style="text-align: left;" %) 1551 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1552 + 1553 +(% style="text-align: left;" %) 1554 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1555 + 1556 +(% style="text-align: left;" %) 1557 +{ 1558 + "vehicleIds": [ 1559 + id ~/~/ здесь передается список идентификаторов объектов 1560 + ], 1561 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1562 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1563 +} 1564 + 1565 +(% style="text-align: left;" %) 1566 +Ответ: 1567 + 1568 +(% style="text-align: left;" %) 1569 +[ 1570 + { 1571 + "vehicleId": 0, ~/~/ идентификатор объекта 1572 + "count": 0 ~/~/ количество сообщений за период 1573 + } 1574 +] 1575 + 1576 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1577 + 672 672 (% class="box infomessage" %) 673 673 ((( 674 - (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GETsensors/types**1580 +**POST /api/v3/terminalMessages** 675 675 ))) 676 676 677 - (% style="color:#000000" %)Методпозволяетполучитьсписоктипов датчиков. Метод возвращает информациюотипах датчиков с учетомстроекавторизованногопользователя, указанноговзапросе(обязательный параметрв заголовках запроса - токен авторизации **«X-Auth»**).1583 +Метод возвращает список сообщений терминала объекта за выбранный период. 678 678 679 -(% style="color:#000000" %)Метод запроса: **GET** 1585 +(% style="text-align: left;" %) 1586 +Метод запроса **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]] 1588 +(% style="text-align: left;" %) 1589 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 682 682 683 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1591 +(% style="text-align: left;" %) 1592 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 684 684 685 -(% style="color:#000000" %)Ответ: [ 1594 +{ 1595 + "vehicleId": 0, ~/~/ id объекта 1596 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1597 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 +} 686 686 687 -(% class="western" style="margin-bottom:19px" %) 688 -{{{ {}}} 1600 +Ответ: 689 689 690 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 1602 +[ 1603 + { 1604 + "messages": [ 1605 + { 1606 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1607 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1608 + "speed": 0, ~/~/ Скорость, км/ч 1609 + "altitude": 0, ~/~/ Высота, м 1610 + "latitude": 0, ~/~/ Широта [-90°;90°] 1611 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1612 + "satellites": 0, ~/~/ Кол-во спутников 1613 + "voltage": 0, ~/~/ Напряжение 1614 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1615 + "additionalProp1": "string", 1616 + "additionalProp2": "string", 1617 + "additionalProp3": "string" 1618 + }, 1619 + "photoCount": 0 ~/~/ Кол-во фото 1620 + } 1621 + ] 1622 + } 1623 +] 691 691 692 -(% class="western" %) 693 -{{{ "description": "" // Описание 694 - },}}} 1625 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных о объекте за период**(%%) = 695 695 1627 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1628 + 1629 +(% class="box infomessage" %) 1630 +((( 1631 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1632 +))) 1633 + 1634 +(% style="color:#000000" %)Метод запроса: **POST** 1635 + 1636 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1637 + 1638 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1639 + 696 696 (% style="text-align:left" %) 697 - (%style="color:#000000" %)… ]1641 +Тело запроса: 698 698 1643 +{ 1644 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1645 + "vehicleIds": [0], ~/~/ Список ID объектов 1646 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1647 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1648 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1649 +} 699 699 1651 +Ответ: 1652 + 1653 +[ 1654 + { 1655 + "vehicleId": 0, ~/~/ ID объекта 1656 + "name": "string", ~/~/ Имя ТС 1657 + "periods": [ ~/~/ Периоды 1658 + { 1659 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1660 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1661 + "mileageBegin": 0, ~/~/ Пробег на начало периода 1662 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 1663 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1664 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 1665 + } 1666 + ] 1667 + } 1668 +] 1669 + 1670 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 1671 + 1672 +(% class="box infomessage" %) 1673 +((( 1674 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 1675 +))) 1676 + 1677 +(% style="color:#000000" %)Метод запроса: **POST** 1678 + 1679 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 1680 + 1681 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1682 + 1683 +(% style="text-align:left" %) 1684 +Тело запроса: 1685 + 1686 +{ 1687 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1688 + "vehicleIds": [0], ~/~/ Список ID объектов 1689 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1690 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1691 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1692 +} 1693 + 1694 +Ответ: 1695 + 1696 +[ 1697 + { 1698 + "vehicleId": 0, ~/~/ ID объекта 1699 + "name": "string", ~/~/ Имя ТС 1700 + "periods": [ ~/~/ Периоды 1701 + { 1702 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1703 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1704 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 1705 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 1706 + "fuelConsumption": 0, ~/~/ Расход топлива 1707 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 1708 + } 1709 + ] 1710 + } 1711 +] 1712 + 1713 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1714 + 1715 +(% class="box infomessage" %) 1716 +((( 1717 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 1718 +))) 1719 + 1720 +(% style="color:#000000" %)Метод запроса: **POST** 1721 + 1722 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 1723 + 1724 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1725 + 1726 +(% style="text-align:left" %) 1727 +Тело запроса: 1728 + 1729 +{ 1730 + "vehicleIds": [0], ~/~/ Список ID объектов 1731 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 1732 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 1733 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1734 +} 1735 + 1736 +Ответ: 1737 + 1738 +[ 1739 + { 1740 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 1741 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 1742 + "vehicleId": 0, ~/~/ ID объекта 1743 + "name": "string", ~/~/ Имя объекта 1744 + "model": "string", ~/~/ Модель объекта 1745 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 1746 + { 1747 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 1748 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 1749 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 1750 + "valueFuel": 0, ~/~/ Количество 1751 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 1752 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 1753 + } 1754 + ] 1755 + } 1756 +] 1757 + 1758 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 1759 + 1760 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1761 + 1762 +(% class="box infomessage" %) 1763 +((( 1764 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1765 +))) 1766 + 1767 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1768 + 1769 +(% style="color:#000000" %)Метод запроса: **POST** 1770 + 1771 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find 1772 + 1773 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1774 + 1775 +(% style="text-align:left" %) 1776 +Тело запроса: 1777 + 1778 +(% style="text-align:left" %) 1779 +{ 1780 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1781 +} 1782 + 1783 +(% style="text-align:left" %) 1784 +Ответ: 1785 + 1786 +[ 1787 + { 1788 + "id": 0, ~/~/ Идентификатор объекта геозоны 1789 + "name": "string", ~/~/ Название объекта геозоны 1790 + "type": 0, ~/~/ Тип объекта геозоны 1791 + "fname": "string", ~/~/ Имя файла 1792 + "parentId": "string", ~/~/ Идентификатор клиента 1793 + "radius": 0, ~/~/ Радиус геообъекта 1794 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 1795 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 1796 + "description": "string", ~/~/ Описание 1797 + "area": 0, ~/~/ Площадь, м^^2^^ 1798 + "perimetr": 0, ~/~/ Периметр, м 1799 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 1800 + } 1801 +] 1802 + 1803 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 1804 + 1805 +(% class="box infomessage" %) 1806 +((( 1807 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 1808 +))) 1809 + 1810 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1811 + 1812 +(% style="color:#000000" %)Метод запроса: **POST** 1813 + 1814 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1815 + 1816 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1817 + 1818 +(% style="text-align:left" %) 1819 +Тело запроса: 1820 + 1821 +{ 1822 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1823 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1824 + "ids": [ ], ~/~/ Массив id объектов 1825 + "byTime": 0, ~/~/ Объединение событий по времени 1826 + "byDist": 0, ~/~/ Объединение событий по расстоянию 1827 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 1828 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1829 +} 1830 + 1831 +Ответ: 1832 +[ 1833 + { 1834 + "geozoneId": 0, ~/~/ ID геообъекта 1835 + "geozoneName": "string", ~/~/ Название геообъекта 1836 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 1837 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 1838 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 1839 + "vehicleId": 0, ~/~/ ID объекта 1840 + "vehicleName": "string" ~/~/ Имя объекта 1841 + } 1842 +] 1843 + 1844 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 1845 + 1846 +(% class="box infomessage" %) 1847 +((( 1848 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 1849 +))) 1850 + 1851 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1852 + 1853 +(% style="color:#000000" %)Метод запроса: **POST** 1854 + 1855 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1856 + 1857 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1858 + 1859 +(% style="text-align:left" %) 1860 +Тело запроса: 1861 + 1862 +{ 1863 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1864 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1865 + "ids": [ ], ~/~/ Массив id геообъектов 1866 + "byTime": 0, ~/~/ Объединение событий по времени 1867 + "byDist": 0, ~/~/ Объединение событий по расстоянию 1868 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 1869 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1870 +} 1871 + 1872 +Ответ: 1873 + 1874 +[ 1875 + { 1876 + "geozoneId": 0, ~/~/ ID геообъекта 1877 + "geozoneName": "string", ~/~/ Название геообъекта 1878 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 1879 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 1880 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 1881 + "vehicleId": 0, ~/~/ ID объекта 1882 + "vehicleName": "string" ~/~/ Имя объекта 1883 + } 1884 +] 1885 + 1886 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1887 + 1888 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 1889 + 1890 +(% class="box infomessage" %) 1891 +((( 1892 +**POST /api/v3/notifications/find** 1893 +))) 1894 + 1895 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1896 + 1897 +(% style="text-align: left;" %) 1898 +Метод запроса **POST** 1899 + 1900 +(% style="text-align: left;" %) 1901 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 1902 + 1903 +(% style="text-align: left;" %) 1904 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1905 + 1906 +{ 1907 + "parentId": "" ~/~/ id клиента 1908 +} 1909 + 1910 +Ответ: 1911 + 1912 +[ 1913 + { 1914 + "id": 0, ~/~/ ID уведомления 1915 + "name": "string", ~/~/ Название уведомления 1916 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 1917 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1918 + "userId": "", ~/~/ Пользователь, создавший уведомление 1919 + "parentId": "", ~/~/ Идентификатор клиента 1920 + "parentName": "string" ~/~/ Имя клиента 1921 + } 1922 +] 1923 + 1924 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1925 + 1926 +(% class="box infomessage" %) 1927 +((( 1928 +**GET /api/v3/notifications/{id}** 1929 +))) 1930 + 1931 +Метод возвращает данные правил формирования выбранного уведомления. 1932 + 1933 +(% style="text-align: left;" %) 1934 +Метод запроса **GET** 1935 + 1936 +(% style="text-align: left;" %) 1937 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1938 + 1939 +(% style="text-align: left;" %) 1940 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 1941 + 1942 +(% style="text-align: left;" %) 1943 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1944 + 1945 +(% style="text-align: left;" %) 1946 +(% style="color:#000000" %)Ответ: 1947 + 1948 +(% style="text-align: left;" %) 1949 +(% style="color:#000000" %){ 1950 + "id": 0, ~/~/ (%%)id уведомления 1951 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1952 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 1953 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 1954 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 1955 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 1956 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 1957 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 1958 +(% style="color:#000000" %) 0 1959 + ], 1960 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 1961 +(% style="color:#000000" %) 0 1962 + ], 1963 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 1964 +(% style="color:#000000" %) 0 1965 + ], 1966 + "settings": { ~/~/ Список параметров уведомления 1967 + "additionalProp1": "string", 1968 + "additionalProp2": "string", 1969 + "additionalProp3": "string" 1970 + }, 1971 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1972 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1973 +(% style="color:#000000" %) "" 1974 + ], 1975 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1976 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 1977 +(% style="color:#000000" %) "string" 1978 + ], 1979 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 1980 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 1981 +(% style="color:#000000" %) { 1982 + "id": 0, ~/~/ (%%)Идентификатор участника чата 1983 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 1984 +(% style="color:#000000" %) } 1985 + ], 1986 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 1987 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 1988 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1989 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 1990 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1991 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 1992 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 1993 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 1994 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1995 +(% style="color:#000000" %)} 1996 + 1997 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1998 + 1999 +(% class="box warningmessage" %) 2000 +((( 2001 +**PUT /api/v3/notifications/** 2002 +))) 2003 + 2004 +Метод позволяет отредактировать уведомление. 2005 + 2006 +Метод запроса **PUT** 2007 + 2008 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2009 + 2010 +В заголовках запроса: X-Auth: Токен авторизации 2011 + 2012 +Тело запроса: 2013 +{ 2014 + "id": 0, ~/~/ id уведомления 2015 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2016 + "userId": "", ~/~/ Пользователь, создавший уведомление 2017 + "parentId": "", ~/~/ Идентификатор клиента 2018 + "parentName": "string", ~/~/ Имя клиента 2019 + "name": "string", ~/~/ Название уведомления 2020 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2021 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2022 + 0 2023 + ], 2024 + "geoids": [ ~/~/ Список id геообъектов для анализа 2025 + 0 2026 + ], 2027 + "fieldids": [ ~/~/ Список id полей для анализа 2028 + 0 2029 + ], 2030 + "settings": { ~/~/ Список параметров уведомления 2031 + "additionalProp1": "string", 2032 + "additionalProp2": "string", 2033 + "additionalProp3": "string" 2034 + }, 2035 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2036 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2037 + "" 2038 + ], 2039 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2040 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2041 + "string" 2042 + ], 2043 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2044 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2045 + { 2046 + "id": 0, ~/~/ Идентификатор участника чата 2047 + "info": "string" ~/~/ Дополнительные сведения 2048 + } 2049 + ], 2050 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2051 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2052 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2053 + "kind": 0, ~/~/ Определяет вид уведомления 2054 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2055 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2056 + "timezone": 0, ~/~/ Сдвиг часового пояса 2057 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2058 + "autoProlongation": true ~/~/ Автопродление срока действия 2059 +} 2060 + 2061 +Ответ: 2062 + 2063 +Success 2064 + 2065 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2066 + 2067 +(% class="box errormessage" %) 2068 +((( 2069 +**DELETE /api/v3/notifications/{id}** 2070 +))) 2071 + 2072 +Метод позволяет удалить выбранное уведомление. 2073 + 2074 +Метод запроса **DELETE** 2075 + 2076 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2077 + 2078 +Передаваемый параметр: {id} - id уведомления 2079 + 2080 +В заголовках запроса: X-Auth: Токен авторизации 2081 + 2082 +Ответ: 2083 + 2084 +Success 2085 + 2086 + 2087 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2088 + 2089 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2090 + 2091 +(% class="box infomessage" %) 2092 +((( 2093 +**POST /api/v3/Drivers/find** 2094 +))) 2095 + 2096 +Передается параметр: parentId - ID клиента-родителя 2097 + 2098 +Ответ: 2099 + 2100 +[ 2101 + { 2102 + "name": "string", ~/~/ Определяет наименование 2103 + "description": "string", ~/~/ Определяет описание 2104 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2105 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2106 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2107 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2108 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2109 + "deleted": true ~/~/ Признак удаления 2110 + } 2111 +] 2112 + 2113 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2114 + 2115 +(% class="box infomessage" %) 2116 +((( 2117 +**GET /api/v3/Drivers/{driverGuid}** 2118 +))) 2119 + 2120 +Передается параметр: ID водителя 2121 + 2122 +Ответ: 2123 + 2124 +{ 2125 + "name": "string", ~/~/ Определяет наименование 2126 + "description": "string", ~/~/ Определяет описание 2127 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2128 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2129 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2130 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2131 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2132 + "deleted": true ~/~/ Признак удаления 2133 +} 2134 + 2135 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2136 + 2137 +(% class="box successmessage" %) 2138 +((( 2139 +**POST /api/v3/Drivers** 2140 +))) 2141 + 2142 +Запрос: 2143 + 2144 +{ 2145 + "name": "string", 2146 + "description": "string", 2147 + "hiredate": "2023-06-30T12:50:54.020Z", 2148 + "chopdate": "2023-06-30T12:50:54.020Z", 2149 + "exclusive": true, 2150 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2151 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2152 + "deleted": true 2153 +} 2154 + 2155 +Ответ: 2156 + 2157 +{ 2158 + "name": "string", 2159 + "description": "string", 2160 + "hiredate": "2023-06-30T12:50:54.051Z", 2161 + "chopdate": "2023-06-30T12:50:54.051Z", 2162 + "exclusive": true, 2163 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2164 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2165 + "deleted": true 2166 +} 2167 + 2168 + 2169 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2170 + 2171 +(% class="box warningmessage" %) 2172 +((( 2173 +**PUT /api/v3/Drivers** 2174 +))) 2175 + 2176 +Запрос: 2177 + 2178 +{ 2179 + "name": "string", 2180 + "description": "string", 2181 + "hiredate": "2023-06-30T12:50:27.910Z", 2182 + "chopdate": "2023-06-30T12:50:27.910Z", 2183 + "exclusive": true, 2184 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2185 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2186 + "deleted": true 2187 +} 2188 + 2189 +Ответ: 2190 + 2191 +{ 2192 + "name": "string", 2193 + "description": "string", 2194 + "hiredate": "2023-06-30T12:50:27.929Z", 2195 + "chopdate": "2023-06-30T12:50:27.929Z", 2196 + "exclusive": true, 2197 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2198 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2199 + "deleted": true 2200 +} 2201 + 2202 + 2203 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2204 + 2205 +(% class="box errormessage" %) 2206 +((( 2207 +**DELETE /api/v3/Drivers/{driverGuid}** 2208 +))) 2209 + 2210 +Передается параметр: ID водителя 2211 + 2212 +Ответ: 2213 + 2214 +Success 2215 + 2216 + 2217 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2218 + 2219 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2220 + 2221 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2222 + 2223 +(% class="box infomessage" %) 2224 +((( 2225 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2226 +))) 2227 + 2228 +Запрос: 2229 + 2230 +{ 2231 + "Ids": [ 2232 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2233 + ], 2234 + "BeginTime": "2023-06-30T12:49:04.365Z", 2235 + "EndTime": "2023-06-30T12:49:04.365Z" 2236 +} 2237 + 2238 +Ответ: 2239 + 2240 +[ 2241 + { 2242 + "VehicleId": 0, 2243 + "CreateTime": "2023-06-30T09:52:31.240Z", 2244 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2245 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2246 + "BeginTime": "2023-06-30T09:52:31.240Z", 2247 + "EndTime": "2023-06-30T09:52:31.240Z" 2248 + } 2249 +] 2250 + 2251 + 2252 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2253 + 2254 +(% class="box infomessage" %) 2255 +((( 2256 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2257 +))) 2258 + 2259 +Запрос: 2260 + 2261 +{ 2262 + "Ids": [ 2263 + 0 2264 + ], 2265 + "BeginTime": "2023-06-30T12:48:39.419Z", 2266 + "EndTime": "2023-06-30T12:48:39.419Z" 2267 +} 2268 + 2269 +Ответ: 2270 + 2271 +[ 2272 + { 2273 + "VehicleId": 0, 2274 + "CreateTime": "2023-06-30T09:54:01.631Z", 2275 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2276 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2277 + "BeginTime": "2023-06-30T09:54:01.631Z", 2278 + "EndTime": "2023-06-30T09:54:01.631Z" 2279 + } 2280 +] 2281 + 2282 + 2283 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2284 + 2285 +(% class="box successmessage" %) 2286 +((( 2287 +**POST /api/v3/DriversVehiclesAssignments** 2288 +))) 2289 + 2290 +Передается массив назначений 2291 + 2292 +Запрос: 2293 + 2294 +[ 2295 + { 2296 + "VehicleId": 0, ~/~/ Идентификатор объекта 2297 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2298 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2299 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2300 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2301 + } 2302 +] 2303 + 2304 +Ответ: 2305 + 2306 +[ 2307 + { 2308 + "VehicleId": 0, 2309 + "CreateTime": "2023-06-30T11:04:46.903Z", 2310 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2311 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2312 + "BeginTime": "2023-06-30T11:04:46.903Z", 2313 + "EndTime": "2023-06-30T11:04:46.903Z" 2314 + } 2315 +] 2316 + 2317 + 2318 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2319 + 2320 +(% class="box warningmessage" %) 2321 +((( 2322 +**PUT /api/v3/DriversVehiclesAssignments** 2323 +))) 2324 + 2325 +Запрос: 2326 + 2327 +[ 2328 + { 2329 + "VehicleId": 0, 2330 + "CreateTime": "2023-06-30T11:14:08.117Z", 2331 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2332 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2333 + "BeginTime": "2023-06-30T11:14:08.117Z", 2334 + "EndTime": "2023-06-30T11:14:08.117Z" 2335 + } 2336 +] 2337 + 2338 +Ответ: 2339 + 2340 +[ 2341 + { 2342 + "VehicleId": 0, 2343 + "CreateTime": "2023-06-30T11:14:53.349Z", 2344 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2345 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2346 + "BeginTime": "2023-06-30T11:14:53.349Z", 2347 + "EndTime": "2023-06-30T11:14:53.349Z" 2348 + } 2349 +] 2350 + 2351 + 2352 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2353 + 2354 +(% class="box errormessage" %) 2355 +((( 2356 +**DELETE /api/v3/DriversVehiclesAssignments** 2357 +))) 2358 + 2359 +Запрос: 2360 + 2361 +[ 2362 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2363 +] 2364 + 2365 +Ответ: 2366 + 2367 +Success 2368 + 2369 + 2370 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2371 + 2372 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2373 + 2374 +(% class="box infomessage" %) 2375 +((( 2376 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2377 +))) 2378 + 2379 +Запрос: 2380 + 2381 +{ 2382 + "Ids": [ 2383 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2384 + ], 2385 + "BeginTime": "2023-06-30T12:47:12.162Z", 2386 + "EndTime": "2023-06-30T12:47:12.162Z" 2387 +} 2388 + 2389 +Ответ: 2390 + 2391 +[ 2392 + { 2393 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2394 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2395 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2396 + "BeginTime": "2023-06-30T11:19:40.703Z", 2397 + "EndTime": "2023-06-30T11:19:40.703Z" 2398 + } 2399 +] 2400 + 2401 + 2402 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2403 + 2404 +(% class="box infomessage" %) 2405 +((( 2406 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2407 +))) 2408 + 2409 +Запрос: 2410 + 2411 +{ 2412 + "Ids": [ 2413 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2414 + ], 2415 + "BeginTime": "2023-06-30T12:47:12.162Z", 2416 + "EndTime": "2023-06-30T12:47:12.162Z" 2417 +} 2418 + 2419 +Ответ: 2420 + 2421 +[ 2422 + { 2423 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2424 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2425 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2426 + "BeginTime": "2023-06-30T11:19:40.703Z", 2427 + "EndTime": "2023-06-30T11:19:40.703Z" 2428 + } 2429 +] 2430 + 2431 + 2432 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2433 + 2434 +(% class="box successmessage" %) 2435 +((( 2436 +**POST /api/v3/DriversRfidsAssignments** 2437 +))) 2438 + 2439 +Запрос: 2440 + 2441 +[ 2442 + { 2443 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2444 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2445 + "BeginTime": "2023-06-30T11:27:08.635Z", 2446 + "EndTime": "2023-06-30T11:27:08.635Z" 2447 + } 2448 +] 2449 + 2450 +Ответ: 2451 + 2452 +[ 2453 + { 2454 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2455 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2456 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2457 + "BeginTime": "2023-06-30T11:27:08.677Z", 2458 + "EndTime": "2023-06-30T11:27:08.677Z" 2459 + } 2460 +] 2461 + 2462 + 2463 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2464 + 2465 +(% class="box warningmessage" %) 2466 +((( 2467 +**PUT /api/v3/DriversRfidsAssignments** 2468 +))) 2469 + 2470 +Запрос: 2471 + 2472 +[ 2473 + { 2474 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2475 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2476 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2477 + "BeginTime": "2023-06-30T11:28:43.330Z", 2478 + "EndTime": "2023-06-30T11:28:43.330Z" 2479 + } 2480 +] 2481 + 2482 +Ответ: 2483 + 2484 +[ 2485 + { 2486 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2487 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2488 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2489 + "BeginTime": "2023-06-30T11:28:43.331Z", 2490 + "EndTime": "2023-06-30T11:28:43.331Z" 2491 + } 2492 +] 2493 + 2494 + 2495 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2496 + 2497 +(% class="box errormessage" %) 2498 +((( 2499 +**DELETE /api/v3/DriversRfidsAssignments** 2500 +))) 2501 + 2502 +Запрос: 2503 + 2504 +[ 2505 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2506 +] 2507 + 2508 +Ответ: 2509 + 2510 +Success 2511 + 2512 + 2513 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 2514 + 2515 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2516 + 2517 +(% class="box infomessage" %) 2518 +((( 2519 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2520 +))) 2521 + 2522 +Запрос: 2523 + 2524 +{ 2525 + "Ids": [ 2526 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2527 + ], 2528 + "BeginTime": "2023-06-30T12:45:10.852Z", 2529 + "EndTime": "2023-06-30T12:45:10.852Z" 2530 +} 2531 + 2532 +Ответ: 2533 + 2534 +[ 2535 + { 2536 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2537 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2538 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2539 + "BeginTime": "2023-06-30T11:58:04.695Z", 2540 + "EndTime": "2023-06-30T11:58:04.695Z" 2541 + } 2542 +] 2543 + 2544 + 2545 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2546 + 2547 +(% class="box infomessage" %) 2548 +((( 2549 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 2550 +))) 2551 + 2552 +Запрос: 2553 + 2554 +{ 2555 + "Ids": [ 2556 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2557 + ], 2558 + "BeginTime": "2023-06-30T12:45:10.852Z", 2559 + "EndTime": "2023-06-30T12:45:10.852Z" 2560 +} 2561 + 2562 +Ответ: 2563 + 2564 +[ 2565 + { 2566 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2567 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2568 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2569 + "BeginTime": "2023-06-30T11:58:04.695Z", 2570 + "EndTime": "2023-06-30T11:58:04.695Z" 2571 + } 2572 +] 2573 + 2574 + 2575 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2576 + 2577 +(% class="box successmessage" %) 2578 +((( 2579 +**POST /api/v3/DriversFuelCardsAssignments** 2580 +))) 2581 + 2582 +Запрос: 2583 + 2584 +[ 2585 + { 2586 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2587 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2588 + "BeginTime": "2023-06-30T12:09:53.175Z", 2589 + "EndTime": "2023-06-30T12:09:53.175Z" 2590 + } 2591 +] 2592 + 2593 +Ответ: 2594 + 2595 +[ 2596 + { 2597 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2598 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2599 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2600 + "BeginTime": "2023-06-30T12:09:53.201Z", 2601 + "EndTime": "2023-06-30T12:09:53.201Z" 2602 + } 2603 +] 2604 + 2605 + 2606 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2607 + 2608 +(% class="box warningmessage" %) 2609 +((( 2610 +**PUT /api/v3/DriversFuelCardsAssignments** 2611 +))) 2612 + 2613 +Запрос: 2614 + 2615 +[ 2616 + { 2617 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2618 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2619 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2620 + "BeginTime": "2023-06-30T12:09:53.201Z", 2621 + "EndTime": "2023-06-30T12:09:53.201Z" 2622 + } 2623 +] 2624 + 2625 +Ответ: 2626 + 2627 +[ 2628 + { 2629 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2630 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2631 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2632 + "BeginTime": "2023-06-30T12:09:53.201Z", 2633 + "EndTime": "2023-06-30T12:09:53.201Z" 2634 + } 2635 +] 2636 + 2637 + 2638 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2639 + 2640 +(% class="box errormessage" %) 2641 +((( 2642 +**DELETE /api/v3/DriversFuelCardsAssignments** 2643 +))) 2644 + 2645 +Запрос: 2646 + 2647 +[ 2648 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2649 +] 2650 + 2651 +Ответ: 2652 + 2653 +Success 2654 + 2655 + 2656 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2657 + 2658 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2659 + 2660 +(% class="box infomessage" %) 2661 +((( 2662 +**POST /api/v3/Rfids/find** 2663 +))) 2664 + 2665 +Запрос: 2666 + 2667 +{ 2668 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2669 +} 2670 + 2671 +Ответ: 2672 + 2673 +[ 2674 + { 2675 + "name": "string", 2676 + "number": 0, 2677 + "period": 0, ~/~/ Частота трансляции радиометки 2678 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2679 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2680 + "deleted": true 2681 + } 2682 +] 2683 + 2684 + 2685 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2686 + 2687 +(% class="box infomessage" %) 2688 +((( 2689 +**GET /api/v3/Rfids/{rfidGuid}** 2690 +))) 2691 + 2692 +Передаем параметр rfidGuid - идентификатор карты-метки 2693 + 2694 +Ответ: 2695 + 2696 +[ 2697 + { 2698 + "name": "string", 2699 + "number": 0, 2700 + "period": 0, ~/~/ Частота трансляции радиометки 2701 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2702 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2703 + "deleted": true 2704 + } 2705 +] 2706 + 2707 + 2708 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2709 + 2710 +(% class="box successmessage" %) 2711 +((( 2712 +**POST /api/v3/Rfids** 2713 +))) 2714 + 2715 +Запрос: 2716 + 2717 +{ 2718 + "name": "string", 2719 + "number": 0, 2720 + "period": 0, 2721 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2722 + "deleted": true 2723 +} 2724 + 2725 +Ответ: 2726 + 2727 +{ 2728 + "name": "string", 2729 + "number": 0, 2730 + "period": 0, 2731 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2732 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2733 + "deleted": true 2734 +} 2735 + 2736 + 2737 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2738 + 2739 +(% class="box warningmessage" %) 2740 +((( 2741 +**PUT /api/v3/Rfids** 2742 +))) 2743 + 2744 +Запрос: 2745 + 2746 +{ 2747 + "name": "string", 2748 + "number": 0, 2749 + "period": 0, 2750 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2751 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2752 + "deleted": true 2753 +} 2754 + 2755 +Ответ: 2756 + 2757 +{ 2758 + "name": "string", 2759 + "number": 0, 2760 + "period": 0, 2761 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2762 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2763 + "deleted": true 2764 +} 2765 + 2766 + 2767 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2768 + 2769 +(% class="box errormessage" %) 2770 +((( 2771 +**DELETE /api/v3/Rfids/{rfidGuid}** 2772 +))) 2773 + 2774 +Передаем параметр rfidGuid - идентификатор карты-метки 2775 + 2776 +Ответ: 2777 + 2778 +Success 2779 + 2780 + 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]] **