Version 49.1 by Илья Крайнов on 2022/11/21 11:03
Hide last authors
Артем Шемяков 9.1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
Артем Шемяков 16.2 2 == Описание ГЛОНАССSoft Public API 3.0 ==
Андрей Калиновский 1.1 3
Артем Шемяков 9.1 4 == ==
5
Илья Крайнов 48.1 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
8
9
10
Артем Шемяков 11.1 11 (% class="box" style="text-align: center;" %)
Артем Шемяков 8.1 12 (((
Артем Шемяков 12.1 13 (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
Артем Шемяков 8.1 14 )))
Андрей Калиновский 2.1 15
Артем Шемяков 8.1 16 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
17
Артем Шемяков 23.2 18 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
Артем Шемяков 8.1 19
20 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
Андрей Калиновский 3.1 21
Андрей Калиновский 1.1 22
Артем Шемяков 8.1 23 (% class="box" style="text-align: center;" %)
24 (((
Артем Шемяков 9.1 25 (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
Артем Шемяков 8.1 26 )))
Андрей Калиновский 1.1 27
Артем Шемяков 27.1 28 (% class="box successmessage" %)
Артем Шемяков 8.1 29 (((
Артем Шемяков 27.1 30 (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
Артем Шемяков 8.1 31 )))
Андрей Калиновский 1.1 32
Артем Шемяков 16.1 33 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
Андрей Калиновский 1.1 34
Артем Шемяков 27.1 35 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 36
Артем Шемяков 27.1 37 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
Андрей Калиновский 1.1 38
Артем Шемяков 28.1 39 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
Андрей Калиновский 1.1 40
Артем Шемяков 27.1 41 (% style="color:#000000" %)Параметры в теле запроса (JSON):
42
43 (% style="color:#000000" %){
44 "login": "testuser",
45 "password": "testuser"
46 }(%%)
47
48
Артем Шемяков 20.4 49 (% style="color:#000000" %)**Ответ:**
Андрей Калиновский 1.1 50
Артем Шемяков 20.4 51 (% lang="en-US" %)
52 (% style="color:#000000" %){
53
54 (% lang="en-US" %)
Артем Шемяков 27.1 55 (% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
56 "User": "testuser" , ~/~/ имя пользователя
Артем Шемяков 20.4 57
58 (% lang="en-US" %)
Артем Шемяков 21.12 59 }
Артем Шемяков 20.4 60
Артем Шемяков 16.1 61 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
Андрей Калиновский 1.1 62
Артем Шемяков 16.1 63
Артем Шемяков 8.1 64 (% class="box infomessage" %)
65 (((
Артем Шемяков 16.1 66 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
Артем Шемяков 8.1 67 )))
Андрей Калиновский 1.1 68
Артем Шемяков 23.2 69 (% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 70
Артем Шемяков 8.1 71 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 72
Артем Шемяков 16.1 73 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
Андрей Калиновский 1.1 74
Артем Шемяков 16.1 75 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 76
Артем Шемяков 8.1 77 (% lang="en-US" %)
Артем Шемяков 16.1 78 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
Андрей Калиновский 1.1 79
80
Артем Шемяков 16.2 81 (% class="box" style="text-align: center;" %)
82 (((
83 (% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
84 )))
85
86 (% class="box infomessage" %)
87 (((
88 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
89 )))
90
Артем Шемяков 23.2 91 (% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Артем Шемяков 16.2 92
93 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
94
95 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
96
Артем Шемяков 22.3 97 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
Артем Шемяков 16.2 98
99 (% style="color:#000000" %)Метод запроса: **GET**
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>
102
Артем Шемяков 22.3 103 (% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
Артем Шемяков 16.2 104
105 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
106
Артем Шемяков 20.4 107 (% style="color:#000000" %)Ответ:
Артем Шемяков 16.2 108
Артем Шемяков 20.4 109 (% style="color:#000000" %){
110 "agentId": "", ~/~/ идентификатор клиента
111 "parentId": "", ~/~/ идентификатор клиента-родителя
112 "name": "", ~/~/ наименование клиента
113 "fullName": "", ~/~/ полное наименование клиента
Артем Шемяков 22.3 114 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
Артем Шемяков 25.7 115 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
Артем Шемяков 21.12 116 }
Артем Шемяков 20.2 117
Артем Шемяков 20.4 118
Артем Шемяков 8.1 119 (% class="box" style="text-align: center;" %)
120 (((
Артем Шемяков 9.1 121 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
Артем Шемяков 8.1 122 )))
Андрей Калиновский 1.1 123
Артем Шемяков 8.1 124 (% class="box successmessage" %)
125 (((
Артем Шемяков 9.1 126 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
Артем Шемяков 8.1 127 )))
Андрей Калиновский 1.1 128
Артем Шемяков 23.2 129 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 130
Артем Шемяков 8.1 131 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 132
Артем Шемяков 8.1 133 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
Андрей Калиновский 1.1 134
Артем Шемяков 8.1 135 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 136
Артем Шемяков 20.3 137 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 138
Артем Шемяков 20.3 139 (% style="color:#000000" %){ 
Артем Шемяков 20.4 140 "lastName": "", ~/~/ фамилия
Артем Шемяков 20.3 141 "firstName": "", ~/~/ имя
142 "position": "", ~/~/ должность
143 "phone": "", ~/~/ телефон
144 "organization": "", ~/~/ организация
Илья Крайнов 40.1 145 "login": "", ~/~/ логин (обязателен)
146 "password": "", ~/~/ пароль (обязателен)
147 "email": "", ~/~/ email (обязателен)
Артем Шемяков 20.3 148 "description": "", ~/~/ описание
149 "isEnabled": "", ~/~/ признак включения
150 "parentId": "", ~/~/ Guid родительского агента
151 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
152 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
153 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
154 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
155 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
Илья Крайнов 38.1 156 "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
Артем Шемяков 21.12 157 }
Артем Шемяков 20.3 158
Артем Шемяков 8.1 159 (% style="text-align:left" %)
Артем Шемяков 20.3 160 (% style="color:#000000; font-weight:normal" %)Ответ:
Андрей Калиновский 1.1 161
Артем Шемяков 20.3 162 (% style="text-align:left" %)
Артем Шемяков 21.2 163 (% style="color:#000000; font-weight:normal" %){    
Андрей Калиновский 1.1 164
Артем Шемяков 20.3 165 (% style="text-align:left" %)
Артем Шемяков 20.4 166 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
Артем Шемяков 20.3 167 "lastName": "" , ~/~/ Фамилия ,
168 "firstName": "" , ~/~/ Имя
169 "position": "" , ~/~/ Должность
170 "phone": "" , ~/~/ Телефон
171 "organization": "" , ~/~/ Организация
172 "login": "" , ~/~/ Логин
173 "password": "" , ~/~/ Пароль
174 "email": "" , ~/~/ Email
175 "description": "" , ~/~/ Описание
176 "isEnabled": "" , ~/~/ Признак включения
177 "parentId": "" , ~/~/ Guid родительского агента
178 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
179 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
180 "kind": "" , ~/~/ тип аутентификации
181 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
Илья Крайнов 39.1 182 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
Артем Шемяков 20.3 183
184 (% style="text-align:left" %)
Артем Шемяков 21.12 185 (% style="color:#000000; font-weight:normal" %)}
Артем Шемяков 20.3 186
187
Артем Шемяков 18.1 188 (% class="box successmessage" %)
189 (((
190 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
191 )))
192
193 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
194
Артем Шемяков 23.2 195 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
Артем Шемяков 18.1 196
197 (% style="color:#000000" %)Метод запроса: **POST**
198
199 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
200
Артем Шемяков 22.5 201 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
Артем Шемяков 18.1 202
Артем Шемяков 22.5 203 (% style="color:#000000" %)Параметры в теле запроса (JSON):
204
Артем Шемяков 20.4 205 (% style="color:#000000" %){
Артем Шемяков 18.1 206
Артем Шемяков 20.4 207 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
208 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
209 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
210 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
211
Артем Шемяков 21.12 212 (% style="color:#000000" %)}
Артем Шемяков 18.1 213
Артем Шемяков 20.4 214 (% style="color:#000000" %)Ответ:
Артем Шемяков 18.1 215
Артем Шемяков 21.2 216 (% style="color:#000000" %){         (%%)
Артем Шемяков 20.4 217
Артем Шемяков 20.5 218 "id": "" , ~/~/ идентификатор пользователя
Артем Шемяков 20.4 219 "lastName": "" , ~/~/ фамилия
220 "firstName": "" , ~/~/ имя
221 "position": "" , ~/~/ должность
222 "phone": "" , ~/~/ телефон
223 "parentId": "" , ~/~/ идентификатор клиента-родителя
224 "parentName": "" , ~/~/ наименование клиента-родителя
225 "organization": "" , ~/~/ организация
226 "login": "" , ~/~/ логин
227 "email": "" , ~/~/ E-mail
Артем Шемяков 20.5 228 "sessionDuration":"", ~/~/ длительность сессии в минутах
229 "status": "1",  ~/~/ статус пользователя
230 "astLogged": "", ~/~/ дата/время последней авторизации
Артем Шемяков 20.4 231
Артем Шемяков 21.12 232 (% style="color:#000000" %)}
Артем Шемяков 20.4 233
Артем Шемяков 18.1 234
Илья Крайнов 41.1 235 (% class="box successmessage" %)
236 (((
237 (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
238 )))
239
Илья Крайнов 43.1 240 (% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
Илья Крайнов 41.1 241
242 (% style="color:#000000" %)Метод запроса: **GET**
243
244 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
245
Илья Крайнов 43.1 246 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
247
Илья Крайнов 41.1 248 (% style="color:#000000" %)Ответ:
249
250 (((
Илья Крайнов 41.2 251 (((
Илья Крайнов 41.1 252 {
253 "id": "", ~/~/ GUID пользователя
Илья Крайнов 47.1 254 "lastName": "", ~/~/ Фамилия 
Илья Крайнов 41.1 255 "firstName": "", ~/~/ Имя
256 "position": "", ~/~/ Должность
257 "phone": "", ~/~/ Номер телефона
258 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
259 "parentName": "", Наименование клиента, которому принадлежит пользователь
260 "organization": "", ~/~/ Организация
261 "login": "", ~/~/ Логин пользователя
262 "email": "", ~/~/ Адрес электронной почты
263 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
264 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
265 "description": "", ~/~/ Описание
266 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
267 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
268 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
269 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
270 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
271 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
272 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
273 "groups": [], ~/~/ Список ролей пользователя
274 "customGroups": [], ~/~/ Список клиентских ролей пользователя
275 "authDevices": [ ], ~/~/ Список авторизованных устройств
276 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
277 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
278 }
279 )))
Илья Крайнов 41.2 280 )))
Илья Крайнов 41.1 281
282
Артем Шемяков 8.1 283 (% class="box warningmessage" %)
284 (((
Артем Шемяков 9.1 285 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
Артем Шемяков 8.1 286 )))
Андрей Калиновский 1.1 287
Артем Шемяков 23.2 288 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 289
Артем Шемяков 8.1 290 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 291
Артем Шемяков 8.1 292 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
Андрей Калиновский 1.1 293
Артем Шемяков 8.1 294 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 295
Илья Крайнов 43.1 296 **При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
297
Артем Шемяков 8.1 298 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 20.6 299 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 300
Артем Шемяков 20.6 301 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.2 302 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
Андрей Калиновский 1.1 303
Артем Шемяков 20.6 304 (% lang="en-US" style="text-align:left" %)
305 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
306 "lastName": "" , ~/~/ фамилия
307 "firstName": "" , ~/~/ имя
308 "position": "" , ~/~/ должность
309 "phone": "" , ~/~/ телефон
310 "organization": "" , ~/~/ организация
Илья Крайнов 41.1 311 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
Илья Крайнов 40.1 312 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
Илья Крайнов 41.1 313 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
Илья Крайнов 40.1 314 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
Артем Шемяков 20.6 315 "isEnabled": "" , ~/~/ признак включения
316 "parentId": "" , ~/~/ Guid родительского агента
317 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
318 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
319 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
320 "kind": "" , ~/~/ тип аутентификации
321 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
322 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
323
324 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 325 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
Артем Шемяков 20.6 326
327 (% lang="en-US" style="text-align:left" %)
328 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
329
330 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 331 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 20.6 332
333 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 334 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
Артем Шемяков 20.6 335 "lastName": "" , ~/~/ фамилия
336 "firstName": "" , ~/~/ имя
337 "position": "" , ~/~/ должность
338 "phone": "" , ~/~/ телефон
339 "organization": "" , ~/~/ организация
340 "login": "" , ~/~/ логин
341 "password": "" , ~/~/ пароль 
342 "email": "" , ~/~/ email
343 "description": "" , ~/~/ описание
344 "isEnabled": "" , ~/~/ признак включения
345 "parentId": "" , ~/~/ Guid родительского агента
346 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
347 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
348 "kind": "" , ~/~/ тип аутентификации
349 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
Артем Шемяков 21.12 350 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
Артем Шемяков 20.6 351
352 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 353 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
Артем Шемяков 20.6 354
355
Артем Шемяков 8.1 356 (% class="box warningmessage" %)
357 (((
Артем Шемяков 18.1 358 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
Артем Шемяков 8.1 359 )))
Андрей Калиновский 1.1 360
Илья Крайнов 30.1 361 (% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 362
Артем Шемяков 8.1 363 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 364
Артем Шемяков 20.7 365 (% 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}
Андрей Калиновский 1.1 366
Артем Шемяков 22.4 367 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
Андрей Калиновский 1.1 368
Артем Шемяков 20.7 369 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 370
Артем Шемяков 20.7 371 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 372
Артем Шемяков 20.7 373 (% style="color:#000000" %){
374
375 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
376 "description": "" , ~/~/ описание
377 "data": "" , ~/~/ данные, связанные со сменой статуса
378
Артем Шемяков 21.12 379 (% style="color:#000000" %)}
Артем Шемяков 20.7 380
Артем Шемяков 8.1 381 (% style="text-align:left" %)
382 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Андрей Калиновский 1.1 383
384
Илья Крайнов 30.1 385 (% class="box warningmessage" %)
386 (((
387 **Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
388 )))
389
390 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
391
392 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
393
394 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
395
396 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
397
398 [ 
399 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
400 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
401 ]
402
Илья Крайнов 31.1 403 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Илья Крайнов 30.1 404
Илья Крайнов 31.1 405
Илья Крайнов 30.1 406 (% class="box warningmessage" %)
407 (((
Илья Крайнов 32.1 408 **Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
Илья Крайнов 30.1 409 )))
410
411 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
412
413 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
414
415 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
416
417 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
418
419 [ 
420 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
421 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
422 ]
423
Андрей Калиновский 33.1 424 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
425 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
Илья Крайнов 30.1 426
Илья Крайнов 41.1 427 (((
Андрей Калиновский 33.1 428 В теле ответа:
429 {
430 "errorMessages": [
431 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
432 ],
433 "users": [
434 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
435 ]
436 }
437 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
438 "users" - массив id пользователей, которых не удалось включить или отключить.
439
Илья Крайнов 41.1 440 )))
Илья Крайнов 31.1 441
Артем Шемяков 8.1 442 (% class="box errormessage" %)
443 (((
Артем Шемяков 9.1 444 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
Артем Шемяков 8.1 445 )))
Андрей Калиновский 1.1 446
Артем Шемяков 23.2 447 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 448
Артем Шемяков 8.1 449 (% style="color:#000000" %)Метод запроса: **DELETE**
Андрей Калиновский 1.1 450
Артем Шемяков 8.1 451 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
Андрей Калиновский 1.1 452
Артем Шемяков 22.5 453 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
Андрей Калиновский 1.1 454
Артем Шемяков 20.8 455 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
456
Артем Шемяков 8.1 457 (% style="text-align:left" %)
458 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
Андрей Калиновский 1.1 459
460
Артем Шемяков 8.1 461 (% class="box" style="text-align: center;" %)
462 (((
Артем Шемяков 9.1 463 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
Артем Шемяков 8.1 464 )))
Андрей Калиновский 1.1 465
Артем Шемяков 8.1 466 (% class="box infomessage" %)
467 (((
Артем Шемяков 9.1 468 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
Артем Шемяков 8.1 469 )))
Андрей Калиновский 1.1 470
Артем Шемяков 8.1 471 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
Андрей Калиновский 1.1 472
Артем Шемяков 23.2 473 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 474
Артем Шемяков 8.1 475 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
Андрей Калиновский 1.1 476
Артем Шемяков 22.5 477 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
Андрей Калиновский 1.1 478
Артем Шемяков 8.1 479 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 480
Артем Шемяков 8.1 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>
Андрей Калиновский 1.1 482
Артем Шемяков 22.5 483 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
Андрей Калиновский 1.1 484
Артем Шемяков 8.1 485 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 486
Артем Шемяков 8.1 487 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 488
Илья Крайнов 41.1 489 (((
Илья Крайнов 35.1 490 {
Илья Крайнов 36.1 491 "vehicleId": "", ~/~/ ID объекта
492 "name": "", ~/~/ Имя объекта
493 "imei": "", ~/~/ IMEI объекта
494 "deviceTypeId": , ~/~/ ID типа устройства
495 "deviceTypeName": "", ~/~/ Название типа устройства
496 "sim1": "", ~/~/ Номер SIM1
497 "parentId": "", Номер SIM2
Илья Крайнов 47.1 498 "parentName": "", Наименование клиента-родителя
Илья Крайнов 36.1 499 "modelId": "", ID модели объекта
500 "modelName": "", Имя модели объекта
501 "createdAt": "", Дата создания объекта
502 "mileageCalcMethod": "", Выбранный метод расчета пробега
503 "counters": { ~/~/ Нормы
504 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
505 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
506 "mileage": "", ~/~/ Пробег по нормам в метрах
507 "motohours": "" ~/~/ Моточасы по нормам, в секундах
Илья Крайнов 35.1 508 },
Илья Крайнов 36.1 509 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
Илья Крайнов 35.1 510 {
Илья Крайнов 47.1 511 "id": "", ~/~/ ID  задания
Илья Крайнов 37.1 512 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
Илья Крайнов 36.1 513 "name": "", ~/~/ Наименование задания
514 "description": "", ~/~/ Описание задания
515 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
516 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
517 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
518 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
519 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
520 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
521 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
522 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Илья Крайнов 35.1 523 }
524 ]
Артем Шемяков 21.12 525 }
Илья Крайнов 41.1 526 )))
Андрей Калиновский 1.1 527
Артем Шемяков 8.1 528 (% style="text-align:left" %)
529 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
Андрей Калиновский 1.1 530
Артем Шемяков 8.1 531 (% style="text-align:left" %)
532 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
Андрей Калиновский 1.1 533
534
Артем Шемяков 8.1 535 (% class="box successmessage" %)
536 (((
Артем Шемяков 9.1 537 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
Артем Шемяков 8.1 538 )))
Андрей Калиновский 1.1 539
Артем Шемяков 23.2 540 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
Андрей Калиновский 1.1 541
Артем Шемяков 8.1 542 (% style="color:#000000" %)Метод запроса: **POST**
543
544 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
545
546 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
547
Артем Шемяков 21.2 548 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
Артем Шемяков 8.1 549
Артем Шемяков 21.2 550 (% style="color:#000000" %){
551
552 "parentId": "" , ~/~/ ID клиента
553 "name": "" , ~/~/ имя ТС
554 "imei": "" , ~/~/ IMEI
555 "deviceTypeId": "" , ~/~/ ID типа устройства
556 "modelId": "" , ~/~/ ID модели
557 "unitId": "" , ~/~/ ID подразделения
558 "sim1": "" , ~/~/ Номер SIM 1
559 "sim2": "" , ~/~/ Номер SIM2
560 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
561 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
Артем Шемяков 28.1 562 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
Артем Шемяков 28.5 563 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
564 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
565 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
566 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
567 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
568 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
569 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
570 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
571 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
Артем Шемяков 28.6 572 "counters": ~/~/ счетчики
573 {
Артем Шемяков 28.2 574 "mileage": "" , ~/~/ пробег
575 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
576 "motohours": "" , ~/~/ моточасы
577 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
Артем Шемяков 21.12 578 },
Артем Шемяков 21.2 579 "cmsv6Parameters": { ~/~/ параметры CMSv6
580 "enabled": true, ~/~/ флаг включения
581 "id": "" , ~/~/ идентификатор
582 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
583 "login": "" , ~/~/ имя учетной записи
584 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 585 },
Артем Шемяков 21.2 586 "inspectionTasks": ~/~/ задания на ТО
Андрей Калиновский 1.1 587 {
Артем Шемяков 21.2 588 "enabled": "" , ~/~/ Признак включения
589 "name": "" , ~/~/ Имя задания
590 "description": "" , ~/~/ Описание задания
591 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
592 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
593 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
594 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
595 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
596 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
597 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
598 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
599 }
Андрей Калиновский 1.1 600
Артем Шемяков 21.2 601 (% style="color:#000000" %) }
Андрей Калиновский 1.1 602
Артем Шемяков 8.1 603 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 604
Артем Шемяков 8.1 605 (% style="color:#000000" %){
Андрей Калиновский 1.1 606
Артем Шемяков 21.3 607 "vehicleId": "", ~/~/ID ТС 
608 "parentId": "", ~/~/Guid владельца ТС
609 "name": "", ~/~/Имя объекта
610 "imei": "", ~/~/IMEI
611 "deviceTypeId": "", ~/~/ID типа устройства
612 "modelId": "", ~/~/ID модели
613 "unitId": "", ~/~/ID подразделения
614 "sim1": "", ~/~/SIM1
615 "sim2": "", ~/~/SIM2
616 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
617 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
618 "counters": { ~/~/Счётчики
619 "mileageEnabled": true,
620 "motohoursEnabled": true,
621 "mileage": "",
622 "motohours": 345.0
Артем Шемяков 21.12 623 },
Артем Шемяков 21.3 624 "cmsv6Parameters": { ~/~/Параметры CmsV6
625 "id": null,
626 "enabled": true, ~/~/флаг включения
627 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
628 "login": "", ~/~/ имя учетной записи
629 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 630 },
Артем Шемяков 21.3 631 "inspectionTasks": { ~/~/ задания на ТО
632 "id": "", ~/~/ ID задачи
633 "enabled": false, ~/~/ Признак включения
634 "name": "", ~/~/ Имя задания
635 "description": "", ~/~/ Описание задания
636 "mileageCondition": "", ~/~/ Условие по пробегу
637 "lastMileage": "", ~/~/ Пробег (в метрах)
638 "motohoursCondition": "", ~/~/ Условие по моточасам
639 "lastMotohours": "", ~/~/ Моточасы
640 "periodicCondition": "", ~/~/ Условие периодичности по времени
641 "kind": "", ~/~/ Вид периодичности по времени 
642 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Артем Шемяков 21.12 643 }
Андрей Калиновский 1.1 644
Артем Шемяков 8.1 645 (% style="text-align:left" %)
646 (% style="color:#000000" %)}
Андрей Калиновский 1.1 647
Артем Шемяков 28.3 648 **Валидация:**
649 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
650 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
651 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Андрей Калиновский 1.1 652
Артем Шемяков 28.4 653
Артем Шемяков 8.1 654 (% class="box successmessage" %)
655 (((
Артем Шемяков 18.1 656 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
Артем Шемяков 8.1 657 )))
Андрей Калиновский 1.1 658
Артем Шемяков 8.1 659 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
Андрей Калиновский 1.1 660
Артем Шемяков 23.2 661 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 662
Артем Шемяков 8.1 663 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
Андрей Калиновский 1.1 664
Артем Шемяков 8.1 665 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
Андрей Калиновский 1.1 666
Артем Шемяков 21.7 667 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
Андрей Калиновский 1.1 668
Артем Шемяков 21.7 669 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
Андрей Калиновский 1.1 670
Артем Шемяков 21.7 671 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
Андрей Калиновский 1.1 672
Артем Шемяков 8.1 673 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 674
Артем Шемяков 8.1 675 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
Андрей Калиновский 1.1 676
Артем Шемяков 8.1 677 (% style="color:#000000" %)В заголовках запроса:
Андрей Калиновский 1.1 678
Артем Шемяков 22.6 679 (% style="color:#000000" %)− Content-Type: __**application/json**__
Андрей Калиновский 1.1 680
Артем Шемяков 8.1 681 (% style="color:#000000" %)− X-Auth: Токен авторизации
682
Артем Шемяков 22.7 683 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
Артем Шемяков 8.1 684
Артем Шемяков 22.7 685 (% style="color:#000000" %)Параметры в теле запроса (JSON):
686
Илья Крайнов 45.1 687 {
688 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
Илья Крайнов 44.1 689 "name": null, ~/~/ Имя ТС (string, опционально)
690 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
691 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
692 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
693 "parentId": null, ~/~/ ID клиента (Guid, опционально)
Илья Крайнов 47.1 694 "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
Илья Крайнов 46.1 695 "customFields": null ~/~/ значение любого из произвольных полей ТС
Илья Крайнов 45.1 696 }
Илья Крайнов 44.1 697
Артем Шемяков 22.7 698 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
Артем Шемяков 8.1 699
Артем Шемяков 21.7 700 (% style="color:#000000" %)Ответ:
Артем Шемяков 8.1 701
Артем Шемяков 21.7 702 (% style="color:#000000" %){
Артем Шемяков 8.1 703
Артем Шемяков 21.7 704 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
705 "name": "" ~/~/ наименование объекта
706 "imei": "" ~/~/ IMEI объекта
707 "deviceTypeId": "" ~/~/ идентификатор типа устройства
708 "deviceTypeName": "" ~/~/ наименование типа устройства
709 "sim1": "" ~/~/ первый номер телефона
710 "sim2": "" ~/~/ второй номер телефона
711 "parentId": "" ~/~/ идентификатор клиента-родителя
712 "parentName": "" ~/~/ наименование клиента-родителя
713 "modelId": "" ~/~/ идентификатор модели объекта
714 "modelName": "" ~/~/ наименование модели объекта
715 "unitId": "" ~/~/ идентификатор подразделения
716 "unitName": "" ~/~/ наименование подразделения
Артем Шемяков 25.1 717 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
718 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
719 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
Илья Крайнов 49.1 720 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
721 "customFields": [ 
722 {
723 "id": "", ~/~/ идентификатор произвольного поля
724 "name": "", ~/~/ имя произвольного поля
725 "value": "", ~/~/ значение произвольного поля
726 "forClient": true, ~/~/ право на отображение у клиента
727 "forTooltip": false, ~/~/ право на отображение в подсказке
728 "forReport": false ~/~/ право на отображение в отчетах
729 }(%%)
Артем Шемяков 21.7 730 (% style="color:#000000" %)}
731
Артем Шемяков 22.7 732 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
Артем Шемяков 21.7 733
Артем Шемяков 22.7 734
Артем Шемяков 8.1 735 (% class="box successmessage" %)
736 (((
Артем Шемяков 9.1 737 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
Артем Шемяков 8.1 738 )))
739
Артем Шемяков 23.2 740 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 8.1 741
742 (% style="color:#000000" %)Метод запроса: **POST**
743
744 (% 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}
745
Артем Шемяков 22.8 746 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
Артем Шемяков 8.1 747
748 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
749
Артем Шемяков 21.8 750 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Артем Шемяков 8.1 751
Артем Шемяков 21.8 752 (% style="color:#000000" %){
Артем Шемяков 21.7 753
Артем Шемяков 21.8 754 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
755 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
756 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
757 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
758 "description": "", ~/~/ Описание
759 "data": "", ~/~/ Данные
760 "overwrite": false, ~/~/ Флаг перезаписи
761 "stage": "", ~/~/ Состояние, может быть null
Андрей Калиновский 1.1 762
Артем Шемяков 21.12 763 (% style="color:#000000" %)}
Артем Шемяков 21.7 764
Артем Шемяков 21.8 765 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 766
Артем Шемяков 21.8 767 (% style="color:#000000" %){
Андрей Калиновский 1.1 768
Артем Шемяков 21.8 769 "status": "", ~/~/ значение статуса
770 "date": "", ~/~/ Дата смены статуса 
771 "description": "", ~/~/ Описание
772 "data": "", ~/~/ Данные
773 "overwrite": false, ~/~/ Флаг перезаписи
774 "stage": "", ~/~/ Состояние
Андрей Калиновский 1.1 775
Артем Шемяков 8.1 776 (% style="text-align:left" %)
Артем Шемяков 21.12 777 (% style="color:#000000" %) }
Андрей Калиновский 1.1 778
779
Артем Шемяков 18.1 780 (% class="box warningmessage" %)
781 (((
782 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
783 )))
784
Артем Шемяков 23.2 785 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 786
787 (% style="color:#000000" %)Метод запроса: **PUT**
788
789 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
790
791 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
792
793 (% style="color:#000000" %)Параметры в теле запроса (JSON):
794
Артем Шемяков 22.2 795 (% style="color:#000000" %){    
Артем Шемяков 18.1 796
Артем Шемяков 28.8 797 (((
Артем Шемяков 21.10 798 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
799 "parentId": "", ~/~/ ID клиента
800 "name": "", ~/~/ имя ТС
801 "imei": "", ~/~/ IMEI
802 "deviceTypeId": "", ~/~/ ID типа устройства
803 "modelId": "", ~/~/ , ID модели    
804 "unitId": "", ~/~/ подразделения
805 "sim1": "", ~/~/ SIM 1
Илья Крайнов 30.1 806 "sim2": "", ~/~/ SIM2     (%%)
Артем Шемяков 28.6 807 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
808 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
809 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
810 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
811 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
812 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
813 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
814 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
815 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
816 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
817 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
818 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
819 (% style="color:#000000" %) "counters": 
Артем Шемяков 21.10 820 {
821 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
822 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
Илья Крайнов 34.1 823 "mileage": "", ~/~/ пробег, в метрах 
824 "motohours": "" ~/~/ моточасы, в секундах
Артем Шемяков 21.10 825 }
826 "cmsv6Parameters": ~/~/ параметры CMSv6
827 {       
828 "id": "", ~/~/ идентификатор
829 "enabled": true, ~/~/ флаг включения
830 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
831 "login": "", ~/~/ имя учетной записи
832 "password": "", ~/~/ пароль учетной записи
833 }
834 "inspectionTasks": ~/~/ задания на ТО
835 {
836 "id": "", ~/~/ ID задания
837 "enabled": false, ~/~/ Признак включения
838 "name": "", ~/~/ Имя задания
839 "description": "", ~/~/ Описание задания
840 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
841 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
842 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
843 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
844 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
845 "kind": "", ~/~/ Вид периодичности по времени
846 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
Артем Шемяков 22.2 847 } 
Артем Шемяков 28.8 848 )))
Артем Шемяков 21.9 849
850 (% style="color:#000000" %)}
851
Артем Шемяков 18.1 852 (% style="color:#000000" %)Ответ:
853
854 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 22.2 855 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 18.1 856
Артем Шемяков 21.11 857 (% lang="en-US" style="text-align:left" %)
858 "vehicleId": "", ~/~/ ID ТС
859 "parentId": "", ~/~/ ID клиента
860 "name": "", ~/~/ имя ТС
861 "imei": "", ~/~/ IMEI
862 "deviceTypeId": "", ~/~/ типа устройства
863 "modelId": "", ~/~/ ID модели
864 "unitId": "", ~/~/ ID подразделения
865 "sim1": "", ~/~/ SIM 1
866 "sim2": "", ~/~/ SIM2
867 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
868 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
869 "counters": 
870 {
871 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
872 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
873 "mileage": "", ~/~/ пробег
874 "motohours": "", ~/~/ моточасы
875 }
876 "cmsv6Parameters": ~/~/ параметры CMSv6
877 {
878 "id": ~/~/ идентификатор
879 "enabled": true, ~/~/ флаг включения
880 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
881 "login": "", ~/~/ имя учетной записи
882 "password": "", ~/~/ пароль учетной записи
883 }
884 "inspectionTasks": ~/~/ задания на ТО
885 {
886 "id": "", ~/~/ ID задания
887 "enabled": false, ~/~/ Признак включения
888 "name": "", ~/~/ Имя задания
889 "description": "", ~/~/ Описание задания
890 "mileageCondition": "", ~/~/ Условие по пробегу
891 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
892 "motohoursCondition": "", ~/~/ Условие по моточасам
893 "lastMotohours": "", ~/~/ Моточасы
894 "periodicCondition": "", ~/~/ Условие периодичности по времени
895 "kind": "", ~/~/ Вид периодичности по времени
896 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
897 }
Артем Шемяков 18.1 898
Артем Шемяков 21.11 899 (% lang="en-US" style="text-align:left" %)
900 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
901
Артем Шемяков 28.7 902 **валидация:**
903 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
904 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
905 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Артем Шемяков 21.11 906
Артем Шемяков 28.7 907
Артем Шемяков 18.1 908 (% class="box errormessage" %)
909 (((
910 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
911 )))
912
Артем Шемяков 23.2 913 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 914
915 (% style="color:#000000" %)Метод запроса: **DELETE**
916
917 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
918
Артем Шемяков 22.8 919 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
Артем Шемяков 18.1 920
921 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
922
923 (% style="text-align:left" %)
924 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
925
926
Артем Шемяков 8.1 927 (% class="box" lang="en-US" style="text-align: center;" %)
928 (((
Артем Шемяков 17.1 929 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
930 )))
931
932 (% class="box infomessage" %)
933 (((
934 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
935 )))
936
Артем Шемяков 23.2 937 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 938
939 (% style="color:#000000" %)Метод запроса: **GET**
940
941 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
942
943 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
944
Артем Шемяков 21.12 945 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 946
Артем Шемяков 21.12 947 (% style="color:#000000" %){
Артем Шемяков 17.1 948
Артем Шемяков 21.12 949 "deviceTypeId" : "", ~/~/ ID типа устройства
950 "deviceTypeName" : "" ~/~/ Название типа устройства
951
Артем Шемяков 17.1 952 (% style="text-align:left" %)
Артем Шемяков 21.12 953 (% style="color:#000000" %)}
Артем Шемяков 17.1 954
955
956 (% class="box" style="text-align: center;" %)
957 (((
958 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
959 )))
960
961 (% class="box infomessage" %)
962 (((
963 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
964 )))
965
Артем Шемяков 23.2 966 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 967
968 (% style="color:#000000" %)Метод запроса: **GET**
969
970 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
971
972 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
973
Артем Шемяков 21.12 974 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 975
Артем Шемяков 21.12 976 (% style="color:#000000" %){
Артем Шемяков 17.1 977
Артем Шемяков 21.12 978 "id": "", ~/~/ ID типа датчика 
979 "name": "", ~/~/ Название
980 "description": "", ~/~/ Описание
Артем Шемяков 17.1 981
982 (% style="text-align:left" %)
Артем Шемяков 21.12 983 (% style="color:#000000" %)}
Артем Шемяков 17.1 984
985
986 (% class="box" lang="en-US" style="text-align: center;" %)
987 (((
Артем Шемяков 14.1 988 (% 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]] **
Артем Шемяков 8.1 989 )))

Меню

ГЛОНАССSoft wiki - 2024 г.