Комментарий

• Свойства страницы (3 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Автор документа

...	...	@@ -1,1 +1,1 @@
1		-XWiki.krainovim
	1	+XWiki.Artem

Теги

...	...	@@ -1,1 +1,0 @@
1		-Public API|API

Содержимое

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