Version 28.5 by Артем Шемяков on 2022/09/22 09:57
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
Артем Шемяков 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
Артем Шемяков 23.2 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
Артем Шемяков 8.1 330 (% class="box errormessage" %)
331 (((
Артем Шемяков 9.1 332 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
Артем Шемяков 8.1 333 )))
Андрей Калиновский 1.1 334
Артем Шемяков 23.2 335 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 336
Артем Шемяков 8.1 337 (% style="color:#000000" %)Метод запроса: **DELETE**
Андрей Калиновский 1.1 338
Артем Шемяков 8.1 339 (% 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 340
Артем Шемяков 22.5 341 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
Андрей Калиновский 1.1 342
Артем Шемяков 20.8 343 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
344
Артем Шемяков 8.1 345 (% style="text-align:left" %)
346 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
Андрей Калиновский 1.1 347
348
Артем Шемяков 8.1 349 (% class="box" style="text-align: center;" %)
350 (((
Артем Шемяков 9.1 351 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
Артем Шемяков 8.1 352 )))
Андрей Калиновский 1.1 353
Артем Шемяков 8.1 354 (% class="box infomessage" %)
355 (((
Артем Шемяков 9.1 356 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
Артем Шемяков 8.1 357 )))
Андрей Калиновский 1.1 358
Артем Шемяков 8.1 359 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
Андрей Калиновский 1.1 360
Артем Шемяков 23.2 361 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 362
Артем Шемяков 8.1 363 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
Андрей Калиновский 1.1 364
Артем Шемяков 22.5 365 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
Андрей Калиновский 1.1 366
Артем Шемяков 8.1 367 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 368
Артем Шемяков 8.1 369 (% 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 370
Артем Шемяков 22.5 371 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
Андрей Калиновский 1.1 372
Артем Шемяков 8.1 373 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 374
Артем Шемяков 8.1 375 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 376
Артем Шемяков 8.1 377 (% style="color:#000000" %){
Андрей Калиновский 1.1 378
Артем Шемяков 20.9 379 "vehicleId": "" , ~/~/ идентификатор объекта
380 "name": "" , ~/~/ имя объекта
381 "imei": "" , ~/~/ IMEI объекта
382 "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 "parentId": "" , ~/~/ идентификатор клиента-родителя
385 "parentName": "" , ~/~/ наименование клиента-родителя,
386 "modelId": "" , ~/~/ идентификатор модели объекта
387 "modelName": "" , ~/~/ наименование модели объекта,
388 "unitId": "" , ~/~/ идентификатор подразделения
389 "unitName": "" , ~/~/ наименование подразделения
390 "status": "" , ~/~/ статус объекта
Андрей Калиновский 1.1 391
Артем Шемяков 21.12 392 }
Андрей Калиновский 1.1 393
Артем Шемяков 8.1 394 (% style="text-align:left" %)
395 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
Андрей Калиновский 1.1 396
Артем Шемяков 8.1 397 (% style="text-align:left" %)
398 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
Андрей Калиновский 1.1 399
400
Артем Шемяков 8.1 401 (% class="box successmessage" %)
402 (((
Артем Шемяков 9.1 403 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
Артем Шемяков 8.1 404 )))
Андрей Калиновский 1.1 405
Артем Шемяков 23.2 406 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
Андрей Калиновский 1.1 407
Артем Шемяков 8.1 408 (% style="color:#000000" %)Метод запроса: **POST**
409
410 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
411
412 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
413
Артем Шемяков 21.2 414 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
Артем Шемяков 8.1 415
Артем Шемяков 21.2 416 (% style="color:#000000" %){
417
418 "parentId": "" , ~/~/ ID клиента
419 "name": "" , ~/~/ имя ТС
420 "imei": "" , ~/~/ IMEI
421 "deviceTypeId": "" , ~/~/ ID типа устройства
422 "modelId": "" , ~/~/ ID модели
423 "unitId": "" , ~/~/ ID подразделения
424 "sim1": "" , ~/~/ Номер SIM 1
425 "sim2": "" , ~/~/ Номер SIM2
426 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
427 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
Артем Шемяков 28.1 428 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
Артем Шемяков 28.5 429 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
430 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
431 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
432 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
433 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
434 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
435 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
436 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
437 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
Артем Шемяков 28.2 438 "counters": {
439 "mileage": "" , ~/~/ пробег
440 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
441 "motohours": "" , ~/~/ моточасы
442 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
Артем Шемяков 21.12 443 },
Артем Шемяков 21.2 444 "cmsv6Parameters": { ~/~/ параметры CMSv6
445 "enabled": true, ~/~/ флаг включения
446 "id": "" , ~/~/ идентификатор
447 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
448 "login": "" , ~/~/ имя учетной записи
449 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 450 },
Артем Шемяков 21.2 451 "inspectionTasks": ~/~/ задания на ТО
Андрей Калиновский 1.1 452 {
Артем Шемяков 21.2 453 "enabled": "" , ~/~/ Признак включения
454 "name": "" , ~/~/ Имя задания
455 "description": "" , ~/~/ Описание задания
456 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
457 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
458 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
459 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
460 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
461 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
462 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
463 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
464 }
Андрей Калиновский 1.1 465
Артем Шемяков 21.2 466 (% style="color:#000000" %) }
Андрей Калиновский 1.1 467
Артем Шемяков 8.1 468 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 469
Артем Шемяков 8.1 470 (% style="color:#000000" %){
Андрей Калиновский 1.1 471
Артем Шемяков 21.3 472 "vehicleId": "", ~/~/ID ТС 
473 "parentId": "", ~/~/Guid владельца ТС
474 "name": "", ~/~/Имя объекта
475 "imei": "", ~/~/IMEI
476 "deviceTypeId": "", ~/~/ID типа устройства
477 "modelId": "", ~/~/ID модели
478 "unitId": "", ~/~/ID подразделения
479 "sim1": "", ~/~/SIM1
480 "sim2": "", ~/~/SIM2
481 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
482 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
483 "counters": { ~/~/Счётчики
484 "mileageEnabled": true,
485 "motohoursEnabled": true,
486 "mileage": "",
487 "motohours": 345.0
Артем Шемяков 21.12 488 },
Артем Шемяков 21.3 489 "cmsv6Parameters": { ~/~/Параметры CmsV6
490 "id": null,
491 "enabled": true, ~/~/флаг включения
492 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
493 "login": "", ~/~/ имя учетной записи
494 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 495 },
Артем Шемяков 21.3 496 "inspectionTasks": { ~/~/ задания на ТО
497 "id": "", ~/~/ ID задачи
498 "enabled": false, ~/~/ Признак включения
499 "name": "", ~/~/ Имя задания
500 "description": "", ~/~/ Описание задания
501 "mileageCondition": "", ~/~/ Условие по пробегу
502 "lastMileage": "", ~/~/ Пробег (в метрах)
503 "motohoursCondition": "", ~/~/ Условие по моточасам
504 "lastMotohours": "", ~/~/ Моточасы
505 "periodicCondition": "", ~/~/ Условие периодичности по времени
506 "kind": "", ~/~/ Вид периодичности по времени 
507 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Артем Шемяков 21.12 508 }
Андрей Калиновский 1.1 509
Артем Шемяков 8.1 510 (% style="text-align:left" %)
511 (% style="color:#000000" %)}
Андрей Калиновский 1.1 512
Артем Шемяков 28.3 513 **Валидация:**
514 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
515 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
516 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Андрей Калиновский 1.1 517
Артем Шемяков 28.4 518
Артем Шемяков 8.1 519 (% class="box successmessage" %)
520 (((
Артем Шемяков 18.1 521 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
Артем Шемяков 8.1 522 )))
Андрей Калиновский 1.1 523
Артем Шемяков 8.1 524 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
Андрей Калиновский 1.1 525
Артем Шемяков 23.2 526 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 527
Артем Шемяков 8.1 528 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
Андрей Калиновский 1.1 529
Артем Шемяков 8.1 530 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
Андрей Калиновский 1.1 531
Артем Шемяков 21.7 532 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
Андрей Калиновский 1.1 533
Артем Шемяков 21.7 534 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
Андрей Калиновский 1.1 535
Артем Шемяков 21.7 536 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
Андрей Калиновский 1.1 537
Артем Шемяков 8.1 538 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 539
Артем Шемяков 8.1 540 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
Андрей Калиновский 1.1 541
Артем Шемяков 8.1 542 (% style="color:#000000" %)В заголовках запроса:
Андрей Калиновский 1.1 543
Артем Шемяков 22.6 544 (% style="color:#000000" %)− Content-Type: __**application/json**__
Андрей Калиновский 1.1 545
Артем Шемяков 8.1 546 (% style="color:#000000" %)− X-Auth: Токен авторизации
547
Артем Шемяков 22.7 548 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
Артем Шемяков 8.1 549
Артем Шемяков 22.7 550 (% style="color:#000000" %)Параметры в теле запроса (JSON):
551
Артем Шемяков 21.5 552 (% class="western" style="color:#000000" %)##{##
Артем Шемяков 8.1 553
Артем Шемяков 25.2 554 (% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
Артем Шемяков 21.5 555 "name": null, ~/~/ Имя ТС (string, опционально) 
556 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
557 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
558 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
559 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
Артем Шемяков 25.2 560 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
Артем Шемяков 21.5 561 (% style="color:#000000" %)}
Артем Шемяков 14.1 562
Артем Шемяков 22.7 563 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
Артем Шемяков 8.1 564
Артем Шемяков 21.7 565 (% style="color:#000000" %)Ответ:
Артем Шемяков 8.1 566
Артем Шемяков 21.7 567 (% style="color:#000000" %){
Артем Шемяков 8.1 568
Артем Шемяков 21.7 569 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
570 "name": "" ~/~/ наименование объекта
571 "imei": "" ~/~/ IMEI объекта
572 "deviceTypeId": "" ~/~/ идентификатор типа устройства
573 "deviceTypeName": "" ~/~/ наименование типа устройства
574 "sim1": "" ~/~/ первый номер телефона
575 "sim2": "" ~/~/ второй номер телефона
576 "parentId": "" ~/~/ идентификатор клиента-родителя
577 "parentName": "" ~/~/ наименование клиента-родителя
578 "modelId": "" ~/~/ идентификатор модели объекта
579 "modelName": "" ~/~/ наименование модели объекта
580 "unitId": "" ~/~/ идентификатор подразделения
581 "unitName": "" ~/~/ наименование подразделения
Артем Шемяков 25.1 582 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
583 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
584 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
585 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
Артем Шемяков 21.7 586 (% style="color:#000000" %)}
587
Артем Шемяков 22.7 588 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
Артем Шемяков 21.7 589
Артем Шемяков 22.7 590
Артем Шемяков 8.1 591 (% class="box successmessage" %)
592 (((
Артем Шемяков 9.1 593 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
Артем Шемяков 8.1 594 )))
595
Артем Шемяков 23.2 596 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 8.1 597
598 (% style="color:#000000" %)Метод запроса: **POST**
599
600 (% 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}
601
Артем Шемяков 22.8 602 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
Артем Шемяков 8.1 603
604 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
605
Артем Шемяков 21.8 606 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Артем Шемяков 8.1 607
Артем Шемяков 21.8 608 (% style="color:#000000" %){
Артем Шемяков 21.7 609
Артем Шемяков 21.8 610 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
611 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
612 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
613 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
614 "description": "", ~/~/ Описание
615 "data": "", ~/~/ Данные
616 "overwrite": false, ~/~/ Флаг перезаписи
617 "stage": "", ~/~/ Состояние, может быть null
Андрей Калиновский 1.1 618
Артем Шемяков 21.12 619 (% style="color:#000000" %)}
Артем Шемяков 21.7 620
Артем Шемяков 21.8 621 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 622
Артем Шемяков 21.8 623 (% style="color:#000000" %){
Андрей Калиновский 1.1 624
Артем Шемяков 21.8 625 "status": "", ~/~/ значение статуса
626 "date": "", ~/~/ Дата смены статуса 
627 "description": "", ~/~/ Описание
628 "data": "", ~/~/ Данные
629 "overwrite": false, ~/~/ Флаг перезаписи
630 "stage": "", ~/~/ Состояние
Андрей Калиновский 1.1 631
Артем Шемяков 8.1 632 (% style="text-align:left" %)
Артем Шемяков 21.12 633 (% style="color:#000000" %) }
Андрей Калиновский 1.1 634
635
Артем Шемяков 18.1 636 (% class="box warningmessage" %)
637 (((
638 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
639 )))
640
Артем Шемяков 23.2 641 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 642
643 (% style="color:#000000" %)Метод запроса: **PUT**
644
645 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
646
647 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
648
649 (% style="color:#000000" %)Параметры в теле запроса (JSON):
650
Артем Шемяков 22.2 651 (% style="color:#000000" %){    
Артем Шемяков 18.1 652
Артем Шемяков 21.10 653 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
654 "parentId": "", ~/~/ ID клиента
655 "name": "", ~/~/ имя ТС
656 "imei": "", ~/~/ IMEI
657 "deviceTypeId": "", ~/~/ ID типа устройства
658 "modelId": "", ~/~/ , ID модели    
659 "unitId": "", ~/~/ подразделения
660 "sim1": "", ~/~/ SIM 1
661 "sim2": "", ~/~/ SIM2
662 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
663 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
664 "counters": 
665 {
666 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
667 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
668 "mileage": «», пробег
669 "motohours": «» моточасы
670 }
671 "cmsv6Parameters": ~/~/ параметры CMSv6
672 {       
673 "id": "", ~/~/ идентификатор
674 "enabled": true, ~/~/ флаг включения
675 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
676 "login": "", ~/~/ имя учетной записи
677 "password": "", ~/~/ пароль учетной записи
678 }
679 "inspectionTasks": ~/~/ задания на ТО
680 {
681 "id": "", ~/~/ ID задания
682 "enabled": false, ~/~/ Признак включения
683 "name": "", ~/~/ Имя задания
684 "description": "", ~/~/ Описание задания
685 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
686 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
687 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
688 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
689 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
690 "kind": "", ~/~/ Вид периодичности по времени
691 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
Артем Шемяков 22.2 692 } 
Артем Шемяков 21.9 693
694 (% style="color:#000000" %)}
695
Артем Шемяков 18.1 696 (% style="color:#000000" %)Ответ:
697
698 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 22.2 699 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 18.1 700
Артем Шемяков 21.11 701 (% lang="en-US" style="text-align:left" %)
702 "vehicleId": "", ~/~/ ID ТС
703 "parentId": "", ~/~/ ID клиента
704 "name": "", ~/~/ имя ТС
705 "imei": "", ~/~/ IMEI
706 "deviceTypeId": "", ~/~/ типа устройства
707 "modelId": "", ~/~/ ID модели
708 "unitId": "", ~/~/ ID подразделения
709 "sim1": "", ~/~/ SIM 1
710 "sim2": "", ~/~/ SIM2
711 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
712 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
713 "counters": 
714 {
715 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
716 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
717 "mileage": "", ~/~/ пробег
718 "motohours": "", ~/~/ моточасы
719 }
720 "cmsv6Parameters": ~/~/ параметры CMSv6
721 {
722 "id": ~/~/ идентификатор
723 "enabled": true, ~/~/ флаг включения
724 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
725 "login": "", ~/~/ имя учетной записи
726 "password": "", ~/~/ пароль учетной записи
727 }
728 "inspectionTasks": ~/~/ задания на ТО
729 {
730 "id": "", ~/~/ ID задания
731 "enabled": false, ~/~/ Признак включения
732 "name": "", ~/~/ Имя задания
733 "description": "", ~/~/ Описание задания
734 "mileageCondition": "", ~/~/ Условие по пробегу
735 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
736 "motohoursCondition": "", ~/~/ Условие по моточасам
737 "lastMotohours": "", ~/~/ Моточасы
738 "periodicCondition": "", ~/~/ Условие периодичности по времени
739 "kind": "", ~/~/ Вид периодичности по времени
740 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
741 }
Артем Шемяков 18.1 742
Артем Шемяков 21.11 743 (% lang="en-US" style="text-align:left" %)
744 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
745
746
Артем Шемяков 18.1 747 (% class="box errormessage" %)
748 (((
749 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
750 )))
751
Артем Шемяков 23.2 752 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 753
754 (% style="color:#000000" %)Метод запроса: **DELETE**
755
756 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
757
Артем Шемяков 22.8 758 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
Артем Шемяков 18.1 759
760 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
761
762 (% style="text-align:left" %)
763 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
764
765
Артем Шемяков 8.1 766 (% class="box" lang="en-US" style="text-align: center;" %)
767 (((
Артем Шемяков 17.1 768 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
769 )))
770
771 (% class="box infomessage" %)
772 (((
773 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
774 )))
775
Артем Шемяков 23.2 776 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 777
778 (% style="color:#000000" %)Метод запроса: **GET**
779
780 (% 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]]
781
782 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
783
Артем Шемяков 21.12 784 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 785
Артем Шемяков 21.12 786 (% style="color:#000000" %){
Артем Шемяков 17.1 787
Артем Шемяков 21.12 788 "deviceTypeId" : "", ~/~/ ID типа устройства
789 "deviceTypeName" : "" ~/~/ Название типа устройства
790
Артем Шемяков 17.1 791 (% style="text-align:left" %)
Артем Шемяков 21.12 792 (% style="color:#000000" %)}
Артем Шемяков 17.1 793
794
795 (% class="box" style="text-align: center;" %)
796 (((
797 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
798 )))
799
800 (% class="box infomessage" %)
801 (((
802 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
803 )))
804
Артем Шемяков 23.2 805 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 806
807 (% style="color:#000000" %)Метод запроса: **GET**
808
809 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
810
811 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
812
Артем Шемяков 21.12 813 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 814
Артем Шемяков 21.12 815 (% style="color:#000000" %){
Артем Шемяков 17.1 816
Артем Шемяков 21.12 817 "id": "", ~/~/ ID типа датчика 
818 "name": "", ~/~/ Название
819 "description": "", ~/~/ Описание
Артем Шемяков 17.1 820
821 (% style="text-align:left" %)
Артем Шемяков 21.12 822 (% style="color:#000000" %)}
Артем Шемяков 17.1 823
824
825 (% class="box" lang="en-US" style="text-align: center;" %)
826 (((
Артем Шемяков 14.1 827 (% 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 828 )))

Меню

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