Last modified by Андрей Калиновский on 2025/03/28 11:43
<
From version < 18.2 >
edited by Артем Шемяков
on 2022/09/01 16:49
To version < 65.1 >
edited by Илья Крайнов
on 2022/11/24 13:23
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,50 +1,70 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
2 += Описание ГЛОНАССSoft Public API 3.0 =
3 3  
4 -== ==
5 5  
6 -(% class="box" style="text-align: center;" %)
7 -(((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 -)))
5 +{{toc/}}
10 10  
7 +
8 += (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) =
9 +
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
12 +(% 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 -)))
16 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
18 +
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +
22 +== (% style="color:#000000; line-height:14px" %)**Авторизация**(%%) ==
23 +
23 23  (% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
31 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
37 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
38 +
39 +(% style="color:#000000" %){
40 + "login": "testuser",
41 + "password": "testuser"
42 +}(%%)
43 +
44 +
45 +(% style="color:#000000" %)**Ответ:**
46 +
36 36  (% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
48 +(% style="color:#000000" %){
38 38  
50 +(% lang="en-US" %)
51 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
52 + "User": "testuser" , ~/~/ имя пользователя
53 +
54 +(% lang="en-US" %)
55 +}
56 +
39 39  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 40  
41 41  
60 +== (% style="color:#000000; line-height:14px" %)**Проверка авторизации**(%%) ==
61 +
42 42  (% class="box infomessage" %)
43 43  (((
44 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
64 +(% lang="en-US" %)**GET /api/v3/auth/check**
45 45  )))
46 46  
47 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
67 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
48 48  
49 49  (% style="color:#000000" %)Метод запроса: **GET**
50 50  
... ... @@ -56,48 +56,201 @@
56 56  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
57 57  
58 58  
59 -(% class="box" style="text-align: center;" %)
60 -(((
61 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
62 -)))
79 +=(% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
63 63  
81 +
82 +== (% style="color:#000000, font-size:14px" %)**Получение основных параметров клиента**(%%) ==
83 +
64 64  (% class="box infomessage" %)
65 65  (((
66 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
86 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
67 67  )))
68 68  
69 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
89 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
70 70  
71 71  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
72 72  
73 73  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
74 74  
75 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
95 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
76 76  
77 77  (% style="color:#000000" %)Метод запроса: **GET**
78 78  
79 79  (% 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>
80 80  
81 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
101 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
82 82  
83 83  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
84 84  
85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
105 +(% style="color:#000000" %)Ответ:
86 86  
87 -(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
107 +(% style="color:#000000" %){
108 + "agentId": "", ~/~/ идентификатор клиента
109 + "parentId": "", ~/~/ идентификатор клиента-родителя
110 + "name": "", ~/~/ наименование клиента
111 + "fullName": "", ~/~/ полное наименование клиента
112 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
113 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
114 +}
88 88  
89 89  
90 -(% class="box" style="text-align: center;" %)
117 +== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
118 +
119 +(% class="box successmessage" %)
91 91  (((
92 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
121 +**POST /api/v3/agents **
93 93  )))
94 94  
124 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
125 +
126 +Метод запроса: **POST**
127 +
128 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
129 +
130 +В заголовках запроса: X-Auth: Токен авторизации
131 +
132 +Параметры в теле запроса (JSON):
133 +
134 +{
135 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
136 + "name": "string", ~/~/ имя
137 + "fullName": "string", ~/~/ полное наименование
138 + "isForeign": true, ~/~/ иностранный контрагент
139 + "district": "string", ~/~/ округ
140 + "region": "string", ~/~/ регион
141 + "city": "string", ~/~/ город
142 + "inn": "string", ~/~/ ИНН
143 + "kpp": "string", ~/~/ КПП
144 + "address": "string", ~/~/ юридический адрес
145 + "addressFact": "string", ~/~/ фактический адрес
146 + "email": "string", ~/~/ email
147 + "director": "string", ~/~/ ФИО руководителя
148 + "bankName": "string", ~/~/ банк
149 + "bankBIK": "string", ~/~/ БИК
150 + "bankRS": "string", ~/~/ номер счёта
151 + "bankKS": "string" ~/~/ корр. счёт
152 +}
153 +
154 +
155 +Ответ:
156 +
157 +{
158 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
159 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
160 + "name": "string", ~/~/ имя
161 + "fullName": "string", ~/~/ полное наименование
162 + "isForeign": true, ~/~/ иностранный контрагент
163 + "district": "string", ~/~/ округ
164 + "region": "string", ~/~/ регион
165 + "city": "string", ~/~/ город
166 + "inn": "string", ~/~/ ИНН
167 + "kpp": "string", ~/~/ КПП
168 + "address": "string", ~/~/ юридический адрес
169 + "addressFact": "string", ~/~/ фактический адрес
170 + "email": "string", ~/~/ email
171 + "director": "string", ~/~/ ФИО руководителя
172 + "bankName": "string", ~/~/ банк
173 + "bankBIK": "string", ~/~/ БИК
174 + "bankRS": "string", ~/~/ номер счёта
175 + "bankKS": "string" ~/~/ корр. счёт
176 +}
177 +
178 +
179 +== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
180 +
181 +(% class="box warningmessage" %)
182 +(((
183 +**PUT /api/v3/agents**
184 +)))
185 +
186 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
187 +
188 +Метод запроса: **PUT**
189 +
190 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
191 +
192 +В заголовках запроса: X-Auth: Токен авторизации
193 +
194 +
195 +Параметры в теле запроса (JSON):
196 +
197 +{
198 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
199 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
200 + "name": "string", ~/~/ имя
201 + "fullName": "string", ~/~/ полное наименование
202 + "isForeign": true, ~/~/ иностранный контрагент
203 + "district": "string", ~/~/ округ
204 + "region": "string", ~/~/ регион
205 + "city": "string", ~/~/ город
206 + "inn": "string", ~/~/ ИНН
207 + "kpp": "string", ~/~/ КПП
208 + "address": "string", ~/~/ юридический адрес
209 + "addressFact": "string", ~/~/ фактический адрес
210 + "email": "string", ~/~/ email
211 + "director": "string", ~/~/ ФИО руководителя
212 + "bankName": "string", ~/~/ банк
213 + "bankBIK": "string", ~/~/ БИК
214 + "bankRS": "string", ~/~/ номер счёта
215 + "bankKS": "string" ~/~/ корр. счёт
216 +}
217 +
218 +
219 +Ответ:
220 +
221 +{
222 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
223 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
224 + "name": "string", ~/~/ имя
225 + "fullName": "string", ~/~/ полное наименование
226 + "isForeign": true, ~/~/ иностранный контрагент
227 + "district": "string", ~/~/ округ
228 + "region": "string", ~/~/ регион
229 + "city": "string", ~/~/ город
230 + "inn": "string", ~/~/ ИНН
231 + "kpp": "string", ~/~/ КПП
232 + "address": "string", ~/~/ юридический адрес
233 + "addressFact": "string", ~/~/ фактический адрес
234 + "email": "string", ~/~/ email
235 + "director": "string", ~/~/ ФИО руководителя
236 + "bankName": "string", ~/~/ банк
237 + "bankBIK": "string", ~/~/ БИК
238 + "bankRS": "string", ~/~/ номер счёта
239 + "bankKS": "string" ~/~/ корр. счёт
240 +}
241 +
242 +
243 +== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
244 +
245 +(% class="box errormessage" %)
246 +(((
247 +**DELETE /api/v3/agents/{clientId}**
248 +)))
249 +
250 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
251 +
252 +Метод запроса: **DELETE**
253 +
254 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
255 +
256 +Параметр запроса: **{clientId}** - Guid пользователя
257 +
258 +В заголовках запроса: X-Auth: Токен авторизации
259 +
260 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
261 +
262 +
263 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
264 +
265 +
266 +== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
267 +
95 95  (% class="box successmessage" %)
96 96  (((
97 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
270 +(% lang="en-US" %)**POST /api/v3/users**
98 98  )))
99 99  
100 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
273 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
101 101  
102 102  (% style="color:#000000" %)Метод запроса: **POST**
103 103  
... ... @@ -105,50 +105,164 @@
105 105  
106 106  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
107 107  
108 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
281 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
109 109  
283 +(% style="color:#000000" %){ 
284 + "lastName": "", ~/~/ фамилия
285 + "firstName": "", ~/~/ имя
286 + "position": "", ~/~/ должность
287 + "phone": "", ~/~/ телефон
288 + "organization": "", ~/~/ организация
289 + "login": "", ~/~/ логин (обязателен)
290 + "password": "", ~/~/ пароль (обязателен)
291 + "email": "", ~/~/ email (обязателен)
292 + "description": "", ~/~/ описание
293 + "isEnabled": "", ~/~/ признак включения
294 + "parentId": "", ~/~/ Guid родительского агента
295 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
296 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
297 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
298 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
299 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
300 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
301 +}
302 +
110 110  (% style="text-align:left" %)
111 -(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
304 +(% style="color:#000000; font-weight:normal" %)Ответ:
112 112  
306 +(% style="text-align:left" %)
307 +(% style="color:#000000; font-weight:normal" %){    
113 113  
309 +(% style="text-align:left" %)
310 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
311 + "lastName": "" , ~/~/ Фамилия ,
312 + "firstName": "" , ~/~/ Имя
313 + "position": "" , ~/~/ Должность
314 + "phone": "" , ~/~/ Телефон
315 + "organization": "" , ~/~/ Организация
316 + "login": "" , ~/~/ Логин
317 + "password": "" , ~/~/ Пароль
318 + "email": "" , ~/~/ Email
319 + "description": "" , ~/~/ Описание
320 + "isEnabled": "" , ~/~/ Признак включения
321 + "parentId": "" , ~/~/ Guid родительского агента
322 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
323 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
324 + "kind": "" , ~/~/ тип аутентификации
325 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
326 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
327 +
328 +(% style="text-align:left" %)
329 +(% style="color:#000000; font-weight:normal" %)}
330 +
331 +
332 +== (% style="color:#000000; line-height:14px" %)**Получение списка пользователей**(%%) ==
333 +
114 114  (% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
336 +(% lang="en-US" %)**POST /api/v3/users/find**
117 117  )))
118 118  
119 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
339 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
120 120  
121 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
341 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
122 122  
123 123  (% style="color:#000000" %)Метод запроса: **POST**
124 124  
125 125  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
126 126  
127 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
347 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
128 128  
129 -(% class="western" %)
130 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
131 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
132 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
133 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
349 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
134 134  
351 +(% style="color:#000000" %){
352 +
353 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
354 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
355 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
356 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
357 +
135 135  (% style="color:#000000" %)}
136 136  
137 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
360 +(% style="color:#000000" %)Ответ:
138 138  
139 -(% class="western" style="margin-bottom:19px" %)
140 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
362 +(% style="color:#000000" %){         (%%)
141 141  
142 -(% lang="en-US" style="text-align:left" %)
143 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
364 + "id": "" , ~/~/ идентификатор пользователя
365 + "lastName": "" , ~/~/ фамилия
366 + "firstName": "" , ~/~/ имя
367 + "position": "" , ~/~/ должность
368 + "phone": "" , ~/~/ телефон
369 + "parentId": "" , ~/~/ идентификатор клиента-родителя
370 + "parentName": "" , ~/~/ наименование клиента-родителя
371 + "organization": "" , ~/~/ организация
372 + "login": "" , ~/~/ логин
373 + "email": "" , ~/~/ E-mail
374 + "sessionDuration":"", ~/~/ длительность сессии в минутах
375 + "status": "1",  ~/~/ статус пользователя
376 + "astLogged": "", ~/~/ дата/время последней авторизации
144 144  
378 +(% style="color:#000000" %)}
145 145  
380 +
381 +== (% style="color:#000000; line-height:14px" %)**Получение информации о пользователе**(%%) ==
382 +
383 +(% class="box successmessage" %)
384 +(((
385 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
386 +)))
387 +
388 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
389 +
390 +(% style="color:#000000" %)Метод запроса: **GET**
391 +
392 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
393 +
394 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
395 +
396 +(% style="color:#000000" %)Ответ:
397 +
398 +(((
399 +(((
400 +{
401 + "id": "", ~/~/ GUID пользователя
402 + "lastName": "", ~/~/ Фамилия 
403 + "firstName": "", ~/~/ Имя
404 + "position": "", ~/~/ Должность
405 + "phone": "", ~/~/ Номер телефона
406 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
407 + "parentName": "", Наименование клиента, которому принадлежит пользователь
408 + "organization": "", ~/~/ Организация
409 + "login": "", ~/~/ Логин пользователя
410 + "email": "", ~/~/ Адрес электронной почты
411 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
412 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
413 + "description": "", ~/~/ Описание
414 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
415 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
416 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
417 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
418 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
419 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
420 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
421 + "groups": [], ~/~/ Список ролей пользователя
422 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
423 + "authDevices": [ ], ~/~/ Список авторизованных устройств
424 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
425 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
426 +}
427 +)))
428 +)))
429 +
430 +
431 +== (% style="color:#000000; line-height:14px" %)**Редактирование пользователя**(%%) ==
432 +
146 146  (% class="box warningmessage" %)
147 147  (((
148 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
435 +(% lang="en-US" %)**PUT /api/v3/users**
149 149  )))
150 150  
151 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
438 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
152 152  
153 153  (% style="color:#000000" %)Метод запроса: **PUT**
154 154  
... ... @@ -157,26 +157,88 @@
157 157  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
158 158  
159 159  (% lang="en-US" style="text-align:left" %)
160 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
447 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
161 161  
449 +(% lang="en-US" style="text-align:left" %)
450 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
162 162  
452 +(% lang="en-US" style="text-align:left" %)
453 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
454 + "lastName": "" , ~/~/ фамилия
455 + "firstName": "" , ~/~/ имя
456 + "position": "" , ~/~/ должность
457 + "phone": "" , ~/~/ телефон
458 + "organization": "" , ~/~/ организация
459 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
460 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
461 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
462 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
463 + "isEnabled": "" , ~/~/ признак включения
464 + "parentId": "" , ~/~/ Guid родительского агента
465 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
466 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
467 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
468 + "kind": "" , ~/~/ тип аутентификации
469 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
470 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
471 +
472 +(% lang="en-US" style="text-align:left" %)
473 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
474 +
475 +(% lang="en-US" style="text-align:left" %)
476 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
477 +
478 +(% lang="en-US" style="text-align:left" %)
479 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
480 +
481 +(% lang="en-US" style="text-align:left" %)
482 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
483 + "lastName": "" , ~/~/ фамилия
484 + "firstName": "" , ~/~/ имя
485 + "position": "" , ~/~/ должность
486 + "phone": "" , ~/~/ телефон
487 + "organization": "" , ~/~/ организация
488 + "login": "" , ~/~/ логин
489 + "password": "" , ~/~/ пароль 
490 + "email": "" , ~/~/ email
491 + "description": "" , ~/~/ описание
492 + "isEnabled": "" , ~/~/ признак включения
493 + "parentId": "" , ~/~/ Guid родительского агента
494 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
495 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
496 + "kind": "" , ~/~/ тип аутентификации
497 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
498 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
499 +
500 +(% lang="en-US" style="text-align:left" %)
501 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
502 +
503 +
504 +== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
505 +
163 163  (% class="box warningmessage" %)
164 164  (((
165 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
508 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
166 166  )))
167 167  
168 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
511 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
169 169  
170 170  (% style="color:#000000" %)Метод запроса: **PUT**
171 171  
172 -(% 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} Параметр запроса:
515 +(% 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}
173 173  
174 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
517 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
175 175  
176 -(% class="western" %)
177 -{{{ "description": "", // описание
178 - "data": "" // данные, связанные со сменой статуса}}}
519 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
179 179  
521 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
522 +
523 +(% style="color:#000000" %){
524 +
525 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
526 + "description": "" , ~/~/ описание
527 + "data": "" , ~/~/ данные, связанные со сменой статуса
528 +
180 180  (% style="color:#000000" %)}
181 181  
182 182  (% style="text-align:left" %)
... ... @@ -183,72 +183,155 @@
183 183  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
184 184  
185 185  
535 +== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
536 +
537 +(% class="box warningmessage" %)
538 +(((
539 +**POST /api/v3/users/disable**
540 +)))
541 +
542 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
543 +
544 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
545 +
546 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
547 +
548 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
549 +
550 + [ 
551 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
552 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
553 + ]
554 +
555 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
556 +
557 +
558 +== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
559 +
560 +(% class="box warningmessage" %)
561 +(((
562 +**POST /api/v3/users/enable**
563 +)))
564 +
565 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
566 +
567 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
568 +
569 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
570 +
571 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
572 +
573 + [ 
574 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
575 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
576 + ]
577 +
578 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
579 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
580 +
581 +(((
582 +В теле ответа:
583 +{
584 + "errorMessages": [
585 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
586 + ],
587 + "users": [
588 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
589 + ]
590 +}
591 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
592 +"users" - массив id пользователей, которых не удалось включить или отключить.
593 +
594 +
595 +== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
596 +)))
597 +
186 186  (% class="box errormessage" %)
187 187  (((
188 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
600 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
189 189  )))
190 190  
191 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
603 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
192 192  
193 193  (% style="color:#000000" %)Метод запроса: **DELETE**
194 194  
195 195  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
196 196  
197 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
609 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
198 198  
611 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
612 +
199 199  (% style="text-align:left" %)
200 200  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
201 201  
202 202  
203 -(% class="box" style="text-align: center;" %)
204 -(((
205 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
206 -)))
617 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
207 207  
619 +
620 +== (% style="color:#000000; line-height:14px" %)**Получение информации об объекте**(%%) ==
621 +
208 208  (% class="box infomessage" %)
209 209  (((
210 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
624 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
211 211  )))
212 212  
213 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
627 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
214 214  
215 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
629 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
216 216  
217 217  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
218 218  
219 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
633 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
220 220  
221 221  (% style="color:#000000" %)Метод запроса: **GET**
222 222  
223 223  (% 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>
224 224  
225 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
639 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
226 226  
227 227  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
228 228  
229 229  (% style="color:#000000" %)Ответ:
230 230  
231 -(% style="color:#000000" %){
645 +(((
646 +{
647 + "vehicleId": "", ~/~/ ID объекта
648 + "name": "", ~/~/ Имя объекта
649 + "imei": "", ~/~/ IMEI объекта
650 + "deviceTypeId": , ~/~/ ID типа устройства
651 + "deviceTypeName": "", ~/~/ Название типа устройства
652 + "sim1": "", ~/~/ Номер SIM1
653 + "parentId": "", Номер SIM2
654 + "parentName": "", Наименование клиента-родителя
655 + "modelId": "", ID модели объекта
656 + "modelName": "", Имя модели объекта
657 + "createdAt": "", Дата создания объекта
658 + "mileageCalcMethod": "", Выбранный метод расчета пробега
659 + "counters": { ~/~/ Нормы
660 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
661 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
662 + "mileage": "", ~/~/ Пробег по нормам в метрах
663 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
664 + },
665 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
666 + {
667 + "id": "", ~/~/ ID  задания
668 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
669 + "name": "", ~/~/ Наименование задания
670 + "description": "", ~/~/ Описание задания
671 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
672 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
673 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
674 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
675 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
676 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
677 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
678 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
679 + }
680 + ]
681 +}
682 +)))
232 232  
233 -(% class="western" %)
234 -{{{ "vehicleId": “”, // идентификатор объекта
235 - "name": "", // имя объекта
236 - "imei": "", // IMEI объекта
237 - "deviceTypeId": “”, // идентификатор устройства объекта
238 - "deviceTypeName": "" // наименование устройства объекта
239 - "parentId": "", // идентификатор клиента-родителя
240 - "parentName": "" // наименование клиента-родителя,
241 - "modelId": "", // идентификатор модели объекта
242 - "modelName": "" // наименование модели объекта,
243 - "unitId": "", // идентификатор подразделения
244 - "unitName": "", // наименование подразделения
245 - "status": “”, // статус объекта
246 - ...
247 - },
248 - ...}}}
249 -
250 -(% style="color:#000000" %)}
251 -
252 252  (% style="text-align:left" %)
253 253  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
254 254  
... ... @@ -256,12 +256,14 @@
256 256  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
257 257  
258 258  
691 +== (% style="color:#000000; line-height:14px" %)**Добавление объекта**(%%) ==
692 +
259 259  (% class="box successmessage" %)
260 260  (((
261 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
695 +(% lang="en-US" %)**POST /api/v3/vehicles**
262 262  )))
263 263  
264 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
698 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
265 265  
266 266  (% style="color:#000000" %)Метод запроса: **POST**
267 267  
... ... @@ -269,118 +269,132 @@
269 269  
270 270  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
271 271  
272 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
706 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
273 273  
274 -(% class="western" %)
275 -{{{ "parentId": "", // ID клиента
276 - "name": "", // имя ТС
277 - "imei": "", // IMEI
278 - "deviceTypeId": "",// ID типа устройства
279 - "modelId": "",
280 - "unitId": "", // ID подразделения
281 - "sim1": "", // Номер SIM 1
282 - "sim2": "", // Номер SIM2
283 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
284 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
285 - "consumptionIdle": "",// Расход топлива на холостом ходу
286 - "counters": {
287 - "mileage": "", // пробег
288 - "mileageEnabled": true, // флаг активности счётчика "пробег"
289 - "motohours":"", // моточасы
290 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
291 - },
292 - "cmsv6Parameters": { // параметры CMSv6
293 - "enabled": true, // флаг включения
294 - //"id": "", // идентификатор
295 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
296 - "login": "", // имя учетной записи
297 - "password": "" // пароль учетной записи
298 - },
299 - "inspectionTasks": [ // задания на ТО
708 +(% style="color:#000000" %){
709 +
710 + "parentId": "" , ~/~/ ID клиента
711 + "name": "" , ~/~/ имя ТС
712 + "imei": "" , ~/~/ IMEI
713 + "deviceTypeId": "" , ~/~/ ID типа устройства
714 + "modelId": "" , ~/~/ ID модели
715 + "unitId": "" , ~/~/ ID подразделения
716 + "sim1": "" , ~/~/ Номер SIM 1
717 + "sim2": "" , ~/~/ Номер SIM2
718 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
719 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
720 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
721 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
722 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
723 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
724 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
725 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
726 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
727 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
728 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
729 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
730 + "counters": ~/~/ счетчики
300 300   {
301 - "enabled": "", // Признак включения
302 - "name": "", // Имя задания
303 - "description": "", // Описание задания
304 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
305 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
306 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
307 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
308 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
309 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
310 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
311 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
732 + "mileage": "" , ~/~/ пробег
733 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
734 + "motohours": "" , ~/~/ моточасы
735 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
312 312   },
313 - ]}}}
737 + "cmsv6Parameters": { ~/~/ параметры CMSv6
738 + "enabled": true, ~/~/ флаг включения
739 + "id": "" , ~/~/ идентификатор
740 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
741 + "login": "" , ~/~/ имя учетной записи
742 + "password": "" ~/~/ пароль учетной записи
743 + },
744 + "inspectionTasks": ~/~/ задания на ТО
745 + {
746 + "enabled": "" , ~/~/ Признак включения
747 + "name": "" , ~/~/ Имя задания
748 + "description": "" , ~/~/ Описание задания
749 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
750 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
751 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
752 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
753 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
754 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
755 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
756 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
757 + }
314 314  
315 -(% style="color:#000000" %)… }
759 +(% style="color:#000000" %) }
316 316  
317 317  (% style="color:#000000" %)Ответ:
318 318  
319 319  (% style="color:#000000" %){
320 320  
321 -(% class="western" %)
322 -{{{ "vehicleId": "", //ID ТС
323 - "parentId": "", //Guid владельца ТС
324 - "name": "", //Имя объекта
325 - "imei": "", //IMEI
326 - "deviceTypeId": "", //ID типа устройства
327 - "modelId": "", //ID модели
328 - "unitId": "", //ID подразделения
329 - "sim1": "", //SIM1
330 - "sim2": "", //SIM2
331 - "consumptionPer100Km": "", //Расход топлива на 100 км
332 - "consumptionIdle": "", //Расход топлива на холостом ходу
333 - "counters": { //Счётчики
334 - "mileageEnabled": true,
335 - "motohoursEnabled": true,
336 - "mileage": "",
337 - "motohours": 345.0
338 - },
339 - "cmsv6Parameters": { //Параметры CmsV6
340 - "id": null,
341 - "enabled": true, //флаг включения
342 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
343 - "login": "", // имя учетной записи
344 - "password": "" // пароль учетной записи
345 - },
346 - "inspectionTasks": [ // задания на ТО
347 - {
348 - "id": "", // ID задачи
349 - "enabled": false, // Признак включения
350 - "name": "", // Имя задания
351 - "description": "", // Описание задания
352 - "mileageCondition": "", // Условие по пробегу
353 - "lastMileage": "", // Пробег (в метрах)
354 - "motohoursCondition": "", // Условие по моточасам
355 - "lastMotohours": "", // Моточасы
356 - "periodicCondition": "", // Условие периодичности по времени
357 - "kind": "", // Вид периодичности по времени
358 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
359 - }
360 - ]}}}
765 + "vehicleId": "", ~/~/ID ТС 
766 + "parentId": "", ~/~/Guid владельца ТС
767 + "name": "", ~/~/Имя объекта
768 + "imei": "", ~/~/IMEI
769 + "deviceTypeId": "", ~/~/ID типа устройства
770 + "modelId": "", ~/~/ID модели
771 + "unitId": "", ~/~/ID подразделения
772 + "sim1": "", ~/~/SIM1
773 + "sim2": "", ~/~/SIM2
774 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
775 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
776 + "counters": { ~/~/Счётчики
777 + "mileageEnabled": true,
778 + "motohoursEnabled": true,
779 + "mileage": "",
780 + "motohours": 345.0
781 + },
782 + "cmsv6Parameters": { ~/~/Параметры CmsV6
783 + "id": null,
784 + "enabled": true, ~/~/флаг включения
785 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
786 + "login": "", ~/~/ имя учетной записи
787 + "password": "" ~/~/ пароль учетной записи
788 + },
789 + "inspectionTasks": { ~/~/ задания на ТО
790 + "id": "", ~/~/ ID задачи
791 + "enabled": false, ~/~/ Признак включения
792 + "name": "", ~/~/ Имя задания
793 + "description": "", ~/~/ Описание задания
794 + "mileageCondition": "", ~/~/ Условие по пробегу
795 + "lastMileage": "", ~/~/ Пробег (в метрах)
796 + "motohoursCondition": "", ~/~/ Условие по моточасам
797 + "lastMotohours": "", ~/~/ Моточасы
798 + "periodicCondition": "", ~/~/ Условие периодичности по времени
799 + "kind": "", ~/~/ Вид периодичности по времени 
800 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
801 + }
361 361  
362 362  (% style="text-align:left" %)
363 363  (% style="color:#000000" %)}
364 364  
806 +**Валидация:**
807 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
808 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
809 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
365 365  
811 +
812 +== (% style="color:#000000; line-height:14px" %)**Получение параметров объектов**(%%) ==
813 +
366 366  (% class="box successmessage" %)
367 367  (((
368 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
816 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
369 369  )))
370 370  
371 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
819 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
372 372  
373 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
821 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
374 374  
375 375  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
376 376  
377 377  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
378 378  
379 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
827 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
380 380  
381 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
829 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
382 382  
383 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
831 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
384 384  
385 385  (% style="color:#000000" %)Метод запроса: **POST**
386 386  
... ... @@ -388,76 +388,117 @@
388 388  
389 389  (% style="color:#000000" %)В заголовках запроса:
390 390  
391 -(% style="color:#000000" %)− Content-Type: application/json
839 +(% style="color:#000000" %)− Content-Type: __**application/json**__
392 392  
393 393  (% style="color:#000000" %)− X-Auth: Токен авторизации
394 394  
395 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
843 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
396 396  
397 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
845 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
398 398  
399 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
847 +{
848 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
849 + "name": null, ~/~/ Имя ТС (string, опционально)
850 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
851 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
852 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
853 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
854 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
855 + "customFields": null ~/~/ значение любого из произвольных полей ТС
856 +}
400 400  
401 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
858 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
402 402  
403 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
860 +(% style="color:#000000" %)Ответ:
404 404  
405 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
862 +(% style="color:#000000" %){
406 406  
407 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
864 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
865 + "name": "" ~/~/ наименование объекта
866 + "imei": "" ~/~/ IMEI объекта
867 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
868 + "deviceTypeName": "" ~/~/ наименование типа устройства
869 + "sim1": "" ~/~/ первый номер телефона
870 + "sim2": "" ~/~/ второй номер телефона
871 + "parentId": "" ~/~/ идентификатор клиента-родителя
872 + "parentName": "" ~/~/ наименование клиента-родителя
873 + "modelId": "" ~/~/ идентификатор модели объекта
874 + "modelName": "" ~/~/ наименование модели объекта
875 + "unitId": "" ~/~/ идентификатор подразделения
876 + "unitName": "" ~/~/ наименование подразделения
877 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
878 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
879 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
880 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
881 + "customFields": [ 
882 + {
883 + "id": "", ~/~/ идентификатор произвольного поля
884 + "name": "", ~/~/ имя произвольного поля
885 + "value": "", ~/~/ значение произвольного поля
886 + "forClient": true, ~/~/ право на отображение у клиента
887 + "forTooltip": false, ~/~/ право на отображение в подсказке
888 + "forReport": false ~/~/ право на отображение в отчетах
889 + }(%%)
890 +(% style="color:#000000" %)}
408 408  
409 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
892 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
410 410  
411 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
412 412  
895 +== (% style="color:#000000; line-height:14px" %)**Изменение статуса объекта**(%%) ==
413 413  
414 414  (% class="box successmessage" %)
415 415  (((
416 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
899 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
417 417  )))
418 418  
419 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
902 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
420 420  
421 421  (% style="color:#000000" %)Метод запроса: **POST**
422 422  
423 423  (% 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}
424 424  
425 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
908 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
426 426  
427 427  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
428 428  
429 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
912 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
430 430  
431 -(% class="western" %)
432 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
433 - "date": "", // Дата смены статуса (null если сменить немедленно)
434 - "description": "", // Описание
435 - "data": "", // Данные
436 - "overwrite": false, // Флаг перезаписи
437 - "stage": "", // Состояние, может быть null}}}
914 +(% style="color:#000000" %){
438 438  
916 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
917 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
918 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
919 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
920 + "description": "", ~/~/ Описание
921 + "data": "", ~/~/ Данные
922 + "overwrite": false, ~/~/ Флаг перезаписи
923 + "stage": "", ~/~/ Состояние, может быть null
924 +
439 439  (% style="color:#000000" %)}
440 440  
441 -(% style="color:#000000" %)Ответ: {
927 +(% style="color:#000000" %)Ответ:
442 442  
443 -(% class="western" %)
444 -{{{ "status": "", // значение статуса
445 - "date": "", // Дата смены статуса
446 - "description": "", // Описание
447 - "data": "", // Данные
448 - "overwrite": false, // Флаг перезаписи
449 - "stage": "", // Состояние}}}
929 +(% style="color:#000000" %){
450 450  
931 + "status": "", ~/~/ значение статуса
932 + "date": "", ~/~/ Дата смены статуса 
933 + "description": "", ~/~/ Описание
934 + "data": "", ~/~/ Данные
935 + "overwrite": false, ~/~/ Флаг перезаписи
936 + "stage": "", ~/~/ Состояние
937 +
451 451  (% style="text-align:left" %)
452 -(% style="color:#000000" %)}
939 +(% style="color:#000000" %) }
453 453  
454 454  
942 +== (% style="color:#000000; line-height:14px" %)**Редактирование объекта**(%%) ==
943 +
455 455  (% class="box warningmessage" %)
456 456  (((
457 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
946 +(% lang="en-US" %)**PUT /api/v3/vehicles**
458 458  )))
459 459  
460 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
949 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
461 461  
462 462  (% style="color:#000000" %)Метод запроса: **PUT**
463 463  
... ... @@ -467,26 +467,133 @@
467 467  
468 468  (% style="color:#000000" %)Параметры в теле запроса (JSON):
469 469  
470 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
959 +(% style="color:#000000" %){    
471 471  
961 +(((
962 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
963 + "parentId": "", ~/~/ ID клиента
964 + "name": "", ~/~/ имя ТС
965 + "imei": "", ~/~/ IMEI
966 + "deviceTypeId": "", ~/~/ ID типа устройства
967 + "modelId": "", ~/~/ , ID модели    
968 + "unitId": "", ~/~/ подразделения
969 + "sim1": "", ~/~/ SIM 1
970 + "sim2": "", ~/~/ SIM2     (%%)
971 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
972 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
973 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
974 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
975 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
976 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
977 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
978 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
979 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
980 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
981 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
982 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
983 +(% style="color:#000000" %) "counters": 
984 + {
985 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
986 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
987 + "mileage": "", ~/~/ пробег, в метрах 
988 + "motohours": "" ~/~/ моточасы, в секундах
989 + }
990 + "cmsv6Parameters": ~/~/ параметры CMSv6
991 + {       
992 + "id": "", ~/~/ идентификатор
993 + "enabled": true, ~/~/ флаг включения
994 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
995 + "login": "", ~/~/ имя учетной записи
996 + "password": "", ~/~/ пароль учетной записи
997 + }
998 + "inspectionTasks": ~/~/ задания на ТО
999 + {
1000 + "id": "", ~/~/ ID задания
1001 + "enabled": false, ~/~/ Признак включения
1002 + "name": "", ~/~/ Имя задания
1003 + "description": "", ~/~/ Описание задания
1004 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1005 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1006 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1007 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1008 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1009 + "kind": "", ~/~/ Вид периодичности по времени
1010 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1011 + } 
1012 +)))
1013 +
1014 +(% style="color:#000000" %)}
1015 +
472 472  (% style="color:#000000" %)Ответ:
473 473  
474 474  (% lang="en-US" style="text-align:left" %)
475 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
1019 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
476 476  
1021 +(% lang="en-US" style="text-align:left" %)
1022 + "vehicleId": "", ~/~/ ID ТС
1023 + "parentId": "", ~/~/ ID клиента
1024 + "name": "", ~/~/ имя ТС
1025 + "imei": "", ~/~/ IMEI
1026 + "deviceTypeId": "", ~/~/ типа устройства
1027 + "modelId": "", ~/~/ ID модели
1028 + "unitId": "", ~/~/ ID подразделения
1029 + "sim1": "", ~/~/ SIM 1
1030 + "sim2": "", ~/~/ SIM2
1031 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1032 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1033 + "counters": 
1034 + {
1035 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1036 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1037 + "mileage": "", ~/~/ пробег
1038 + "motohours": "", ~/~/ моточасы
1039 + }
1040 + "cmsv6Parameters": ~/~/ параметры CMSv6
1041 + {
1042 + "id": ~/~/ идентификатор
1043 + "enabled": true, ~/~/ флаг включения
1044 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1045 + "login": "", ~/~/ имя учетной записи
1046 + "password": "", ~/~/ пароль учетной записи
1047 + }
1048 + "inspectionTasks": ~/~/ задания на ТО
1049 + {
1050 + "id": "", ~/~/ ID задания
1051 + "enabled": false, ~/~/ Признак включения
1052 + "name": "", ~/~/ Имя задания
1053 + "description": "", ~/~/ Описание задания
1054 + "mileageCondition": "", ~/~/ Условие по пробегу
1055 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1056 + "motohoursCondition": "", ~/~/ Условие по моточасам
1057 + "lastMotohours": "", ~/~/ Моточасы
1058 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1059 + "kind": "", ~/~/ Вид периодичности по времени
1060 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1061 + }
477 477  
1063 +(% lang="en-US" style="text-align:left" %)
1064 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1065 +
1066 +**валидация:**
1067 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1068 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1069 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1070 +
1071 +
1072 +== (% style="color:#000000; line-height:14px" %)**Удаление объекта**(%%) ==
1073 +
478 478  (% class="box errormessage" %)
479 479  (((
480 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1076 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
481 481  )))
482 482  
483 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1079 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
484 484  
485 485  (% style="color:#000000" %)Метод запроса: **DELETE**
486 486  
487 487  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
488 488  
489 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1085 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
490 490  
491 491  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
492 492  
... ... @@ -494,17 +494,17 @@
494 494  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
495 495  
496 496  
497 -(% class="box" lang="en-US" style="text-align: center;" %)
498 -(((
499 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
500 -)))
1093 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
501 501  
1095 +
1096 +== (% style="color:#000000; line-height:14px" %)**Получение списка типов устройств**(%%) ==
1097 +
502 502  (% class="box infomessage" %)
503 503  (((
504 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1100 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
505 505  )))
506 506  
507 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1103 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
508 508  
509 509  (% style="color:#000000" %)Метод запроса: **GET**
510 510  
... ... @@ -512,29 +512,28 @@
512 512  
513 513  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
514 514  
515 -(% style="color:#000000" %)Ответ: [
1111 +(% style="color:#000000" %)Ответ:
516 516  
517 -(% class="western" %)
518 -{{{ {
519 - "deviceTypeId" : "", // ID типа устройства
520 - "deviceTypeName" : "" // Название типа устройства
521 - },}}}
1113 +(% style="color:#000000" %){
522 522  
1115 + "deviceTypeId" : "", ~/~/ ID типа устройства
1116 + "deviceTypeName" : "" ~/~/ Название типа устройства
1117 +
523 523  (% style="text-align:left" %)
524 -(% style="color:#000000" %)…** **]
1119 +(% style="color:#000000" %)}
525 525  
526 526  
527 -(% class="box" style="text-align: center;" %)
528 -(((
529 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
530 -)))
1122 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
531 531  
1124 +
1125 +== (% style="color:#000000; line-height:14px" %)**Получение списка типов датчиков**(%%) ==
1126 +
532 532  (% class="box infomessage" %)
533 533  (((
534 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1129 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
535 535  )))
536 536  
537 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1132 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
538 538  
539 539  (% style="color:#000000" %)Метод запроса: **GET**
540 540  
... ... @@ -542,19 +542,16 @@
542 542  
543 543  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
544 544  
545 -(% style="color:#000000" %)Ответ: [
1140 +(% style="color:#000000" %)Ответ:
546 546  
547 -(% class="western" style="margin-bottom:19px" %)
548 -{{{ {}}}
1142 +(% style="color:#000000" %){
549 549  
550 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1144 + "id": "", ~/~/ ID типа датчика 
1145 + "name": "", ~/~/ Название
1146 + "description": "", ~/~/ Описание
551 551  
552 -(% class="western" %)
553 -{{{ "description": "" // Описание
554 - },}}}
555 -
556 556  (% style="text-align:left" %)
557 -(% style="color:#000000" %)… ]
1149 +(% style="color:#000000" %)}
558 558  
559 559  
560 560  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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