Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,37 +1,32 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 2 +((( 3 +**Содержание страницы:** 4 +))) 3 3 4 - == ==6 +{{toc/}} 5 5 6 -[[ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**>>Авторизация — POST /api/v3/auth/login||anchor="Авторизация — POST /api/v3/auth/login"]] 7 7 9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 8 8 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 9 9 13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 10 10 11 -(% class="box" style="text-align: center;" %) 12 -((( 13 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 14 -))) 15 +Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 15 15 16 -(% style="color:#000000" %)−(%%) Между запросами должнабытьпауза в1секунду(превышениеотвергаетсясистемой с уведомлениемо превышениичастотызапросов).17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 17 18 -(% style="color:#000000" %) −(%%) Для работы со всеми методами API необходимо в заголовокдобавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 19 19 20 -Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 21 - 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 22 23 -(% class="box "style="text-align: center;" %)23 +(% class="box infomessage" %) 24 24 ((( 25 -(% style="color:#000000; font-size:14pt" %)**РазделАвторизация**25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% class="box successmessage" %) 29 -((( 30 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login** 31 -))) 28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 32 32 33 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 34 - 35 35 (% style="color:#000000" %)Метод запроса: **POST** 36 36 37 37 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] ... ... @@ -43,9 +43,9 @@ 43 43 (% style="color:#000000" %){ 44 44 "login": "testuser", 45 45 "password": "testuser" 46 -}(%%) 47 - 41 +} 48 48 43 + 49 49 (% style="color:#000000" %)**Ответ:** 50 50 51 51 (% lang="en-US" %) ... ... @@ -60,13 +60,14 @@ 60 60 61 61 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 62 62 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 63 63 64 64 (% class="box infomessage" %) 65 65 ((( 66 -(% 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** 67 67 ))) 68 68 69 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 70 70 71 71 (% style="color:#000000" %)Метод запроса: **GET** 72 72 ... ... @@ -77,18 +77,58 @@ 77 77 (% lang="en-US" %) 78 78 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 79 79 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 80 80 81 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 82 82 ((( 83 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 84 84 ))) 85 85 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 + 86 86 (% class="box infomessage" %) 87 87 ((( 88 -(% 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(%%)** 89 89 ))) 90 90 91 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 92 92 93 93 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 94 94 ... ... @@ -96,37 +96,184 @@ 96 96 97 97 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 98 98 99 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% style="color:#000000" %)Метод запроса: **POST** 100 100 101 -(% 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 102 102 103 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 104 104 105 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 106 106 107 107 (% style="color:#000000" %)Ответ: 108 108 109 -(% style="color:#000000" %){ 110 - "agentId": "", ~/~/ идентификатор клиента 111 - "parentId": "", ~/~/ идентификатор клиента-родителя 112 - "name": "", ~/~/ наименование клиента 113 - "fullName": "", ~/~/ полное наименование клиента 114 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 115 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 147 +{ 148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 116 116 } 117 117 157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 118 118 119 -(% class="box "style="text-align: center;" %)159 +(% class="box successmessage" %) 120 120 ((( 121 - (%style="color:#000000; font-size:14pt"%)**Раздел Пользователи**161 +**POST /api/v3/agents ** 122 122 ))) 123 123 164 +Метод позволяет добавить клиента, указанного в запросе. 165 + 166 +Метод запроса: **POST** 167 + 168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 169 + 170 +В заголовках запроса: X-Auth: Токен авторизации 171 + 172 +Параметры в теле запроса (JSON): 173 + 174 +{ 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 + "name": "string", ~/~/ имя 177 + "fullName": "string", ~/~/ полное наименование 178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 179 + "isForeign": true, ~/~/ иностранный контрагент 180 + "district": "string", ~/~/ округ 181 + "region": "string", ~/~/ регион 182 + "city": "string", ~/~/ город 183 + "inn": "string", ~/~/ ИНН 184 + "kpp": "string", ~/~/ КПП 185 + "address": "string", ~/~/ юридический адрес 186 + "addressFact": "string", ~/~/ фактический адрес 187 + "email": "string", ~/~/ email 188 + "director": "string", ~/~/ ФИО руководителя 189 + "bankName": "string", ~/~/ банк 190 + "bankBIK": "string", ~/~/ БИК 191 + "bankRS": "string", ~/~/ номер счёта 192 + "bankKS": "string" ~/~/ корр. счёт 193 +} 194 + 195 + 196 +Ответ: 197 + 198 +{ 199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 201 + "name": "string", ~/~/ имя 202 + "fullName": "string", ~/~/ полное наименование 203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 204 + "isForeign": true, ~/~/ иностранный контрагент 205 + "district": "string", ~/~/ округ 206 + "region": "string", ~/~/ регион 207 + "city": "string", ~/~/ город 208 + "inn": "string", ~/~/ ИНН 209 + "kpp": "string", ~/~/ КПП 210 + "address": "string", ~/~/ юридический адрес 211 + "addressFact": "string", ~/~/ фактический адрес 212 + "email": "string", ~/~/ email 213 + "director": "string", ~/~/ ФИО руководителя 214 + "bankName": "string", ~/~/ банк 215 + "bankBIK": "string", ~/~/ БИК 216 + "bankRS": "string", ~/~/ номер счёта 217 + "bankKS": "string" ~/~/ корр. счёт 218 +} 219 + 220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 + 222 +(% class="box warningmessage" %) 223 +((( 224 +**PUT /api/v3/agents** 225 +))) 226 + 227 +Метод позволяет отредактировать клиента, указанного в запросе. 228 + 229 +Метод запроса: **PUT** 230 + 231 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 232 + 233 +В заголовках запроса: X-Auth: Токен авторизации 234 + 235 + 236 +Параметры в теле запроса (JSON): 237 + 238 +{ 239 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 240 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 241 + "name": "string", ~/~/ имя 242 + "fullName": "string", ~/~/ полное наименование 243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 244 + "isForeign": true, ~/~/ иностранный контрагент 245 + "district": "string", ~/~/ округ 246 + "region": "string", ~/~/ регион 247 + "city": "string", ~/~/ город 248 + "inn": "string", ~/~/ ИНН 249 + "kpp": "string", ~/~/ КПП 250 + "address": "string", ~/~/ юридический адрес 251 + "addressFact": "string", ~/~/ фактический адрес 252 + "email": "string", ~/~/ email 253 + "director": "string", ~/~/ ФИО руководителя 254 + "bankName": "string", ~/~/ банк 255 + "bankBIK": "string", ~/~/ БИК 256 + "bankRS": "string", ~/~/ номер счёта 257 + "bankKS": "string" ~/~/ корр. счёт 258 +} 259 + 260 + 261 +Ответ: 262 + 263 +{ 264 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 265 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 266 + "name": "string", ~/~/ имя 267 + "fullName": "string", ~/~/ полное наименование 268 + "isForeign": true, ~/~/ иностранный контрагент 269 + "district": "string", ~/~/ округ 270 + "region": "string", ~/~/ регион 271 + "city": "string", ~/~/ город 272 + "inn": "string", ~/~/ ИНН 273 + "kpp": "string", ~/~/ КПП 274 + "address": "string", ~/~/ юридический адрес 275 + "addressFact": "string", ~/~/ фактический адрес 276 + "email": "string", ~/~/ email 277 + "director": "string", ~/~/ ФИО руководителя 278 + "bankName": "string", ~/~/ банк 279 + "bankBIK": "string", ~/~/ БИК 280 + "bankRS": "string", ~/~/ номер счёта 281 + "bankKS": "string" ~/~/ корр. счёт 282 +} 283 + 284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 285 + 286 +(% class="box errormessage" %) 287 +((( 288 +**DELETE /api/v3/agents/{clientId}** 289 +))) 290 + 291 +Метод позволяет удалить клиента, указанного в строке запроса. 292 + 293 +Метод запроса: **DELETE** 294 + 295 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 296 + 297 +Параметр запроса: **{clientId}** - Guid пользователя 298 + 299 +В заголовках запроса: X-Auth: Токен авторизации 300 + 301 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 + 303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 + 305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 306 + 124 124 (% class="box successmessage" %) 125 125 ((( 126 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 127 127 ))) 128 128 129 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 130 130 131 131 (% style="color:#000000" %)Метод запроса: **POST** 132 132 ... ... @@ -136,7 +136,8 @@ 136 136 137 137 (% style="color:#000000" %)Параметры в теле запроса (JSON): 138 138 139 -(% style="color:#000000" %){ 322 +(% style="color:#000000" %) 323 +{ 140 140 "lastName": "", ~/~/ фамилия 141 141 "firstName": "", ~/~/ имя 142 142 "position": "", ~/~/ должность ... ... @@ -145,17 +145,41 @@ 145 145 "login": "", ~/~/ логин (обязателен) 146 146 "password": "", ~/~/ пароль (обязателен) 147 147 "email": "", ~/~/ email (обязателен) 148 - "description": "", ~/~/ описание 149 - "isEnabled": "", ~/~/ признак включения 332 + "description": "string", ~/~/ Описание 333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 150 150 "parentId": "", ~/~/ Guid родительского агента 151 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 152 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 153 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 154 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 155 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 156 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 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 - Азербайджанский 157 157 } 158 158 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 + 159 159 (% style="text-align:left" %) 160 160 (% style="color:#000000; font-weight:normal" %)Ответ: 161 161 ... ... @@ -184,13 +184,14 @@ 184 184 (% style="text-align:left" %) 185 185 (% style="color:#000000; font-weight:normal" %)} 186 186 395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 187 187 188 -(% class="box successmessage" %)397 +(% class="box infomessage" %) 189 189 ((( 190 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**399 +(% lang="en-US" %)**POST /api/v3/users/find** 191 191 ))) 192 192 193 -(% style="color:#000000" %) 402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 194 194 195 195 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 196 196 ... ... @@ -227,17 +227,18 @@ 227 227 "email": "" , ~/~/ E-mail 228 228 "sessionDuration":"", ~/~/ длительность сессии в минутах 229 229 "status": "1", ~/~/ статус пользователя 230 - "astLogged": "", ~/~/ дата/время последней авторизации 439 + "lastLogged": "", ~/~/ дата/время последней авторизации 231 231 232 232 (% style="color:#000000" %)} 233 233 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 234 234 235 -(% class="box successmessage" %)445 +(% class="box infomessage" %) 236 236 ((( 237 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 238 238 ))) 239 239 240 -(% style="color:#000000" %) 450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 241 241 242 242 (% style="color:#000000" %)Метод запроса: **GET** 243 243 ... ... @@ -264,8 +264,11 @@ 264 264 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 265 265 "description": "", ~/~/ Описание 266 266 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 267 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 268 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 477 + "doubleAuth": 478 + { 479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 + }, 269 269 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 270 270 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 271 271 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован ... ... @@ -279,13 +279,14 @@ 279 279 ))) 280 280 ))) 281 281 495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 282 282 283 283 (% class="box warningmessage" %) 284 284 ((( 285 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**499 +(% lang="en-US" %)**PUT /api/v3/users** 286 286 ))) 287 287 288 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 289 289 290 290 (% style="color:#000000" %)Метод запроса: **PUT** 291 291 ... ... @@ -293,8 +293,6 @@ 293 293 294 294 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 295 295 296 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!** 297 - 298 298 (% lang="en-US" style="text-align:left" %) 299 299 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 300 300 ... ... @@ -309,7 +309,9 @@ 309 309 "phone": "" , ~/~/ телефон 310 310 "organization": "" , ~/~/ организация 311 311 "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 312 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 313 313 "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 314 314 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 315 315 "isEnabled": "" , ~/~/ признак включения ... ... @@ -316,9 +316,12 @@ 316 316 "parentId": "" , ~/~/ Guid родительского агента 317 317 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 318 318 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 319 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 320 - "kind": "" , ~/~/ тип аутентификации 321 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 322 322 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 323 323 324 324 (% lang="en-US" style="text-align:left" %) ... ... @@ -344,8 +344,12 @@ 344 344 "isEnabled": "" , ~/~/ признак включения 345 345 "parentId": "" , ~/~/ Guid родительского агента 346 346 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 347 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 348 - "kind": "" , ~/~/ тип аутентификации 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 349 349 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 350 350 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 351 351 ... ... @@ -352,13 +352,14 @@ 352 352 (% lang="en-US" style="text-align:left" %) 353 353 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 354 354 576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 355 355 356 356 (% class="box warningmessage" %) 357 357 ((( 358 -(% 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}** 359 359 ))) 360 360 361 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 362 362 363 363 (% style="color:#000000" %)Метод запроса: **PUT** 364 364 ... ... @@ -381,13 +381,14 @@ 381 381 (% style="text-align:left" %) 382 382 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 383 383 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 384 384 385 385 (% class="box warningmessage" %) 386 386 ((( 387 -** Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/disable**610 +**POST /api/v3/users/disable** 388 388 ))) 389 389 390 -Метода позволяет выполнить массовую блокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 391 391 392 392 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 393 393 ... ... @@ -402,13 +402,14 @@ 402 402 403 403 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 404 404 628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 405 405 406 406 (% class="box warningmessage" %) 407 407 ((( 408 -** Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/enable**632 +**POST /api/v3/users/enable** 409 409 ))) 410 410 411 -Метода позволяет выполнить массовую разблокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 412 412 413 413 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 414 414 ... ... @@ -436,15 +436,16 @@ 436 436 } 437 437 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 438 438 "users" - массив id пользователей, которых не удалось включить или отключить. 439 - 440 440 ))) 441 441 665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 + 442 442 (% class="box errormessage" %) 443 443 ((( 444 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 445 445 ))) 446 446 447 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 448 448 449 449 (% style="color:#000000" %)Метод запроса: **DELETE** 450 450 ... ... @@ -457,20 +457,237 @@ 457 457 (% style="text-align:left" %) 458 458 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 459 459 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 460 460 461 -(% class="box" style="text-align: center;" %) 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 688 + 689 +(% class="box infomessage" %) 462 462 ((( 463 -(% style="color:#000000; font-size:14pt" %)**РазделТранспортные средства**691 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 464 464 ))) 465 465 694 +Метод возвращает полную информацию о модели объекта. 695 + 696 +(% style="color:#000000" %)Метод запроса: **GET** 697 + 698 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 699 + 700 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 701 + 702 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 703 + 704 +(% style="color:#000000" %)Ответ: 705 + 706 +(% style="color:#000000" %){ 707 + "parentName": "string", 708 + "name": "string", 709 + "picture": "string", 710 + "minspeed": 0, 711 + "maxspeed": 0, 712 + "width": 0, 713 + "imbeddedtrailer": true, 714 + "fueloutlay": 0, 715 + "hoppercapacity": 0, 716 + "hopperdischargespeed": 0, 717 + "modelType": 0, 718 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 719 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 720 + "deleted": true 721 +} 722 + 723 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 724 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 725 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 726 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 727 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 728 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 734 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 737 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 738 + 739 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 740 + 741 +(% class="box successmessage" %) 742 +((( 743 +(% lang="en-US" %)**POST /api/v3/models/find** 744 +))) 745 + 746 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 747 + 748 +(% style="color:#000000" %)Метод запроса: **POST** 749 + 750 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 751 + 752 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 753 + 754 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 755 + 756 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 757 +} 758 + 759 +(% style="color:#000000" %)Ответ: 760 + 761 +(% style="color:#000000" %)[ 762 + { 763 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 764 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 765 + "parentName": "string", 766 + "name": "string", 767 + "modelType": 0 768 + } 769 +] 770 + 771 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 772 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 773 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 774 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 775 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 776 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 777 + 778 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 779 + 780 +(% class="box successmessage" %) 781 +((( 782 +(% lang="en-US" %)**POST /api/v3/models** 783 +))) 784 + 785 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 786 + 787 +(% style="color:#000000" %)Метод запроса: **POST** 788 + 789 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 790 + 791 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 792 + 793 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 794 + 795 +{ 796 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 797 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 798 + "deleted": true, 799 + "extId": "string", 800 + "name": "string", 801 + "picture": "string", 802 + "minspeed": 0, 803 + "maxspeed": 0, 804 + "width": 0, 805 + "imbeddedtrailer": true, 806 + "fueloutlay": 0, 807 + "hoppercapacity": 0, 808 + "hopperdischargespeed": 0, 809 + "modelType": 0 810 +} 811 + 812 +Ответ: 813 + 814 +{ 815 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 816 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 817 + "deleted": true, 818 + "extId": "string", 819 + "name": "string", 820 + "picture": "string", 821 + "minspeed": 0, 822 + "maxspeed": 0, 823 + "width": 0, 824 + "imbeddedtrailer": true, 825 + "fueloutlay": 0, 826 + "hoppercapacity": 0, 827 + "hopperdischargespeed": 0, 828 + "modelType": 0 829 +} 830 + 831 + 832 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 + 834 +(% class="box warningmessage" %) 835 +((( 836 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 837 +))) 838 + 839 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 840 + 841 +(% style="color:#000000" %)Метод запроса: **PUT** 842 + 843 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 844 + 845 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 846 + 847 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 848 + 849 +{ 850 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 851 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 852 + "deleted": true, 853 + "extId": "string", 854 + "name": "string", 855 + "picture": "string", 856 + "minspeed": 0, 857 + "maxspeed": 0, 858 + "width": 0, 859 + "imbeddedtrailer": true, 860 + "fueloutlay": 0, 861 + "hoppercapacity": 0, 862 + "hopperdischargespeed": 0, 863 + "modelType": 0 864 +} 865 + 866 +Ответ: 867 + 868 +{ 869 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 871 + "deleted": true, 872 + "extId": "string", 873 + "name": "string", 874 + "picture": "string", 875 + "minspeed": 0, 876 + "maxspeed": 0, 877 + "width": 0, 878 + "imbeddedtrailer": true, 879 + "fueloutlay": 0, 880 + "hoppercapacity": 0, 881 + "hopperdischargespeed": 0, 882 + "modelType": 0 883 +} 884 + 885 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 + 887 +(% class="box errormessage" %) 888 +((( 889 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 890 +))) 891 + 892 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 893 + 894 +(% style="color:#000000" %)Метод запроса: **DELETE** 895 + 896 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 897 + 898 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 899 + 900 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 901 + 902 +Ответ: В случае успеха **Success 200** 903 + 904 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 905 + 906 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 907 + 466 466 (% class="box infomessage" %) 467 467 ((( 468 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**910 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 469 469 ))) 470 470 471 -(% style="color:#000000" %) 913 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 472 472 473 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):915 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 474 474 475 475 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 476 476 ... ... @@ -478,9 +478,9 @@ 478 478 479 479 (% style="color:#000000" %)Метод запроса: **GET** 480 480 481 -(% 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>923 +(% 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} 482 482 483 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)925 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 484 484 485 485 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 486 486 ... ... @@ -494,18 +494,148 @@ 494 494 "deviceTypeId": , ~/~/ ID типа устройства 495 495 "deviceTypeName": "", ~/~/ Название типа устройства 496 496 "sim1": "", ~/~/ Номер SIM1 497 - "parentId": "", Номер SIM2 498 - "parentName": "", Наименование клиента-родителя 499 - "modelId": "", ID модели объекта 500 - "modelName": "", Имя модели объекта 501 - "createdAt": "", Дата создания объекта 502 - "mileageCalcMethod": "", Выбранный метод расчета пробега 503 - "counters": { ~/~/ Нормы 504 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 505 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 506 - "mileage": "", ~/~/ Пробег по нормам в метрах 507 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 939 + "sim2": "", ~/~/ Номер SIM2 940 + 941 + "parentId": "", ~/~/ ID клиента-родителя 942 + "parentName": "", ~/~/ Наименование клиента-родителя 943 + "modelId": "", ~/~/ ID модели объекта 944 + "modelName": "", ~/~/ Имя модели объекта 945 + 946 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 + "unitName": "string", ~/~/ Наименование подразделения 948 + "status": 0, ~/~/ Статус объекта 949 + 950 + "createdAt": "", ~/~/ Дата создания объекта 508 508 }, 952 + 953 +"customFields": [ ~/~/ Произвольные поля 954 + { 955 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 956 + "name": "string", ~/~/ Имя поля 957 + "value": "string", ~/~/ Значение поля 958 + "forClient": true, ~/~/ Не используемая функция 959 + "forTooltip": true, ~/~/ Отображать в подсказке 960 + "forReport": true ~/~/ Отображать в отчете 961 + } 962 + 963 +], ~/~/ Данные с вкладки нормы 964 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 965 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 966 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 967 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 968 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 969 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 970 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 971 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 972 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 + 977 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 + "mileageCoeff": 0, ~/~/ коэффициент пробега 979 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 980 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 981 + "counters": { ~/~/ Счетчики 982 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 983 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 984 + "mileage": 0, ~/~/ Текущий пробег 985 + "motohours": 0, ~/~/ Текущие моточасы 986 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 987 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 988 + }, 989 + 990 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 991 + "id": "string", ~/~/ ID объекта 992 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 993 + "host": "string", ~/~/ CMSV6 Web Host 994 + "login": "string", ~/~/ CMSV6 Account 995 + "password": "string" ~/~/ CMSV6 Password 996 + }, 997 + 998 +"commandTemplates": [ ~/~/ Шаблоны команд 999 + { 1000 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1001 + "name": "string", ~/~/ Наименование команды 1002 + "command": "string", ~/~/ Текст команды 1003 + "retries": 0 ~/~/ Количество попыток 1004 + } 1005 + ], 1006 + 1007 + "sensors": [ ~/~/ Датчики 1008 + { 1009 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1010 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1011 + "type": 0, ~/~/ Тип датчика 1012 + "name": "string", ~/~/ Имя датчика 1013 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1014 + "inputNumber": 0, ~/~/ Номер входа 1015 + "pseudonym": "string", ~/~/ Псевдоним 1016 + "medianDegree": 0, ~/~/ Медианная фильтрация 1017 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1018 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1019 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1020 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1021 + { 1022 + "grades": [ ~/~/ Таблица тарировки 1 1023 + { 1024 + "input": 0, ~/~/ Входящее значение 1025 + "output": 0 ~/~/ Выходящее значение 1026 + } 1027 + ], 1028 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1029 + } 1030 + ], 1031 + "showInTooltip": true, ~/~/ Отображать в подсказке 1032 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1033 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1034 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1035 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1036 + "expr": "string", ~/~/ Формула 1037 + "children": [ ~/~/ массив дочерних датчиков 1038 + "string" 1039 + ], 1040 + "customParams": { ~/~/ прочие произвольные параметры 1041 + "additionalProp1": "string", 1042 + "additionalProp2": "string", 1043 + "additionalProp3": "string" 1044 + }, 1045 + 1046 +~/~/ Характерные для произвольного: 1047 + 1048 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 + 1050 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 + 1052 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 + 1054 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 + 1056 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 + 1058 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 + 1060 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 + 1062 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 + 1064 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 + 1066 +~/~/ "ValueOn": "Вкл.", 1067 + 1068 +~/~/ "ValueOff": "Выкл." 1069 + "summaryMaxValue": 0 ~/~/ Макс. значение 1070 + } 1071 + 1072 + "drivers": [ ~/~/ Водители 1073 + { 1074 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1075 + "name": "string", ~/~/ Наименование 1076 + "description": "string", 1077 + "isDefault": true ~/~/ По умолчанию 1078 + } 1079 + ], 1080 + 509 509 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 510 510 { 511 511 "id": "", ~/~/ ID задания ... ... @@ -521,7 +521,17 @@ 521 521 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 522 522 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 523 523 } 524 - ] 1096 + ], 1097 + 1098 + "statusHistory": [ ~/~/ История статусов 1099 + { 1100 + "status": 0, 1101 + "date": "2023-05-22T09:57:39.562Z", 1102 + "description": "string", 1103 + "additionalInfo": "string" 1104 + } 1105 + ] 1106 + 525 525 } 526 526 ))) 527 527 ... ... @@ -531,13 +531,14 @@ 531 531 (% style="text-align:left" %) 532 532 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 533 533 1116 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 534 534 535 535 (% class="box successmessage" %) 536 536 ((( 537 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**1120 +(% lang="en-US" %)**POST /api/v3/vehicles** 538 538 ))) 539 539 540 -(% style="color:#000000" %) . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).1123 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 541 541 542 542 (% style="color:#000000" %)Метод запроса: **POST** 543 543 ... ... @@ -569,6 +569,11 @@ 569 569 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 570 570 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 571 571 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 + 1156 + "mileageCalcMethod": 0, 1157 + "mileageCoeff": 0, 1158 + "locationByCellId": true, 1159 + "dottedLineTrackWhenNoCoords": true, 572 572 "counters": ~/~/ счетчики 573 573 { 574 574 "mileage": "" , ~/~/ пробег ... ... @@ -598,8 +598,98 @@ 598 598 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 599 599 } 600 600 601 -(% style="color:#000000" %) } 1189 +"drivers": [ ~/~/ Водители 1190 + { 1191 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1192 + "isDefault": true 1193 + } 1194 + ], 1195 + "commandTemplates": [ ~/~/ Шаблон команды 1196 + { 1197 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1198 + "name": "string", 1199 + "command": "string", 1200 + "retries": 0 1201 + } 1202 + ], 602 602 1204 + "sensors": [ ~/~/ Датчики 1205 + { 1206 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1208 + "type": 0, ~/~/ Тип датчика 1209 + "name": "string", ~/~/ Имя датчика 1210 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1211 + "inputNumber": 0, ~/~/ Номер входа 1212 + "pseudonym": "string", ~/~/ Псевдоним 1213 + "medianDegree": 0, ~/~/ Медианная фильтрация 1214 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1215 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1216 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1217 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1218 + { 1219 + "grades": [ ~/~/ Таблица тарировки 1 1220 + { 1221 + "input": 0, ~/~/ Входящее значение 1222 + "output": 0 ~/~/ Выходящее значение 1223 + } 1224 + ], 1225 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1226 + } 1227 + ], 1228 + "showInTooltip": true, ~/~/ Отображать в подсказке 1229 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1230 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1231 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1232 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1233 + "expr": "string", ~/~/ Формула 1234 + "children": [ ~/~/ массив дочерних датчиков 1235 + "string" 1236 + ], 1237 + "customParams": { ~/~/ прочие произвольные параметры 1238 + "additionalProp1": "string", 1239 + "additionalProp2": "string", 1240 + "additionalProp3": "string" 1241 + }, 1242 + 1243 +~/~/ Характерные для произвольного: 1244 + 1245 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 + 1247 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 + 1249 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 + 1251 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 + 1253 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 + 1255 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 + 1257 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 + 1259 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 + 1261 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 + 1263 +~/~/ "ValueOn": "Вкл.", 1264 + 1265 +~/~/ "ValueOff": "Выкл." 1266 + "summaryMaxValue": 0 ~/~/ Макс. значение 1267 + } 1268 + ], 1269 + "customFields": [ ~/~/ Произвольные поля 1270 + { 1271 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 + "name": "string", 1273 + "value": "string", 1274 + "forClient": true, 1275 + "forTooltip": true, 1276 + "forReport": true 1277 + } 1278 + ] 1279 +} 1280 + 603 603 (% style="color:#000000" %)Ответ: 604 604 605 605 (% style="color:#000000" %){ ... ... @@ -650,15 +650,16 @@ 650 650 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 651 651 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 652 652 1331 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 653 653 654 -(% class="box successmessage" %)1333 +(% class="box infomessage" %) 655 655 ((( 656 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**1335 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 657 657 ))) 658 658 659 -(% style="color:#000000" %) 1338 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 660 660 661 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):1340 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 662 662 663 663 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 664 664 ... ... @@ -695,7 +695,7 @@ 695 695 "customFields": null ~/~/ значение любого из произвольных полей ТС 696 696 } 697 697 698 -(% style="color:#000000" %) 1377 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 699 699 700 700 (% style="color:#000000" %)Ответ: 701 701 ... ... @@ -717,18 +717,28 @@ 717 717 "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 718 718 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 719 719 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 720 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%) 1399 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1400 + "customFields": [ 1401 + { 1402 + "id": "", ~/~/ идентификатор произвольного поля 1403 + "name": "", ~/~/ имя произвольного поля 1404 + "value": "", ~/~/ значение произвольного поля 1405 + "forClient": true, ~/~/ право на отображение у клиента 1406 + "forTooltip": false, ~/~/ право на отображение в подсказке 1407 + "forReport": false ~/~/ право на отображение в отчетах 1408 + }(%%) 721 721 (% style="color:#000000" %)} 722 722 723 723 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 724 724 1413 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 725 725 726 726 (% class="box successmessage" %) 727 727 ((( 728 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**1417 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 729 729 ))) 730 730 731 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1420 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 732 732 733 733 (% style="color:#000000" %)Метод запроса: **POST** 734 734 ... ... @@ -767,13 +767,14 @@ 767 767 (% style="text-align:left" %) 768 768 (% style="color:#000000" %) } 769 769 1459 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 770 770 771 771 (% class="box warningmessage" %) 772 772 ((( 773 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**1463 +(% lang="en-US" %)**PUT /api/v3/vehicles** 774 774 ))) 775 775 776 -(% style="color:#000000" %) . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1466 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 777 777 778 778 (% style="color:#000000" %)Метод запроса: **PUT** 779 779 ... ... @@ -783,18 +783,16 @@ 783 783 784 784 (% style="color:#000000" %)Параметры в теле запроса (JSON): 785 785 786 -(% style="color:#000000" %){ 787 - 788 -((( 789 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 790 - "parentId": "", ~/~/ ID клиента 791 - "name": "", ~/~/ имя ТС 792 - "imei": "", ~/~/ IMEI 793 - "deviceTypeId": "", ~/~/ ID типа устройства 794 - "modelId": "", ~/~/ , ID модели 795 - "unitId": "", ~/~/ подразделения 796 - "sim1": "", ~/~/ SIM 1 797 - "sim2": "", ~/~/ SIM2 (%%) 1476 +(% style="color:#000000" %){ 1477 + "vehicleId": , ~/~/ ID объекта 1478 + "parentId": "" , ~/~/ ID клиента 1479 + "name": "" , ~/~/ имя ТС 1480 + "imei": "" , ~/~/ IMEI 1481 + "deviceTypeId": "" , ~/~/ ID типа устройства 1482 + "modelId": "" , ~/~/ ID модели 1483 + "unitId": "" , ~/~/ ID подразделения 1484 + "sim1": "" , ~/~/ Номер SIM 1 1485 + "sim2": "" , ~/~/ Номер SIM2 798 798 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 799 799 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 800 800 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -807,39 +807,132 @@ 807 807 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 808 808 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 809 809 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 810 -(% style="color:#000000" %) "counters": 811 - { 812 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 813 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 814 - "mileage": "", ~/~/ пробег, в метрах 815 - "motohours": "" ~/~/ моточасы, в секундах 816 - } 817 - "cmsv6Parameters": ~/~/ параметры CMSv6 818 - { 819 - "id": "", ~/~/ идентификатор 820 - "enabled": true, ~/~/ флаг включения 821 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 822 - "login": "", ~/~/ имя учетной записи 823 - "password": "", ~/~/ пароль учетной записи 824 - } 825 - "inspectionTasks": ~/~/ задания на ТО 826 - { 827 - "id": "", ~/~/ ID задания 828 - "enabled": false, ~/~/ Признак включения 829 - "name": "", ~/~/ Имя задания 830 - "description": "", ~/~/ Описание задания 831 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 832 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 833 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 834 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 835 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 836 - "kind": "", ~/~/ Вид периодичности по времени 837 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 838 - } 839 -))) 840 840 841 -(% style="color:#000000" %)} 1499 + "mileageCalcMethod": 0, 1500 + "mileageCoeff": 0, 1501 + "locationByCellId": true, 1502 + "dottedLineTrackWhenNoCoords": true, 1503 + "counters": ~/~/ счетчики 1504 + { 1505 + "mileage": "" , ~/~/ пробег 1506 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1507 + "motohours": "" , ~/~/ моточасы 1508 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1509 + }, 1510 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1511 + "enabled": true, ~/~/ флаг включения 1512 + "id": "" , ~/~/ идентификатор 1513 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1514 + "login": "" , ~/~/ имя учетной записи 1515 + "password": "" ~/~/ пароль учетной записи 1516 + }, 1517 + "inspectionTasks": ~/~/ задания на ТО 1518 + { 1519 + "enabled": "" , ~/~/ Признак включения 1520 + "name": "" , ~/~/ Имя задания 1521 + "description": "" , ~/~/ Описание задания 1522 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1523 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1524 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1525 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1526 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1527 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1528 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1529 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1530 + } 842 842 1532 +"drivers": [ ~/~/ Водители 1533 + { 1534 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1535 + "isDefault": true 1536 + } 1537 + ], 1538 + "commandTemplates": [ ~/~/ Шаблон команды 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1541 + "name": "string", 1542 + "command": "string", 1543 + "retries": 0 1544 + } 1545 + ], 1546 + 1547 + "sensors": [ ~/~/ Датчики 1548 + { 1549 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1551 + "type": 0, ~/~/ Тип датчика 1552 + "name": "string", ~/~/ Имя датчика 1553 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1554 + "inputNumber": 0, ~/~/ Номер входа 1555 + "pseudonym": "string", ~/~/ Псевдоним 1556 + "medianDegree": 0, ~/~/ Медианная фильтрация 1557 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1558 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1559 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1560 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1561 + { 1562 + "grades": [ ~/~/ Таблица тарировки 1 1563 + { 1564 + "input": 0, ~/~/ Входящее значение 1565 + "output": 0 ~/~/ Выходящее значение 1566 + } 1567 + ], 1568 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1569 + } 1570 + ], 1571 + "showInTooltip": true, ~/~/ Отображать в подсказке 1572 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1573 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1574 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1575 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1576 + "expr": "string", ~/~/ Формула 1577 + "children": [ ~/~/ массив дочерних датчиков 1578 + "string" 1579 + ], 1580 + "customParams": { ~/~/ прочие произвольные параметры 1581 + "additionalProp1": "string", 1582 + "additionalProp2": "string", 1583 + "additionalProp3": "string" 1584 + }, 1585 + 1586 +~/~/ Характерные для произвольного: 1587 + 1588 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 + 1590 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 + 1592 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 + 1594 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 + 1596 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 + 1598 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 + 1600 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 + 1602 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 + 1604 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 + 1606 +~/~/ "ValueOn": "Вкл.", 1607 + 1608 +~/~/ "ValueOff": "Выкл." 1609 + "summaryMaxValue": 0 ~/~/ Макс. значение 1610 + } 1611 + ], 1612 + "customFields": [ ~/~/ Произвольные поля 1613 + { 1614 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1615 + "name": "string", 1616 + "value": "string", 1617 + "forClient": true, 1618 + "forTooltip": true, 1619 + "forReport": true 1620 + } 1621 + ] 1622 +} 1623 + 843 843 (% style="color:#000000" %)Ответ: 844 844 845 845 (% lang="en-US" style="text-align:left" %) ... ... @@ -890,18 +890,19 @@ 890 890 (% lang="en-US" style="text-align:left" %) 891 891 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 892 892 893 -** валидация:**1674 +**Валидация:** 894 894 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 895 895 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 896 896 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 897 897 1679 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 898 898 899 899 (% class="box errormessage" %) 900 900 ((( 901 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1683 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 902 902 ))) 903 903 904 -(% style="color:#000000" %) . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1686 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 905 905 906 906 (% style="color:#000000" %)Метод запроса: **DELETE** 907 907 ... ... @@ -914,18 +914,16 @@ 914 914 (% style="text-align:left" %) 915 915 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 916 916 1699 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 917 917 918 -(% class="box" lang="en-US" style="text-align: center;" %) 919 -((( 920 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 921 -))) 1701 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 922 922 923 923 (% class="box infomessage" %) 924 924 ((( 925 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов устройств**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**1705 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 926 926 ))) 927 927 928 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1708 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 929 929 930 930 (% style="color:#000000" %)Метод запроса: **GET** 931 931 ... ... @@ -943,24 +943,22 @@ 943 943 (% style="text-align:left" %) 944 944 (% style="color:#000000" %)} 945 945 1726 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 946 946 947 -(% class="box" style="text-align: center;" %) 948 -((( 949 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 950 -))) 1728 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 951 951 952 952 (% class="box infomessage" %) 953 953 ((( 954 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов датчиков**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**1732 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 955 955 ))) 956 956 957 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1735 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 958 958 959 959 (% style="color:#000000" %)Метод запроса: **GET** 960 960 961 961 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 962 962 963 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1741 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 964 964 965 965 (% style="color:#000000" %)Ответ: 966 966 ... ... @@ -973,7 +973,1622 @@ 973 973 (% style="text-align:left" %) 974 974 (% style="color:#000000" %)} 975 975 1754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 976 976 1756 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1757 + 1758 +(% class="box infomessage" style="text-align: left;" %) 1759 +((( 1760 +**POST /api/v3/terminalMessages/count** 1761 +))) 1762 + 1763 +(% style="text-align: left;" %) 1764 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1765 + 1766 +(% style="text-align: left;" %) 1767 +Метод запроса **POST** 1768 + 1769 +(% style="text-align: left;" %) 1770 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1771 + 1772 +(% style="text-align: left;" %) 1773 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1774 + 1775 +(% style="text-align: left;" %) 1776 +{ 1777 + "vehicleIds": [ 1778 + id ~/~/ здесь передается список идентификаторов объектов 1779 + ], 1780 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1781 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1782 +} 1783 + 1784 +(% style="text-align: left;" %) 1785 +Ответ: 1786 + 1787 +(% style="text-align: left;" %) 1788 +[ 1789 + { 1790 + "vehicleId": 0, ~/~/ идентификатор объекта 1791 + "count": 0 ~/~/ количество сообщений за период 1792 + } 1793 +] 1794 + 1795 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 + 1797 +(% class="box infomessage" %) 1798 +((( 1799 +**POST /api/v3/terminalMessages** 1800 +))) 1801 + 1802 +Метод возвращает список сообщений терминала объекта за выбранный период. 1803 + 1804 +(% style="text-align: left;" %) 1805 +Метод запроса **POST** 1806 + 1807 +(% style="text-align: left;" %) 1808 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1809 + 1810 +(% style="text-align: left;" %) 1811 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1812 + 1813 +{ 1814 + "vehicleId": 0, ~/~/ id объекта 1815 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1816 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 +} 1818 + 1819 +Ответ: 1820 + 1821 +[ 1822 + { 1823 + "messages": [ 1824 + { 1825 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 + "speed": 0, ~/~/ Скорость, км/ч 1828 + "altitude": 0, ~/~/ Высота, м 1829 + "latitude": 0, ~/~/ Широта [-90°;90°] 1830 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 + "satellites": 0, ~/~/ Кол-во спутников 1832 + "voltage": 0, ~/~/ Напряжение 1833 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1834 + "additionalProp1": "string", 1835 + "additionalProp2": "string", 1836 + "additionalProp3": "string" 1837 + }, 1838 + "photoCount": 0 ~/~/ Кол-во фото 1839 + } 1840 + ] 1841 + } 1842 +] 1843 + 1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1845 + 1846 +(% class="box infomessage" %) 1847 +((( 1848 +**POST /api/v3/vehicles/export/history** 1849 +))) 1850 + 1851 +Метод возвращает список сообщений терминала объекта за выбранный период. 1852 + 1853 +(% style="text-align: left;" %) 1854 +Метод запроса **POST** 1855 + 1856 +(% style="text-align: left;" %) 1857 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 + 1859 +(% style="text-align: left;" %) 1860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 + 1862 +{ 1863 + "vehicleId": 0, ~/~/ ID объекта 1864 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 +} 1868 + 1869 +Ответ: 1870 + 1871 +Получаете файл. Сообщение: Code 200/Success 1872 + 1873 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 + 1875 +(% class="box infomessage" %) 1876 +((( 1877 +**GET /api/v3/vehicles/export/history/status** 1878 +))) 1879 + 1880 +Метод возвращает список сообщений терминала объекта за выбранный период. 1881 + 1882 +(% style="text-align: left;" %) 1883 +Метод запроса **GET** 1884 + 1885 +(% style="text-align: left;" %) 1886 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 + 1888 +(% style="text-align: left;" %) 1889 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 + 1891 +Ответ: 1892 + 1893 +{ 1894 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 + "message": "string" ~/~/ текст описывающий статус. 1897 +} 1898 + 1899 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 + 1901 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1902 + 1903 +(% class="box infomessage" %) 1904 +((( 1905 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1906 +))) 1907 + 1908 +(% style="color:#000000" %)Метод запроса: **POST** 1909 + 1910 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1911 + 1912 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1913 + 1914 +(% style="text-align:left" %) 1915 +Тело запроса: 1916 + 1917 +{ 1918 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1919 + "vehicleIds": [0], ~/~/ Список ID объектов 1920 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1921 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1922 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1923 +} 1924 + 1925 +Ответ: 1926 + 1927 +[ 1928 + { 1929 + "vehicleId": 0, ~/~/ ID объекта 1930 + "name": "string", ~/~/ Имя ТС 1931 + "periods": [ ~/~/ Периоды 1932 + { 1933 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1934 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1935 + "mileageBegin": 0, ~/~/ Пробег на начало периода 1936 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 1937 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1938 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 1939 + } 1940 + ] 1941 + } 1942 +] 1943 + 1944 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 1945 + 1946 +(% class="box infomessage" %) 1947 +((( 1948 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 1949 +))) 1950 + 1951 +(% style="color:#000000" %)Метод запроса: **POST** 1952 + 1953 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 1954 + 1955 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1956 + 1957 +(% style="text-align:left" %) 1958 +Тело запроса: 1959 + 1960 +{ 1961 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1962 + "vehicleIds": [0], ~/~/ Список ID объектов 1963 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1964 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1965 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1966 +} 1967 + 1968 +Ответ: 1969 + 1970 +[ 1971 + { 1972 + "vehicleId": 0, ~/~/ ID объекта 1973 + "name": "string", ~/~/ Имя ТС 1974 + "periods": [ ~/~/ Периоды 1975 + { 1976 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1977 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1978 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 1979 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 1980 + "fuelConsumption": 0, ~/~/ Расход топлива 1981 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 1982 + } 1983 + ] 1984 + } 1985 +] 1986 + 1987 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 + 1989 +(% class="box infomessage" %) 1990 +((( 1991 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 1992 +))) 1993 + 1994 +(% style="color:#000000" %)Метод запроса: **POST** 1995 + 1996 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 1997 + 1998 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1999 + 2000 +(% style="text-align:left" %) 2001 +Тело запроса: 2002 + 2003 +{ 2004 + "vehicleIds": [0], ~/~/ Список ID объектов 2005 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2006 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2007 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2008 +} 2009 + 2010 +Ответ: 2011 + 2012 +[ 2013 + { 2014 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2015 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2016 + "vehicleId": 0, ~/~/ ID объекта 2017 + "name": "string", ~/~/ Имя объекта 2018 + "model": "string", ~/~/ Модель объекта 2019 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2020 + { 2021 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2022 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2023 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2024 + "valueFuel": 0, ~/~/ Количество 2025 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2026 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2027 + } 2028 + ] 2029 + } 2030 +] 2031 + 2032 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 + 2034 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2035 + 2036 +(% class="box infomessage" %) 2037 +((( 2038 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2039 +))) 2040 + 2041 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2042 + 2043 +(% style="color:#000000" %)Метод запроса: **POST** 2044 + 2045 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2046 + 2047 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2048 + 2049 +(% style="text-align:left" %) 2050 +Тело запроса: 2051 + 2052 +(% style="text-align:left" %) 2053 +{ 2054 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2055 +} 2056 + 2057 +(% style="text-align:left" %) 2058 +Ответ: 2059 + 2060 +[ 2061 + { 2062 + "id": 0, ~/~/ Идентификатор объекта геозоны 2063 + "name": "string", ~/~/ Название объекта геозоны 2064 + "type": 0, ~/~/ Тип объекта геозоны 2065 + "fname": "string", ~/~/ Имя файла 2066 + "parentId": "string", ~/~/ Идентификатор клиента 2067 + "radius": 0, ~/~/ Радиус геообъекта 2068 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2069 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2070 + "description": "string", ~/~/ Описание 2071 + "area": 0, ~/~/ Площадь, м^^2^^ 2072 + "perimetr": 0, ~/~/ Периметр, м 2073 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2074 + } 2075 +] 2076 + 2077 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2078 + 2079 +(% class="box infomessage" %) 2080 +((( 2081 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2082 +))) 2083 + 2084 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2085 + 2086 +(% style="color:#000000" %)Метод запроса: **POST** 2087 + 2088 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2089 + 2090 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2091 + 2092 +(% style="text-align:left" %) 2093 +Тело запроса: 2094 + 2095 +{ 2096 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2097 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2098 + "ids": [ ], ~/~/ Массив id объектов 2099 + "byTime": 0, ~/~/ Объединение событий по времени 2100 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2101 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2102 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2103 +} 2104 + 2105 +Ответ: 2106 +[ 2107 + { 2108 + "geozoneId": 0, ~/~/ ID геообъекта 2109 + "geozoneName": "string", ~/~/ Название геообъекта 2110 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2111 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2112 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2113 + "vehicleId": 0, ~/~/ ID объекта 2114 + "vehicleName": "string" ~/~/ Имя объекта 2115 + } 2116 +] 2117 + 2118 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2119 + 2120 +(% class="box infomessage" %) 2121 +((( 2122 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2123 +))) 2124 + 2125 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2126 + 2127 +(% style="color:#000000" %)Метод запроса: **POST** 2128 + 2129 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2130 + 2131 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2132 + 2133 +(% style="text-align:left" %) 2134 +Тело запроса: 2135 + 2136 +{ 2137 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2138 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2139 + "ids": [ ], ~/~/ Массив id геообъектов 2140 + "byTime": 0, ~/~/ Объединение событий по времени 2141 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2142 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2143 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2144 +} 2145 + 2146 +Ответ: 2147 + 2148 +[ 2149 + { 2150 + "geozoneId": 0, ~/~/ ID геообъекта 2151 + "geozoneName": "string", ~/~/ Название геообъекта 2152 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2153 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2154 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2155 + "vehicleId": 0, ~/~/ ID объекта 2156 + "vehicleName": "string" ~/~/ Имя объекта 2157 + } 2158 +] 2159 + 2160 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2161 + 2162 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2163 + 2164 +(% class="box infomessage" %) 2165 +((( 2166 +**POST /api/v3/notifications/find** 2167 +))) 2168 + 2169 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2170 + 2171 +(% style="text-align: left;" %) 2172 +Метод запроса **POST** 2173 + 2174 +(% style="text-align: left;" %) 2175 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2176 + 2177 +(% style="text-align: left;" %) 2178 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2179 + 2180 +{ 2181 + "parentId": "" ~/~/ id клиента 2182 +} 2183 + 2184 +Ответ: 2185 + 2186 +[ 2187 + { 2188 + "id": 0, ~/~/ ID уведомления 2189 + "name": "string", ~/~/ Название уведомления 2190 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2191 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2192 + "userId": "", ~/~/ Пользователь, создавший уведомление 2193 + "parentId": "", ~/~/ Идентификатор клиента 2194 + "parentName": "string" ~/~/ Имя клиента 2195 + } 2196 +] 2197 + 2198 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2199 + 2200 +(% class="box infomessage" %) 2201 +((( 2202 +**GET /api/v3/notifications/{id}** 2203 +))) 2204 + 2205 +Метод возвращает данные правил формирования выбранного уведомления. 2206 + 2207 +(% style="text-align: left;" %) 2208 +Метод запроса **GET** 2209 + 2210 +(% style="text-align: left;" %) 2211 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2212 + 2213 +(% style="text-align: left;" %) 2214 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2215 + 2216 +(% style="text-align: left;" %) 2217 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2218 + 2219 +(% style="text-align: left;" %) 2220 +(% style="color:#000000" %)Ответ: 2221 + 2222 +(% style="text-align: left;" %) 2223 +(% style="color:#000000" %){ 2224 + "id": 0, ~/~/ (%%)id уведомления 2225 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2226 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2227 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2228 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2229 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2230 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2231 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2232 +(% style="color:#000000" %) 0 2233 + ], 2234 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2235 +(% style="color:#000000" %) 0 2236 + ], 2237 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2238 +(% style="color:#000000" %) 0 2239 + ], 2240 + "settings": { ~/~/ Список параметров уведомления 2241 + "additionalProp1": "string", 2242 + "additionalProp2": "string", 2243 + "additionalProp3": "string" 2244 + }, 2245 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2246 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2247 +(% style="color:#000000" %) "" 2248 + ], 2249 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2250 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2251 +(% style="color:#000000" %) "string" 2252 + ], 2253 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2254 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2255 +(% style="color:#000000" %) { 2256 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2257 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2258 +(% style="color:#000000" %) } 2259 + ], 2260 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2261 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2262 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2263 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2264 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2265 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2266 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2267 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2268 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2269 +(% style="color:#000000" %)} 2270 + 2271 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2272 + 2273 +(% class="box warningmessage" %) 2274 +((( 2275 +**PUT /api/v3/notifications/** 2276 +))) 2277 + 2278 +Метод позволяет отредактировать уведомление. 2279 + 2280 +Метод запроса **PUT** 2281 + 2282 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2283 + 2284 +В заголовках запроса: X-Auth: Токен авторизации 2285 + 2286 +Тело запроса: 2287 +{ 2288 + "id": 0, ~/~/ id уведомления 2289 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2290 + "userId": "", ~/~/ Пользователь, создавший уведомление 2291 + "parentId": "", ~/~/ Идентификатор клиента 2292 + "parentName": "string", ~/~/ Имя клиента 2293 + "name": "string", ~/~/ Название уведомления 2294 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2295 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2296 + 0 2297 + ], 2298 + "geoids": [ ~/~/ Список id геообъектов для анализа 2299 + 0 2300 + ], 2301 + "fieldids": [ ~/~/ Список id полей для анализа 2302 + 0 2303 + ], 2304 + "settings": { ~/~/ Список параметров уведомления 2305 + "additionalProp1": "string", 2306 + "additionalProp2": "string", 2307 + "additionalProp3": "string" 2308 + }, 2309 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2310 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2311 + "" 2312 + ], 2313 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2314 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2315 + "string" 2316 + ], 2317 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2318 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2319 + { 2320 + "id": 0, ~/~/ Идентификатор участника чата 2321 + "info": "string" ~/~/ Дополнительные сведения 2322 + } 2323 + ], 2324 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2325 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2326 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2327 + "kind": 0, ~/~/ Определяет вид уведомления 2328 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2329 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2330 + "timezone": 0, ~/~/ Сдвиг часового пояса 2331 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2332 + "autoProlongation": true ~/~/ Автопродление срока действия 2333 +} 2334 + 2335 +Ответ: 2336 + 2337 +Success 2338 + 2339 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2340 + 2341 +(% class="box errormessage" %) 2342 +((( 2343 +**DELETE /api/v3/notifications/{id}** 2344 +))) 2345 + 2346 +Метод позволяет удалить выбранное уведомление. 2347 + 2348 +Метод запроса **DELETE** 2349 + 2350 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2351 + 2352 +Передаваемый параметр: {id} - id уведомления 2353 + 2354 +В заголовках запроса: X-Auth: Токен авторизации 2355 + 2356 +Ответ: 2357 + 2358 +Success 2359 + 2360 + 2361 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2362 + 2363 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2364 + 2365 +(% class="box infomessage" %) 2366 +((( 2367 +**POST /api/v3/Drivers/find** 2368 +))) 2369 + 2370 +Передается параметр: parentId - ID клиента-родителя 2371 + 2372 +Ответ: 2373 + 2374 +[ 2375 + { 2376 + "name": "string", ~/~/ Определяет наименование 2377 + "description": "string", ~/~/ Определяет описание 2378 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2379 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2380 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2381 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2382 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2383 + "deleted": true ~/~/ Признак удаления 2384 + } 2385 +] 2386 + 2387 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2388 + 2389 +(% class="box infomessage" %) 2390 +((( 2391 +**GET /api/v3/Drivers/{driverGuid}** 2392 +))) 2393 + 2394 +Передается параметр: ID водителя 2395 + 2396 +Ответ: 2397 + 2398 +{ 2399 + "name": "string", ~/~/ Определяет наименование 2400 + "description": "string", ~/~/ Определяет описание 2401 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2402 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2403 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2404 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2405 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2406 + "deleted": true ~/~/ Признак удаления 2407 +} 2408 + 2409 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2410 + 2411 +(% class="box successmessage" %) 2412 +((( 2413 +**POST /api/v3/Drivers** 2414 +))) 2415 + 2416 +Запрос: 2417 + 2418 +{ 2419 + "name": "string", 2420 + "description": "string", 2421 + "hiredate": "2023-06-30T12:50:54.020Z", 2422 + "chopdate": "2023-06-30T12:50:54.020Z", 2423 + "exclusive": true, 2424 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2425 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2426 + "deleted": true 2427 +} 2428 + 2429 +Ответ: 2430 + 2431 +{ 2432 + "name": "string", 2433 + "description": "string", 2434 + "hiredate": "2023-06-30T12:50:54.051Z", 2435 + "chopdate": "2023-06-30T12:50:54.051Z", 2436 + "exclusive": true, 2437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2438 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2439 + "deleted": true 2440 +} 2441 + 2442 + 2443 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2444 + 2445 +(% class="box warningmessage" %) 2446 +((( 2447 +**PUT /api/v3/Drivers** 2448 +))) 2449 + 2450 +Запрос: 2451 + 2452 +{ 2453 + "name": "string", 2454 + "description": "string", 2455 + "hiredate": "2023-06-30T12:50:27.910Z", 2456 + "chopdate": "2023-06-30T12:50:27.910Z", 2457 + "exclusive": true, 2458 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2459 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2460 + "deleted": true 2461 +} 2462 + 2463 +Ответ: 2464 + 2465 +{ 2466 + "name": "string", 2467 + "description": "string", 2468 + "hiredate": "2023-06-30T12:50:27.929Z", 2469 + "chopdate": "2023-06-30T12:50:27.929Z", 2470 + "exclusive": true, 2471 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2472 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2473 + "deleted": true 2474 +} 2475 + 2476 + 2477 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2478 + 2479 +(% class="box errormessage" %) 2480 +((( 2481 +**DELETE /api/v3/Drivers/{driverGuid}** 2482 +))) 2483 + 2484 +Передается параметр: ID водителя 2485 + 2486 +Ответ: 2487 + 2488 +Success 2489 + 2490 + 2491 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2492 + 2493 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2494 + 2495 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2496 + 2497 +(% class="box infomessage" %) 2498 +((( 2499 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2500 +))) 2501 + 2502 +Запрос: 2503 + 2504 +{ 2505 + "Ids": [ 2506 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2507 + ], 2508 + "BeginTime": "2023-06-30T12:49:04.365Z", 2509 + "EndTime": "2023-06-30T12:49:04.365Z" 2510 +} 2511 + 2512 +Ответ: 2513 + 2514 +[ 2515 + { 2516 + "VehicleId": 0, 2517 + "CreateTime": "2023-06-30T09:52:31.240Z", 2518 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2519 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2520 + "BeginTime": "2023-06-30T09:52:31.240Z", 2521 + "EndTime": "2023-06-30T09:52:31.240Z" 2522 + } 2523 +] 2524 + 2525 + 2526 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2527 + 2528 +(% class="box infomessage" %) 2529 +((( 2530 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2531 +))) 2532 + 2533 +Запрос: 2534 + 2535 +{ 2536 + "Ids": [ 2537 + 0 2538 + ], 2539 + "BeginTime": "2023-06-30T12:48:39.419Z", 2540 + "EndTime": "2023-06-30T12:48:39.419Z" 2541 +} 2542 + 2543 +Ответ: 2544 + 2545 +[ 2546 + { 2547 + "VehicleId": 0, 2548 + "CreateTime": "2023-06-30T09:54:01.631Z", 2549 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2550 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2551 + "BeginTime": "2023-06-30T09:54:01.631Z", 2552 + "EndTime": "2023-06-30T09:54:01.631Z" 2553 + } 2554 +] 2555 + 2556 + 2557 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2558 + 2559 +(% class="box successmessage" %) 2560 +((( 2561 +**POST /api/v3/DriversVehiclesAssignments** 2562 +))) 2563 + 2564 +Передается массив назначений 2565 + 2566 +Запрос: 2567 + 2568 +[ 2569 + { 2570 + "VehicleId": 0, ~/~/ Идентификатор объекта 2571 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2572 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2573 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2574 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2575 + } 2576 +] 2577 + 2578 +Ответ: 2579 + 2580 +[ 2581 + { 2582 + "VehicleId": 0, 2583 + "CreateTime": "2023-06-30T11:04:46.903Z", 2584 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2585 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2586 + "BeginTime": "2023-06-30T11:04:46.903Z", 2587 + "EndTime": "2023-06-30T11:04:46.903Z" 2588 + } 2589 +] 2590 + 2591 + 2592 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2593 + 2594 +(% class="box warningmessage" %) 2595 +((( 2596 +**PUT /api/v3/DriversVehiclesAssignments** 2597 +))) 2598 + 2599 +Запрос: 2600 + 2601 +[ 2602 + { 2603 + "VehicleId": 0, 2604 + "CreateTime": "2023-06-30T11:14:08.117Z", 2605 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2606 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2607 + "BeginTime": "2023-06-30T11:14:08.117Z", 2608 + "EndTime": "2023-06-30T11:14:08.117Z" 2609 + } 2610 +] 2611 + 2612 +Ответ: 2613 + 2614 +[ 2615 + { 2616 + "VehicleId": 0, 2617 + "CreateTime": "2023-06-30T11:14:53.349Z", 2618 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2619 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2620 + "BeginTime": "2023-06-30T11:14:53.349Z", 2621 + "EndTime": "2023-06-30T11:14:53.349Z" 2622 + } 2623 +] 2624 + 2625 + 2626 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2627 + 2628 +(% class="box errormessage" %) 2629 +((( 2630 +**DELETE /api/v3/DriversVehiclesAssignments** 2631 +))) 2632 + 2633 +Запрос: 2634 + 2635 +[ 2636 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2637 +] 2638 + 2639 +Ответ: 2640 + 2641 +Success 2642 + 2643 + 2644 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2645 + 2646 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2647 + 2648 +(% class="box infomessage" %) 2649 +((( 2650 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2651 +))) 2652 + 2653 +Запрос: 2654 + 2655 +{ 2656 + "Ids": [ 2657 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2658 + ], 2659 + "BeginTime": "2023-06-30T12:47:12.162Z", 2660 + "EndTime": "2023-06-30T12:47:12.162Z" 2661 +} 2662 + 2663 +Ответ: 2664 + 2665 +[ 2666 + { 2667 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2668 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2669 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2670 + "BeginTime": "2023-06-30T11:19:40.703Z", 2671 + "EndTime": "2023-06-30T11:19:40.703Z" 2672 + } 2673 +] 2674 + 2675 + 2676 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2677 + 2678 +(% class="box infomessage" %) 2679 +((( 2680 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2681 +))) 2682 + 2683 +Запрос: 2684 + 2685 +{ 2686 + "Ids": [ 2687 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2688 + ], 2689 + "BeginTime": "2023-06-30T12:47:12.162Z", 2690 + "EndTime": "2023-06-30T12:47:12.162Z" 2691 +} 2692 + 2693 +Ответ: 2694 + 2695 +[ 2696 + { 2697 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2698 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2699 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2700 + "BeginTime": "2023-06-30T11:19:40.703Z", 2701 + "EndTime": "2023-06-30T11:19:40.703Z" 2702 + } 2703 +] 2704 + 2705 + 2706 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2707 + 2708 +(% class="box successmessage" %) 2709 +((( 2710 +**POST /api/v3/DriversRfidsAssignments** 2711 +))) 2712 + 2713 +Запрос: 2714 + 2715 +[ 2716 + { 2717 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2718 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2719 + "BeginTime": "2023-06-30T11:27:08.635Z", 2720 + "EndTime": "2023-06-30T11:27:08.635Z" 2721 + } 2722 +] 2723 + 2724 +Ответ: 2725 + 2726 +[ 2727 + { 2728 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2729 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2730 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2731 + "BeginTime": "2023-06-30T11:27:08.677Z", 2732 + "EndTime": "2023-06-30T11:27:08.677Z" 2733 + } 2734 +] 2735 + 2736 + 2737 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2738 + 2739 +(% class="box warningmessage" %) 2740 +((( 2741 +**PUT /api/v3/DriversRfidsAssignments** 2742 +))) 2743 + 2744 +Запрос: 2745 + 2746 +[ 2747 + { 2748 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2749 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2750 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2751 + "BeginTime": "2023-06-30T11:28:43.330Z", 2752 + "EndTime": "2023-06-30T11:28:43.330Z" 2753 + } 2754 +] 2755 + 2756 +Ответ: 2757 + 2758 +[ 2759 + { 2760 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2761 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2762 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2763 + "BeginTime": "2023-06-30T11:28:43.331Z", 2764 + "EndTime": "2023-06-30T11:28:43.331Z" 2765 + } 2766 +] 2767 + 2768 + 2769 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2770 + 2771 +(% class="box errormessage" %) 2772 +((( 2773 +**DELETE /api/v3/DriversRfidsAssignments** 2774 +))) 2775 + 2776 +Запрос: 2777 + 2778 +[ 2779 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2780 +] 2781 + 2782 +Ответ: 2783 + 2784 +Success 2785 + 2786 + 2787 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 2788 + 2789 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2790 + 2791 +(% class="box infomessage" %) 2792 +((( 2793 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2794 +))) 2795 + 2796 +Запрос: 2797 + 2798 +{ 2799 + "Ids": [ 2800 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2801 + ], 2802 + "BeginTime": "2023-06-30T12:45:10.852Z", 2803 + "EndTime": "2023-06-30T12:45:10.852Z" 2804 +} 2805 + 2806 +Ответ: 2807 + 2808 +[ 2809 + { 2810 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2811 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2812 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2813 + "BeginTime": "2023-06-30T11:58:04.695Z", 2814 + "EndTime": "2023-06-30T11:58:04.695Z" 2815 + } 2816 +] 2817 + 2818 + 2819 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2820 + 2821 +(% class="box infomessage" %) 2822 +((( 2823 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 2824 +))) 2825 + 2826 +Запрос: 2827 + 2828 +{ 2829 + "Ids": [ 2830 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2831 + ], 2832 + "BeginTime": "2023-06-30T12:45:10.852Z", 2833 + "EndTime": "2023-06-30T12:45:10.852Z" 2834 +} 2835 + 2836 +Ответ: 2837 + 2838 +[ 2839 + { 2840 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2841 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2842 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2843 + "BeginTime": "2023-06-30T11:58:04.695Z", 2844 + "EndTime": "2023-06-30T11:58:04.695Z" 2845 + } 2846 +] 2847 + 2848 + 2849 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2850 + 2851 +(% class="box successmessage" %) 2852 +((( 2853 +**POST /api/v3/DriversFuelCardsAssignments** 2854 +))) 2855 + 2856 +Запрос: 2857 + 2858 +[ 2859 + { 2860 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2861 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2862 + "BeginTime": "2023-06-30T12:09:53.175Z", 2863 + "EndTime": "2023-06-30T12:09:53.175Z" 2864 + } 2865 +] 2866 + 2867 +Ответ: 2868 + 2869 +[ 2870 + { 2871 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2872 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2873 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2874 + "BeginTime": "2023-06-30T12:09:53.201Z", 2875 + "EndTime": "2023-06-30T12:09:53.201Z" 2876 + } 2877 +] 2878 + 2879 + 2880 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2881 + 2882 +(% class="box warningmessage" %) 2883 +((( 2884 +**PUT /api/v3/DriversFuelCardsAssignments** 2885 +))) 2886 + 2887 +Запрос: 2888 + 2889 +[ 2890 + { 2891 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2892 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2893 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2894 + "BeginTime": "2023-06-30T12:09:53.201Z", 2895 + "EndTime": "2023-06-30T12:09:53.201Z" 2896 + } 2897 +] 2898 + 2899 +Ответ: 2900 + 2901 +[ 2902 + { 2903 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2904 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2905 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2906 + "BeginTime": "2023-06-30T12:09:53.201Z", 2907 + "EndTime": "2023-06-30T12:09:53.201Z" 2908 + } 2909 +] 2910 + 2911 + 2912 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2913 + 2914 +(% class="box errormessage" %) 2915 +((( 2916 +**DELETE /api/v3/DriversFuelCardsAssignments** 2917 +))) 2918 + 2919 +Запрос: 2920 + 2921 +[ 2922 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2923 +] 2924 + 2925 +Ответ: 2926 + 2927 +Success 2928 + 2929 + 2930 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 + 2932 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2933 + 2934 +(% class="box infomessage" %) 2935 +((( 2936 +**POST /api/v3/Rfids/find** 2937 +))) 2938 + 2939 +Запрос: 2940 + 2941 +{ 2942 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2943 +} 2944 + 2945 +Ответ: 2946 + 2947 +[ 2948 + { 2949 + "name": "string", 2950 + "number": 0, 2951 + "period": 0, ~/~/ Частота трансляции радиометки 2952 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 + "deleted": true 2955 + } 2956 +] 2957 + 2958 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 + 2960 +(% class="box infomessage" %) 2961 +((( 2962 +**GET /api/v3/Rfids/{rfidGuid}** 2963 +))) 2964 + 2965 +Передаем параметр rfidGuid - идентификатор карты-метки 2966 + 2967 +Ответ: 2968 + 2969 +[ 2970 + { 2971 + "name": "string", 2972 + "number": 0, 2973 + "period": 0, ~/~/ Частота трансляции радиометки 2974 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 + "deleted": true 2977 + } 2978 +] 2979 + 2980 + 2981 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 + 2983 +(% class="box successmessage" %) 2984 +((( 2985 +**POST /api/v3/Rfids** 2986 +))) 2987 + 2988 +Запрос: 2989 + 2990 +{ 2991 + "name": "string", 2992 + "number": 0, 2993 + "period": 0, 2994 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 + "deleted": true 2996 +} 2997 + 2998 +Ответ: 2999 + 3000 +{ 3001 + "name": "string", 3002 + "number": 0, 3003 + "period": 0, 3004 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 + "deleted": true 3007 +} 3008 + 3009 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 + 3011 +(% class="box warningmessage" %) 3012 +((( 3013 +**PUT /api/v3/Rfids** 3014 +))) 3015 + 3016 +Запрос: 3017 + 3018 +{ 3019 + "name": "string", 3020 + "number": 0, 3021 + "period": 0, 3022 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 + "deleted": true 3025 +} 3026 + 3027 +Ответ: 3028 + 3029 +{ 3030 + "name": "string", 3031 + "number": 0, 3032 + "period": 0, 3033 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 + "deleted": true 3036 +} 3037 + 3038 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 + 3040 +(% class="box errormessage" %) 3041 +((( 3042 +**DELETE /api/v3/Rfids/{rfidGuid}** 3043 +))) 3044 + 3045 +Передаем параметр rfidGuid - идентификатор карты-метки 3046 + 3047 +Ответ: 3048 + 3049 +Success 3050 + 3051 + 3052 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3053 + 3054 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3055 + 3056 +(% class="box infomessage" %) 3057 +((( 3058 +**GET /api/v3/Billing/client/balance/{clientId}** 3059 +))) 3060 + 3061 +Параметр запроса: **clientId **- идентификатор клиента. 3062 + 3063 +Ответ: 3064 + 3065 +{ 3066 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3067 + "Balance": 0 3068 +} 3069 + 3070 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3071 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3072 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3073 + 3074 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3075 + 3076 +(% class="box infomessage" %) 3077 +((( 3078 +**GET /api/v3/Billing/client/constraint/{clientId}** 3079 +))) 3080 + 3081 +Параметр запроса: **clientId **- идентификатор клиента. 3082 + 3083 +Ответ: 3084 + 3085 +{ 3086 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3087 + "CalculationType": 0, 3088 + "PermissibleBalance": 0, 3089 + "DefermentDays": 0, 3090 + "SendUiNotifications": true, 3091 + "SendEmailNotifications": true, 3092 + "IsPrivate": true, 3093 +} 3094 + 3095 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3096 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3097 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3098 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3099 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3100 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3101 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3102 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3103 + 3104 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3105 + 3106 +(% class="box infomessage" %) 3107 +((( 3108 +**GET /api/v3/Billing/client/plan/{clientId}** 3109 +))) 3110 + 3111 +Параметры запроса: 3112 + 3113 +**clientId **- идентификатор клиента. 3114 + 3115 +**planId **- идентификатор тарифного плана. 3116 + 3117 +Ответ: 3118 + 3119 +{ 3120 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3121 + "Plan": { **~/~/ Описание тарифного плана** 3122 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3123 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3124 + "Name": "string", 3125 + "IsArchived": true, 3126 + "Constraint": { 3127 + "CalculationType": 0, 3128 + "PermissibleBalance": 0, 3129 + "DefermentDays": 0 3130 + }, 3131 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3132 + { 3133 + "Feature": "string", 3134 + "IsFactual": true, 3135 + "Limit": 0, 3136 + "Price": 0, 3137 + "PeriodValue": 0, 3138 + "PeriodType": 0 3139 + } 3140 + ] 3141 + }, 3142 + "DebitDate": "2023-10-18T12:46:24.213Z", 3143 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3144 + { 3145 + "Feature": "string", 3146 + "IsEnabled": true, 3147 + "IsPrivate": true, 3148 + "IsFactual": true, 3149 + "Limit": 0, 3150 + "Price": 0, 3151 + "DebitDate": "2023-10-18T12:46:24.213Z", 3152 + "PeriodValue": 0, 3153 + "PeriodType": 0 3154 + } 3155 + ] 3156 +} 3157 + 3158 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3159 +|ClientId|Идентификатор клиента 3160 +|Id|Идентификатор тарифного плана 3161 +|OwnerId|Идентификатор клиента-владельца 3162 +|Name|Наименование тарифного плана 3163 +|IsArchived|Признак, определяющий архивный тарифный план 3164 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3165 +|PermissibleBalance|Допустимый баланс 3166 +|DefermentDays|Отсрочка, количество дней 3167 +|Feature|Код услуги 3168 +|IsEnabled|Признак, определяющий активирована ли услуга 3169 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3170 +|IsFactual|Признак, определяющий расчёт по факту 3171 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3172 +|Price|Цена за единицу. 3173 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3174 +|PeriodValue|Значение периода. 3175 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3176 + 3177 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3178 + 3179 +(% class="box infomessage" %) 3180 +((( 3181 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3182 +))) 3183 + 3184 +Параметр запроса: **clientId **- идентификатор клиента. 3185 + 3186 +Ответ: 3187 + 3188 +[ 3189 + { 3190 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3191 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3192 + "Name": "string", 3193 + "IsArchived": true, 3194 + "Constraint": { 3195 + "CalculationType": 0, 3196 + "PermissibleBalance": 0, 3197 + "DefermentDays": 0 3198 + }, 3199 + "Features": [ 3200 + { 3201 + "Feature": "string", 3202 + "IsFactual": true, 3203 + "Limit": 0, 3204 + "Price": 0, 3205 + "PeriodValue": 0, 3206 + "PeriodType": 0 3207 + } 3208 + ] 3209 + } 3210 +] 3211 + 3212 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3213 +|ClientId|Идентификатор клиента 3214 +|Id|Идентификатор тарифного плана 3215 +|OwnerId|Идентификатор клиента-владельца 3216 +|Name|Наименование тарифного плана 3217 +|IsArchived|Признак, определяющий архивный тарифный план 3218 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3219 +|PermissibleBalance|Допустимый баланс 3220 +|DefermentDays|Отсрочка, количество дней 3221 +|Feature|Код услуги 3222 +|IsFactual|Признак, определяющий расчёт по факту 3223 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3224 +|Price|Цена за единицу. 3225 +|PeriodValue|Значение периода. 3226 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3227 + 3228 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3229 + 3230 +(% class="box infomessage" %) 3231 +((( 3232 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3233 +))) 3234 + 3235 +Параметр запроса: **clientId **- идентификатор клиента. 3236 + 3237 +Ответ: 3238 + 3239 +[ 3240 + { 3241 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3242 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3243 + "Name": "string", 3244 + "IsArchived": true, 3245 + "Constraint": { 3246 + "CalculationType": 0, 3247 + "PermissibleBalance": 0, 3248 + "DefermentDays": 0 3249 + }, 3250 + "Features": [ 3251 + { 3252 + "Feature": "string", 3253 + "IsFactual": true, 3254 + "Limit": 0, 3255 + "Price": 0, 3256 + "PeriodValue": 0, 3257 + "PeriodType": 0 3258 + } 3259 + ] 3260 + } 3261 +] 3262 + 3263 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3264 +|ClientId|Идентификатор клиента 3265 +|Id|Идентификатор тарифного плана 3266 +|OwnerId|Идентификатор клиента-владельца 3267 +|Name|Наименование тарифного плана 3268 +|IsArchived|Признак, определяющий архивный тарифный план 3269 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3270 +|PermissibleBalance|Допустимый баланс 3271 +|DefermentDays|Отсрочка, количество дней 3272 +|Feature|Код услуги 3273 +|IsFactual|Признак, определяющий расчёт по факту 3274 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3275 +|Price|Цена за единицу. 3276 +|PeriodValue|Значение периода. 3277 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3278 + 3279 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3280 + 3281 +(% class="box warningmessage" %) 3282 +((( 3283 +**PUT /api/v3/Billing/client/balance** 3284 +))) 3285 + 3286 +Тело запроса: 3287 + 3288 +{ 3289 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3290 + "Balance": 0 3291 +} 3292 + 3293 +Ответ: Success 3294 + 3295 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3296 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 + 3299 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 + 3301 +(% class="box warningmessage" %) 3302 +((( 3303 +**PUT /api/v3/Billing/client/constraint** 3304 +))) 3305 + 3306 +Тело запроса: 3307 + 3308 +{ 3309 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3310 + "CalculationType": 0, 3311 + "PermissibleBalance": 0, 3312 + "DefermentDays": 0, 3313 + "SendUiNotifications": true, 3314 + "SendEmailNotifications": true, 3315 + "IsPrivate": true, 3316 +} 3317 + 3318 +Ответ: Success 3319 + 3320 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3321 +|ClientId|Идентификатор клиента 3322 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3323 +|PermissibleBalance|Допустимый баланс 3324 +|DefermentDays|((( 3325 +Отсрочка, количество дней 3326 +))) 3327 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3328 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3329 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3330 + 3331 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3332 + 3333 +(% class="box warningmessage" %) 3334 +((( 3335 +**PUT /api/v3/Billing/client/plan** 3336 +))) 3337 + 3338 +Тело запроса: 3339 + 3340 +{ 3341 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3342 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3343 + "Features": [ 3344 + { 3345 + "Feature": "string", 3346 + "IsEnabled": true, 3347 + "IsFactual": true, 3348 + "Limit": 0, 3349 + "Price": 0, 3350 + "DebitDate": "2023-10-18T13:26:58.987Z", 3351 + "PeriodValue": 0, 3352 + "PeriodType": 0 3353 + } 3354 + ] 3355 +} 3356 + 3357 +Ответ: Success 3358 + 3359 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3360 +|ClientId|Идентификатор клиента 3361 +|Feature|Код услуги 3362 +|IsEnabled|Признак, определяющий активирована ли услуга 3363 +|IsFactual|Признак, определяющий расчёт по факту 3364 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3365 +|Price|Цена за единицу. 3366 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3367 +|PeriodValue|Значение периода. 3368 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3369 + 977 977 (% class="box" lang="en-US" style="text-align: center;" %) 978 978 ((( 979 979 (% 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]] **