Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/28 11:43
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.krainovim - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,50 +1,68 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 3 - 4 -== == 5 - 6 -(% class="box" style="text-align: center;" %) 7 7 ((( 8 - (% style="color:#000000; font-size:18.6667px" %)**Действующиеограничения**3 +**Содержание страницы:** 9 9 ))) 10 10 11 - (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).6 +{{toc/}} 12 12 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 14 14 9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 + 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 + 13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 + 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 - 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 22 22 19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 + 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 + 23 23 (% class="box infomessage" %) 24 24 ((( 25 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) 28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %)Метод запроса: ** GET**30 +(% style="color:#000000" %)Метод запроса: **POST** 31 31 32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login ?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 37 + 38 +(% style="color:#000000" %){ 39 + "login": "testuser", 40 + "password": "testuser" 41 +} 42 + 43 + 44 +(% style="color:#000000" %)**Ответ:** 45 + 36 36 (% lang="en-US" %) 37 -(% style="color:#000000" %) **Ответ: [{«AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**47 +(% style="color:#000000" %){ 38 38 49 +(% lang="en-US" %) 50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 + "User": "testuser" , ~/~/ имя пользователя 52 + 53 +(% lang="en-US" %) 54 +} 55 + 39 39 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 40 40 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 41 41 42 42 (% class="box infomessage" %) 43 43 ((( 44 -(% 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** 45 45 ))) 46 46 47 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 48 48 49 49 (% style="color:#000000" %)Метод запроса: **GET** 50 50 ... ... @@ -55,57 +55,243 @@ 55 55 (% lang="en-US" %) 56 56 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 57 57 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 58 58 59 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 60 60 ((( 61 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 62 62 ))) 63 63 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 + 64 64 (% class="box infomessage" %) 65 65 ((( 66 -(% 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(%%)** 67 67 ))) 68 68 69 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 70 70 71 71 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 72 72 73 73 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 74 74 75 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 76 76 77 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% style="color:#000000" %)Метод запроса: **POST** 78 78 79 -(% 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 80 80 81 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 82 82 83 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 84 84 85 -(% style="color:#000000" %)Ответ: [ { 86 - "agentId": "", ~/~/ идентификатор клиента 87 - "parentId": "", ~/~/ идентификатор клиента-родителя 88 - "name": "", ~/~/ наименование клиента 89 - "fullName": "", ~/~/ полное наименование клиента 90 - "agentInfoType": "", ~/~/ тип клиента1 91 - "status": "", ~/~/ статус клиента 92 - }, … ] 145 +(% style="color:#000000" %)Ответ: 93 93 147 +{ 148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 155 +} 94 94 95 - (% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US"%)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовыйклиент, 5 - договор(%style="color:#000000"%)]157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 96 96 159 +(% class="box successmessage" %) 160 +((( 161 +**POST /api/v3/agents ** 162 +))) 97 97 98 -(% class="box" style="text-align: center;" %) 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" %) 99 99 ((( 100 - (%style="color:#000000; font-size:14pt" %)**Раздел Пользователи**224 +**PUT /api/v3/agents** 101 101 ))) 102 102 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 + 103 103 (% class="box successmessage" %) 104 104 ((( 105 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 106 106 ))) 107 107 108 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 109 109 110 110 (% style="color:#000000" %)Метод запроса: **POST** 111 111 ... ... @@ -113,50 +113,189 @@ 113 113 114 114 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 115 115 116 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }320 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 117 117 322 +(% style="color:#000000" %) 323 +{ 324 + "lastName": "", ~/~/ фамилия 325 + "firstName": "", ~/~/ имя 326 + "position": "", ~/~/ должность 327 + "phone": "", ~/~/ телефон 328 + "organization": "", ~/~/ организация 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 - отключен 336 + "parentId": "", ~/~/ Guid родительского агента 337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 339 + "doubleAuth": 340 + { 341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 343 + }, 344 + "groups": 345 + [ 346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 347 + ], 348 + "customGroups": 349 + [ 350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 + ], 352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 +} 354 + 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 + 118 118 (% style="text-align:left" %) 119 -(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }368 +(% style="color:#000000; font-weight:normal" %)Ответ: 120 120 370 +(% style="text-align:left" %) 371 +(% style="color:#000000; font-weight:normal" %){ 121 121 122 -(% class="box successmessage" %) 373 +(% style="text-align:left" %) 374 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 375 + "lastName": "" , ~/~/ Фамилия , 376 + "firstName": "" , ~/~/ Имя 377 + "position": "" , ~/~/ Должность 378 + "phone": "" , ~/~/ Телефон 379 + "organization": "" , ~/~/ Организация 380 + "login": "" , ~/~/ Логин 381 + "password": "" , ~/~/ Пароль 382 + "email": "" , ~/~/ Email 383 + "description": "" , ~/~/ Описание 384 + "isEnabled": "" , ~/~/ Признак включения 385 + "parentId": "" , ~/~/ Guid родительского агента 386 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 387 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 388 + "kind": "" , ~/~/ тип аутентификации 389 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 391 + 392 +(% style="text-align:left" %) 393 +(% style="color:#000000; font-weight:normal" %)} 394 + 395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 + 397 +(% class="box infomessage" %) 123 123 ((( 124 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**399 +(% lang="en-US" %)**POST /api/v3/users/find** 125 125 ))) 126 126 127 -(% style="color:#000000" %) 402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 128 128 129 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 404 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 130 130 131 131 (% style="color:#000000" %)Метод запроса: **POST** 132 132 133 133 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 134 134 135 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {410 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 136 136 137 -(% class="western" %) 138 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 139 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 140 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 141 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 412 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 142 142 414 +(% style="color:#000000" %){ 415 + 416 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 + 143 143 (% style="color:#000000" %)} 144 144 145 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail423 +(% style="color:#000000" %)Ответ: 146 146 147 -(% class="western" style="margin-bottom:19px" %) 148 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 425 +(% style="color:#000000" %){ (%%) 149 149 150 -(% lang="en-US" style="text-align:left" %) 151 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 427 + "id": "" , ~/~/ идентификатор пользователя 428 + "lastName": "" , ~/~/ фамилия 429 + "firstName": "" , ~/~/ имя 430 + "position": "" , ~/~/ должность 431 + "phone": "" , ~/~/ телефон 432 + "parentId": "" , ~/~/ идентификатор клиента-родителя 433 + "parentName": "" , ~/~/ наименование клиента-родителя 434 + "organization": "" , ~/~/ организация 435 + "login": "" , ~/~/ логин 436 + "email": "" , ~/~/ E-mail 437 + "sessionDuration":"", ~/~/ длительность сессии в минутах 438 + "status": "1", ~/~/ статус пользователя 439 + "lastLogged": "", ~/~/ дата/время последней авторизации 152 152 441 +(% style="color:#000000" %)} 153 153 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 444 + 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 + 154 154 (% class="box warningmessage" %) 155 155 ((( 156 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**499 +(% lang="en-US" %)**PUT /api/v3/users** 157 157 ))) 158 158 159 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 160 160 161 161 (% style="color:#000000" %)Метод запроса: **PUT** 162 162 ... ... @@ -165,98 +165,386 @@ 165 165 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 166 166 167 167 (% lang="en-US" style="text-align:left" %) 168 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } //511 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 169 169 513 +(% lang="en-US" style="text-align:left" %) 514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 170 170 516 +(% lang="en-US" style="text-align:left" %) 517 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 518 + "lastName": "" , ~/~/ фамилия 519 + "firstName": "" , ~/~/ имя 520 + "position": "" , ~/~/ должность 521 + "phone": "" , ~/~/ телефон 522 + "organization": "" , ~/~/ организация 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": "" , ~/~/ описание 529 + "isEnabled": "" , ~/~/ признак включения 530 + "parentId": "" , ~/~/ Guid родительского агента 531 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 532 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 + 541 +(% lang="en-US" style="text-align:left" %) 542 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 + 544 +(% lang="en-US" style="text-align:left" %) 545 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 + 547 +(% lang="en-US" style="text-align:left" %) 548 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 + 550 +(% lang="en-US" style="text-align:left" %) 551 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 552 + "lastName": "" , ~/~/ фамилия 553 + "firstName": "" , ~/~/ имя 554 + "position": "" , ~/~/ должность 555 + "phone": "" , ~/~/ телефон 556 + "organization": "" , ~/~/ организация 557 + "login": "" , ~/~/ логин 558 + "password": "" , ~/~/ пароль 559 + "email": "" , ~/~/ email 560 + "description": "" , ~/~/ описание 561 + "isEnabled": "" , ~/~/ признак включения 562 + "parentId": "" , ~/~/ Guid родительского агента 563 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 572 + 573 +(% lang="en-US" style="text-align:left" %) 574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 + 576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 + 171 171 (% class="box warningmessage" %) 172 172 ((( 173 -(% 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}** 174 174 ))) 175 175 176 -(% style="color:#000000" %) . Метод позволяет изменить статус пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 177 177 178 178 (% style="color:#000000" %)Метод запроса: **PUT** 179 179 180 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:587 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 181 181 182 -(% style="color:#000000" %) {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизацииПараметрыв телезапроса(JSON): {«status»~:// «»,//статуспользователя(0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)589 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 183 183 184 -(% class="western" %) 185 -{{{ "description": "", // описание 186 - "data": "" // данные, связанные со сменой статуса}}} 591 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 187 187 593 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 594 + 595 +(% style="color:#000000" %){ 596 + 597 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 + "description": "" , ~/~/ описание 599 + "data": "" , ~/~/ данные, связанные со сменой статуса 600 + 188 188 (% style="color:#000000" %)} 189 189 190 190 (% style="text-align:left" %) 191 191 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 192 192 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 193 193 608 +(% class="box warningmessage" %) 609 +((( 610 +**POST /api/v3/users/disable** 611 +))) 612 + 613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 614 + 615 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 616 + 617 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 618 + 619 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 + 621 + [ 622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 + ] 625 + 626 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 627 + 628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 629 + 630 +(% class="box warningmessage" %) 631 +((( 632 +**POST /api/v3/users/enable** 633 +))) 634 + 635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 636 + 637 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 638 + 639 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 640 + 641 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 642 + 643 + [ 644 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 645 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 646 + ] 647 + 648 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 649 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 650 + 651 +((( 652 +В теле ответа: 653 +{ 654 + "errorMessages": [ 655 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 656 + ], 657 + "users": [ 658 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 659 + ] 660 +} 661 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 662 +"users" - массив id пользователей, которых не удалось включить или отключить. 663 +))) 664 + 665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 + 194 194 (% class="box errormessage" %) 195 195 ((( 196 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 197 197 ))) 198 198 199 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 200 200 201 201 (% style="color:#000000" %)Метод запроса: **DELETE** 202 202 203 203 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 204 204 205 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации678 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 206 206 680 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 681 + 207 207 (% style="text-align:left" %) 208 208 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 209 209 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 210 210 211 -(% class="box" style="text-align: center;" %) 212 -((( 213 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 214 -))) 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 215 215 216 216 (% class="box infomessage" %) 217 217 ((( 218 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 219 219 ))) 220 220 221 -(% style="color:#000000" %) 694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 222 222 223 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 224 224 225 225 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 226 226 227 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 700 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 228 228 229 229 (% style="color:#000000" %)Метод запроса: **GET** 230 230 231 -(% 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} 232 232 233 -(% style="color:#000000" %)Параметр запроса: <vehicleid>- идентификатор объекта (опционально)706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 234 234 235 235 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 236 236 237 237 (% style="color:#000000" %)Ответ: 238 238 239 -(% style="color:#000000" %){ 712 +((( 713 +{ 714 + "vehicleId": "", ~/~/ ID объекта 715 + "name": "", ~/~/ Имя объекта 716 + "imei": "", ~/~/ IMEI объекта 717 + "deviceTypeId": , ~/~/ ID типа устройства 718 + "deviceTypeName": "", ~/~/ Название типа устройства 719 + "sim1": "", ~/~/ Номер SIM1 720 + "sim2": "", ~/~/ Номер SIM2 240 240 241 -(% class="western" %) 242 -{{{ "vehicleId": “”, // идентификатор объекта 243 - "name": "", // имя объекта 244 - "imei": "", // IMEI объекта 245 - "deviceTypeId": “”, // идентификатор устройства объекта 246 - "deviceTypeName": "" // наименование устройства объекта 247 - "parentId": "", // идентификатор клиента-родителя 248 - "parentName": "" // наименование клиента-родителя, 249 - "modelId": "", // идентификатор модели объекта 250 - "modelName": "" // наименование модели объекта, 251 - "unitId": "", // идентификатор подразделения 252 - "unitName": "", // наименование подразделения 253 - "status": “”, // статус объекта 254 - ... 722 + "parentId": "", ~/~/ ID клиента-родителя 723 + "parentName": "", ~/~/ Наименование клиента-родителя 724 + "modelId": "", ~/~/ ID модели объекта 725 + "modelName": "", ~/~/ Имя модели объекта 726 + 727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 + "unitName": "string", ~/~/ Наименование подразделения 729 + "status": 0, ~/~/ Статус объекта 730 + 731 + "createdAt": "", ~/~/ Дата создания объекта 732 + }, 733 + 734 +"customFields": [ ~/~/ Произвольные поля 735 + { 736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 737 + "name": "string", ~/~/ Имя поля 738 + "value": "string", ~/~/ Значение поля 739 + "forClient": true, ~/~/ Не используемая функция 740 + "forTooltip": true, ~/~/ Отображать в подсказке 741 + "forReport": true ~/~/ Отображать в отчете 742 + } 743 + 744 +], ~/~/ Данные с вкладки нормы 745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 + 758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 + "mileageCoeff": 0, ~/~/ коэффициент пробега 760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 762 + "counters": { ~/~/ Счетчики 763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 765 + "mileage": 0, ~/~/ Текущий пробег 766 + "motohours": 0, ~/~/ Текущие моточасы 767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 255 255 }, 256 - ...}}} 257 257 258 -(% style="color:#000000" %)} 771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 772 + "id": "string", ~/~/ ID объекта 773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 774 + "host": "string", ~/~/ CMSV6 Web Host 775 + "login": "string", ~/~/ CMSV6 Account 776 + "password": "string" ~/~/ CMSV6 Password 777 + }, 259 259 779 +"commandTemplates": [ ~/~/ Шаблоны команд 780 + { 781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 782 + "name": "string", ~/~/ Наименование команды 783 + "command": "string", ~/~/ Текст команды 784 + "retries": 0 ~/~/ Количество попыток 785 + } 786 + ], 787 + 788 + "sensors": [ ~/~/ Датчики 789 + { 790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 791 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 792 + "type": 0, ~/~/ Тип датчика 793 + "name": "string", ~/~/ Имя датчика 794 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 795 + "inputNumber": 0, ~/~/ Номер входа 796 + "pseudonym": "string", ~/~/ Псевдоним 797 + "medianDegree": 0, ~/~/ Медианная фильтрация 798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 800 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 801 + "gradesTables": [ ~/~/ Массив таблиц тарировки 802 + { 803 + "grades": [ ~/~/ Таблица тарировки 1 804 + { 805 + "input": 0, ~/~/ Входящее значение 806 + "output": 0 ~/~/ Выходящее значение 807 + } 808 + ], 809 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 810 + } 811 + ], 812 + "showInTooltip": true, ~/~/ Отображать в подсказке 813 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 814 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 815 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 816 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 817 + "expr": "string", ~/~/ Формула 818 + "children": [ ~/~/ массив дочерних датчиков 819 + "string" 820 + ], 821 + "customParams": { ~/~/ прочие произвольные параметры 822 + "additionalProp1": "string", 823 + "additionalProp2": "string", 824 + "additionalProp3": "string" 825 + }, 826 + 827 +~/~/ Характерные для произвольного: 828 + 829 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 830 + 831 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 832 + 833 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 834 + 835 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 836 + 837 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 838 + 839 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 840 + 841 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 842 + 843 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 844 + 845 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 846 + 847 +~/~/ "ValueOn": "Вкл.", 848 + 849 +~/~/ "ValueOff": "Выкл." 850 + "summaryMaxValue": 0 ~/~/ Макс. значение 851 + } 852 + 853 + "drivers": [ ~/~/ Водители 854 + { 855 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 856 + "name": "string", ~/~/ Наименование 857 + "description": "string", 858 + "isDefault": true ~/~/ По умолчанию 859 + } 860 + ], 861 + 862 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 863 + { 864 + "id": "", ~/~/ ID задания 865 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 866 + "name": "", ~/~/ Наименование задания 867 + "description": "", ~/~/ Описание задания 868 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 869 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 870 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 871 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 872 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 873 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 874 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 875 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 876 + } 877 + ], 878 + 879 + "statusHistory": [ ~/~/ История статусов 880 + { 881 + "status": 0, 882 + "date": "2023-05-22T09:57:39.562Z", 883 + "description": "string", 884 + "additionalInfo": "string" 885 + } 886 + ] 887 + 888 +} 889 +))) 890 + 260 260 (% style="text-align:left" %) 261 261 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 262 262 ... ... @@ -263,13 +263,14 @@ 263 263 (% style="text-align:left" %) 264 264 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 265 265 897 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 266 266 267 267 (% class="box successmessage" %) 268 268 ((( 269 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**901 +(% lang="en-US" %)**POST /api/v3/vehicles** 270 270 ))) 271 271 272 -(% style="color:#000000" %) . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).904 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 273 273 274 274 (% style="color:#000000" %)Метод запроса: **POST** 275 275 ... ... @@ -277,118 +277,226 @@ 277 277 278 278 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 279 279 280 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {912 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 281 281 282 -(% class="western" %) 283 -{{{ "parentId": "", // ID клиента 284 - "name": "", // имя ТС 285 - "imei": "", // IMEI 286 - "deviceTypeId": "",// ID типа устройства 287 - "modelId": "", 288 - "unitId": "", // ID подразделения 289 - "sim1": "", // Номер SIM 1 290 - "sim2": "", // Номер SIM2 291 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 292 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 293 - "consumptionIdle": "",// Расход топлива на холостом ходу 294 - "counters": { 295 - "mileage": "", // пробег 296 - "mileageEnabled": true, // флаг активности счётчика "пробег" 297 - "motohours":"", // моточасы 298 - "motohoursEnabled": true // флаг активности счётчика "моточасы" 299 - }, 300 - "cmsv6Parameters": { // параметры CMSv6 301 - "enabled": true, // флаг включения 302 - //"id": "", // идентификатор 303 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 304 - "login": "", // имя учетной записи 305 - "password": "" // пароль учетной записи 914 +(% style="color:#000000" %){ 915 + 916 + "parentId": "" , ~/~/ ID клиента 917 + "name": "" , ~/~/ имя ТС 918 + "imei": "" , ~/~/ IMEI 919 + "deviceTypeId": "" , ~/~/ ID типа устройства 920 + "modelId": "" , ~/~/ ID модели 921 + "unitId": "" , ~/~/ ID подразделения 922 + "sim1": "" , ~/~/ Номер SIM 1 923 + "sim2": "" , ~/~/ Номер SIM2 924 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 925 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 926 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 927 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 928 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 929 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 930 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 931 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 932 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 933 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 934 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 935 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 936 + 937 + "mileageCalcMethod": 0, 938 + "mileageCoeff": 0, 939 + "locationByCellId": true, 940 + "dottedLineTrackWhenNoCoords": true, 941 + "counters": ~/~/ счетчики 942 + { 943 + "mileage": "" , ~/~/ пробег 944 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 945 + "motohours": "" , ~/~/ моточасы 946 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 306 306 }, 307 - "inspectionTasks": [ // задания на ТО 948 + "cmsv6Parameters": { ~/~/ параметры CMSv6 949 + "enabled": true, ~/~/ флаг включения 950 + "id": "" , ~/~/ идентификатор 951 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 952 + "login": "" , ~/~/ имя учетной записи 953 + "password": "" ~/~/ пароль учетной записи 954 + }, 955 + "inspectionTasks": ~/~/ задания на ТО 308 308 { 309 - "enabled": "", // Признак включения 310 - "name": "", // Имя задания 311 - "description": "", // Описание задания 312 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 313 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 314 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 315 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 316 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 317 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 318 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 319 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 957 + "enabled": "" , ~/~/ Признак включения 958 + "name": "" , ~/~/ Имя задания 959 + "description": "" , ~/~/ Описание задания 960 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 961 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 962 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 963 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 964 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 965 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 966 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 967 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 968 + } 969 + 970 +"drivers": [ ~/~/ Водители 971 + { 972 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 973 + "isDefault": true 974 + } 975 + ], 976 + "commandTemplates": [ ~/~/ Шаблон команды 977 + { 978 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 979 + "name": "string", 980 + "command": "string", 981 + "retries": 0 982 + } 983 + ], 984 + 985 + "sensors": [ ~/~/ Датчики 986 + { 987 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 988 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 989 + "type": 0, ~/~/ Тип датчика 990 + "name": "string", ~/~/ Имя датчика 991 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 992 + "inputNumber": 0, ~/~/ Номер входа 993 + "pseudonym": "string", ~/~/ Псевдоним 994 + "medianDegree": 0, ~/~/ Медианная фильтрация 995 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 996 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 997 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 998 + "gradesTables": [ ~/~/ Массив таблиц тарировки 999 + { 1000 + "grades": [ ~/~/ Таблица тарировки 1 1001 + { 1002 + "input": 0, ~/~/ Входящее значение 1003 + "output": 0 ~/~/ Выходящее значение 1004 + } 1005 + ], 1006 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1007 + } 1008 + ], 1009 + "showInTooltip": true, ~/~/ Отображать в подсказке 1010 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1011 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1012 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1013 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1014 + "expr": "string", ~/~/ Формула 1015 + "children": [ ~/~/ массив дочерних датчиков 1016 + "string" 1017 + ], 1018 + "customParams": { ~/~/ прочие произвольные параметры 1019 + "additionalProp1": "string", 1020 + "additionalProp2": "string", 1021 + "additionalProp3": "string" 320 320 }, 321 - ]}}} 322 322 323 - (%style="color:#000000"%)…}1024 +~/~/ Характерные для произвольного: 324 324 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 + 325 325 (% style="color:#000000" %)Ответ: 326 326 327 327 (% style="color:#000000" %){ 328 328 329 -(% class="western" %) 330 -{{{ "vehicleId": "", //ID ТС 331 - "parentId": "", //Guid владельца ТС 332 - "name": "", //Имя объекта 333 - "imei": "", //IMEI 334 - "deviceTypeId": "", //ID типа устройства 335 - "modelId": "", //ID модели 336 - "unitId": "", //ID подразделения 337 - "sim1": "", //SIM1 338 - "sim2": "", //SIM2 339 - "consumptionPer100Km": "", //Расход топлива на 100 км 340 - "consumptionIdle": "", //Расход топлива на холостом ходу 341 - "counters": { //Счётчики 342 - "mileageEnabled": true, 343 - "motohoursEnabled": true, 344 - "mileage": "", 345 - "motohours": 345.0 346 - }, 347 - "cmsv6Parameters": { //Параметры CmsV6 348 - "id": null, 349 - "enabled": true, //флаг включения 350 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 351 - "login": "", // имя учетной записи 352 - "password": "" // пароль учетной записи 353 - }, 354 - "inspectionTasks": [ // задания на ТО 355 - { 356 - "id": "", // ID задачи 357 - "enabled": false, // Признак включения 358 - "name": "", // Имя задания 359 - "description": "", // Описание задания 360 - "mileageCondition": "", // Условие по пробегу 361 - "lastMileage": "", // Пробег (в метрах) 362 - "motohoursCondition": "", // Условие по моточасам 363 - "lastMotohours": "", // Моточасы 364 - "periodicCondition": "", // Условие периодичности по времени 365 - "kind": "", // Вид периодичности по времени 366 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 367 - } 368 - ]}}} 1066 + "vehicleId": "", ~/~/ID ТС 1067 + "parentId": "", ~/~/Guid владельца ТС 1068 + "name": "", ~/~/Имя объекта 1069 + "imei": "", ~/~/IMEI 1070 + "deviceTypeId": "", ~/~/ID типа устройства 1071 + "modelId": "", ~/~/ID модели 1072 + "unitId": "", ~/~/ID подразделения 1073 + "sim1": "", ~/~/SIM1 1074 + "sim2": "", ~/~/SIM2 1075 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1076 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1077 + "counters": { ~/~/Счётчики 1078 + "mileageEnabled": true, 1079 + "motohoursEnabled": true, 1080 + "mileage": "", 1081 + "motohours": 345.0 1082 + }, 1083 + "cmsv6Parameters": { ~/~/Параметры CmsV6 1084 + "id": null, 1085 + "enabled": true, ~/~/флаг включения 1086 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1087 + "login": "", ~/~/ имя учетной записи 1088 + "password": "" ~/~/ пароль учетной записи 1089 + }, 1090 + "inspectionTasks": { ~/~/ задания на ТО 1091 + "id": "", ~/~/ ID задачи 1092 + "enabled": false, ~/~/ Признак включения 1093 + "name": "", ~/~/ Имя задания 1094 + "description": "", ~/~/ Описание задания 1095 + "mileageCondition": "", ~/~/ Условие по пробегу 1096 + "lastMileage": "", ~/~/ Пробег (в метрах) 1097 + "motohoursCondition": "", ~/~/ Условие по моточасам 1098 + "lastMotohours": "", ~/~/ Моточасы 1099 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1100 + "kind": "", ~/~/ Вид периодичности по времени 1101 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1102 + } 369 369 370 370 (% style="text-align:left" %) 371 371 (% style="color:#000000" %)} 372 372 1107 +**Валидация:** 1108 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1109 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1110 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 373 373 374 -(% class="box successmessage" %) 1112 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1113 + 1114 +(% class="box infomessage" %) 375 375 ((( 376 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**1116 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 377 377 ))) 378 378 379 -(% style="color:#000000" %) 1119 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 380 380 381 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):1121 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 382 382 383 383 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 384 384 385 385 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 386 386 387 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 1127 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 388 388 389 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 1129 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 390 390 391 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 1131 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 392 392 393 393 (% style="color:#000000" %)Метод запроса: **POST** 394 394 ... ... @@ -396,78 +396,115 @@ 396 396 397 397 (% style="color:#000000" %)В заголовках запроса: 398 398 399 -(% style="color:#000000" %)− Content-Type: application/json 1139 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 400 400 401 401 (% style="color:#000000" %)− X-Auth: Токен авторизации 402 402 403 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):1143 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 404 404 405 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ ИмяТС(string,опционально)"imei":null,~/~/"710179307",##1145 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 406 406 407 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 1147 +{ 1148 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1149 + "name": null, ~/~/ Имя ТС (string, опционально) 1150 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1151 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1152 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1153 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 1154 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1155 + "customFields": null ~/~/ значение любого из произвольных полей ТС 1156 +} 408 408 409 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства(short,опционально)"parentId":null,~/~/IDклиента(Guid,опционально)"unitId":null##1158 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 410 410 411 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}1160 +(% style="color:#000000" %)Ответ: 412 412 413 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».1162 +(% style="color:#000000" %){ 414 414 415 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 1164 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1165 + "name": "" ~/~/ наименование объекта 1166 + "imei": "" ~/~/ IMEI объекта 1167 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 1168 + "deviceTypeName": "" ~/~/ наименование типа устройства 1169 + "sim1": "" ~/~/ первый номер телефона 1170 + "sim2": "" ~/~/ второй номер телефона 1171 + "parentId": "" ~/~/ идентификатор клиента-родителя 1172 + "parentName": "" ~/~/ наименование клиента-родителя 1173 + "modelId": "" ~/~/ идентификатор модели объекта 1174 + "modelName": "" ~/~/ наименование модели объекта 1175 + "unitId": "" ~/~/ идентификатор подразделения 1176 + "unitName": "" ~/~/ наименование подразделения 1177 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1178 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1179 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1180 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1181 + "customFields": [ 1182 + { 1183 + "id": "", ~/~/ идентификатор произвольного поля 1184 + "name": "", ~/~/ имя произвольного поля 1185 + "value": "", ~/~/ значение произвольного поля 1186 + "forClient": true, ~/~/ право на отображение у клиента 1187 + "forTooltip": false, ~/~/ право на отображение в подсказке 1188 + "forReport": false ~/~/ право на отображение в отчетах 1189 + }(%%) 1190 +(% style="color:#000000" %)} 416 416 417 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:1192 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 418 418 419 - 0-«Блокировка»1- «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис»,6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан»,11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».1194 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 420 420 421 - 422 422 (% class="box successmessage" %) 423 423 ((( 424 -(% 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}** 425 425 ))) 426 426 427 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1201 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 428 428 429 429 (% style="color:#000000" %)Метод запроса: **POST** 430 430 431 431 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId} 432 432 433 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 1207 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 434 434 435 435 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 436 436 437 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {1211 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 438 438 439 -(% class="western" %) 440 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 441 - // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 442 - // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 443 - "date": "", // Дата смены статуса (null если сменить немедленно) 444 - "description": "", // Описание 445 - "data": "", // Данные 446 - "overwrite": false, // Флаг перезаписи 447 - "stage": "", // Состояние, может быть null}}} 1213 +(% style="color:#000000" %){ 448 448 1215 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1216 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1217 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1218 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1219 + "description": "", ~/~/ Описание 1220 + "data": "", ~/~/ Данные 1221 + "overwrite": false, ~/~/ Флаг перезаписи 1222 + "stage": "", ~/~/ Состояние, может быть null 1223 + 449 449 (% style="color:#000000" %)} 450 450 451 -(% style="color:#000000" %)Ответ: {1226 +(% style="color:#000000" %)Ответ: 452 452 453 -(% class="western" %) 454 -{{{ "status": "", // значение статуса 455 - "date": "", // Дата смены статуса 456 - "description": "", // Описание 457 - "data": "", // Данные 458 - "overwrite": false, // Флаг перезаписи 459 - "stage": "", // Состояние}}} 1228 +(% style="color:#000000" %){ 460 460 1230 + "status": "", ~/~/ значение статуса 1231 + "date": "", ~/~/ Дата смены статуса 1232 + "description": "", ~/~/ Описание 1233 + "data": "", ~/~/ Данные 1234 + "overwrite": false, ~/~/ Флаг перезаписи 1235 + "stage": "", ~/~/ Состояние 1236 + 461 461 (% style="text-align:left" %) 462 -(% style="color:#000000" %)} 1238 +(% style="color:#000000" %) } 463 463 1240 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 464 464 465 465 (% class="box warningmessage" %) 466 466 ((( 467 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**1244 +(% lang="en-US" %)**PUT /api/v3/vehicles** 468 468 ))) 469 469 470 -(% style="color:#000000" %) . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1247 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 471 471 472 472 (% style="color:#000000" %)Метод запроса: **PUT** 473 473 ... ... @@ -477,26 +477,223 @@ 477 477 478 478 (% style="color:#000000" %)Параметры в теле запроса (JSON): 479 479 480 -(% style="color:#000000" %) //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON{«vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }1257 +(% style="color:#000000" %){ 481 481 1259 + "parentId": "" , ~/~/ ID клиента 1260 + "name": "" , ~/~/ имя ТС 1261 + "imei": "" , ~/~/ IMEI 1262 + "deviceTypeId": "" , ~/~/ ID типа устройства 1263 + "modelId": "" , ~/~/ ID модели 1264 + "unitId": "" , ~/~/ ID подразделения 1265 + "sim1": "" , ~/~/ Номер SIM 1 1266 + "sim2": "" , ~/~/ Номер SIM2 1267 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1268 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1269 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1270 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1271 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1272 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1273 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1274 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1275 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1276 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1277 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1278 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1279 + 1280 + "mileageCalcMethod": 0, 1281 + "mileageCoeff": 0, 1282 + "locationByCellId": true, 1283 + "dottedLineTrackWhenNoCoords": true, 1284 + "counters": ~/~/ счетчики 1285 + { 1286 + "mileage": "" , ~/~/ пробег 1287 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1288 + "motohours": "" , ~/~/ моточасы 1289 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1290 + }, 1291 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1292 + "enabled": true, ~/~/ флаг включения 1293 + "id": "" , ~/~/ идентификатор 1294 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1295 + "login": "" , ~/~/ имя учетной записи 1296 + "password": "" ~/~/ пароль учетной записи 1297 + }, 1298 + "inspectionTasks": ~/~/ задания на ТО 1299 + { 1300 + "enabled": "" , ~/~/ Признак включения 1301 + "name": "" , ~/~/ Имя задания 1302 + "description": "" , ~/~/ Описание задания 1303 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1304 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1305 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1306 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1307 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1308 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1309 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1310 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1311 + } 1312 + 1313 +"drivers": [ ~/~/ Водители 1314 + { 1315 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1316 + "isDefault": true 1317 + } 1318 + ], 1319 + "commandTemplates": [ ~/~/ Шаблон команды 1320 + { 1321 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1322 + "name": "string", 1323 + "command": "string", 1324 + "retries": 0 1325 + } 1326 + ], 1327 + 1328 + "sensors": [ ~/~/ Датчики 1329 + { 1330 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1331 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1332 + "type": 0, ~/~/ Тип датчика 1333 + "name": "string", ~/~/ Имя датчика 1334 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1335 + "inputNumber": 0, ~/~/ Номер входа 1336 + "pseudonym": "string", ~/~/ Псевдоним 1337 + "medianDegree": 0, ~/~/ Медианная фильтрация 1338 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1339 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1340 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1341 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1342 + { 1343 + "grades": [ ~/~/ Таблица тарировки 1 1344 + { 1345 + "input": 0, ~/~/ Входящее значение 1346 + "output": 0 ~/~/ Выходящее значение 1347 + } 1348 + ], 1349 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1350 + } 1351 + ], 1352 + "showInTooltip": true, ~/~/ Отображать в подсказке 1353 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1354 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1355 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1356 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1357 + "expr": "string", ~/~/ Формула 1358 + "children": [ ~/~/ массив дочерних датчиков 1359 + "string" 1360 + ], 1361 + "customParams": { ~/~/ прочие произвольные параметры 1362 + "additionalProp1": "string", 1363 + "additionalProp2": "string", 1364 + "additionalProp3": "string" 1365 + }, 1366 + 1367 +~/~/ Характерные для произвольного: 1368 + 1369 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1370 + 1371 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1372 + 1373 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1374 + 1375 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1376 + 1377 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1378 + 1379 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1380 + 1381 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1382 + 1383 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1384 + 1385 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1386 + 1387 +~/~/ "ValueOn": "Вкл.", 1388 + 1389 +~/~/ "ValueOff": "Выкл." 1390 + "summaryMaxValue": 0 ~/~/ Макс. значение 1391 + } 1392 + ], 1393 + "customFields": [ ~/~/ Произвольные поля 1394 + { 1395 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1396 + "name": "string", 1397 + "value": "string", 1398 + "forClient": true, 1399 + "forTooltip": true, 1400 + "forReport": true 1401 + } 1402 + ] 1403 +} 1404 + 482 482 (% style="color:#000000" %)Ответ: 483 483 484 484 (% lang="en-US" style="text-align:left" %) 485 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»:«», //ID ТС «parentId»:«», //ID клиента «name»:«», //имя ТС «imei»:«»,//IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }1408 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 486 486 1410 +(% lang="en-US" style="text-align:left" %) 1411 + "vehicleId": "", ~/~/ ID ТС 1412 + "parentId": "", ~/~/ ID клиента 1413 + "name": "", ~/~/ имя ТС 1414 + "imei": "", ~/~/ IMEI 1415 + "deviceTypeId": "", ~/~/ типа устройства 1416 + "modelId": "", ~/~/ ID модели 1417 + "unitId": "", ~/~/ ID подразделения 1418 + "sim1": "", ~/~/ SIM 1 1419 + "sim2": "", ~/~/ SIM2 1420 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1421 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1422 + "counters": 1423 + { 1424 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1425 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1426 + "mileage": "", ~/~/ пробег 1427 + "motohours": "", ~/~/ моточасы 1428 + } 1429 + "cmsv6Parameters": ~/~/ параметры CMSv6 1430 + { 1431 + "id": ~/~/ идентификатор 1432 + "enabled": true, ~/~/ флаг включения 1433 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1434 + "login": "", ~/~/ имя учетной записи 1435 + "password": "", ~/~/ пароль учетной записи 1436 + } 1437 + "inspectionTasks": ~/~/ задания на ТО 1438 + { 1439 + "id": "", ~/~/ ID задания 1440 + "enabled": false, ~/~/ Признак включения 1441 + "name": "", ~/~/ Имя задания 1442 + "description": "", ~/~/ Описание задания 1443 + "mileageCondition": "", ~/~/ Условие по пробегу 1444 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1445 + "motohoursCondition": "", ~/~/ Условие по моточасам 1446 + "lastMotohours": "", ~/~/ Моточасы 1447 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1448 + "kind": "", ~/~/ Вид периодичности по времени 1449 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1450 + } 487 487 1452 +(% lang="en-US" style="text-align:left" %) 1453 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1454 + 1455 +**Валидация:** 1456 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1457 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1458 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1459 + 1460 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1461 + 488 488 (% class="box errormessage" %) 489 489 ((( 490 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1464 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 491 491 ))) 492 492 493 -(% style="color:#000000" %) . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1467 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 494 494 495 495 (% style="color:#000000" %)Метод запроса: **DELETE** 496 496 497 497 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 498 498 499 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 1473 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 500 500 501 501 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 502 502 ... ... @@ -503,70 +503,1013 @@ 503 503 (% style="text-align:left" %) 504 504 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 505 505 1480 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 506 506 507 -(% class="box" lang="en-US" style="text-align: center;" %) 1482 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1483 + 1484 +(% class="box infomessage" %) 508 508 ((( 509 -(% style="color:#000000; font-size:14pt" %)**РазделУстройства**1486 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 510 510 ))) 511 511 1489 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1490 + 1491 +(% style="color:#000000" %)Метод запроса: **GET** 1492 + 1493 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1494 + 1495 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1496 + 1497 +(% style="color:#000000" %)Ответ: 1498 + 1499 +(% style="color:#000000" %){ 1500 + 1501 + "deviceTypeId" : "", ~/~/ ID типа устройства 1502 + "deviceTypeName" : "" ~/~/ Название типа устройства 1503 + 1504 +(% style="text-align:left" %) 1505 +(% style="color:#000000" %)} 1506 + 1507 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1508 + 1509 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1510 + 512 512 (% class="box infomessage" %) 513 513 ((( 514 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов устройств**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**1513 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 515 515 ))) 516 516 517 -(% style="color:#000000" %) устройств. Метод возвращает информацию о типахустройств с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1516 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 518 518 519 519 (% style="color:#000000" %)Метод запроса: **GET** 520 520 521 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]1520 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 522 522 523 523 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 524 524 525 -(% style="color:#000000" %)Ответ: [1524 +(% style="color:#000000" %)Ответ: 526 526 527 -(% class="western" %) 528 -{{{ { 529 - "deviceTypeId" : "", // ID типа устройства 530 - "deviceTypeName" : "" // Название типа устройства 531 - },}}} 1526 +(% style="color:#000000" %){ 532 532 1528 + "id": "", ~/~/ ID типа датчика 1529 + "name": "", ~/~/ Название 1530 + "description": "", ~/~/ Описание 1531 + 533 533 (% style="text-align:left" %) 534 -(% style="color:#000000" %) …** **]1533 +(% style="color:#000000" %)} 535 535 1535 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 536 536 537 -(% class="box" style="text-align: center;" %) 1537 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1538 + 1539 +(% class="box infomessage" style="text-align: left;" %) 538 538 ((( 539 - (%style="color:#000000; font-size:14pt" %)**Раздел Датчики**1541 +**POST /api/v3/terminalMessages/count** 540 540 ))) 541 541 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 + 542 542 (% class="box infomessage" %) 543 543 ((( 544 - (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GETsensors/types**1580 +**POST /api/v3/terminalMessages** 545 545 ))) 546 546 547 - (% style="color:#000000" %)Методпозволяетполучитьсписоктипов датчиков. Метод возвращает информациюотипах датчиков с учетомстроекавторизованногопользователя, указанноговзапросе(обязательный параметрв заголовках запроса - токен авторизации **«X-Auth»**).1583 +Метод возвращает список сообщений терминала объекта за выбранный период. 548 548 549 -(% style="color:#000000" %)Метод запроса: **GET** 1585 +(% style="text-align: left;" %) 1586 +Метод запроса **POST** 550 550 551 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1588 +(% style="text-align: left;" %) 1589 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 552 552 553 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1591 +(% style="text-align: left;" %) 1592 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 554 554 555 -(% style="color:#000000" %)Ответ: [ 1594 +{ 1595 + "vehicleId": 0, ~/~/ id объекта 1596 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1597 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 +} 556 556 557 -(% class="western" style="margin-bottom:19px" %) 558 -{{{ {}}} 1600 +Ответ: 559 559 560 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 1602 +[ 1603 + { 1604 + "messages": [ 1605 + { 1606 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1607 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1608 + "speed": 0, ~/~/ Скорость, км/ч 1609 + "altitude": 0, ~/~/ Высота, м 1610 + "latitude": 0, ~/~/ Широта [-90°;90°] 1611 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1612 + "satellites": 0, ~/~/ Кол-во спутников 1613 + "voltage": 0, ~/~/ Напряжение 1614 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1615 + "additionalProp1": "string", 1616 + "additionalProp2": "string", 1617 + "additionalProp3": "string" 1618 + }, 1619 + "photoCount": 0 ~/~/ Кол-во фото 1620 + } 1621 + ] 1622 + } 1623 +] 561 561 562 -(% class="western" %) 563 -{{{ "description": "" // Описание 564 - },}}} 1625 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 565 565 566 -(% style="text-align:left" %) 567 -(% style="color:#000000" %)… ] 1627 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 568 568 1629 +(% class="box infomessage" %) 1630 +((( 1631 +**POST /api/v3/notifications/find** 1632 +))) 569 569 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 + 570 570 (% class="box" lang="en-US" style="text-align: center;" %) 571 571 ((( 572 572 (% 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]] **