Summary

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

Details

Page properties

Title

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

Author

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

Content

...	...	@@ -1,271 +1,359 @@
1		-== Описание ГЛОНАССSoft Public API ==
	1	+(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
	2	+== Описание ГЛОНАССSoft Public API 3.0 ==
2	2
3	3	== ==
4	4
5		- **Действующие ограничения**
	6	+(% class="box" style="text-align: center;" %)
	7	+(((
	8	+(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
	9	+)))
6	6
7		-Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
	11	+(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
8	8
	13	+(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
	14	+
9	9	Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
	16	+
10	10
11		- **Авторизация**
	18	+(% class="box" style="text-align: center;" %)
	19	+(((
	20	+(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
	21	+)))
12	12
13		-Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
	23	+(% class="box infomessage" %)
	24	+(((
	25	+ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
	26	+)))
14	14
15		-Метод запроса: GET
	28	+(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
16	16
17		-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]]
	30	+(% style="color:#000000" %)Метод запроса: **GET**
18	18
19		-В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
	32	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
20	20
21		-Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
	34	+(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
22	22
23		- **Получение списка объектов**
	36	+(% lang="en-US" %)
	37	+(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
24	24
25		-Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
	39	+**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
26	26
27		-−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
28	28
29		-−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
	42	+(% class="box infomessage" %)
	43	+(((
	44	+(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
	45	+)))
30	30
31		-−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
	47	+(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
32	32
33		-−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
	49	+(% style="color:#000000" %)Метод запроса: **GET**
34	34
35		-−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
	51	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
36	36
37		-Метод запроса: POST
	53	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
38	38
39		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
	55	+(% lang="en-US" %)
	56	+(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
40	40
41		-В заголовках запроса:
42	42
43		-−Content-Type: application/json
	59	+(% class="box" style="text-align: center;" %)
	60	+(((
	61	+(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
	62	+)))
44	44
45		-−X-Auth: Токен авторизации
	64	+(% class="box infomessage" %)
	65	+(((
	66	+(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
	67	+)))
46	46
47		-Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
	69	+(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
48	48
49		-{{{{"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, опционально)}}}}
	71	+(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
50	50
51		-Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
	73	+(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
52	52
53		-Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов  //}, … ]
	75	+(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
54	54
55		-Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
	77	+(% style="color:#000000" %)Метод запроса: **GET**
56	56
57		-0 - «Блокировка»
	79	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
58	58
59		-1 - «Активен»,
	81	+(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
60	60
61		-2 - «Отменен»
	83	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
62	62
63		-3 - «Оборудован»
	85	+(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
64	64
65		-4 - «Диагностика»
	87	+(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
66	66
67		-5 - «Сервис»
68	68
69		-6 - «Демонтаж»
	90	+(% class="box" lang="en-US" style="text-align: center;" %)
	91	+(((
	92	+(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
	93	+)))
70	70
71		-7 - «Монтаж»
	95	+(% class="box infomessage" %)
	96	+(((
	97	+(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
	98	+)))
72	72
73		-8 - «Дозаказ»
	100	+(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
74	74
75		-9 - «Обслужен»
	102	+(% style="color:#000000" %)Метод запроса: **GET**
76	76
77		-10 - «Списан»
	104	+(% 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]]
78	78
79		-11 - «Неисправен»
	106	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
80	80
81		-12 - «Проверен»
	108	+(% style="color:#000000" %)Ответ: [
82	82
83		-13 - «Не эксплуатируется»
	110	+(% class="western" %)
	111	+{{{ {
	112	+ "deviceTypeId" : "", // ID типа устройства
	113	+ "deviceTypeName" : "" // Название типа устройства
	114	+ },}}}
84	84
85		- **Получение списка клиентов.**
	116	+(% style="text-align:left" %)
	117	+(% style="color:#000000" %)…** **]
86	86
87		-Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
88	88
89		-−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
	120	+(% class="box" style="text-align: center;" %)
	121	+(((
	122	+(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
	123	+)))
90	90
91		-−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
	125	+(% class="box infomessage" %)
	126	+(((
	127	+(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
	128	+)))
92	92
93		-−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
	130	+(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
94	94
95		-Метод запроса: GET
	132	+(% style="color:#000000" %)Метод запроса: **GET**
96	96
97		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
	134	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
98	98
99		-Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
	136	+(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
100	100
101		-В заголовках запроса: X-Auth: Токен авторизации
	138	+(% style="color:#000000" %)Ответ: [
102	102
103		-Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
	140	+(% class="western" style="margin-bottom:19px" %)
	141	+{{{ {}}}
104	104
105		-Примечание. Возможные значение параметра agentInfoType:
	143	+(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
106	106
107		- **Получение списка пользователей.**
	145	+(% class="western" %)
	146	+{{{ "description": "" // Описание
	147	+ },}}}
108	108
109		-Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
	149	+(% style="text-align:left" %)
	150	+(% style="color:#000000" %)… ]
110	110
111		-Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
112	112
113		-Метод запроса: POST
	153	+(% class="box" style="text-align: center;" %)
	154	+(((
	155	+(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
	156	+)))
114	114
115		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
	158	+(% class="box successmessage" %)
	159	+(((
	160	+(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
	161	+)))
116	116
117		-Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
	163	+(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
118	118
119		-{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
120		- //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
121		- "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
122		- //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
	165	+(% style="color:#000000" %)Метод запроса: **POST**
123	123
124		-}
	167	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
125	125
126		-Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
	169	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
127	127
128		-{{{ "sessionDuration": "", // длительность сессии в минутах}}}
	171	+(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
129	129
130		- «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
	173	+(% style="text-align:left" %)
	174	+(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
131	131
132		- **Получение списка типов устройств**
133	133
134		-Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	177	+(% class="box warningmessage" %)
	178	+(((
	179	+(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
	180	+)))
135	135
136		-Метод запроса: GET
	182	+(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
137	137
138		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
	184	+(% style="color:#000000" %)Метод запроса: **PUT**
139	139
140		-В заголовках запроса:X-Auth: Токен авторизации
	186	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
141	141
142		-Ответ: [
	188	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
143	143
144		-{{{ {
145		- "deviceTypeId" : "", // ID типа устройства
146		- "deviceTypeName" : "" // Название типа устройства
147		- },}}}
	190	+(% lang="en-US" style="text-align:left" %)
	191	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
148	148
149		-… ]
150	150
151		- **Получение списка типов датчиков**
	194	+(% class="box warningmessage" %)
	195	+(((
	196	+(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
	197	+)))
152	152
153		-Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	199	+(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
154	154
155		-Метод запроса: GET
	201	+(% style="color:#000000" %)Метод запроса: **PUT**
156	156
157		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
	203	+(% 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} Параметр запроса:
158	158
159		-В заголовках запроса:X-Auth: Токен авторизации
	205	+(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
160	160
161		-Ответ: [
	207	+(% class="western" %)
	208	+{{{ "description": "", // описание
	209	+ "data": "" // данные, связанные со сменой статуса}}}
162	162
163		-{{{ {}}}
	211	+(% style="color:#000000" %)}
164	164
165		-«id»: «», //ID типа датчика «name»: «», //Название
	213	+(% style="text-align:left" %)
	214	+(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
166	166
167		-{{{ "description": "" // Описание
168		- },}}}
169	169
170		-… ]
	217	+(% class="box successmessage" %)
	218	+(((
	219	+(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
	220	+)))
171	171
172		- **Получение информации об объекте**
	222	+(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
173	173
174		-Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
	224	+(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
175	175
176		-Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
	226	+(% style="color:#000000" %)Метод запроса: **POST**
177	177
178		-−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
	228	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
179	179
180		-Метод запроса: GET
	230	+(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
181	181
182		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
	232	+(% class="western" %)
	233	+{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
	234	+ //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
	235	+ "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
	236	+ //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
183	183
184		-Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
	238	+(% style="color:#000000" %)}
185	185
186		-В заголовках запроса: X-Auth: Токен авторизации
	240	+(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
187	187
188		-Ответ:
	242	+(% class="western" style="margin-bottom:19px" %)
	243	+{{{ "sessionDuration":"", // длительность сессии в минутах}}}
189	189
190		-{
	245	+(% lang="en-US" style="text-align:left" %)
	246	+(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
191	191
192		-{{{ "vehicleId": “”, // идентификатор объекта
193		- "name": "", // имя объекта
194		- "imei": "", // IMEI объекта
195		- "deviceTypeId": “”, // идентификатор устройства объекта
196		- "deviceTypeName": "" // наименование устройства объекта
197		- "parentId": "", // идентификатор клиента-родителя
198		- "parentName": "" // наименование клиента-родителя,
199		- "modelId": "", // идентификатор модели объекта
200		- "modelName": "" // наименование модели объекта,
201		- "unitId": "", // идентификатор подразделения
202		- "unitName": "", // наименование подразделения
203		- "status": “”, // статус объекта
204		- ...
205		- },
206		- ...}}}
207	207
208		-}
	249	+(% class="box errormessage" %)
	250	+(((
	251	+(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
	252	+)))
209	209
210		-Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
	254	+(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
211	211
212		- **Добавление пользователя**
	256	+(% style="color:#000000" %)Метод запроса: **DELETE**
213	213
214		-Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	258	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
215	215
216		-Метод запроса: POST
	260	+(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
217	217
218		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
	262	+(% style="text-align:left" %)
	263	+(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
219	219
220		-В заголовках запроса: X-Auth: Токен авторизации
221	221
222		-Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
	266	+(% class="box" style="text-align: center;" %)
	267	+(((
	268	+(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
	269	+)))
223	223
224		-Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
	271	+(% class="box errormessage" %)
	272	+(((
	273	+(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
	274	+)))
225	225
226		- **Редактирование пользователя**
	276	+(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
227	227
228		-Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	278	+(% style="color:#000000" %)Метод запроса: **DELETE**
229	229
230		-Метод запроса: PUT
	280	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
231	231
232		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
	282	+(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
233	233
234		-В заголовках запроса: X-Auth: Токен авторизации
	284	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235	235
236		-Параметры в теле запроса (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 - блокирован)
	286	+(% style="text-align:left" %)
	287	+(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
237	237
238		-{{{ "description": "", // описание
239		- "data": "" // данные, связанные со сменой статуса}}}
240	240
241		-}
	290	+(% class="box infomessage" %)
	291	+(((
	292	+(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
	293	+)))
242	242
243		-Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	295	+(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
244	244
245		- **Удаление пользователя**
	297	+(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
246	246
247		-Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	299	+(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
248	248
249		-Метод запроса: DELETE
	301	+(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
250	250
251		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
	303	+(% style="color:#000000" %)Метод запроса: **GET**
252	252
253		-Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
	305	+(% 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>
254	254
255		-Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	307	+(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
256	256
257		- **Добавление объекта**
	309	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
258	258
259		-Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
	311	+(% style="color:#000000" %)Ответ:
260	260
261		-Метод запроса: POST
	313	+(% style="color:#000000" %){
262	262
263		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	315	+(% class="western" %)
	316	+{{{ "vehicleId": “”, // идентификатор объекта
	317	+ "name": "", // имя объекта
	318	+ "imei": "", // IMEI объекта
	319	+ "deviceTypeId": “”, // идентификатор устройства объекта
	320	+ "deviceTypeName": "" // наименование устройства объекта
	321	+ "parentId": "", // идентификатор клиента-родителя
	322	+ "parentName": "" // наименование клиента-родителя,
	323	+ "modelId": "", // идентификатор модели объекта
	324	+ "modelName": "" // наименование модели объекта,
	325	+ "unitId": "", // идентификатор подразделения
	326	+ "unitName": "", // наименование подразделения
	327	+ "status": “”, // статус объекта
	328	+ ...
	329	+ },
	330	+ ...}}}
264	264
265		-В заголовках запроса: X-Auth: Токен авторизации
	332	+(% style="color:#000000" %)}
266	266
267		-Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
	334	+(% style="text-align:left" %)
	335	+Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
268	268
	337	+(% style="text-align:left" %)
	338	+0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
	339	+
	340	+
	341	+(% class="box successmessage" %)
	342	+(((
	343	+(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
	344	+)))
	345	+
	346	+(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
	347	+
	348	+(% style="color:#000000" %)Метод запроса: **POST**
	349	+
	350	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	351	+
	352	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	353	+
	354	+(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
	355	+
	356	+(% class="western" %)
269	269	{{{ "parentId": "", // ID клиента
270	270	"name": "", // имя ТС
271	271	"imei": "", // IMEI
...	...	@@ -306,12 +306,13 @@
306	306	},
307	307	]}}}
308	308
309		-… }
	397	+(% style="color:#000000" %)… }
310	310
311		-Ответ:
	399	+(% style="color:#000000" %)Ответ:
312	312
313		-{
	401	+(% style="color:#000000" %){
314	314
	403	+(% class="western" %)
315	315	{{{ "vehicleId": "", //ID ТС
316	316	"parentId": "", //Guid владельца ТС
317	317	"name": "", //Имя объекта
...	...	@@ -346,61 +346,132 @@
346	346	"lastMileage": "", // Пробег (в метрах)
347	347	"motohoursCondition": "", // Условие по моточасам
348	348	"lastMotohours": "", // Моточасы
349		- "periodicCondition": "", // Условие периодичности по времени}}}
350		-
351		-{{{ "kind": "", // Вид периодичности по времени
	438	+ "periodicCondition": "", // Условие периодичности по времени
	439	+ "kind": "", // Вид периодичности по времени
352	352	"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
353	353	}
354	354	]}}}
355	355
356		-}
	444	+(% style="text-align:left" %)
	445	+(% style="color:#000000" %)}
357	357
358		- **Удаление объекта**
359	359
360		-Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	448	+(% class="box warningmessage" %)
	449	+(((
	450	+(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
	451	+)))
361	361
362		-Метод запроса: DELETE
	453	+(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
363	363
364		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
	455	+(% style="color:#000000" %)Метод запроса: **PUT**
365	365
366		-Параметр запроса: {id} - Guid объекта
	457	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
367	367
368		-В заголовках запроса: X-Auth: Токен авторизации
	459	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
369	369
370		-Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	461	+(% style="color:#000000" %)Параметры в теле запроса (JSON):
371	371
372		- **Редактирование объекта**
	463	+(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
373	373
374		-Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	465	+(% style="color:#000000" %)Ответ:
375	375
376		-Метод запроса: PUT
	467	+(% lang="en-US" style="text-align:left" %)
	468	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
377	377
378		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
379	379
380		-В заголовках запроса: X-Auth: Токен авторизации
	471	+(% class="box successmessage" %)
	472	+(((
	473	+(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
	474	+)))
381	381
382		-Параметры в теле запроса (JSON):
	476	+(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
383	383
384		-//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
	478	+(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
385	385
386		-Ответ:
	480	+(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
387	387
388		-{ «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»: «» //Сколько раз выполнить задание } ] }
	482	+(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
389	389
390		- **Изменение статуса объекта**
	484	+(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
391	391
392		-Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	486	+(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
393	393
394		-Метод запроса: POST
	488	+(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
395	395
396		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
	490	+(% style="color:#000000" %)Метод запроса: **POST**
397	397
398		-Параметр запроса: {vehicleId} - ID ТС
	492	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
399	399
400		-В заголовках запроса: X-Auth: Токен авторизации
	494	+(% style="color:#000000" %)В заголовках запроса:
401	401
402		-Параметры в теле запроса (JSON): {
	496	+(% style="color:#000000" %)− Content-Type: application/json
403	403
	498	+(% style="color:#000000" %)− X-Auth: Токен авторизации
	499	+
	500	+(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
	501	+
	502	+(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
	503	+
	504	+(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
	505	+
	506	+(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
	507	+
	508	+(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
	509	+
	510	+(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
	511	+
	512	+(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
	513	+
	514	+(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
	515	+
	516	+(% style="color:#000000" %)0 - «Блокировка»
	517	+
	518	+(% style="color:#000000" %)1 - «Активен»,
	519	+
	520	+(% style="color:#000000" %)2 - «Отменен»
	521	+
	522	+(% style="color:#000000" %)3 - «Оборудован»
	523	+
	524	+(% style="color:#000000" %)4 - «Диагностика»
	525	+
	526	+(% style="color:#000000" %)5 - «Сервис»
	527	+
	528	+(% style="color:#000000" %)6 - «Демонтаж»
	529	+
	530	+(% style="color:#000000" %)7 - «Монтаж»
	531	+
	532	+(% style="color:#000000" %)8 - «Дозаказ»
	533	+
	534	+(% style="color:#000000" %)9 - «Обслужен»
	535	+
	536	+(% style="color:#000000" %)10 - «Списан»
	537	+
	538	+(% style="color:#000000" %)11 - «Неисправен»
	539	+
	540	+(% style="color:#000000" %)12 - «Проверен»
	541	+
	542	+(% style="text-align:left" %)
	543	+(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
	544	+
	545	+
	546	+(% class="box successmessage" %)
	547	+(((
	548	+(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
	549	+)))
	550	+
	551	+(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	552	+
	553	+(% style="color:#000000" %)Метод запроса: **POST**
	554	+
	555	+(% 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}
	556	+
	557	+(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
	558	+
	559	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	560	+
	561	+(% style="color:#000000" %)Параметры в теле запроса (JSON): {
	562	+
	563	+(% class="western" %)
404	404	{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
405	405	"date": "", // Дата смены статуса (null если сменить немедленно)
406	406	"description": "", // Описание
...	...	@@ -408,10 +408,11 @@
408	408	"overwrite": false, // Флаг перезаписи
409	409	"stage": "", // Состояние, может быть null}}}
410	410
411		-}
	571	+(% style="color:#000000" %)}
412	412
413		-Ответ: {
	573	+(% style="color:#000000" %)Ответ: {
414	414
	575	+(% class="western" %)
415	415	{{{ "status": "", // значение статуса
416	416	"date": "", // Дата смены статуса
417	417	"description": "", // Описание
...	...	@@ -419,18 +419,11 @@
419	419	"overwrite": false, // Флаг перезаписи
420	420	"stage": "", // Состояние}}}
421	421
422		-}
	583	+(% style="text-align:left" %)
	584	+(% style="color:#000000" %)}
423	423
424		- **Проверка авторизации**
425	425
426		-Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
427		-
428		-Метод запроса: GET
429		-
430		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
431		-
432		-В заголовках запроса: X-Auth: Токен авторизации
433		-
434		-Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
435		-
436		-**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
	587	+(% class="box" lang="en-US" style="text-align: center;" %)
	588	+(((
	589	+(% 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]] **
	590	+)))