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

Меню

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