Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 47.1 >
edited by Илья Крайнов
on 2022/11/21 10:32
To version < 69.1 >
edited by Илья Крайнов
on 2022/11/30 14:00
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,31 +1,31 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
6 +{{toc/}}
7 +
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
41 +}
43 43  
43 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,18 +72,16 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
77 -(((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 -)))
78 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
80 80  
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -110,18 +110,159 @@
110 110   "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 111  }
112 112  
112 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -(% class="box" style="text-align: center;" %)
114 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
116 +**POST /api/v3/agents **
117 117  )))
118 118  
119 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
120 +
121 +Метод запроса: **POST**
122 +
123 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
124 +
125 +В заголовках запроса: X-Auth: Токен авторизации
126 +
127 +Параметры в теле запроса (JSON):
128 +
129 +{
130 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
131 + "name": "string", ~/~/ имя
132 + "fullName": "string", ~/~/ полное наименование
133 + "isForeign": true, ~/~/ иностранный контрагент
134 + "district": "string", ~/~/ округ
135 + "region": "string", ~/~/ регион
136 + "city": "string", ~/~/ город
137 + "inn": "string", ~/~/ ИНН
138 + "kpp": "string", ~/~/ КПП
139 + "address": "string", ~/~/ юридический адрес
140 + "addressFact": "string", ~/~/ фактический адрес
141 + "email": "string", ~/~/ email
142 + "director": "string", ~/~/ ФИО руководителя
143 + "bankName": "string", ~/~/ банк
144 + "bankBIK": "string", ~/~/ БИК
145 + "bankRS": "string", ~/~/ номер счёта
146 + "bankKS": "string" ~/~/ корр. счёт
147 +}
148 +
149 +
150 +Ответ:
151 +
152 +{
153 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
154 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
155 + "name": "string", ~/~/ имя
156 + "fullName": "string", ~/~/ полное наименование
157 + "isForeign": true, ~/~/ иностранный контрагент
158 + "district": "string", ~/~/ округ
159 + "region": "string", ~/~/ регион
160 + "city": "string", ~/~/ город
161 + "inn": "string", ~/~/ ИНН
162 + "kpp": "string", ~/~/ КПП
163 + "address": "string", ~/~/ юридический адрес
164 + "addressFact": "string", ~/~/ фактический адрес
165 + "email": "string", ~/~/ email
166 + "director": "string", ~/~/ ФИО руководителя
167 + "bankName": "string", ~/~/ банк
168 + "bankBIK": "string", ~/~/ БИК
169 + "bankRS": "string", ~/~/ номер счёта
170 + "bankKS": "string" ~/~/ корр. счёт
171 +}
172 +
173 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
174 +
175 +(% class="box warningmessage" %)
176 +(((
177 +**PUT /api/v3/agents**
178 +)))
179 +
180 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
181 +
182 +Метод запроса: **PUT**
183 +
184 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
185 +
186 +В заголовках запроса: X-Auth: Токен авторизации
187 +
188 +
189 +Параметры в теле запроса (JSON):
190 +
191 +{
192 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
193 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
194 + "name": "string", ~/~/ имя
195 + "fullName": "string", ~/~/ полное наименование
196 + "isForeign": true, ~/~/ иностранный контрагент
197 + "district": "string", ~/~/ округ
198 + "region": "string", ~/~/ регион
199 + "city": "string", ~/~/ город
200 + "inn": "string", ~/~/ ИНН
201 + "kpp": "string", ~/~/ КПП
202 + "address": "string", ~/~/ юридический адрес
203 + "addressFact": "string", ~/~/ фактический адрес
204 + "email": "string", ~/~/ email
205 + "director": "string", ~/~/ ФИО руководителя
206 + "bankName": "string", ~/~/ банк
207 + "bankBIK": "string", ~/~/ БИК
208 + "bankRS": "string", ~/~/ номер счёта
209 + "bankKS": "string" ~/~/ корр. счёт
210 +}
211 +
212 +
213 +Ответ:
214 +
215 +{
216 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
217 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
218 + "name": "string", ~/~/ имя
219 + "fullName": "string", ~/~/ полное наименование
220 + "isForeign": true, ~/~/ иностранный контрагент
221 + "district": "string", ~/~/ округ
222 + "region": "string", ~/~/ регион
223 + "city": "string", ~/~/ город
224 + "inn": "string", ~/~/ ИНН
225 + "kpp": "string", ~/~/ КПП
226 + "address": "string", ~/~/ юридический адрес
227 + "addressFact": "string", ~/~/ фактический адрес
228 + "email": "string", ~/~/ email
229 + "director": "string", ~/~/ ФИО руководителя
230 + "bankName": "string", ~/~/ банк
231 + "bankBIK": "string", ~/~/ БИК
232 + "bankRS": "string", ~/~/ номер счёта
233 + "bankKS": "string" ~/~/ корр. счёт
234 +}
235 +
236 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
237 +
238 +(% class="box errormessage" %)
239 +(((
240 +**DELETE /api/v3/agents/{clientId}**
241 +)))
242 +
243 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
244 +
245 +Метод запроса: **DELETE**
246 +
247 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
248 +
249 +Параметр запроса: **{clientId}** - Guid пользователя
250 +
251 +В заголовках запроса: X-Auth: Токен авторизации
252 +
253 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
254 +
255 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
256 +
257 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
258 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
261 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
264 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -179,13 +179,14 @@
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
322 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 183  (% class="box successmessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
326 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
329 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -226,13 +226,14 @@
226 226  
227 227  (% style="color:#000000" %)}
228 228  
370 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
230 230  (% class="box successmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
374 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
377 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **GET**
238 238  
... ... @@ -274,13 +274,14 @@
274 274  )))
275 275  )))
276 276  
419 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
277 277  
278 278  (% class="box warningmessage" %)
279 279  (((
280 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
423 +(% lang="en-US" %)**PUT /api/v3/users**
281 281  )))
282 282  
283 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
426 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
284 284  
285 285  (% style="color:#000000" %)Метод запроса: **PUT**
286 286  
... ... @@ -288,8 +288,6 @@
288 288  
289 289  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
290 290  
291 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
292 -
293 293  (% lang="en-US" style="text-align:left" %)
294 294  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
295 295  
... ... @@ -347,13 +347,14 @@
347 347  (% lang="en-US" style="text-align:left" %)
348 348  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
349 349  
491 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
350 350  
351 351  (% class="box warningmessage" %)
352 352  (((
353 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
495 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
354 354  )))
355 355  
356 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
498 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
357 357  
358 358  (% style="color:#000000" %)Метод запроса: **PUT**
359 359  
... ... @@ -376,10 +376,11 @@
376 376  (% style="text-align:left" %)
377 377  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
378 378  
521 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
379 379  
380 380  (% class="box warningmessage" %)
381 381  (((
382 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
525 +**POST /api/v3/users/disable**
383 383  )))
384 384  
385 385  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -397,10 +397,11 @@
397 397  
398 398  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
399 399  
543 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
400 400  
401 401  (% class="box warningmessage" %)
402 402  (((
403 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
547 +**POST /api/v3/users/enable**
404 404  )))
405 405  
406 406  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -431,15 +431,16 @@
431 431  }
432 432  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
433 433  "users" - массив id пользователей, которых не удалось включить или отключить.
434 -
435 435  )))
436 436  
580 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
581 +
437 437  (% class="box errormessage" %)
438 438  (((
439 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
584 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
440 440  )))
441 441  
442 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
587 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
443 443  
444 444  (% style="color:#000000" %)Метод запроса: **DELETE**
445 445  
... ... @@ -452,20 +452,18 @@
452 452  (% style="text-align:left" %)
453 453  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
454 454  
600 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
455 455  
456 -(% class="box" style="text-align: center;" %)
457 -(((
458 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
459 -)))
602 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
460 460  
461 461  (% class="box infomessage" %)
462 462  (((
463 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
606 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
464 464  )))
465 465  
466 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
609 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
467 467  
468 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
611 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
469 469  
470 470  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
471 471  
... ... @@ -526,13 +526,14 @@
526 526  (% style="text-align:left" %)
527 527  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
528 528  
672 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
529 529  
530 530  (% class="box successmessage" %)
531 531  (((
532 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
676 +(% lang="en-US" %)**POST /api/v3/vehicles**
533 533  )))
534 534  
535 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
679 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
536 536  
537 537  (% style="color:#000000" %)Метод запроса: **POST**
538 538  
... ... @@ -645,15 +645,16 @@
645 645  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
646 646  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
647 647  
792 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
648 648  
649 649  (% class="box successmessage" %)
650 650  (((
651 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
796 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
652 652  )))
653 653  
654 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
799 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
655 655  
656 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
801 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
657 657  
658 658  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
659 659  
... ... @@ -690,7 +690,7 @@
690 690   "customFields": null ~/~/ значение любого из произвольных полей ТС
691 691  }
692 692  
693 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
838 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
694 694  
695 695  (% style="color:#000000" %)Ответ:
696 696  
... ... @@ -712,18 +712,28 @@
712 712   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
713 713   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
714 714   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
715 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
860 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
861 + "customFields": [ 
862 + {
863 + "id": "", ~/~/ идентификатор произвольного поля
864 + "name": "", ~/~/ имя произвольного поля
865 + "value": "", ~/~/ значение произвольного поля
866 + "forClient": true, ~/~/ право на отображение у клиента
867 + "forTooltip": false, ~/~/ право на отображение в подсказке
868 + "forReport": false ~/~/ право на отображение в отчетах
869 + }(%%)
716 716  (% style="color:#000000" %)}
717 717  
718 718  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
719 719  
874 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
720 720  
721 721  (% class="box successmessage" %)
722 722  (((
723 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
878 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
724 724  )))
725 725  
726 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
881 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
727 727  
728 728  (% style="color:#000000" %)Метод запроса: **POST**
729 729  
... ... @@ -762,13 +762,14 @@
762 762  (% style="text-align:left" %)
763 763  (% style="color:#000000" %) }
764 764  
920 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
765 765  
766 766  (% class="box warningmessage" %)
767 767  (((
768 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
924 +(% lang="en-US" %)**PUT /api/v3/vehicles**
769 769  )))
770 770  
771 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
927 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
772 772  
773 773  (% style="color:#000000" %)Метод запроса: **PUT**
774 774  
... ... @@ -890,13 +890,14 @@
890 890  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
891 891  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
892 892  
1049 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
893 893  
894 894  (% class="box errormessage" %)
895 895  (((
896 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1053 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
897 897  )))
898 898  
899 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1056 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
900 900  
901 901  (% style="color:#000000" %)Метод запроса: **DELETE**
902 902  
... ... @@ -909,18 +909,16 @@
909 909  (% style="text-align:left" %)
910 910  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
911 911  
1069 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
912 912  
913 -(% class="box" lang="en-US" style="text-align: center;" %)
914 -(((
915 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
916 -)))
1071 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
917 917  
918 918  (% class="box infomessage" %)
919 919  (((
920 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1075 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
921 921  )))
922 922  
923 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1078 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
924 924  
925 925  (% style="color:#000000" %)Метод запроса: **GET**
926 926  
... ... @@ -938,18 +938,16 @@
938 938  (% style="text-align:left" %)
939 939  (% style="color:#000000" %)}
940 940  
1096 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
941 941  
942 -(% class="box" style="text-align: center;" %)
943 -(((
944 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
945 -)))
1098 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
946 946  
947 947  (% class="box infomessage" %)
948 948  (((
949 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1102 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
950 950  )))
951 951  
952 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1105 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
953 953  
954 954  (% style="color:#000000" %)Метод запроса: **GET**
955 955  

Меню

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