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