Версия 36.1 от Илья Крайнов на 2022/11/17 13:35
Скрыть последних авторов
Артем Шемяков 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
Илья Крайнов 31.1 348 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Илья Крайнов 30.1 349
Илья Крайнов 31.1 350
Илья Крайнов 30.1 351 (% class="box warningmessage" %)
352 (((
Илья Крайнов 32.1 353 **Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
Илья Крайнов 30.1 354 )))
355
356 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
357
358 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
359
360 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
361
362 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
363
364 [ 
365 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
366 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
367 ]
368
Андрей Калиновский 33.1 369 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
Илья Крайнов 30.1 371
Андрей Калиновский 33.1 372 В теле ответа:
373 {
374 "errorMessages": [
375 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
376 ],
377 "users": [
378 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
379 ]
380 }
381 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 "users" - массив id пользователей, которых не удалось включить или отключить.
383
Илья Крайнов 31.1 384
Артем Шемяков 8.1 385 (% class="box errormessage" %)
386 (((
Артем Шемяков 9.1 387 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
Артем Шемяков 8.1 388 )))
Андрей Калиновский 1.1 389
Артем Шемяков 23.2 390 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 391
Артем Шемяков 8.1 392 (% style="color:#000000" %)Метод запроса: **DELETE**
Андрей Калиновский 1.1 393
Артем Шемяков 8.1 394 (% 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 395
Артем Шемяков 22.5 396 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
Андрей Калиновский 1.1 397
Артем Шемяков 20.8 398 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
399
Артем Шемяков 8.1 400 (% style="text-align:left" %)
401 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
Андрей Калиновский 1.1 402
403
Артем Шемяков 8.1 404 (% class="box" style="text-align: center;" %)
405 (((
Артем Шемяков 9.1 406 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
Артем Шемяков 8.1 407 )))
Андрей Калиновский 1.1 408
Артем Шемяков 8.1 409 (% class="box infomessage" %)
410 (((
Артем Шемяков 9.1 411 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
Артем Шемяков 8.1 412 )))
Андрей Калиновский 1.1 413
Артем Шемяков 8.1 414 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
Андрей Калиновский 1.1 415
Артем Шемяков 23.2 416 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 417
Артем Шемяков 8.1 418 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
Андрей Калиновский 1.1 419
Артем Шемяков 22.5 420 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
Андрей Калиновский 1.1 421
Артем Шемяков 8.1 422 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 423
Артем Шемяков 8.1 424 (% 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 425
Артем Шемяков 22.5 426 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
Андрей Калиновский 1.1 427
Артем Шемяков 8.1 428 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 429
Артем Шемяков 8.1 430 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 431
Илья Крайнов 35.1 432 {
Андрей Калиновский 1.1 433
Илья Крайнов 36.1 434 "vehicleId": "", ~/~/ ID объекта
Андрей Калиновский 1.1 435
Илья Крайнов 36.1 436 "name": "", ~/~/ Имя объекта
Илья Крайнов 35.1 437
Илья Крайнов 36.1 438 "imei": "", ~/~/ IMEI объекта
Илья Крайнов 35.1 439
Илья Крайнов 36.1 440 "deviceTypeId": , ~/~/ ID типа устройства
Илья Крайнов 35.1 441
Илья Крайнов 36.1 442 "deviceTypeName": "", ~/~/ Название типа устройства
Илья Крайнов 35.1 443
Илья Крайнов 36.1 444 "sim1": "", ~/~/ Номер SIM1
Илья Крайнов 35.1 445
Илья Крайнов 36.1 446 "parentId": "", Номер SIM2
Илья Крайнов 35.1 447
Илья Крайнов 36.1 448 "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
Илья Крайнов 35.1 449
Илья Крайнов 36.1 450 "modelId": "", ID модели объекта
Илья Крайнов 35.1 451
Илья Крайнов 36.1 452 "modelName": "", Имя модели объекта
Илья Крайнов 35.1 453
Илья Крайнов 36.1 454 "createdAt": "", Дата создания объекта
Илья Крайнов 35.1 455
Илья Крайнов 36.1 456 "mileageCalcMethod": "", Выбранный метод расчета пробега
Илья Крайнов 35.1 457
Илья Крайнов 36.1 458 "counters": { ~/~/ Нормы
Илья Крайнов 35.1 459
Илья Крайнов 36.1 460 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
Илья Крайнов 35.1 461
Илья Крайнов 36.1 462 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
Илья Крайнов 35.1 463
Илья Крайнов 36.1 464 "mileage": "", ~/~/ Пробег по нормам в метрах
Илья Крайнов 35.1 465
Илья Крайнов 36.1 466 "motohours": "" ~/~/ Моточасы по нормам, в секундах
Илья Крайнов 35.1 467
468 },
469
Илья Крайнов 36.1 470 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
Илья Крайнов 35.1 471
472 {
473
Илья Крайнов 36.1 474 "id": "", ~/~/ ID  задания
Илья Крайнов 35.1 475
Илья Крайнов 36.1 476 "enabled": "", ~/~/ Флаг активности задания
Илья Крайнов 35.1 477
Илья Крайнов 36.1 478 "name": "", ~/~/ Наименование задания
Илья Крайнов 35.1 479
Илья Крайнов 36.1 480 "description": "", ~/~/ Описание задания
Илья Крайнов 35.1 481
Илья Крайнов 36.1 482 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
Илья Крайнов 35.1 483
Илья Крайнов 36.1 484 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
Илья Крайнов 35.1 485
Илья Крайнов 36.1 486 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
Илья Крайнов 35.1 487
Илья Крайнов 36.1 488 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
Илья Крайнов 35.1 489
Илья Крайнов 36.1 490 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
Илья Крайнов 35.1 491
Илья Крайнов 36.1 492 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
Илья Крайнов 35.1 493
Илья Крайнов 36.1 494 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
Илья Крайнов 35.1 495
Илья Крайнов 36.1 496 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497
Илья Крайнов 35.1 498 }
499
500 ]
501
Артем Шемяков 21.12 502 }
Андрей Калиновский 1.1 503
Артем Шемяков 8.1 504 (% style="text-align:left" %)
505 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
Андрей Калиновский 1.1 506
Артем Шемяков 8.1 507 (% style="text-align:left" %)
508 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
Андрей Калиновский 1.1 509
510
Артем Шемяков 8.1 511 (% class="box successmessage" %)
512 (((
Артем Шемяков 9.1 513 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
Артем Шемяков 8.1 514 )))
Андрей Калиновский 1.1 515
Артем Шемяков 23.2 516 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
Андрей Калиновский 1.1 517
Артем Шемяков 8.1 518 (% style="color:#000000" %)Метод запроса: **POST**
519
520 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
521
522 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
523
Артем Шемяков 21.2 524 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
Артем Шемяков 8.1 525
Артем Шемяков 21.2 526 (% style="color:#000000" %){
527
528 "parentId": "" , ~/~/ ID клиента
529 "name": "" , ~/~/ имя ТС
530 "imei": "" , ~/~/ IMEI
531 "deviceTypeId": "" , ~/~/ ID типа устройства
532 "modelId": "" , ~/~/ ID модели
533 "unitId": "" , ~/~/ ID подразделения
534 "sim1": "" , ~/~/ Номер SIM 1
535 "sim2": "" , ~/~/ Номер SIM2
536 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
537 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
Артем Шемяков 28.1 538 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
Артем Шемяков 28.5 539 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
540 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
541 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
542 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
543 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
544 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
545 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
546 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
547 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
Артем Шемяков 28.6 548 "counters": ~/~/ счетчики
549 {
Артем Шемяков 28.2 550 "mileage": "" , ~/~/ пробег
551 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
552 "motohours": "" , ~/~/ моточасы
553 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
Артем Шемяков 21.12 554 },
Артем Шемяков 21.2 555 "cmsv6Parameters": { ~/~/ параметры CMSv6
556 "enabled": true, ~/~/ флаг включения
557 "id": "" , ~/~/ идентификатор
558 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
559 "login": "" , ~/~/ имя учетной записи
560 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 561 },
Артем Шемяков 21.2 562 "inspectionTasks": ~/~/ задания на ТО
Андрей Калиновский 1.1 563 {
Артем Шемяков 21.2 564 "enabled": "" , ~/~/ Признак включения
565 "name": "" , ~/~/ Имя задания
566 "description": "" , ~/~/ Описание задания
567 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
568 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
569 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
570 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
571 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
572 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
573 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
574 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
575 }
Андрей Калиновский 1.1 576
Артем Шемяков 21.2 577 (% style="color:#000000" %) }
Андрей Калиновский 1.1 578
Артем Шемяков 8.1 579 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 580
Артем Шемяков 8.1 581 (% style="color:#000000" %){
Андрей Калиновский 1.1 582
Артем Шемяков 21.3 583 "vehicleId": "", ~/~/ID ТС 
584 "parentId": "", ~/~/Guid владельца ТС
585 "name": "", ~/~/Имя объекта
586 "imei": "", ~/~/IMEI
587 "deviceTypeId": "", ~/~/ID типа устройства
588 "modelId": "", ~/~/ID модели
589 "unitId": "", ~/~/ID подразделения
590 "sim1": "", ~/~/SIM1
591 "sim2": "", ~/~/SIM2
592 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
593 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
594 "counters": { ~/~/Счётчики
595 "mileageEnabled": true,
596 "motohoursEnabled": true,
597 "mileage": "",
598 "motohours": 345.0
Артем Шемяков 21.12 599 },
Артем Шемяков 21.3 600 "cmsv6Parameters": { ~/~/Параметры CmsV6
601 "id": null,
602 "enabled": true, ~/~/флаг включения
603 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
604 "login": "", ~/~/ имя учетной записи
605 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 606 },
Артем Шемяков 21.3 607 "inspectionTasks": { ~/~/ задания на ТО
608 "id": "", ~/~/ ID задачи
609 "enabled": false, ~/~/ Признак включения
610 "name": "", ~/~/ Имя задания
611 "description": "", ~/~/ Описание задания
612 "mileageCondition": "", ~/~/ Условие по пробегу
613 "lastMileage": "", ~/~/ Пробег (в метрах)
614 "motohoursCondition": "", ~/~/ Условие по моточасам
615 "lastMotohours": "", ~/~/ Моточасы
616 "periodicCondition": "", ~/~/ Условие периодичности по времени
617 "kind": "", ~/~/ Вид периодичности по времени 
618 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Артем Шемяков 21.12 619 }
Андрей Калиновский 1.1 620
Артем Шемяков 8.1 621 (% style="text-align:left" %)
622 (% style="color:#000000" %)}
Андрей Калиновский 1.1 623
Артем Шемяков 28.3 624 **Валидация:**
625 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
626 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
627 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Андрей Калиновский 1.1 628
Артем Шемяков 28.4 629
Артем Шемяков 8.1 630 (% class="box successmessage" %)
631 (((
Артем Шемяков 18.1 632 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
Артем Шемяков 8.1 633 )))
Андрей Калиновский 1.1 634
Артем Шемяков 8.1 635 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
Андрей Калиновский 1.1 636
Артем Шемяков 23.2 637 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 638
Артем Шемяков 8.1 639 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
Андрей Калиновский 1.1 640
Артем Шемяков 8.1 641 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
Андрей Калиновский 1.1 642
Артем Шемяков 21.7 643 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
Андрей Калиновский 1.1 644
Артем Шемяков 21.7 645 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
Андрей Калиновский 1.1 646
Артем Шемяков 21.7 647 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
Андрей Калиновский 1.1 648
Артем Шемяков 8.1 649 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 650
Артем Шемяков 8.1 651 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
Андрей Калиновский 1.1 652
Артем Шемяков 8.1 653 (% style="color:#000000" %)В заголовках запроса:
Андрей Калиновский 1.1 654
Артем Шемяков 22.6 655 (% style="color:#000000" %)− Content-Type: __**application/json**__
Андрей Калиновский 1.1 656
Артем Шемяков 8.1 657 (% style="color:#000000" %)− X-Auth: Токен авторизации
658
Артем Шемяков 22.7 659 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
Артем Шемяков 8.1 660
Артем Шемяков 22.7 661 (% style="color:#000000" %)Параметры в теле запроса (JSON):
662
Артем Шемяков 21.5 663 (% class="western" style="color:#000000" %)##{##
Артем Шемяков 8.1 664
Артем Шемяков 25.2 665 (% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
Артем Шемяков 21.5 666 "name": null, ~/~/ Имя ТС (string, опционально) 
667 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
Артем Шемяков 25.2 671 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
Артем Шемяков 21.5 672 (% style="color:#000000" %)}
Артем Шемяков 14.1 673
Артем Шемяков 22.7 674 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
Артем Шемяков 8.1 675
Артем Шемяков 21.7 676 (% style="color:#000000" %)Ответ:
Артем Шемяков 8.1 677
Артем Шемяков 21.7 678 (% style="color:#000000" %){
Артем Шемяков 8.1 679
Артем Шемяков 21.7 680 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
681 "name": "" ~/~/ наименование объекта
682 "imei": "" ~/~/ IMEI объекта
683 "deviceTypeId": "" ~/~/ идентификатор типа устройства
684 "deviceTypeName": "" ~/~/ наименование типа устройства
685 "sim1": "" ~/~/ первый номер телефона
686 "sim2": "" ~/~/ второй номер телефона
687 "parentId": "" ~/~/ идентификатор клиента-родителя
688 "parentName": "" ~/~/ наименование клиента-родителя
689 "modelId": "" ~/~/ идентификатор модели объекта
690 "modelName": "" ~/~/ наименование модели объекта
691 "unitId": "" ~/~/ идентификатор подразделения
692 "unitName": "" ~/~/ наименование подразделения
Артем Шемяков 25.1 693 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
694 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
695 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
696 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
Артем Шемяков 21.7 697 (% style="color:#000000" %)}
698
Артем Шемяков 22.7 699 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
Артем Шемяков 21.7 700
Артем Шемяков 22.7 701
Артем Шемяков 8.1 702 (% class="box successmessage" %)
703 (((
Артем Шемяков 9.1 704 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
Артем Шемяков 8.1 705 )))
706
Артем Шемяков 23.2 707 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 8.1 708
709 (% style="color:#000000" %)Метод запроса: **POST**
710
711 (% 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}
712
Артем Шемяков 22.8 713 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
Артем Шемяков 8.1 714
715 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
716
Артем Шемяков 21.8 717 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Артем Шемяков 8.1 718
Артем Шемяков 21.8 719 (% style="color:#000000" %){
Артем Шемяков 21.7 720
Артем Шемяков 21.8 721 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
722 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
723 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
724 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
725 "description": "", ~/~/ Описание
726 "data": "", ~/~/ Данные
727 "overwrite": false, ~/~/ Флаг перезаписи
728 "stage": "", ~/~/ Состояние, может быть null
Андрей Калиновский 1.1 729
Артем Шемяков 21.12 730 (% style="color:#000000" %)}
Артем Шемяков 21.7 731
Артем Шемяков 21.8 732 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 733
Артем Шемяков 21.8 734 (% style="color:#000000" %){
Андрей Калиновский 1.1 735
Артем Шемяков 21.8 736 "status": "", ~/~/ значение статуса
737 "date": "", ~/~/ Дата смены статуса 
738 "description": "", ~/~/ Описание
739 "data": "", ~/~/ Данные
740 "overwrite": false, ~/~/ Флаг перезаписи
741 "stage": "", ~/~/ Состояние
Андрей Калиновский 1.1 742
Артем Шемяков 8.1 743 (% style="text-align:left" %)
Артем Шемяков 21.12 744 (% style="color:#000000" %) }
Андрей Калиновский 1.1 745
746
Артем Шемяков 18.1 747 (% class="box warningmessage" %)
748 (((
749 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
750 )))
751
Артем Шемяков 23.2 752 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 753
754 (% style="color:#000000" %)Метод запроса: **PUT**
755
756 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
757
758 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
759
760 (% style="color:#000000" %)Параметры в теле запроса (JSON):
761
Артем Шемяков 22.2 762 (% style="color:#000000" %){    
Артем Шемяков 18.1 763
Артем Шемяков 28.8 764 (((
Артем Шемяков 21.10 765 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
766 "parentId": "", ~/~/ ID клиента
767 "name": "", ~/~/ имя ТС
768 "imei": "", ~/~/ IMEI
769 "deviceTypeId": "", ~/~/ ID типа устройства
770 "modelId": "", ~/~/ , ID модели    
771 "unitId": "", ~/~/ подразделения
772 "sim1": "", ~/~/ SIM 1
Илья Крайнов 30.1 773 "sim2": "", ~/~/ SIM2     (%%)
Артем Шемяков 28.6 774 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
775 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
776 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
777 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
778 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
779 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
780 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
781 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
782 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
783 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
784 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
785 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
786 (% style="color:#000000" %) "counters": 
Артем Шемяков 21.10 787 {
788 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
789 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
Илья Крайнов 34.1 790 "mileage": "", ~/~/ пробег, в метрах 
791 "motohours": "" ~/~/ моточасы, в секундах
Артем Шемяков 21.10 792 }
793 "cmsv6Parameters": ~/~/ параметры CMSv6
794 {       
795 "id": "", ~/~/ идентификатор
796 "enabled": true, ~/~/ флаг включения
797 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
798 "login": "", ~/~/ имя учетной записи
799 "password": "", ~/~/ пароль учетной записи
800 }
801 "inspectionTasks": ~/~/ задания на ТО
802 {
803 "id": "", ~/~/ ID задания
804 "enabled": false, ~/~/ Признак включения
805 "name": "", ~/~/ Имя задания
806 "description": "", ~/~/ Описание задания
807 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
808 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
809 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
810 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
811 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
812 "kind": "", ~/~/ Вид периодичности по времени
813 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
Артем Шемяков 22.2 814 } 
Артем Шемяков 28.8 815 )))
Артем Шемяков 21.9 816
817 (% style="color:#000000" %)}
818
Артем Шемяков 18.1 819 (% style="color:#000000" %)Ответ:
820
821 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 22.2 822 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 18.1 823
Артем Шемяков 21.11 824 (% lang="en-US" style="text-align:left" %)
825 "vehicleId": "", ~/~/ ID ТС
826 "parentId": "", ~/~/ ID клиента
827 "name": "", ~/~/ имя ТС
828 "imei": "", ~/~/ IMEI
829 "deviceTypeId": "", ~/~/ типа устройства
830 "modelId": "", ~/~/ ID модели
831 "unitId": "", ~/~/ ID подразделения
832 "sim1": "", ~/~/ SIM 1
833 "sim2": "", ~/~/ SIM2
834 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
835 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
836 "counters": 
837 {
838 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
839 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
840 "mileage": "", ~/~/ пробег
841 "motohours": "", ~/~/ моточасы
842 }
843 "cmsv6Parameters": ~/~/ параметры CMSv6
844 {
845 "id": ~/~/ идентификатор
846 "enabled": true, ~/~/ флаг включения
847 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
848 "login": "", ~/~/ имя учетной записи
849 "password": "", ~/~/ пароль учетной записи
850 }
851 "inspectionTasks": ~/~/ задания на ТО
852 {
853 "id": "", ~/~/ ID задания
854 "enabled": false, ~/~/ Признак включения
855 "name": "", ~/~/ Имя задания
856 "description": "", ~/~/ Описание задания
857 "mileageCondition": "", ~/~/ Условие по пробегу
858 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
859 "motohoursCondition": "", ~/~/ Условие по моточасам
860 "lastMotohours": "", ~/~/ Моточасы
861 "periodicCondition": "", ~/~/ Условие периодичности по времени
862 "kind": "", ~/~/ Вид периодичности по времени
863 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
864 }
Артем Шемяков 18.1 865
Артем Шемяков 21.11 866 (% lang="en-US" style="text-align:left" %)
867 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
868
Артем Шемяков 28.7 869 **валидация:**
870 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
871 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
872 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Артем Шемяков 21.11 873
Артем Шемяков 28.7 874
Артем Шемяков 18.1 875 (% class="box errormessage" %)
876 (((
877 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
878 )))
879
Артем Шемяков 23.2 880 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 881
882 (% style="color:#000000" %)Метод запроса: **DELETE**
883
884 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
885
Артем Шемяков 22.8 886 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
Артем Шемяков 18.1 887
888 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
889
890 (% style="text-align:left" %)
891 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
892
893
Артем Шемяков 8.1 894 (% class="box" lang="en-US" style="text-align: center;" %)
895 (((
Артем Шемяков 17.1 896 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
897 )))
898
899 (% class="box infomessage" %)
900 (((
901 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
902 )))
903
Артем Шемяков 23.2 904 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 905
906 (% style="color:#000000" %)Метод запроса: **GET**
907
908 (% 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]]
909
910 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911
Артем Шемяков 21.12 912 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 913
Артем Шемяков 21.12 914 (% style="color:#000000" %){
Артем Шемяков 17.1 915
Артем Шемяков 21.12 916 "deviceTypeId" : "", ~/~/ ID типа устройства
917 "deviceTypeName" : "" ~/~/ Название типа устройства
918
Артем Шемяков 17.1 919 (% style="text-align:left" %)
Артем Шемяков 21.12 920 (% style="color:#000000" %)}
Артем Шемяков 17.1 921
922
923 (% class="box" style="text-align: center;" %)
924 (((
925 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
926 )))
927
928 (% class="box infomessage" %)
929 (((
930 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
931 )))
932
Артем Шемяков 23.2 933 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 934
935 (% style="color:#000000" %)Метод запроса: **GET**
936
937 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
938
939 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
940
Артем Шемяков 21.12 941 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 942
Артем Шемяков 21.12 943 (% style="color:#000000" %){
Артем Шемяков 17.1 944
Артем Шемяков 21.12 945 "id": "", ~/~/ ID типа датчика 
946 "name": "", ~/~/ Название
947 "description": "", ~/~/ Описание
Артем Шемяков 17.1 948
949 (% style="text-align:left" %)
Артем Шемяков 21.12 950 (% style="color:#000000" %)}
Артем Шемяков 17.1 951
952
953 (% class="box" lang="en-US" style="text-align: center;" %)
954 (((
Артем Шемяков 14.1 955 (% 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 956 )))

Меню

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