Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/28 11:43
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.krainovim - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,41 +1,52 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 == Описание ГЛОНАССSoft Public API 3.0 == 3 3 4 -== == 5 5 6 -(% class="box" style="text-align: center;" %) 7 -((( 8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 9 -))) 5 +{{toc/}} 10 10 7 + 8 +=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) === 9 + 11 11 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 12 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 12 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 17 +==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ==== 22 22 23 -(% class="box infomessage" %) 24 -((( 25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 26 -))) 27 27 28 -(% style="color:#000000" %) Метод позволяетполучить токен авторизации, который необходимо добавлятьвзаголовокдляработысовсеми методами API.Впараметрах метода передается имя пользователя и пароль.20 +===== (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**(%%) ===== 29 29 30 -(% style="color:#000000" %)Метод запроса :**GET**22 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 31 31 32 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]24 +(% style="color:#000000" %)Метод запроса: **POST** 33 33 34 -(% style="color:#000000" %) В случае успешного выполнения метода,поле «AuthId» содержит токен авторизации «X-Auth».26 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 35 35 28 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 29 + 30 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 31 + 32 +(% style="color:#000000" %){ 33 + "login": "testuser", 34 + "password": "testuser" 35 +}(%%) 36 + 37 + 38 +(% style="color:#000000" %)**Ответ:** 39 + 36 36 (% lang="en-US" %) 37 -(% style="color:#000000" %) **Ответ: [{«AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**41 +(% style="color:#000000" %){ 38 38 43 +(% lang="en-US" %) 44 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 45 + "User": "testuser" , ~/~/ имя пользователя 46 + 47 +(% lang="en-US" %) 48 +} 49 + 39 39 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 40 40 41 41 ... ... @@ -44,7 +44,7 @@ 44 44 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 45 45 ))) 46 46 47 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 58 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 48 48 49 49 (% style="color:#000000" %)Метод запроса: **GET** 50 50 ... ... @@ -66,27 +66,176 @@ 66 66 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 67 67 ))) 68 68 69 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 80 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 70 70 71 71 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 72 72 73 73 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 74 74 75 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 86 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 76 76 77 77 (% style="color:#000000" %)Метод запроса: **GET** 78 78 79 79 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId> 80 80 81 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 92 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально) 82 82 83 83 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 84 84 85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ]96 +(% style="color:#000000" %)Ответ: 86 86 87 -(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 98 +(% style="color:#000000" %){ 99 + "agentId": "", ~/~/ идентификатор клиента 100 + "parentId": "", ~/~/ идентификатор клиента-родителя 101 + "name": "", ~/~/ наименование клиента 102 + "fullName": "", ~/~/ полное наименование клиента 103 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 104 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 105 +} 88 88 89 89 108 +(% class="box successmessage" %) 109 +((( 110 +**Добавление клиента — POST /api/v3/agents ** 111 +))) 112 + 113 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 114 + 115 +Метод запроса: **POST** 116 + 117 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 118 + 119 +В заголовках запроса: X-Auth: Токен авторизации 120 + 121 +Параметры в теле запроса (JSON): 122 + 123 +{ 124 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 125 + "name": "string", ~/~/ имя 126 + "fullName": "string", ~/~/ полное наименование 127 + "isForeign": true, ~/~/ иностранный контрагент 128 + "district": "string", ~/~/ округ 129 + "region": "string", ~/~/ регион 130 + "city": "string", ~/~/ город 131 + "inn": "string", ~/~/ ИНН 132 + "kpp": "string", ~/~/ КПП 133 + "address": "string", ~/~/ юридический адрес 134 + "addressFact": "string", ~/~/ фактический адрес 135 + "email": "string", ~/~/ email 136 + "director": "string", ~/~/ ФИО руководителя 137 + "bankName": "string", ~/~/ банк 138 + "bankBIK": "string", ~/~/ БИК 139 + "bankRS": "string", ~/~/ номер счёта 140 + "bankKS": "string" ~/~/ корр. счёт 141 +} 142 + 143 + 144 +Ответ: 145 + 146 +{ 147 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 148 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 149 + "name": "string", ~/~/ имя 150 + "fullName": "string", ~/~/ полное наименование 151 + "isForeign": true, ~/~/ иностранный контрагент 152 + "district": "string", ~/~/ округ 153 + "region": "string", ~/~/ регион 154 + "city": "string", ~/~/ город 155 + "inn": "string", ~/~/ ИНН 156 + "kpp": "string", ~/~/ КПП 157 + "address": "string", ~/~/ юридический адрес 158 + "addressFact": "string", ~/~/ фактический адрес 159 + "email": "string", ~/~/ email 160 + "director": "string", ~/~/ ФИО руководителя 161 + "bankName": "string", ~/~/ банк 162 + "bankBIK": "string", ~/~/ БИК 163 + "bankRS": "string", ~/~/ номер счёта 164 + "bankKS": "string" ~/~/ корр. счёт 165 +} 166 + 167 + 168 +(% class="box warningmessage" %) 169 +((( 170 +**Редактирование клиента — PUT /api/v3/agents** 171 +))) 172 + 173 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 174 + 175 +Метод запроса: **PUT** 176 + 177 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 178 + 179 +В заголовках запроса: X-Auth: Токен авторизации 180 + 181 + 182 +Параметры в теле запроса (JSON): 183 + 184 +{ 185 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 186 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 187 + "name": "string", ~/~/ имя 188 + "fullName": "string", ~/~/ полное наименование 189 + "isForeign": true, ~/~/ иностранный контрагент 190 + "district": "string", ~/~/ округ 191 + "region": "string", ~/~/ регион 192 + "city": "string", ~/~/ город 193 + "inn": "string", ~/~/ ИНН 194 + "kpp": "string", ~/~/ КПП 195 + "address": "string", ~/~/ юридический адрес 196 + "addressFact": "string", ~/~/ фактический адрес 197 + "email": "string", ~/~/ email 198 + "director": "string", ~/~/ ФИО руководителя 199 + "bankName": "string", ~/~/ банк 200 + "bankBIK": "string", ~/~/ БИК 201 + "bankRS": "string", ~/~/ номер счёта 202 + "bankKS": "string" ~/~/ корр. счёт 203 +} 204 + 205 + 206 +Ответ: 207 + 208 +{ 209 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 210 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 211 + "name": "string", ~/~/ имя 212 + "fullName": "string", ~/~/ полное наименование 213 + "isForeign": true, ~/~/ иностранный контрагент 214 + "district": "string", ~/~/ округ 215 + "region": "string", ~/~/ регион 216 + "city": "string", ~/~/ город 217 + "inn": "string", ~/~/ ИНН 218 + "kpp": "string", ~/~/ КПП 219 + "address": "string", ~/~/ юридический адрес 220 + "addressFact": "string", ~/~/ фактический адрес 221 + "email": "string", ~/~/ email 222 + "director": "string", ~/~/ ФИО руководителя 223 + "bankName": "string", ~/~/ банк 224 + "bankBIK": "string", ~/~/ БИК 225 + "bankRS": "string", ~/~/ номер счёта 226 + "bankKS": "string" ~/~/ корр. счёт 227 +} 228 + 229 + 230 +(% class="box errormessage" %) 231 +((( 232 +**Удаление клиента — DELETE /api/v3/agents/{clientId}** 233 +))) 234 + 235 + 236 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 237 + 238 +Метод запроса: **DELETE** 239 + 240 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 241 + 242 +Параметр запроса: **{clientId}** - Guid пользователя 243 + 244 +В заголовках запроса: X-Auth: Токен авторизации 245 + 246 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 247 + 248 + 249 + 90 90 (% class="box" style="text-align: center;" %) 91 91 ((( 92 92 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -97,7 +97,7 @@ 97 97 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 98 98 ))) 99 99 100 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 260 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 101 101 102 102 (% style="color:#000000" %)Метод запроса: **POST** 103 103 ... ... @@ -105,18 +105,158 @@ 105 105 106 106 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 107 107 108 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }268 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 109 109 270 +(% style="color:#000000" %){ 271 + "lastName": "", ~/~/ фамилия 272 + "firstName": "", ~/~/ имя 273 + "position": "", ~/~/ должность 274 + "phone": "", ~/~/ телефон 275 + "organization": "", ~/~/ организация 276 + "login": "", ~/~/ логин (обязателен) 277 + "password": "", ~/~/ пароль (обязателен) 278 + "email": "", ~/~/ email (обязателен) 279 + "description": "", ~/~/ описание 280 + "isEnabled": "", ~/~/ признак включения 281 + "parentId": "", ~/~/ Guid родительского агента 282 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 283 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 284 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 285 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 286 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 287 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 288 +} 289 + 110 110 (% style="text-align:left" %) 111 -(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }291 +(% style="color:#000000; font-weight:normal" %)Ответ: 112 112 293 +(% style="text-align:left" %) 294 +(% style="color:#000000; font-weight:normal" %){ 113 113 296 +(% style="text-align:left" %) 297 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 298 + "lastName": "" , ~/~/ Фамилия , 299 + "firstName": "" , ~/~/ Имя 300 + "position": "" , ~/~/ Должность 301 + "phone": "" , ~/~/ Телефон 302 + "organization": "" , ~/~/ Организация 303 + "login": "" , ~/~/ Логин 304 + "password": "" , ~/~/ Пароль 305 + "email": "" , ~/~/ Email 306 + "description": "" , ~/~/ Описание 307 + "isEnabled": "" , ~/~/ Признак включения 308 + "parentId": "" , ~/~/ Guid родительского агента 309 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 310 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 311 + "kind": "" , ~/~/ тип аутентификации 312 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 313 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 314 + 315 +(% style="text-align:left" %) 316 +(% style="color:#000000; font-weight:normal" %)} 317 + 318 + 319 +(% class="box successmessage" %) 320 +((( 321 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 322 +))) 323 + 324 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 325 + 326 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 327 + 328 +(% style="color:#000000" %)Метод запроса: **POST** 329 + 330 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 331 + 332 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 333 + 334 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 335 + 336 +(% style="color:#000000" %){ 337 + 338 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 339 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 340 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 341 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 342 + 343 +(% style="color:#000000" %)} 344 + 345 +(% style="color:#000000" %)Ответ: 346 + 347 +(% style="color:#000000" %){ (%%) 348 + 349 + "id": "" , ~/~/ идентификатор пользователя 350 + "lastName": "" , ~/~/ фамилия 351 + "firstName": "" , ~/~/ имя 352 + "position": "" , ~/~/ должность 353 + "phone": "" , ~/~/ телефон 354 + "parentId": "" , ~/~/ идентификатор клиента-родителя 355 + "parentName": "" , ~/~/ наименование клиента-родителя 356 + "organization": "" , ~/~/ организация 357 + "login": "" , ~/~/ логин 358 + "email": "" , ~/~/ E-mail 359 + "sessionDuration":"", ~/~/ длительность сессии в минутах 360 + "status": "1", ~/~/ статус пользователя 361 + "astLogged": "", ~/~/ дата/время последней авторизации 362 + 363 +(% style="color:#000000" %)} 364 + 365 + 366 +(% class="box successmessage" %) 367 +((( 368 +(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}** 369 +))) 370 + 371 +(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 372 + 373 +(% style="color:#000000" %)Метод запроса: **GET** 374 + 375 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 376 + 377 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 378 + 379 +(% style="color:#000000" %)Ответ: 380 + 381 +((( 382 +((( 383 +{ 384 + "id": "", ~/~/ GUID пользователя 385 + "lastName": "", ~/~/ Фамилия 386 + "firstName": "", ~/~/ Имя 387 + "position": "", ~/~/ Должность 388 + "phone": "", ~/~/ Номер телефона 389 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 390 + "parentName": "", Наименование клиента, которому принадлежит пользователь 391 + "organization": "", ~/~/ Организация 392 + "login": "", ~/~/ Логин пользователя 393 + "email": "", ~/~/ Адрес электронной почты 394 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 395 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 396 + "description": "", ~/~/ Описание 397 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 398 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 399 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 400 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 401 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 402 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 403 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 404 + "groups": [], ~/~/ Список ролей пользователя 405 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 406 + "authDevices": [ ], ~/~/ Список авторизованных устройств 407 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 408 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 409 +} 410 +))) 411 +))) 412 + 413 + 114 114 (% class="box warningmessage" %) 115 115 ((( 116 116 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 117 117 ))) 118 118 119 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 419 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 120 120 121 121 (% style="color:#000000" %)Метод запроса: **PUT** 122 122 ... ... @@ -124,27 +124,89 @@ 124 124 125 125 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 126 126 427 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!** 428 + 127 127 (% lang="en-US" style="text-align:left" %) 128 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } //430 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 129 129 432 +(% lang="en-US" style="text-align:left" %) 433 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 130 130 435 +(% lang="en-US" style="text-align:left" %) 436 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 437 + "lastName": "" , ~/~/ фамилия 438 + "firstName": "" , ~/~/ имя 439 + "position": "" , ~/~/ должность 440 + "phone": "" , ~/~/ телефон 441 + "organization": "" , ~/~/ организация 442 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 443 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 444 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 445 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 446 + "isEnabled": "" , ~/~/ признак включения 447 + "parentId": "" , ~/~/ Guid родительского агента 448 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 449 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 450 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 451 + "kind": "" , ~/~/ тип аутентификации 452 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 453 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 454 + 455 +(% lang="en-US" style="text-align:left" %) 456 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 457 + 458 +(% lang="en-US" style="text-align:left" %) 459 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 460 + 461 +(% lang="en-US" style="text-align:left" %) 462 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 463 + 464 +(% lang="en-US" style="text-align:left" %) 465 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 466 + "lastName": "" , ~/~/ фамилия 467 + "firstName": "" , ~/~/ имя 468 + "position": "" , ~/~/ должность 469 + "phone": "" , ~/~/ телефон 470 + "organization": "" , ~/~/ организация 471 + "login": "" , ~/~/ логин 472 + "password": "" , ~/~/ пароль 473 + "email": "" , ~/~/ email 474 + "description": "" , ~/~/ описание 475 + "isEnabled": "" , ~/~/ признак включения 476 + "parentId": "" , ~/~/ Guid родительского агента 477 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 478 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 479 + "kind": "" , ~/~/ тип аутентификации 480 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 481 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 482 + 483 +(% lang="en-US" style="text-align:left" %) 484 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 485 + 486 + 131 131 (% class="box warningmessage" %) 132 132 ((( 133 -(% style="color:#000000" %)**Измени тьстатус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**489 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 134 134 ))) 135 135 136 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя . Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).492 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 137 137 138 138 (% style="color:#000000" %)Метод запроса: **PUT** 139 139 140 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:496 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 141 141 142 -(% style="color:#000000" %) {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизацииПараметрыв телезапроса(JSON): {«status»~:// «»,//статуспользователя(0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)498 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 143 143 144 -(% class="western" %) 145 -{{{ "description": "", // описание 146 - "data": "" // данные, связанные со сменой статуса}}} 500 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 147 147 502 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 503 + 504 +(% style="color:#000000" %){ 505 + 506 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 507 + "description": "" , ~/~/ описание 508 + "data": "" , ~/~/ данные, связанные со сменой статуса 509 + 148 148 (% style="color:#000000" %)} 149 149 150 150 (% style="text-align:left" %) ... ... @@ -151,72 +151,75 @@ 151 151 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 152 152 153 153 154 -(% class="box successmessage" %)516 +(% class="box warningmessage" %) 155 155 ((( 156 -(% style="color:#000000; line-height:100%" %)** Получение списка пользователей—**(% lang="en-US" %)**POST /api/v3/users/find**518 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable** 157 157 ))) 158 158 159 - (% style="color:#000000" %)Метод позволяет получитьосновныепараметрыпользователей:логин, имя,адрес электронной почты, номертелефона,статус,идентификаторклиента-родителяипрочее.521 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 160 160 161 -(% style="color:#000000" %)Метод возвращает информацию опользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляетсяприналичииправа**«Просмотр пользователей»**.523 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 162 162 163 -(% style="color:#000000" %) Методзапроса:**POST**525 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 164 164 165 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]527 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 166 166 167 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 529 + [ 530 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 531 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 532 + ] 168 168 169 -(% class="western" %) 170 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 171 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 172 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 173 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 534 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 174 174 175 -(% style="color:#000000" %)} 176 176 177 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 178 - 179 -(% class="western" style="margin-bottom:19px" %) 180 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 181 - 182 -(% lang="en-US" style="text-align:left" %) 183 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 184 - 185 - 186 -(% class="box errormessage" %) 537 +(% class="box warningmessage" %) 187 187 ((( 188 -(% style="color:#000000; line-height:100%" %)** Удаление пользователя—**(% lang="en-US" %)**DELETE/api/v3/users/{id}**539 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable** 189 189 ))) 190 190 191 - (% style="color:#000000" %)Метод позволяетудалитьпользователя. Метод позволяетудалитьпользователя, указанного в строкезапроса(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).542 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 192 192 193 -(% style="color:#000000" %)Метод запроса: ** DELETE**544 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 194 194 195 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>> url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}546 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 196 196 197 -(% style="color:#000000" %) Параметрзапроса:{id}-Guid пользователя В заголовках запроса: X-Auth: Токенавторизации548 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 198 198 199 -(% style="text-align:left" %) 200 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 550 + [ 551 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 552 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 553 + ] 201 201 555 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 556 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 202 202 203 -(% class="box" style="text-align: center;" %) 204 204 ((( 205 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 559 +В теле ответа: 560 +{ 561 + "errorMessages": [ 562 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 563 + ], 564 + "users": [ 565 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 566 + ] 567 +} 568 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 569 +"users" - массив id пользователей, которых не удалось включить или отключить. 570 + 206 206 ))) 207 207 208 208 (% class="box errormessage" %) 209 209 ((( 210 -(% style="color:#000000; line-height:100%" %)**Удаление о бъекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**575 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 211 211 ))) 212 212 213 -(% style="color:#000000" %) Метод позволяет удалить о бъект. Метод позволяет удалить объект, указанныйв строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).578 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 214 214 215 215 (% style="color:#000000" %)Метод запроса: **DELETE** 216 216 217 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}582 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 218 218 219 -(% style="color:#000000" %)Параметр запроса: {id} - Guid о бъекта584 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 220 220 221 221 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 222 222 ... ... @@ -224,6 +224,11 @@ 224 224 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 225 225 226 226 592 +(% class="box" style="text-align: center;" %) 593 +((( 594 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 595 +))) 596 + 227 227 (% class="box infomessage" %) 228 228 ((( 229 229 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -231,43 +231,61 @@ 231 231 232 232 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 233 233 234 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 604 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 235 235 236 236 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 237 237 238 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 608 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 239 239 240 240 (% style="color:#000000" %)Метод запроса: **GET** 241 241 242 242 (% 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> 243 243 244 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 614 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 245 245 246 246 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 247 247 248 248 (% style="color:#000000" %)Ответ: 249 249 250 -(% style="color:#000000" %){ 620 +((( 621 +{ 622 + "vehicleId": "", ~/~/ ID объекта 623 + "name": "", ~/~/ Имя объекта 624 + "imei": "", ~/~/ IMEI объекта 625 + "deviceTypeId": , ~/~/ ID типа устройства 626 + "deviceTypeName": "", ~/~/ Название типа устройства 627 + "sim1": "", ~/~/ Номер SIM1 628 + "parentId": "", Номер SIM2 629 + "parentName": "", Наименование клиента-родителя 630 + "modelId": "", ID модели объекта 631 + "modelName": "", Имя модели объекта 632 + "createdAt": "", Дата создания объекта 633 + "mileageCalcMethod": "", Выбранный метод расчета пробега 634 + "counters": { ~/~/ Нормы 635 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 636 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 637 + "mileage": "", ~/~/ Пробег по нормам в метрах 638 + "motohours": "" ~/~/ Моточасы по нормам, в секундах 639 + }, 640 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 641 + { 642 + "id": "", ~/~/ ID задания 643 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 644 + "name": "", ~/~/ Наименование задания 645 + "description": "", ~/~/ Описание задания 646 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 647 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 648 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 649 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 650 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 651 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 652 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 653 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 654 + } 655 + ] 656 +} 657 +))) 251 251 252 -(% class="western" %) 253 -{{{ "vehicleId": “”, // идентификатор объекта 254 - "name": "", // имя объекта 255 - "imei": "", // IMEI объекта 256 - "deviceTypeId": “”, // идентификатор устройства объекта 257 - "deviceTypeName": "" // наименование устройства объекта 258 - "parentId": "", // идентификатор клиента-родителя 259 - "parentName": "" // наименование клиента-родителя, 260 - "modelId": "", // идентификатор модели объекта 261 - "modelName": "" // наименование модели объекта, 262 - "unitId": "", // идентификатор подразделения 263 - "unitName": "", // наименование подразделения 264 - "status": “”, // статус объекта 265 - ... 266 - }, 267 - ...}}} 268 - 269 -(% style="color:#000000" %)} 270 - 271 271 (% style="text-align:left" %) 272 272 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 273 273 ... ... @@ -280,7 +280,7 @@ 280 280 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 281 281 ))) 282 282 283 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**). 671 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 284 284 285 285 (% style="color:#000000" %)Метод запроса: **POST** 286 286 ... ... @@ -288,141 +288,130 @@ 288 288 289 289 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 290 290 291 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {679 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 292 292 293 -(% class="western" %) 294 -{{{ "parentId": "", // ID клиента 295 - "name": "", // имя ТС 296 - "imei": "", // IMEI 297 - "deviceTypeId": "",// ID типа устройства 298 - "modelId": "", 299 - "unitId": "", // ID подразделения 300 - "sim1": "", // Номер SIM 1 301 - "sim2": "", // Номер SIM2 302 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 303 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 304 - "consumptionIdle": "",// Расход топлива на холостом ходу 305 - "counters": { 306 - "mileage": "", // пробег 307 - "mileageEnabled": true, // флаг активности счётчика "пробег" 308 - "motohours":"", // моточасы 309 - "motohoursEnabled": true // флаг активности счётчика "моточасы" 310 - }, 311 - "cmsv6Parameters": { // параметры CMSv6 312 - "enabled": true, // флаг включения 313 - //"id": "", // идентификатор 314 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 315 - "login": "", // имя учетной записи 316 - "password": "" // пароль учетной записи 317 - }, 318 - "inspectionTasks": [ // задания на ТО 681 +(% style="color:#000000" %){ 682 + 683 + "parentId": "" , ~/~/ ID клиента 684 + "name": "" , ~/~/ имя ТС 685 + "imei": "" , ~/~/ IMEI 686 + "deviceTypeId": "" , ~/~/ ID типа устройства 687 + "modelId": "" , ~/~/ ID модели 688 + "unitId": "" , ~/~/ ID подразделения 689 + "sim1": "" , ~/~/ Номер SIM 1 690 + "sim2": "" , ~/~/ Номер SIM2 691 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 692 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 693 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 694 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 695 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 696 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 697 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 698 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 699 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 700 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 701 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 702 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 703 + "counters": ~/~/ счетчики 319 319 { 320 - "enabled": "", // Признак включения 321 - "name": "", // Имя задания 322 - "description": "", // Описание задания 323 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 324 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 325 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 326 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 327 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 328 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 329 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 330 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 705 + "mileage": "" , ~/~/ пробег 706 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 707 + "motohours": "" , ~/~/ моточасы 708 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 331 331 }, 332 - ]}}} 710 + "cmsv6Parameters": { ~/~/ параметры CMSv6 711 + "enabled": true, ~/~/ флаг включения 712 + "id": "" , ~/~/ идентификатор 713 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 714 + "login": "" , ~/~/ имя учетной записи 715 + "password": "" ~/~/ пароль учетной записи 716 + }, 717 + "inspectionTasks": ~/~/ задания на ТО 718 + { 719 + "enabled": "" , ~/~/ Признак включения 720 + "name": "" , ~/~/ Имя задания 721 + "description": "" , ~/~/ Описание задания 722 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 723 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 724 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 725 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 726 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 727 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 728 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 729 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 730 + } 333 333 334 -(% style="color:#000000" %) …}732 +(% style="color:#000000" %) } 335 335 336 336 (% style="color:#000000" %)Ответ: 337 337 338 338 (% style="color:#000000" %){ 339 339 340 -(% class="western" %) 341 -{{{ "vehicleId": "", //ID ТС 342 - "parentId": "", //Guid владельца ТС 343 - "name": "", //Имя объекта 344 - "imei": "", //IMEI 345 - "deviceTypeId": "", //ID типа устройства 346 - "modelId": "", //ID модели 347 - "unitId": "", //ID подразделения 348 - "sim1": "", //SIM1 349 - "sim2": "", //SIM2 350 - "consumptionPer100Km": "", //Расход топлива на 100 км 351 - "consumptionIdle": "", //Расход топлива на холостом ходу 352 - "counters": { //Счётчики 353 - "mileageEnabled": true, 354 - "motohoursEnabled": true, 355 - "mileage": "", 356 - "motohours": 345.0 357 - }, 358 - "cmsv6Parameters": { //Параметры CmsV6 359 - "id": null, 360 - "enabled": true, //флаг включения 361 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 362 - "login": "", // имя учетной записи 363 - "password": "" // пароль учетной записи 364 - }, 365 - "inspectionTasks": [ // задания на ТО 366 - { 367 - "id": "", // ID задачи 368 - "enabled": false, // Признак включения 369 - "name": "", // Имя задания 370 - "description": "", // Описание задания 371 - "mileageCondition": "", // Условие по пробегу 372 - "lastMileage": "", // Пробег (в метрах) 373 - "motohoursCondition": "", // Условие по моточасам 374 - "lastMotohours": "", // Моточасы 375 - "periodicCondition": "", // Условие периодичности по времени 376 - "kind": "", // Вид периодичности по времени 377 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 378 - } 379 - ]}}} 738 + "vehicleId": "", ~/~/ID ТС 739 + "parentId": "", ~/~/Guid владельца ТС 740 + "name": "", ~/~/Имя объекта 741 + "imei": "", ~/~/IMEI 742 + "deviceTypeId": "", ~/~/ID типа устройства 743 + "modelId": "", ~/~/ID модели 744 + "unitId": "", ~/~/ID подразделения 745 + "sim1": "", ~/~/SIM1 746 + "sim2": "", ~/~/SIM2 747 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 748 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 749 + "counters": { ~/~/Счётчики 750 + "mileageEnabled": true, 751 + "motohoursEnabled": true, 752 + "mileage": "", 753 + "motohours": 345.0 754 + }, 755 + "cmsv6Parameters": { ~/~/Параметры CmsV6 756 + "id": null, 757 + "enabled": true, ~/~/флаг включения 758 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 759 + "login": "", ~/~/ имя учетной записи 760 + "password": "" ~/~/ пароль учетной записи 761 + }, 762 + "inspectionTasks": { ~/~/ задания на ТО 763 + "id": "", ~/~/ ID задачи 764 + "enabled": false, ~/~/ Признак включения 765 + "name": "", ~/~/ Имя задания 766 + "description": "", ~/~/ Описание задания 767 + "mileageCondition": "", ~/~/ Условие по пробегу 768 + "lastMileage": "", ~/~/ Пробег (в метрах) 769 + "motohoursCondition": "", ~/~/ Условие по моточасам 770 + "lastMotohours": "", ~/~/ Моточасы 771 + "periodicCondition": "", ~/~/ Условие периодичности по времени 772 + "kind": "", ~/~/ Вид периодичности по времени 773 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 774 + } 380 380 381 381 (% style="text-align:left" %) 382 382 (% style="color:#000000" %)} 383 383 779 +**Валидация:** 780 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 781 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 782 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 384 384 385 -(% class="box warningmessage" %) 386 -((( 387 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 388 -))) 389 389 390 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 391 - 392 -(% style="color:#000000" %)Метод запроса: **PUT** 393 - 394 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 395 - 396 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 397 - 398 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 399 - 400 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 401 - 402 -(% style="color:#000000" %)Ответ: 403 - 404 -(% lang="en-US" style="text-align:left" %) 405 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 406 - 407 - 408 408 (% class="box successmessage" %) 409 409 ((( 410 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**787 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 411 411 ))) 412 412 413 413 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 414 414 415 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 792 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 416 416 417 417 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 418 418 419 419 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 420 420 421 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 798 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 422 422 423 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 800 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 424 424 425 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 802 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 426 426 427 427 (% style="color:#000000" %)Метод запроса: **POST** 428 428 ... ... @@ -430,95 +430,252 @@ 430 430 431 431 (% style="color:#000000" %)В заголовках запроса: 432 432 433 -(% style="color:#000000" %)− Content-Type: application/json 810 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 434 434 435 435 (% style="color:#000000" %)− X-Auth: Токен авторизации 436 436 437 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):814 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 438 438 439 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ ИмяТС(string,опционально)"imei":null,~/~/"710179307",##816 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 440 440 441 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 818 +{ 819 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 820 + "name": null, ~/~/ Имя ТС (string, опционально) 821 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 822 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 823 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 824 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 825 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 826 + "customFields": null ~/~/ значение любого из произвольных полей ТС 827 +} 442 442 443 -(% class="western" style="color:#000000" %)##~/~/IDтипа устройства(short,опционально)"parentId":null,~/~/IDклиента(Guid,опционально)"unitId":null##829 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 444 444 445 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}831 +(% style="color:#000000" %)Ответ: 446 446 447 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».833 +(% style="color:#000000" %){ 448 448 449 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 835 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 836 + "name": "" ~/~/ наименование объекта 837 + "imei": "" ~/~/ IMEI объекта 838 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 839 + "deviceTypeName": "" ~/~/ наименование типа устройства 840 + "sim1": "" ~/~/ первый номер телефона 841 + "sim2": "" ~/~/ второй номер телефона 842 + "parentId": "" ~/~/ идентификатор клиента-родителя 843 + "parentName": "" ~/~/ наименование клиента-родителя 844 + "modelId": "" ~/~/ идентификатор модели объекта 845 + "modelName": "" ~/~/ наименование модели объекта 846 + "unitId": "" ~/~/ идентификатор подразделения 847 + "unitName": "" ~/~/ наименование подразделения 848 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 849 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 850 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 851 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 852 + "customFields": [ 853 + { 854 + "id": "", ~/~/ идентификатор произвольного поля 855 + "name": "", ~/~/ имя произвольного поля 856 + "value": "", ~/~/ значение произвольного поля 857 + "forClient": true, ~/~/ право на отображение у клиента 858 + "forTooltip": false, ~/~/ право на отображение в подсказке 859 + "forReport": false ~/~/ право на отображение в отчетах 860 + }(%%) 861 +(% style="color:#000000" %)} 450 450 451 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:863 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 452 452 453 -(% style="color:#000000" %)0 - «Блокировка» 454 454 455 -(% style="color:#000000" %)1 - «Активен», 866 +(% class="box successmessage" %) 867 +((( 868 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 869 +))) 456 456 457 -(% style="color:#000000" %) 2-«Отменен»871 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 458 458 459 -(% style="color:#000000" %) 3 - «Оборудован»873 +(% style="color:#000000" %)Метод запроса: **POST** 460 460 461 -(% style="color:#000000" %) 4 - «Диагностика»875 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId} 462 462 463 -(% style="color:#000000" %) 5-«Сервис»877 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 464 464 465 -(% style="color:#000000" %) 6-«Демонтаж»879 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 466 466 467 -(% style="color:#000000" %) 7-«Монтаж»881 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 468 468 469 -(% style="color:#000000" %) 8 - «Дозаказ»883 +(% style="color:#000000" %){ 470 470 471 -(% style="color:#000000" %)9 - «Обслужен» 885 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 886 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 887 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 888 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 889 + "description": "", ~/~/ Описание 890 + "data": "", ~/~/ Данные 891 + "overwrite": false, ~/~/ Флаг перезаписи 892 + "stage": "", ~/~/ Состояние, может быть null 472 472 473 -(% style="color:#000000" %) 10 - «Списан»894 +(% style="color:#000000" %)} 474 474 475 -(% style="color:#000000" %) 11 - «Неисправен»896 +(% style="color:#000000" %)Ответ: 476 476 477 -(% style="color:#000000" %) 12 - «Проверен»898 +(% style="color:#000000" %){ 478 478 900 + "status": "", ~/~/ значение статуса 901 + "date": "", ~/~/ Дата смены статуса 902 + "description": "", ~/~/ Описание 903 + "data": "", ~/~/ Данные 904 + "overwrite": false, ~/~/ Флаг перезаписи 905 + "stage": "", ~/~/ Состояние 906 + 479 479 (% style="text-align:left" %) 480 -(% style="color:#000000 ; font-weight:normal" %)13-«Не эксплуатируется»908 +(% style="color:#000000" %) } 481 481 482 482 483 -(% class="box successmessage" %)911 +(% class="box warningmessage" %) 484 484 ((( 485 -(% style="color:#000000; line-height:100%" %)** Изменениестатусаобъекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**913 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 486 486 ))) 487 487 488 -(% style="color:#000000" %) Метод позволяет изменитьстатусобъекта. Метод позволяетизменитьстатусобъекта, указанногов запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).916 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 489 489 490 -(% style="color:#000000" %)Метод запроса: **P OST**918 +(% style="color:#000000" %)Метод запроса: **PUT** 491 491 492 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles /changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}920 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 493 493 494 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 495 - 496 496 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 497 497 498 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {924 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 499 499 500 -(% class="western" %) 501 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 502 - "date": "", // Дата смены статуса (null если сменить немедленно) 503 - "description": "", // Описание 504 - "data": "", // Данные 505 - "overwrite": false, // Флаг перезаписи 506 - "stage": "", // Состояние, может быть null}}} 926 +(% style="color:#000000" %){ 507 507 928 +((( 929 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 930 + "parentId": "", ~/~/ ID клиента 931 + "name": "", ~/~/ имя ТС 932 + "imei": "", ~/~/ IMEI 933 + "deviceTypeId": "", ~/~/ ID типа устройства 934 + "modelId": "", ~/~/ , ID модели 935 + "unitId": "", ~/~/ подразделения 936 + "sim1": "", ~/~/ SIM 1 937 + "sim2": "", ~/~/ SIM2 (%%) 938 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 939 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 940 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 941 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 942 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 943 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 944 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 945 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 946 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 947 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 948 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 949 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 950 +(% style="color:#000000" %) "counters": 951 + { 952 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 953 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 954 + "mileage": "", ~/~/ пробег, в метрах 955 + "motohours": "" ~/~/ моточасы, в секундах 956 + } 957 + "cmsv6Parameters": ~/~/ параметры CMSv6 958 + { 959 + "id": "", ~/~/ идентификатор 960 + "enabled": true, ~/~/ флаг включения 961 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 962 + "login": "", ~/~/ имя учетной записи 963 + "password": "", ~/~/ пароль учетной записи 964 + } 965 + "inspectionTasks": ~/~/ задания на ТО 966 + { 967 + "id": "", ~/~/ ID задания 968 + "enabled": false, ~/~/ Признак включения 969 + "name": "", ~/~/ Имя задания 970 + "description": "", ~/~/ Описание задания 971 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 972 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 973 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 974 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 975 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 976 + "kind": "", ~/~/ Вид периодичности по времени 977 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 978 + } 979 +))) 980 + 508 508 (% style="color:#000000" %)} 509 509 510 -(% style="color:#000000" %)Ответ: {983 +(% style="color:#000000" %)Ответ: 511 511 512 -(% class="western" %) 513 -{{{ "status": "", // значение статуса 514 - "date": "", // Дата смены статуса 515 - "description": "", // Описание 516 - "data": "", // Данные 517 - "overwrite": false, // Флаг перезаписи 518 - "stage": "", // Состояние}}} 985 +(% lang="en-US" style="text-align:left" %) 986 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 519 519 988 +(% lang="en-US" style="text-align:left" %) 989 + "vehicleId": "", ~/~/ ID ТС 990 + "parentId": "", ~/~/ ID клиента 991 + "name": "", ~/~/ имя ТС 992 + "imei": "", ~/~/ IMEI 993 + "deviceTypeId": "", ~/~/ типа устройства 994 + "modelId": "", ~/~/ ID модели 995 + "unitId": "", ~/~/ ID подразделения 996 + "sim1": "", ~/~/ SIM 1 997 + "sim2": "", ~/~/ SIM2 998 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 999 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1000 + "counters": 1001 + { 1002 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1003 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1004 + "mileage": "", ~/~/ пробег 1005 + "motohours": "", ~/~/ моточасы 1006 + } 1007 + "cmsv6Parameters": ~/~/ параметры CMSv6 1008 + { 1009 + "id": ~/~/ идентификатор 1010 + "enabled": true, ~/~/ флаг включения 1011 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1012 + "login": "", ~/~/ имя учетной записи 1013 + "password": "", ~/~/ пароль учетной записи 1014 + } 1015 + "inspectionTasks": ~/~/ задания на ТО 1016 + { 1017 + "id": "", ~/~/ ID задания 1018 + "enabled": false, ~/~/ Признак включения 1019 + "name": "", ~/~/ Имя задания 1020 + "description": "", ~/~/ Описание задания 1021 + "mileageCondition": "", ~/~/ Условие по пробегу 1022 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1023 + "motohoursCondition": "", ~/~/ Условие по моточасам 1024 + "lastMotohours": "", ~/~/ Моточасы 1025 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1026 + "kind": "", ~/~/ Вид периодичности по времени 1027 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1028 + } 1029 + 1030 +(% lang="en-US" style="text-align:left" %) 1031 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1032 + 1033 +**валидация:** 1034 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1035 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1036 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1037 + 1038 + 1039 +(% class="box errormessage" %) 1040 +((( 1041 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1042 +))) 1043 + 1044 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1045 + 1046 +(% style="color:#000000" %)Метод запроса: **DELETE** 1047 + 1048 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 1049 + 1050 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 1051 + 1052 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1053 + 520 520 (% style="text-align:left" %) 521 -(% style="color:#000000" %) }1055 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 522 522 523 523 524 524 (% class="box" lang="en-US" style="text-align: center;" %) ... ... @@ -531,7 +531,7 @@ 531 531 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 532 532 ))) 533 533 534 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1068 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 535 535 536 536 (% style="color:#000000" %)Метод запроса: **GET** 537 537 ... ... @@ -539,16 +539,15 @@ 539 539 540 540 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 541 541 542 -(% style="color:#000000" %)Ответ: [1076 +(% style="color:#000000" %)Ответ: 543 543 544 -(% class="western" %) 545 -{{{ { 546 - "deviceTypeId" : "", // ID типа устройства 547 - "deviceTypeName" : "" // Название типа устройства 548 - },}}} 1078 +(% style="color:#000000" %){ 549 549 1080 + "deviceTypeId" : "", ~/~/ ID типа устройства 1081 + "deviceTypeName" : "" ~/~/ Название типа устройства 1082 + 550 550 (% style="text-align:left" %) 551 -(% style="color:#000000" %) …** **]1084 +(% style="color:#000000" %)} 552 552 553 553 554 554 (% class="box" style="text-align: center;" %) ... ... @@ -561,7 +561,7 @@ 561 561 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 562 562 ))) 563 563 564 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1097 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 565 565 566 566 (% style="color:#000000" %)Метод запроса: **GET** 567 567 ... ... @@ -569,19 +569,16 @@ 569 569 570 570 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 571 571 572 -(% style="color:#000000" %)Ответ: [1105 +(% style="color:#000000" %)Ответ: 573 573 574 -(% class="western" style="margin-bottom:19px" %) 575 -{{{ {}}} 1107 +(% style="color:#000000" %){ 576 576 577 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 1109 + "id": "", ~/~/ ID типа датчика 1110 + "name": "", ~/~/ Название 1111 + "description": "", ~/~/ Описание 578 578 579 -(% class="western" %) 580 -{{{ "description": "" // Описание 581 - },}}} 582 - 583 583 (% style="text-align:left" %) 584 -(% style="color:#000000" %) … ]1114 +(% style="color:#000000" %)} 585 585 586 586 587 587 (% class="box" lang="en-US" style="text-align: center;" %)