Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,31 +1,31 @@ 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 8 + 9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 + 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 + 13 13 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 - 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 22 22 23 -(% class="box successmessage" %) 19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 + 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 + 23 +(% class="box infomessage" %) 24 24 ((( 25 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) 28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 30 (% style="color:#000000" %)Метод запроса: **POST** 31 31 ... ... @@ -38,9 +38,9 @@ 38 38 (% style="color:#000000" %){ 39 39 "login": "testuser", 40 40 "password": "testuser" 41 -}(%%) 42 - 41 +} 43 43 43 + 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -55,13 +55,14 @@ 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 58 58 59 59 (% class="box infomessage" %) 60 60 ((( 61 -(% 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** 62 62 ))) 63 63 64 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 65 65 66 66 (% style="color:#000000" %)Метод запроса: **GET** 67 67 ... ... @@ -72,18 +72,58 @@ 72 72 (% lang="en-US" %) 73 73 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 74 74 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 75 75 76 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 77 77 ((( 78 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 79 79 ))) 80 80 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 + 81 81 (% class="box infomessage" %) 82 82 ((( 83 -(% 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(%%)** 84 84 ))) 85 85 86 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 87 87 88 88 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 89 89 ... ... @@ -91,37 +91,184 @@ 91 91 92 92 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 93 93 94 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% style="color:#000000" %)Метод запроса: **POST** 95 95 96 -(% 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 97 97 98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 99 99 100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 101 101 102 102 (% style="color:#000000" %)Ответ: 103 103 104 -(% style="color:#000000" %){ 105 - "agentId": "", ~/~/ идентификатор клиента 106 - "parentId": "", ~/~/ идентификатор клиента-родителя 107 - "name": "", ~/~/ наименование клиента 108 - "fullName": "", ~/~/ полное наименование клиента 109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 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 - Отказ) 111 111 } 112 112 157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 113 113 114 -(% class="box "style="text-align: center;" %)159 +(% class="box successmessage" %) 115 115 ((( 116 - (%style="color:#000000; font-size:14pt"%)**Раздел Пользователи**161 +**POST /api/v3/agents ** 117 117 ))) 118 118 164 +Метод позволяет добавить клиента, указанного в запросе. 165 + 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" %) 223 +((( 224 +**PUT /api/v3/agents** 225 +))) 226 + 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 + 119 119 (% class="box successmessage" %) 120 120 ((( 121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 122 122 ))) 123 123 124 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 125 125 126 126 (% style="color:#000000" %)Метод запроса: **POST** 127 127 ... ... @@ -131,26 +131,51 @@ 131 131 132 132 (% style="color:#000000" %)Параметры в теле запроса (JSON): 133 133 134 -(% style="color:#000000" %){ 322 +(% style="color:#000000" %) 323 +{ 135 135 "lastName": "", ~/~/ фамилия 136 136 "firstName": "", ~/~/ имя 137 137 "position": "", ~/~/ должность 138 138 "phone": "", ~/~/ телефон 139 139 "organization": "", ~/~/ организация 140 - "login": "", ~/~/ логин 141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 142 - "email": "", ~/~/ email 143 - "description": "", ~/~/ описание 144 - "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 - отключен 145 145 "parentId": "", ~/~/ Guid родительского агента 146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 151 - "groups": "" , ~/~/ группы пользователя, названия групп 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 - Азербайджанский 152 152 } 153 153 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 + 154 154 (% style="text-align:left" %) 155 155 (% style="color:#000000; font-weight:normal" %)Ответ: 156 156 ... ... @@ -174,18 +174,19 @@ 174 174 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 175 175 "kind": "" , ~/~/ тип аутентификации 176 176 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 177 - "groups": группы пользователя,«user»названия группыпользователя390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 178 178 179 179 (% style="text-align:left" %) 180 180 (% style="color:#000000; font-weight:normal" %)} 181 181 395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 182 182 183 -(% class="box successmessage" %)397 +(% class="box infomessage" %) 184 184 ((( 185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**399 +(% lang="en-US" %)**POST /api/v3/users/find** 186 186 ))) 187 187 188 -(% style="color:#000000" %) 402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 189 189 190 190 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 191 191 ... ... @@ -222,17 +222,70 @@ 222 222 "email": "" , ~/~/ E-mail 223 223 "sessionDuration":"", ~/~/ длительность сессии в минутах 224 224 "status": "1", ~/~/ статус пользователя 225 - "astLogged": "", ~/~/ дата/время последней авторизации 439 + "lastLogged": "", ~/~/ дата/время последней авторизации 226 226 227 227 (% style="color:#000000" %)} 228 228 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 229 229 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 + 230 230 (% class="box warningmessage" %) 231 231 ((( 232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**499 +(% lang="en-US" %)**PUT /api/v3/users** 233 233 ))) 234 234 235 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 236 236 237 237 (% style="color:#000000" %)Метод запроса: **PUT** 238 238 ... ... @@ -253,17 +253,22 @@ 253 253 "position": "" , ~/~/ должность 254 254 "phone": "" , ~/~/ телефон 255 255 "organization": "" , ~/~/ организация 256 - "login": "" , ~/~/ логин 257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 258 - "email": "" , ~/~/ email 259 - "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": "" , ~/~/ описание 260 260 "isEnabled": "" , ~/~/ признак включения 261 261 "parentId": "" , ~/~/ Guid родительского агента 262 262 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 263 263 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 264 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 265 - "kind": "" , ~/~/ тип аутентификации 266 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 267 267 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 268 268 269 269 (% lang="en-US" style="text-align:left" %) ... ... @@ -289,8 +289,12 @@ 289 289 "isEnabled": "" , ~/~/ признак включения 290 290 "parentId": "" , ~/~/ Guid родительского агента 291 291 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 293 - "kind": "" , ~/~/ тип аутентификации 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 294 294 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 295 295 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 296 296 ... ... @@ -297,13 +297,14 @@ 297 297 (% lang="en-US" style="text-align:left" %) 298 298 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 299 299 576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 300 300 301 301 (% class="box warningmessage" %) 302 302 ((( 303 -(% 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}** 304 304 ))) 305 305 306 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 307 307 308 308 (% style="color:#000000" %)Метод запроса: **PUT** 309 309 ... ... @@ -326,13 +326,14 @@ 326 326 (% style="text-align:left" %) 327 327 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 328 328 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 329 329 330 330 (% class="box warningmessage" %) 331 331 ((( 332 -** Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/disable**610 +**POST /api/v3/users/disable** 333 333 ))) 334 334 335 -Метода позволяет выполнить массовую блокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 336 336 337 337 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 338 338 ... ... @@ -347,13 +347,14 @@ 347 347 348 348 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 349 349 628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 350 350 351 351 (% class="box warningmessage" %) 352 352 ((( 353 -** Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/enable**632 +**POST /api/v3/users/enable** 354 354 ))) 355 355 356 -Метода позволяет выполнить массовую разблокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 357 357 358 358 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 359 359 ... ... @@ -369,6 +369,7 @@ 369 369 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 370 370 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 371 371 651 +((( 372 372 В теле ответа: 373 373 { 374 374 "errorMessages": [ ... ... @@ -380,14 +380,16 @@ 380 380 } 381 381 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 382 382 "users" - массив id пользователей, которых не удалось включить или отключить. 383 - 663 +))) 384 384 665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 + 385 385 (% class="box errormessage" %) 386 386 ((( 387 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 388 388 ))) 389 389 390 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 391 391 392 392 (% style="color:#000000" %)Метод запроса: **DELETE** 393 393 ... ... @@ -400,20 +400,18 @@ 400 400 (% style="text-align:left" %) 401 401 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 402 402 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 403 403 404 -(% class="box" style="text-align: center;" %) 405 -((( 406 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 407 -))) 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 408 408 409 409 (% class="box infomessage" %) 410 410 ((( 411 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 412 412 ))) 413 413 414 -(% style="color:#000000" %) 694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 415 415 416 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 417 417 418 418 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 419 419 ... ... @@ -421,83 +421,192 @@ 421 421 422 422 (% style="color:#000000" %)Метод запроса: **GET** 423 423 424 -(% 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} 425 425 426 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 427 427 428 428 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 429 429 430 430 (% style="color:#000000" %)Ответ: 431 431 712 +((( 432 432 { 714 + "vehicleId": "", ~/~/ ID объекта 715 + "name": "", ~/~/ Имя объекта 716 + "imei": "", ~/~/ IMEI объекта 717 + "deviceTypeId": , ~/~/ ID типа устройства 718 + "deviceTypeName": "", ~/~/ Название типа устройства 719 + "sim1": "", ~/~/ Номер SIM1 720 + "sim2": "", ~/~/ Номер SIM2 433 433 434 - "vehicleId": , 722 + "parentId": "", ~/~/ ID клиента-родителя 723 + "parentName": "", ~/~/ Наименование клиента-родителя 724 + "modelId": "", ~/~/ ID модели объекта 725 + "modelName": "", ~/~/ Имя модели объекта 435 435 436 - "name": "", 727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 + "unitName": "string", ~/~/ Наименование подразделения 729 + "status": 0, ~/~/ Статус объекта 437 437 438 - "imei": "", 731 + "createdAt": "", ~/~/ Дата создания объекта 732 + }, 439 439 440 - "deviceTypeId": , 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 + } 441 441 442 - "deviceTypeName": "", 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": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 443 443 444 - "sim1": "", 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" ~/~/ Дата пересчета последних моточасов 769 + }, 445 445 446 - "parentId": "", 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 + }, 447 447 448 - "parentName": "", 779 +"commandTemplates": [ ~/~/ Шаблоны команд 780 + { 781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 782 + "name": "string", ~/~/ Наименование команды 783 + "command": "string", ~/~/ Текст команды 784 + "retries": 0 ~/~/ Количество попыток 785 + } 786 + ], 449 449 450 - "modelId": "", 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 + }, 451 451 452 - "modelName":"",827 +~/~/ Характерные для произвольного: 453 453 454 - " createdAt": "",829 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 455 455 456 - "m ileageCalcMethod": "",831 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 457 457 458 - " counters":{833 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 459 459 460 - "m ileageEnabled":835 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 461 461 462 - " motohoursEnabled": ,837 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 463 463 464 - " mileage":22438858.137653351, ~/~/пробег понормам в метрах839 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 465 465 466 - " motohours":54545302.0~/~/моточасыпормам,в секундах841 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 467 467 468 - },843 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 469 469 470 - "inspectionTasks":[845 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 471 471 472 - {847 +~/~/ "ValueOn": "Вкл.", 473 473 474 - "id": "", 849 +~/~/ "ValueOff": "Выкл." 850 + "summaryMaxValue": 0 ~/~/ Макс. значение 851 + } 475 475 476 - "enabled": , 853 + "drivers": [ ~/~/ Водители 854 + { 855 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 856 + "name": "string", ~/~/ Наименование 857 + "description": "string", 858 + "isDefault": true ~/~/ По умолчанию 859 + } 860 + ], 477 477 478 - "name": "", 479 - 480 - "description": "", 481 - 482 - "mileageCondition": , 483 - 484 - "lastMileage": , 485 - 486 - "motohoursCondition": , 487 - 488 - "lastMotohours": , 489 - 490 - "periodicCondition": , 491 - 492 - "kind": "", 493 - 494 - "lastInspectionDate": "" 495 - 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 - однократно) 496 496 } 877 + ], 497 497 498 - ] 879 + "statusHistory": [ ~/~/ История статусов 880 + { 881 + "status": 0, 882 + "date": "2023-05-22T09:57:39.562Z", 883 + "description": "string", 884 + "additionalInfo": "string" 885 + } 886 + ] 499 499 500 500 } 889 +))) 501 501 502 502 (% style="text-align:left" %) 503 503 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -505,13 +505,14 @@ 505 505 (% style="text-align:left" %) 506 506 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 507 507 897 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 508 508 509 509 (% class="box successmessage" %) 510 510 ((( 511 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**901 +(% lang="en-US" %)**POST /api/v3/vehicles** 512 512 ))) 513 513 514 -(% style="color:#000000" %) . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).904 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 515 515 516 516 (% style="color:#000000" %)Метод запроса: **POST** 517 517 ... ... @@ -543,6 +543,11 @@ 543 543 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 544 544 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 545 545 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 936 + 937 + "mileageCalcMethod": 0, 938 + "mileageCoeff": 0, 939 + "locationByCellId": true, 940 + "dottedLineTrackWhenNoCoords": true, 546 546 "counters": ~/~/ счетчики 547 547 { 548 548 "mileage": "" , ~/~/ пробег ... ... @@ -572,8 +572,98 @@ 572 572 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 573 573 } 574 574 575 -(% style="color:#000000" %) } 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 + ], 576 576 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" 1022 + }, 1023 + 1024 +~/~/ Характерные для произвольного: 1025 + 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 + 577 577 (% style="color:#000000" %)Ответ: 578 578 579 579 (% style="color:#000000" %){ ... ... @@ -624,15 +624,16 @@ 624 624 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 625 625 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 626 626 1112 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 627 627 628 -(% class="box successmessage" %)1114 +(% class="box infomessage" %) 629 629 ((( 630 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**1116 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 631 631 ))) 632 632 633 -(% style="color:#000000" %) 1119 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 634 634 635 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):1121 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 636 636 637 637 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 638 638 ... ... @@ -658,19 +658,19 @@ 658 658 659 659 (% style="color:#000000" %)Параметры в теле запроса (JSON): 660 660 661 -(% class="western" style="color:#000000" %)##{## 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 +} 662 662 663 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 664 - "name": null, ~/~/ Имя ТС (string, опционально) 665 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 666 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 667 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 668 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 669 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%) 670 -(% style="color:#000000" %)} 1158 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 671 671 672 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 673 - 674 674 (% style="color:#000000" %)Ответ: 675 675 676 676 (% style="color:#000000" %){ ... ... @@ -691,18 +691,28 @@ 691 691 "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 692 692 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 693 693 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 694 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%) 1180 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1181 + "customFields": [ 1182 + { 1183 + "id": "", ~/~/ идентификатор произвольного поля 1184 + "name": "", ~/~/ имя произвольного поля 1185 + "value": "", ~/~/ значение произвольного поля 1186 + "forClient": true, ~/~/ право на отображение у клиента 1187 + "forTooltip": false, ~/~/ право на отображение в подсказке 1188 + "forReport": false ~/~/ право на отображение в отчетах 1189 + }(%%) 695 695 (% style="color:#000000" %)} 696 696 697 697 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 698 698 1194 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 699 699 700 700 (% class="box successmessage" %) 701 701 ((( 702 -(% 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}** 703 703 ))) 704 704 705 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1201 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 706 706 707 707 (% style="color:#000000" %)Метод запроса: **POST** 708 708 ... ... @@ -741,13 +741,14 @@ 741 741 (% style="text-align:left" %) 742 742 (% style="color:#000000" %) } 743 743 1240 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 744 744 745 745 (% class="box warningmessage" %) 746 746 ((( 747 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**1244 +(% lang="en-US" %)**PUT /api/v3/vehicles** 748 748 ))) 749 749 750 -(% style="color:#000000" %) . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1247 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 751 751 752 752 (% style="color:#000000" %)Метод запроса: **PUT** 753 753 ... ... @@ -757,18 +757,16 @@ 757 757 758 758 (% style="color:#000000" %)Параметры в теле запроса (JSON): 759 759 760 -(% style="color:#000000" %){ 1257 +(% style="color:#000000" %){ 761 761 762 -((( 763 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 764 - "parentId": "", ~/~/ ID клиента 765 - "name": "", ~/~/ имя ТС 766 - "imei": "", ~/~/ IMEI 767 - "deviceTypeId": "", ~/~/ ID типа устройства 768 - "modelId": "", ~/~/ , ID модели 769 - "unitId": "", ~/~/ подразделения 770 - "sim1": "", ~/~/ SIM 1 771 - "sim2": "", ~/~/ SIM2 (%%) 1259 + "parentId": "" , ~/~/ ID клиента 1260 + "name": "" , ~/~/ имя ТС 1261 + "imei": "" , ~/~/ IMEI 1262 + "deviceTypeId": "" , ~/~/ ID типа устройства 1263 + "modelId": "" , ~/~/ ID модели 1264 + "unitId": "" , ~/~/ ID подразделения 1265 + "sim1": "" , ~/~/ Номер SIM 1 1266 + "sim2": "" , ~/~/ Номер SIM2 772 772 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 773 773 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 774 774 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -781,39 +781,132 @@ 781 781 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 782 782 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 783 783 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 784 -(% style="color:#000000" %) "counters": 785 - { 786 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 787 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 788 - "mileage": "", ~/~/ пробег, в метрах 789 - "motohours": "" ~/~/ моточасы, в секундах 790 - } 791 - "cmsv6Parameters": ~/~/ параметры CMSv6 792 - { 793 - "id": "", ~/~/ идентификатор 794 - "enabled": true, ~/~/ флаг включения 795 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 796 - "login": "", ~/~/ имя учетной записи 797 - "password": "", ~/~/ пароль учетной записи 798 - } 799 - "inspectionTasks": ~/~/ задания на ТО 800 - { 801 - "id": "", ~/~/ ID задания 802 - "enabled": false, ~/~/ Признак включения 803 - "name": "", ~/~/ Имя задания 804 - "description": "", ~/~/ Описание задания 805 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 806 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 807 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 808 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 809 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 810 - "kind": "", ~/~/ Вид периодичности по времени 811 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 812 - } 813 -))) 814 814 815 -(% style="color:#000000" %)} 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 + } 816 816 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 + 817 817 (% style="color:#000000" %)Ответ: 818 818 819 819 (% lang="en-US" style="text-align:left" %) ... ... @@ -864,18 +864,19 @@ 864 864 (% lang="en-US" style="text-align:left" %) 865 865 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 866 866 867 -** валидация:**1455 +**Валидация:** 868 868 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 869 869 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 870 870 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 871 871 1460 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 872 872 873 873 (% class="box errormessage" %) 874 874 ((( 875 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1464 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 876 876 ))) 877 877 878 -(% style="color:#000000" %) . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1467 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 879 879 880 880 (% style="color:#000000" %)Метод запроса: **DELETE** 881 881 ... ... @@ -888,18 +888,16 @@ 888 888 (% style="text-align:left" %) 889 889 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 890 890 1480 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 891 891 892 -(% class="box" lang="en-US" style="text-align: center;" %) 893 -((( 894 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 895 -))) 1482 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 896 896 897 897 (% class="box infomessage" %) 898 898 ((( 899 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов устройств**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**1486 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 900 900 ))) 901 901 902 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1489 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 903 903 904 904 (% style="color:#000000" %)Метод запроса: **GET** 905 905 ... ... @@ -917,24 +917,22 @@ 917 917 (% style="text-align:left" %) 918 918 (% style="color:#000000" %)} 919 919 1507 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 920 920 921 -(% class="box" style="text-align: center;" %) 922 -((( 923 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 924 -))) 1509 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 925 925 926 926 (% class="box infomessage" %) 927 927 ((( 928 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов датчиков**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**1513 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 929 929 ))) 930 930 931 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1516 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 932 932 933 933 (% style="color:#000000" %)Метод запроса: **GET** 934 934 935 935 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 936 936 937 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1522 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 938 938 939 939 (% style="color:#000000" %)Ответ: 940 940 ... ... @@ -947,7 +947,958 @@ 947 947 (% style="text-align:left" %) 948 948 (% style="color:#000000" %)} 949 949 1535 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 950 950 1537 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1538 + 1539 +(% class="box infomessage" style="text-align: left;" %) 1540 +((( 1541 +**POST /api/v3/terminalMessages/count** 1542 +))) 1543 + 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 + 1578 +(% class="box infomessage" %) 1579 +((( 1580 +**POST /api/v3/terminalMessages** 1581 +))) 1582 + 1583 +Метод возвращает список сообщений терминала объекта за выбранный период. 1584 + 1585 +(% style="text-align: left;" %) 1586 +Метод запроса **POST** 1587 + 1588 +(% style="text-align: left;" %) 1589 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1590 + 1591 +(% style="text-align: left;" %) 1592 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1593 + 1594 +{ 1595 + "vehicleId": 0, ~/~/ id объекта 1596 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1597 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 +} 1599 + 1600 +Ответ: 1601 + 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 +] 1624 + 1625 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1626 + 1627 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 1628 + 1629 +(% class="box infomessage" %) 1630 +((( 1631 +**POST /api/v3/notifications/find** 1632 +))) 1633 + 1634 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1635 + 1636 +(% style="text-align: left;" %) 1637 +Метод запроса **POST** 1638 + 1639 +(% style="text-align: left;" %) 1640 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 1641 + 1642 +(% style="text-align: left;" %) 1643 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1644 + 1645 +{ 1646 + "parentId": "" ~/~/ id клиента 1647 +} 1648 + 1649 +Ответ: 1650 + 1651 +[ 1652 + { 1653 + "id": 0, ~/~/ ID уведомления 1654 + "name": "string", ~/~/ Название уведомления 1655 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 1656 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1657 + "userId": "", ~/~/ Пользователь, создавший уведомление 1658 + "parentId": "", ~/~/ Идентификатор клиента 1659 + "parentName": "string" ~/~/ Имя клиента 1660 + } 1661 +] 1662 + 1663 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1664 + 1665 +(% class="box infomessage" %) 1666 +((( 1667 +**GET /api/v3/notifications/{id}** 1668 +))) 1669 + 1670 +Метод возвращает данные правил формирования выбранного уведомления. 1671 + 1672 +(% style="text-align: left;" %) 1673 +Метод запроса **GET** 1674 + 1675 +(% style="text-align: left;" %) 1676 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1677 + 1678 +(% style="text-align: left;" %) 1679 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 1680 + 1681 +(% style="text-align: left;" %) 1682 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1683 + 1684 +(% style="text-align: left;" %) 1685 +(% style="color:#000000" %)Ответ: 1686 + 1687 +(% style="text-align: left;" %) 1688 +(% style="color:#000000" %){ 1689 + "id": 0, ~/~/ (%%)id уведомления 1690 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1691 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 1692 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 1693 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 1694 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 1695 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 1696 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 1697 +(% style="color:#000000" %) 0 1698 + ], 1699 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 1700 +(% style="color:#000000" %) 0 1701 + ], 1702 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 1703 +(% style="color:#000000" %) 0 1704 + ], 1705 + "settings": { ~/~/ Список параметров уведомления 1706 + "additionalProp1": "string", 1707 + "additionalProp2": "string", 1708 + "additionalProp3": "string" 1709 + }, 1710 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1711 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1712 +(% style="color:#000000" %) "" 1713 + ], 1714 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1715 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 1716 +(% style="color:#000000" %) "string" 1717 + ], 1718 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 1719 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 1720 +(% style="color:#000000" %) { 1721 + "id": 0, ~/~/ (%%)Идентификатор участника чата 1722 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 1723 +(% style="color:#000000" %) } 1724 + ], 1725 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 1726 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 1727 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1728 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 1729 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1730 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 1731 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 1732 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 1733 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1734 +(% style="color:#000000" %)} 1735 + 1736 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1737 + 1738 +(% class="box warningmessage" %) 1739 +((( 1740 +**PUT /api/v3/notifications/** 1741 +))) 1742 + 1743 +Метод позволяет отредактировать уведомление. 1744 + 1745 +Метод запроса **PUT** 1746 + 1747 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 1748 + 1749 +В заголовках запроса: X-Auth: Токен авторизации 1750 + 1751 +Тело запроса: 1752 +{ 1753 + "id": 0, ~/~/ id уведомления 1754 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1755 + "userId": "", ~/~/ Пользователь, создавший уведомление 1756 + "parentId": "", ~/~/ Идентификатор клиента 1757 + "parentName": "string", ~/~/ Имя клиента 1758 + "name": "string", ~/~/ Название уведомления 1759 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 1760 + "vehicleIds": [ ~/~/ Список id объектов для анализа 1761 + 0 1762 + ], 1763 + "geoids": [ ~/~/ Список id геообъектов для анализа 1764 + 0 1765 + ], 1766 + "fieldids": [ ~/~/ Список id полей для анализа 1767 + 0 1768 + ], 1769 + "settings": { ~/~/ Список параметров уведомления 1770 + "additionalProp1": "string", 1771 + "additionalProp2": "string", 1772 + "additionalProp3": "string" 1773 + }, 1774 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1775 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1776 + "" 1777 + ], 1778 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1779 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 1780 + "string" 1781 + ], 1782 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 1783 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 1784 + { 1785 + "id": 0, ~/~/ Идентификатор участника чата 1786 + "info": "string" ~/~/ Дополнительные сведения 1787 + } 1788 + ], 1789 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 1790 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 1791 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1792 + "kind": 0, ~/~/ Определяет вид уведомления 1793 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1794 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 1795 + "timezone": 0, ~/~/ Сдвиг часового пояса 1796 + "validity": 0, ~/~/ Срок действия в днях (1-90) 1797 + "autoProlongation": true ~/~/ Автопродление срока действия 1798 +} 1799 + 1800 +Ответ: 1801 + 1802 +Success 1803 + 1804 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1805 + 1806 +(% class="box errormessage" %) 1807 +((( 1808 +**DELETE /api/v3/notifications/{id}** 1809 +))) 1810 + 1811 +Метод позволяет удалить выбранное уведомление. 1812 + 1813 +Метод запроса **DELETE** 1814 + 1815 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1816 + 1817 +Передаваемый параметр: {id} - id уведомления 1818 + 1819 +В заголовках запроса: X-Auth: Токен авторизации 1820 + 1821 +Ответ: 1822 + 1823 +Success 1824 + 1825 + 1826 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 1827 + 1828 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 1829 + 1830 +POST /api/v3/Drivers/find 1831 + 1832 +Передается параметр: parentId - ID клиента-родителя 1833 + 1834 +Ответ: 1835 + 1836 +[ 1837 + { 1838 + "name": "string", ~/~/ Определяет наименование 1839 + "description": "string", ~/~/ Определяет описание 1840 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 1841 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 1842 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 1843 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 1844 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 1845 + "deleted": true ~/~/ Признак удаления 1846 + } 1847 +] 1848 + 1849 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 1850 + 1851 +GET /api/v3/Drivers/{driverGuid} 1852 + 1853 +Передается параметр: ID водителя 1854 + 1855 +Ответ: 1856 + 1857 +{ 1858 + "name": "string", ~/~/ Определяет наименование 1859 + "description": "string", ~/~/ Определяет описание 1860 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 1861 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 1862 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 1863 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 1864 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 1865 + "deleted": true ~/~/ Признак удаления 1866 +} 1867 + 1868 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 1869 + 1870 +POST /api/v3/Drivers 1871 + 1872 +Запрос: 1873 + 1874 +{ 1875 + "name": "string", 1876 + "description": "string", 1877 + "hiredate": "2023-06-30T12:50:54.020Z", 1878 + "chopdate": "2023-06-30T12:50:54.020Z", 1879 + "exclusive": true, 1880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1881 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1882 + "deleted": true 1883 +} 1884 + 1885 +Ответ: 1886 + 1887 +{ 1888 + "name": "string", 1889 + "description": "string", 1890 + "hiredate": "2023-06-30T12:50:54.051Z", 1891 + "chopdate": "2023-06-30T12:50:54.051Z", 1892 + "exclusive": true, 1893 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1894 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1895 + "deleted": true 1896 +} 1897 + 1898 + 1899 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 1900 + 1901 +PUT /api/v3/Drivers 1902 + 1903 +Запрос: 1904 + 1905 +{ 1906 + "name": "string", 1907 + "description": "string", 1908 + "hiredate": "2023-06-30T12:50:27.910Z", 1909 + "chopdate": "2023-06-30T12:50:27.910Z", 1910 + "exclusive": true, 1911 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1912 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1913 + "deleted": true 1914 +} 1915 + 1916 +Ответ: 1917 + 1918 +{ 1919 + "name": "string", 1920 + "description": "string", 1921 + "hiredate": "2023-06-30T12:50:27.929Z", 1922 + "chopdate": "2023-06-30T12:50:27.929Z", 1923 + "exclusive": true, 1924 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1925 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1926 + "deleted": true 1927 +} 1928 + 1929 + 1930 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 1931 + 1932 +DELETE /api/v3/Drivers/{driverGuid} 1933 + 1934 +Передается параметр: ID водителя 1935 + 1936 +Ответ: 1937 + 1938 +Success 1939 + 1940 + 1941 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 1942 + 1943 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 1944 + 1945 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 1946 + 1947 +POST /api/v3/DriversVehiclesAssignments/GetByDrivers 1948 + 1949 +Запрос: 1950 + 1951 +{ 1952 + "Ids": [ 1953 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1954 + ], 1955 + "BeginTime": "2023-06-30T12:49:04.365Z", 1956 + "EndTime": "2023-06-30T12:49:04.365Z" 1957 +} 1958 + 1959 +Ответ: 1960 + 1961 +[ 1962 + { 1963 + "VehicleId": 0, 1964 + "CreateTime": "2023-06-30T09:52:31.240Z", 1965 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1966 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1967 + "BeginTime": "2023-06-30T09:52:31.240Z", 1968 + "EndTime": "2023-06-30T09:52:31.240Z" 1969 + } 1970 +] 1971 + 1972 + 1973 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 1974 + 1975 +POST /api/v3/DriversVehiclesAssignments/GetByVehicles 1976 + 1977 +Запрос: 1978 + 1979 +{ 1980 + "Ids": [ 1981 + 0 1982 + ], 1983 + "BeginTime": "2023-06-30T12:48:39.419Z", 1984 + "EndTime": "2023-06-30T12:48:39.419Z" 1985 +} 1986 + 1987 +Ответ: 1988 + 1989 +[ 1990 + { 1991 + "VehicleId": 0, 1992 + "CreateTime": "2023-06-30T09:54:01.631Z", 1993 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1994 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1995 + "BeginTime": "2023-06-30T09:54:01.631Z", 1996 + "EndTime": "2023-06-30T09:54:01.631Z" 1997 + } 1998 +] 1999 + 2000 + 2001 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2002 + 2003 +POST /api/v3/DriversVehiclesAssignments 2004 + 2005 +Передается массив назначений 2006 + 2007 +Запрос: 2008 + 2009 +[ 2010 + { 2011 + "VehicleId": 0, ~/~/ Идентификатор объекта 2012 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2013 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2014 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2015 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2016 + } 2017 +] 2018 + 2019 +Ответ: 2020 + 2021 +[ 2022 + { 2023 + "VehicleId": 0, 2024 + "CreateTime": "2023-06-30T11:04:46.903Z", 2025 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2026 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2027 + "BeginTime": "2023-06-30T11:04:46.903Z", 2028 + "EndTime": "2023-06-30T11:04:46.903Z" 2029 + } 2030 +] 2031 + 2032 + 2033 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2034 + 2035 +PUT /api/v3/DriversVehiclesAssignments 2036 + 2037 +Запрос: 2038 + 2039 +[ 2040 + { 2041 + "VehicleId": 0, 2042 + "CreateTime": "2023-06-30T11:14:08.117Z", 2043 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2044 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2045 + "BeginTime": "2023-06-30T11:14:08.117Z", 2046 + "EndTime": "2023-06-30T11:14:08.117Z" 2047 + } 2048 +] 2049 + 2050 +Ответ: 2051 + 2052 +[ 2053 + { 2054 + "VehicleId": 0, 2055 + "CreateTime": "2023-06-30T11:14:53.349Z", 2056 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2057 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2058 + "BeginTime": "2023-06-30T11:14:53.349Z", 2059 + "EndTime": "2023-06-30T11:14:53.349Z" 2060 + } 2061 +] 2062 + 2063 + 2064 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2065 + 2066 +DELETE /api/v3/DriversVehiclesAssignments 2067 + 2068 +Запрос: 2069 + 2070 +[ 2071 + { 2072 + "VehicleId": 0, 2073 + "CreateTime": "2023-06-30T11:16:08.341Z", 2074 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2075 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2076 + "BeginTime": "2023-06-30T11:16:08.342Z", 2077 + "EndTime": "2023-06-30T11:16:08.342Z" 2078 + } 2079 +] 2080 + 2081 +Ответ: 2082 + 2083 +[ 2084 + { 2085 + "VehicleId": 0, 2086 + "CreateTime": "2023-06-30T11:16:08.344Z", 2087 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2088 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2089 + "BeginTime": "2023-06-30T11:16:08.344Z", 2090 + "EndTime": "2023-06-30T11:16:08.344Z" 2091 + } 2092 +] 2093 + 2094 + 2095 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2096 + 2097 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2098 + 2099 +POST /api/v3/DriversRfidsAssignments/GetByDrivers 2100 + 2101 +Запрос: 2102 + 2103 +{ 2104 + "Ids": [ 2105 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2106 + ], 2107 + "BeginTime": "2023-06-30T12:47:12.162Z", 2108 + "EndTime": "2023-06-30T12:47:12.162Z" 2109 +} 2110 + 2111 +Ответ: 2112 + 2113 +[ 2114 + { 2115 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2116 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2117 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2118 + "BeginTime": "2023-06-30T11:19:40.703Z", 2119 + "EndTime": "2023-06-30T11:19:40.703Z" 2120 + } 2121 +] 2122 + 2123 + 2124 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2125 + 2126 +POST /api/v3/DriversRfidsAssignments/GetByRfids 2127 + 2128 +Запрос: 2129 + 2130 +{ 2131 + "Ids": [ 2132 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2133 + ], 2134 + "BeginTime": "2023-06-30T12:47:12.162Z", 2135 + "EndTime": "2023-06-30T12:47:12.162Z" 2136 +} 2137 + 2138 +Ответ: 2139 + 2140 +[ 2141 + { 2142 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2143 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2144 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2145 + "BeginTime": "2023-06-30T11:19:40.703Z", 2146 + "EndTime": "2023-06-30T11:19:40.703Z" 2147 + } 2148 +] 2149 + 2150 + 2151 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2152 + 2153 +POST /api/v3/DriversRfidsAssignments 2154 + 2155 +Запрос: 2156 + 2157 +[ 2158 + { 2159 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2160 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2161 + "BeginTime": "2023-06-30T11:27:08.635Z", 2162 + "EndTime": "2023-06-30T11:27:08.635Z" 2163 + } 2164 +] 2165 + 2166 +Ответ: 2167 + 2168 +[ 2169 + { 2170 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2171 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2172 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2173 + "BeginTime": "2023-06-30T11:27:08.677Z", 2174 + "EndTime": "2023-06-30T11:27:08.677Z" 2175 + } 2176 +] 2177 + 2178 + 2179 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2180 + 2181 +PUT /api/v3/DriversRfidsAssignments 2182 + 2183 +Запрос: 2184 + 2185 +[ 2186 + { 2187 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2188 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2189 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2190 + "BeginTime": "2023-06-30T11:28:43.330Z", 2191 + "EndTime": "2023-06-30T11:28:43.330Z" 2192 + } 2193 +] 2194 + 2195 +Ответ: 2196 + 2197 +[ 2198 + { 2199 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2200 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2201 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2202 + "BeginTime": "2023-06-30T11:28:43.331Z", 2203 + "EndTime": "2023-06-30T11:28:43.331Z" 2204 + } 2205 +] 2206 + 2207 + 2208 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2209 + 2210 +DELETE /api/v3/DriversRfidsAssignments 2211 + 2212 +Запрос: 2213 + 2214 +[ 2215 + { 2216 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2217 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2218 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2219 + "BeginTime": "2023-06-30T11:28:43.330Z", 2220 + "EndTime": "2023-06-30T11:28:43.330Z" 2221 + } 2222 +] 2223 + 2224 +Ответ: 2225 + 2226 +[ 2227 + { 2228 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2229 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2230 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2231 + "BeginTime": "2023-06-30T11:28:43.331Z", 2232 + "EndTime": "2023-06-30T11:28:43.331Z" 2233 + } 2234 +] 2235 + 2236 + 2237 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 2238 + 2239 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2240 + 2241 +POST /api/v3/DriversFuelCardsAssignments/GetByDrivers 2242 + 2243 +Запрос: 2244 + 2245 +{ 2246 + "Ids": [ 2247 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2248 + ], 2249 + "BeginTime": "2023-06-30T12:45:10.852Z", 2250 + "EndTime": "2023-06-30T12:45:10.852Z" 2251 +} 2252 + 2253 +Ответ: 2254 + 2255 +[ 2256 + { 2257 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2258 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2259 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2260 + "BeginTime": "2023-06-30T11:58:04.695Z", 2261 + "EndTime": "2023-06-30T11:58:04.695Z" 2262 + } 2263 +] 2264 + 2265 + 2266 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2267 + 2268 +POST /api/v3/DriversFuelCardsAssignments/GetByCards 2269 + 2270 +Запрос: 2271 + 2272 +{ 2273 + "Ids": [ 2274 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2275 + ], 2276 + "BeginTime": "2023-06-30T12:45:10.852Z", 2277 + "EndTime": "2023-06-30T12:45:10.852Z" 2278 +} 2279 + 2280 +Ответ: 2281 + 2282 +[ 2283 + { 2284 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2285 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2286 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2287 + "BeginTime": "2023-06-30T11:58:04.695Z", 2288 + "EndTime": "2023-06-30T11:58:04.695Z" 2289 + } 2290 +] 2291 + 2292 + 2293 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2294 + 2295 +POST /api/v3/DriversFuelCardsAssignments 2296 + 2297 +Запрос: 2298 + 2299 +[ 2300 + { 2301 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2302 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2303 + "BeginTime": "2023-06-30T12:09:53.175Z", 2304 + "EndTime": "2023-06-30T12:09:53.175Z" 2305 + } 2306 +] 2307 + 2308 +Ответ: 2309 + 2310 +[ 2311 + { 2312 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2313 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2314 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2315 + "BeginTime": "2023-06-30T12:09:53.201Z", 2316 + "EndTime": "2023-06-30T12:09:53.201Z" 2317 + } 2318 +] 2319 + 2320 + 2321 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2322 + 2323 +PUT /api/v3/DriversFuelCardsAssignments 2324 + 2325 +Запрос: 2326 + 2327 +[ 2328 + { 2329 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2330 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2331 + "BeginTime": "2023-06-30T12:09:53.175Z", 2332 + "EndTime": "2023-06-30T12:09:53.175Z" 2333 + } 2334 +] 2335 + 2336 +Ответ: 2337 + 2338 +[ 2339 + { 2340 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2341 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2342 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2343 + "BeginTime": "2023-06-30T12:09:53.201Z", 2344 + "EndTime": "2023-06-30T12:09:53.201Z" 2345 + } 2346 +] 2347 + 2348 + 2349 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2350 + 2351 +DELETE /api/v3/DriversFuelCardsAssignments 2352 + 2353 +Запрос: 2354 + 2355 +[ 2356 + { 2357 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2358 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2359 + "BeginTime": "2023-06-30T12:09:53.175Z", 2360 + "EndTime": "2023-06-30T12:09:53.175Z" 2361 + } 2362 +] 2363 + 2364 +Ответ: 2365 + 2366 +[ 2367 + { 2368 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2369 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2370 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2371 + "BeginTime": "2023-06-30T12:09:53.201Z", 2372 + "EndTime": "2023-06-30T12:09:53.201Z" 2373 + } 2374 +] 2375 + 2376 + 2377 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2378 + 2379 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2380 + 2381 +POST /api/v3/Rfids/find 2382 + 2383 +Запрос: 2384 + 2385 +{ 2386 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2387 +} 2388 + 2389 +Ответ: 2390 + 2391 +[ 2392 + { 2393 + "name": "string", 2394 + "number": 0, 2395 + "period": 0, ~/~/ Частота трансляции радиометки 2396 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2397 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2398 + "deleted": true 2399 + } 2400 +] 2401 + 2402 + 2403 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2404 + 2405 +GET /api/v3/Rfids/{rfidGuid} 2406 + 2407 +Передаем параметр rfidGuid - идентификатор карты-метки 2408 + 2409 +Ответ: 2410 + 2411 +[ 2412 + { 2413 + "name": "string", 2414 + "number": 0, 2415 + "period": 0, ~/~/ Частота трансляции радиометки 2416 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2417 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2418 + "deleted": true 2419 + } 2420 +] 2421 + 2422 + 2423 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2424 + 2425 +POST /api/v3/Rfids 2426 + 2427 +Запрос: 2428 + 2429 +{ 2430 + "name": "string", 2431 + "number": 0, 2432 + "period": 0, 2433 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2434 + "deleted": true 2435 +} 2436 + 2437 +Ответ: 2438 + 2439 +{ 2440 + "name": "string", 2441 + "number": 0, 2442 + "period": 0, 2443 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2444 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2445 + "deleted": true 2446 +} 2447 + 2448 + 2449 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2450 + 2451 +PUT /api/v3/Rfids 2452 + 2453 +Запрос: 2454 + 2455 +{ 2456 + "name": "string", 2457 + "number": 0, 2458 + "period": 0, 2459 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2460 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2461 + "deleted": true 2462 +} 2463 + 2464 +Ответ: 2465 + 2466 +{ 2467 + "name": "string", 2468 + "number": 0, 2469 + "period": 0, 2470 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2471 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2472 + "deleted": true 2473 +} 2474 + 2475 + 2476 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2477 + 2478 +**DELETE /api/v3/Rfids/{rfidGuid}** 2479 + 2480 +Передаем параметр rfidGuid - идентификатор карты-метки 2481 + 2482 +Ответ: 2483 + 2484 +Success 2485 + 2486 + 951 951 (% class="box" lang="en-US" style="text-align: center;" %) 952 952 ((( 953 953 (% 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]] **