Summary

• Page properties (4 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Методы API для работы с ГЛОНАССSoft
	1	+API

Author

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

Tags

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

Content

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