Summary

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

Details

Page properties

Author

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

Tags

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

Content

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