Summary

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

Details

Page properties

Content

...	...	@@ -1,5 +1,5 @@
1	1	(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2		-== Описание ГЛОНАССSoft Public API 3.0 ==
	2	+== Описание ГЛОНАССSoft Public API ==
3	3
4	4	== ==
5	5
...	...	@@ -17,28 +17,40 @@
17	17
18	18	(% class="box" style="text-align: center;" %)
19	19	(((
20		-(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
	20	+(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
21	21	)))
22	22
23	23	(% class="box infomessage" %)
24	24	(((
25		- (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
	25	+(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
26	26	)))
27	27
28		-(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
	28	+(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
29	29
	30	+(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
	31	+
	32	+(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
	33	+
	34	+(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
	35	+
30	30	(% style="color:#000000" %)Метод запроса: **GET**
31	31
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]]
	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>
33	33
34		-(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
	40	+(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
35	35
36		-(% lang="en-US" %)
37		-(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
	42	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
38	38
39		-**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
	44	+(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
40	40
	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" %)]
41	41
	48	+
	49	+(% class="box" style="text-align: center;" %)
	50	+(((
	51	+(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
	52	+)))
	53	+
42	42	(% class="box infomessage" %)
43	43	(((
44	44	(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
...	...	@@ -56,45 +56,87 @@
56	56	(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
57	57
58	58
59		-(% class="box" style="text-align: center;" %)
	71	+(% class="box infomessage" %)
60	60	(((
61		-(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
	73	+(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
62	62	)))
63	63
	76	+(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
	77	+
	78	+(% style="color:#000000" %)Метод запроса: **GET**
	79	+
	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]]
	81	+
	82	+(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
	83	+
	84	+(% lang="en-US" %)
	85	+(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
	86	+
	87	+**Примечание: **Время жизни токена авторизации задается через настройки пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
	88	+
	89	+(% class="box" lang="en-US" style="text-align: center;" %)
	90	+(((
	91	+(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
	92	+)))
	93	+
64	64	(% class="box infomessage" %)
65	65	(((
66		-(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
	96	+(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
67	67	)))
68	68
69		-(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
	99	+(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
70	70
71		-(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
	101	+(% style="color:#000000" %)Метод запроса: **GET**
72	72
73		-(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
	103	+(% 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]]
74	74
75		-(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
	105	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
76	76
	107	+(% style="color:#000000" %)Ответ: [
	108	+
	109	+(% class="western" %)
	110	+{{{ {
	111	+ "deviceTypeId" : "", // ID типа устройства
	112	+ "deviceTypeName" : "" // Название типа устройства
	113	+ },}}}
	114	+
	115	+(% style="text-align:left" %)
	116	+(% style="color:#000000" %)…** **]
	117	+
	118	+
	119	+(% class="box" style="text-align: center;" %)
	120	+(((
	121	+(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
	122	+)))
	123	+
	124	+(% class="box infomessage" %)
	125	+(((
	126	+(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
	127	+)))
	128	+
	129	+(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	130	+
77	77	(% style="color:#000000" %)Метод запроса: **GET**
78	78
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>
	133	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
80	80
81		-(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
	135	+(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
82	82
83		-(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	137	+(% style="color:#000000" %)Ответ: [
84	84
85		-(% style="color:#000000" %)Ответ: [ {
86		- "agentId": "", ~/~/ идентификатор клиента
87		- "parentId": "", ~/~/ идентификатор клиента-родителя
88		- "name": "", ~/~/ наименование клиента
89		- "fullName": "", ~/~/ полное наименование клиента
90		- "agentInfoType": "", ~/~/ тип клиента1
91		- "status": "", ~/~/ статус клиента
92		- }, … ]
	139	+(% class="western" style="margin-bottom:19px" %)
	140	+{{{ {}}}
93	93
	142	+(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
94	94
95		-(% 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" %)]
	144	+(% class="western" %)
	145	+{{{ "description": "" // Описание
	146	+ },}}}
96	96
	148	+(% style="text-align:left" %)
	149	+(% style="color:#000000" %)… ]
97	97
	151	+
98	98	(% class="box" style="text-align: center;" %)
99	99	(((
100	100	(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
...	...	@@ -119,38 +119,6 @@
119	119	(% 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» //названия групп ] }
120	120
121	121
122		-(% class="box successmessage" %)
123		-(((
124		-(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
125		-)))
126		-
127		-(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
128		-
129		-(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
130		-
131		-(% style="color:#000000" %)Метод запроса: **POST**
132		-
133		-(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
134		-
135		-(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
136		-
137		-(% class="western" %)
138		-{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
139		- //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
140		- "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
141		- //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
142		-
143		-(% style="color:#000000" %)}
144		-
145		-(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
146		-
147		-(% class="western" style="margin-bottom:19px" %)
148		-{{{ "sessionDuration":"", // длительность сессии в минутах}}}
149		-
150		-(% lang="en-US" style="text-align:left" %)
151		-(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
152		-
153		-
154	154	(% class="box warningmessage" %)
155	155	(((
156	156	(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
...	...	@@ -170,7 +170,7 @@
170	170
171	171	(% class="box warningmessage" %)
172	172	(((
173		-(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
	195	+(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
174	174	)))
175	175
176	176	(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
...	...	@@ -191,6 +191,38 @@
191	191	(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
192	192
193	193
	216	+(% class="box successmessage" %)
	217	+(((
	218	+(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
	219	+)))
	220	+
	221	+(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
	222	+
	223	+(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
	224	+
	225	+(% style="color:#000000" %)Метод запроса: **POST**
	226	+
	227	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
	228	+
	229	+(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
	230	+
	231	+(% class="western" %)
	232	+{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
	233	+ //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
	234	+ "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
	235	+ //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
	236	+
	237	+(% style="color:#000000" %)}
	238	+
	239	+(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
	240	+
	241	+(% class="western" style="margin-bottom:19px" %)
	242	+{{{ "sessionDuration":"", // длительность сессии в минутах}}}
	243	+
	244	+(% lang="en-US" style="text-align:left" %)
	245	+(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
	246	+
	247	+
194	194	(% class="box errormessage" %)
195	195	(((
196	196	(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
...	...	@@ -213,6 +213,25 @@
213	213	(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
214	214	)))
215	215
	270	+(% class="box errormessage" %)
	271	+(((
	272	+(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
	273	+)))
	274	+
	275	+(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	276	+
	277	+(% style="color:#000000" %)Метод запроса: **DELETE**
	278	+
	279	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
	280	+
	281	+(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
	282	+
	283	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	284	+
	285	+(% style="text-align:left" %)
	286	+(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
	287	+
	288	+
216	216	(% class="box infomessage" %)
217	217	(((
218	218	(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
...	...	@@ -371,9 +371,32 @@
371	371	(% style="color:#000000" %)}
372	372
373	373
	447	+(% class="box warningmessage" %)
	448	+(((
	449	+(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
	450	+)))
	451	+
	452	+(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	453	+
	454	+(% style="color:#000000" %)Метод запроса: **PUT**
	455	+
	456	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	457	+
	458	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	459	+
	460	+(% style="color:#000000" %)Параметры в теле запроса (JSON):
	461	+
	462	+(% 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»: «» //Сколько раз выполнить задание } ] }
	463	+
	464	+(% style="color:#000000" %)Ответ:
	465	+
	466	+(% lang="en-US" style="text-align:left" %)
	467	+(% 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»: «» //Сколько раз выполнить задание } ] }
	468	+
	469	+
374	374	(% class="box successmessage" %)
375	375	(((
376		-(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
	472	+(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
377	377	)))
378	378
379	379	(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
...	...	@@ -416,9 +416,36 @@
416	416
417	417	(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
418	418
419		-0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
	515	+(% style="color:#000000" %)0 - «Блокировка»
420	420
	517	+(% style="color:#000000" %)1 - «Активен»,
421	421
	519	+(% style="color:#000000" %)2 - «Отменен»
	520	+
	521	+(% style="color:#000000" %)3 - «Оборудован»
	522	+
	523	+(% style="color:#000000" %)4 - «Диагностика»
	524	+
	525	+(% style="color:#000000" %)5 - «Сервис»
	526	+
	527	+(% style="color:#000000" %)6 - «Демонтаж»
	528	+
	529	+(% style="color:#000000" %)7 - «Монтаж»
	530	+
	531	+(% style="color:#000000" %)8 - «Дозаказ»
	532	+
	533	+(% style="color:#000000" %)9 - «Обслужен»
	534	+
	535	+(% style="color:#000000" %)10 - «Списан»
	536	+
	537	+(% style="color:#000000" %)11 - «Неисправен»
	538	+
	539	+(% style="color:#000000" %)12 - «Проверен»
	540	+
	541	+(% style="text-align:left" %)
	542	+(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
	543	+
	544	+
422	422	(% class="box successmessage" %)
423	423	(((
424	424	(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
...	...	@@ -437,9 +437,7 @@
437	437	(% style="color:#000000" %)Параметры в теле запроса (JSON): {
438	438
439	439	(% class="western" %)
440		-{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
441		-  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
442		-  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
	563	+{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
443	443	"date": "", // Дата смены статуса (null если сменить немедленно)
444	444	"description": "", // Описание
445	445	"data": "", // Данные
...	...	@@ -462,112 +462,7 @@
462	462	(% style="color:#000000" %)}
463	463
464	464
465		-(% class="box warningmessage" %)
466		-(((
467		-(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
468		-)))
469		-
470		-(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
471		-
472		-(% style="color:#000000" %)Метод запроса: **PUT**
473		-
474		-(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
475		-
476		-(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
477		-
478		-(% style="color:#000000" %)Параметры в теле запроса (JSON):
479		-
480		-(% 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»: «» //Сколько раз выполнить задание } ] }
481		-
482		-(% style="color:#000000" %)Ответ:
483		-
484		-(% lang="en-US" style="text-align:left" %)
485		-(% 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»: «» //Сколько раз выполнить задание } ] }
486		-
487		-
488		-(% class="box errormessage" %)
489		-(((
490		-(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
491		-)))
492		-
493		-(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
494		-
495		-(% style="color:#000000" %)Метод запроса: **DELETE**
496		-
497		-(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
498		-
499		-(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
500		-
501		-(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
502		-
503		-(% style="text-align:left" %)
504		-(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
505		-
506		-
507	507	(% class="box" lang="en-US" style="text-align: center;" %)
508	508	(((
509		-(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
510		-)))
511		-
512		-(% class="box infomessage" %)
513		-(((
514		-(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
515		-)))
516		-
517		-(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
518		-
519		-(% style="color:#000000" %)Метод запроса: **GET**
520		-
521		-(% 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]]
522		-
523		-(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
524		-
525		-(% style="color:#000000" %)Ответ: [
526		-
527		-(% class="western" %)
528		-{{{ {
529		- "deviceTypeId" : "", // ID типа устройства
530		- "deviceTypeName" : "" // Название типа устройства
531		- },}}}
532		-
533		-(% style="text-align:left" %)
534		-(% style="color:#000000" %)…** **]
535		-
536		-
537		-(% class="box" style="text-align: center;" %)
538		-(((
539		-(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
540		-)))
541		-
542		-(% class="box infomessage" %)
543		-(((
544		-(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
545		-)))
546		-
547		-(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
548		-
549		-(% style="color:#000000" %)Метод запроса: **GET**
550		-
551		-(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
552		-
553		-(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
554		-
555		-(% style="color:#000000" %)Ответ: [
556		-
557		-(% class="western" style="margin-bottom:19px" %)
558		-{{{ {}}}
559		-
560		-(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
561		-
562		-(% class="western" %)
563		-{{{ "description": "" // Описание
564		- },}}}
565		-
566		-(% style="text-align:left" %)
567		-(% style="color:#000000" %)… ]
568		-
569		-
570		-(% class="box" lang="en-US" style="text-align: center;" %)
571		-(((
572	572	(% 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]] **
573	573	)))