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,413 @@
1		-== Описание ГЛОНАССSoft Public API
2		- ==
	1	+(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
	2	+== Описание ГЛОНАССSoft Public API 3.0 ==
3	3
4		- **Действующие ограничения**
	4	+== ==
5	5
6		-Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
	6	+(% class="box" style="text-align: center;" %)
	7	+(((
	8	+(% style="color:#000000; 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; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
	26	+)))
13	13
14		-Метод запроса: GET
	28	+(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
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" %)Метод запроса: **GET**
17	17
18		-В случае успешного выполнения метода, поле «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]]
19	19
20		-Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
	34	+(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
21	21
22		- **Получение списка объектов**
	36	+(% lang="en-US" %)
	37	+(% style="color:#000000" %)**Ответ:**
23	23
24		-Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
	39	+(% lang="en-US" %)
	40	+(% style="color:#000000" %){
25	25
26		-−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
	42	+(% lang="en-US" %)
	43	+(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
	44	+ "User": "" , ~/~/ имя пользователя
27	27
28		-−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
	46	+(% lang="en-US" %)
	47	+ }
29	29
30		-−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
	49	+**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
31	31
32		-−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
33	33
34		-−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
	52	+(% class="box infomessage" %)
	53	+(((
	54	+(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
	55	+)))
35	35
36		-Метод запроса: POST
	57	+(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
37	37
38		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
	59	+(% style="color:#000000" %)Метод запроса: **GET**
39	39
40		-В заголовках запроса:
	61	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
41	41
42		-−Content-Type: application/json
	63	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
43	43
44		-−X-Auth: Токен авторизации
	65	+(% lang="en-US" %)
	66	+(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
45	45
46		-Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
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, опционально)}}}}
	69	+(% class="box" style="text-align: center;" %)
	70	+(((
	71	+(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
	72	+)))
55	55
56		-Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
	74	+(% class="box infomessage" %)
	75	+(((
	76	+(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
	77	+)))
57	57
58		-Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «» // статус объекта }, … ]
	79	+(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
59	59
60		-Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
	81	+(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
61	61
62		-0 - «Блокировка»
	83	+(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
63	63
64		-1 - «Активен»,
	85	+(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
65	65
66		-2 - «Отменен»
	87	+(% style="color:#000000" %)Метод запроса: **GET**
67	67
68		-3 - «Оборудован»
	89	+(% 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>
69	69
70		-4 - «Диагностика»
	91	+(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
71	71
72		-5 - «Сервис»
	93	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
73	73
74		-6 - «Демонтаж»
	95	+(% style="color:#000000" %)Ответ:
75	75
76		-7 - «Монтаж»
	97	+(% style="color:#000000" %){
	98	+ "agentId": "", ~/~/ идентификатор клиента
	99	+ "parentId": "", ~/~/ идентификатор клиента-родителя
	100	+ "name": "", ~/~/ наименование клиента
	101	+ "fullName": "", ~/~/ полное наименование клиента
	102	+ "agentInfoType": "", ~/~/ тип клиента1
	103	+ "status": "", ~/~/ статус клиента
	104	+ }
77	77
78		-8 - «Дозаказ»
79	79
80		-9 - «Обслужен»
	107	+(% 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" %)]
81	81
82		-10 - «Списан»
83	83
84		-11 - «Неисправен»
	110	+(% class="box" style="text-align: center;" %)
	111	+(((
	112	+(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
	113	+)))
85	85
86		-12 - «Проверен»
	115	+(% class="box successmessage" %)
	116	+(((
	117	+(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
	118	+)))
87	87
88		-13 - «Не эксплуатируется»
	120	+(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
89	89
90		- **Получение списка клиентов.**
	122	+(% style="color:#000000" %)Метод запроса: **POST**
91	91
92		-Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	124	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
93	93
94		-−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
	126	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
95	95
96		-−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
	128	+(% style="color:#000000" %)Параметры в теле запроса (JSON):
97	97
98		-−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
	130	+(% style="color:#000000" %){
	131	+ "lastName": "", ~/~/ фамилия
	132	+ "firstName": "", ~/~/ имя
	133	+ "position": "", ~/~/ должность
	134	+ "phone": "", ~/~/ телефон
	135	+ "organization": "", ~/~/ организация
	136	+ "login": "", ~/~/ логин
	137	+ "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
	138	+ "email": "", ~/~/ email
	139	+ "description": "", ~/~/ описание
	140	+ "isEnabled": "", ~/~/ признак включения
	141	+ "parentId": "", ~/~/ Guid родительского агента
	142	+ "leaderId": "", ~/~/ Guid руководителя (null - не задан)
	143	+ "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
	144	+ "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	145	+ "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
	146	+ "target": "" , ~/~/ в случае аутентификации по email - email-адрес
	147	+ "groups": "" , ~/~/ группы пользователя, названия групп
	148	+ }
99	99
100		-Метод запроса: GET
	150	+(% style="text-align:left" %)
	151	+(% style="color:#000000; font-weight:normal" %)Ответ:
101	101
102		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
	153	+(% style="text-align:left" %)
	154	+(% style="color:#000000; font-weight:normal" %){
103	103
104		-Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
	156	+(% style="text-align:left" %)
	157	+(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
	158	+ "lastName": "" , ~/~/ Фамилия ,
	159	+ "firstName": "" , ~/~/ Имя
	160	+ "position": "" , ~/~/ Должность
	161	+ "phone": "" , ~/~/ Телефон
	162	+ "organization": "" , ~/~/ Организация
	163	+ "login": "" , ~/~/ Логин
	164	+ "password": "" , ~/~/ Пароль
	165	+ "email": "" , ~/~/ Email
	166	+ "description": "" , ~/~/ Описание
	167	+ "isEnabled": "" , ~/~/ Признак включения
	168	+ "parentId": "" , ~/~/ Guid родительского агента
	169	+ "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
	170	+ "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	171	+ "kind": "" , ~/~/ тип аутентификации
	172	+ "target": "" , ~/~/ в случае аутентификации по email - email-адрес
	173	+ "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
105	105
106		-В заголовках запроса: X-Auth: Токен авторизации
	175	+(% style="text-align:left" %)
	176	+(% style="color:#000000; font-weight:normal" %) }
107	107
108		-Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
109	109
110		-Примечание. Возможные значение параметра agentInfoType:
	179	+(% class="box successmessage" %)
	180	+(((
	181	+(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
	182	+)))
111	111
112		- **Получение списка пользователей.**
	184	+(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
113	113
114		-Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
	186	+(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
115	115
116		-Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
	188	+(% style="color:#000000" %)Метод запроса: **POST**
117	117
118		-Метод запроса: POST
	190	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
119	119
120		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
	192	+(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
121	121
122		-Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
	194	+(% style="color:#000000" %){
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 - неважно}}}
	196	+ "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
	197	+ "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
	198	+ "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
	199	+ "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
128	128
129		-}
	201	+(% style="color:#000000" %) }
130	130
131		-Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
	203	+(% style="color:#000000" %)Ответ:
132	132
133		-{{{ "sessionDuration": "", // длительность сессии в минутах}}}
	205	+(% style="color:#000000" %){ (%%)
134	134
135		- «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
	207	+ "id": "" , ~/~/ идентификатор пользователя
	208	+ "lastName": "" , ~/~/ фамилия
	209	+ "firstName": "" , ~/~/ имя
	210	+ "position": "" , ~/~/ должность
	211	+ "phone": "" , ~/~/ телефон
	212	+ "parentId": "" , ~/~/ идентификатор клиента-родителя
	213	+ "parentName": "" , ~/~/ наименование клиента-родителя
	214	+ "organization": "" , ~/~/ организация
	215	+ "login": "" , ~/~/ логин
	216	+ "email": "" , ~/~/ E-mail
	217	+ "sessionDuration":"", ~/~/ длительность сессии в минутах
	218	+ "status": "1",  ~/~/ статус пользователя
	219	+ "astLogged": "", ~/~/ дата/время последней авторизации
136	136
137		- **Получение списка типов устройств**
	221	+(% style="color:#000000" %) }
138	138
139		-Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
140	140
141		-Метод запроса: GET
	224	+(% class="box warningmessage" %)
	225	+(((
	226	+(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
	227	+)))
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]]
	229	+(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
144	144
145		-В заголовках запроса:X-Auth: Токен авторизации
	231	+(% style="color:#000000" %)Метод запроса: **PUT**
146	146
147		-Ответ: [
	233	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
148	148
149		-{{{ {
150		- "deviceTypeId" : "", // ID типа устройства
151		- "deviceTypeName" : "" // Название типа устройства
152		- },}}}
	235	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
153	153
154		-… ]
	237	+(% lang="en-US" style="text-align:left" %)
	238	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
155	155
156		- **Получение списка типов датчиков**
	240	+(% lang="en-US" style="text-align:left" %)
	241	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
157	157
158		-Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	243	+(% lang="en-US" style="text-align:left" %)
	244	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
	245	+ "lastName": "" , ~/~/ фамилия
	246	+ "firstName": "" , ~/~/ имя
	247	+ "position": "" , ~/~/ должность
	248	+ "phone": "" , ~/~/ телефон
	249	+ "organization": "" , ~/~/ организация
	250	+ "login": "" , ~/~/ логин
	251	+ "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
	252	+ "email": "" , ~/~/ email
	253	+ "description": "" , ~/~/ описание
	254	+ "isEnabled": "" , ~/~/ признак включения
	255	+ "parentId": "" , ~/~/ Guid родительского агента
	256	+ "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
	257	+ "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
	258	+ "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	259	+ "kind": "" , ~/~/ тип аутентификации
	260	+ "target": "" , ~/~/ в случае аутентификации по email - email-адрес
	261	+ "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
159	159
160		-Метод запроса: GET
	263	+(% lang="en-US" style="text-align:left" %)
	264	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
161	161
162		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
	266	+(% lang="en-US" style="text-align:left" %)
	267	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
163	163
164		-В заголовках запроса:X-Auth: Токен авторизации
	269	+(% lang="en-US" style="text-align:left" %)
	270	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ //
165	165
166		-Ответ: [
	272	+(% lang="en-US" style="text-align:left" %)
	273	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
	274	+ "lastName": "" , ~/~/ фамилия
	275	+ "firstName": "" , ~/~/ имя
	276	+ "position": "" , ~/~/ должность
	277	+ "phone": "" , ~/~/ телефон
	278	+ "organization": "" , ~/~/ организация
	279	+ "login": "" , ~/~/ логин
	280	+ "password": "" , ~/~/ пароль
	281	+ "email": "" , ~/~/ email
	282	+ "description": "" , ~/~/ описание
	283	+ "isEnabled": "" , ~/~/ признак включения
	284	+ "parentId": "" , ~/~/ Guid родительского агента
	285	+ "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах
	286	+ "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	287	+ "kind": "" , ~/~/ тип аутентификации
	288	+ "target": "" , ~/~/ в случае аутентификации по email - email-адрес
	289	+ "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
167	167
168		-{{{ {}}}
	291	+(% lang="en-US" style="text-align:left" %)
	292	+(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
169	169
170		-«id»: «», //ID типа датчика «name»: «», //Название
171	171
172		-{{{ "description": "" // Описание
173		- },}}}
	295	+(% class="box warningmessage" %)
	296	+(((
	297	+(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
	298	+)))
174	174
175		-… ]
	300	+(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
176	176
177		- **Получение информации об объекте**
	302	+(% style="color:#000000" %)Метод запроса: **PUT**
178	178
179		-Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
	304	+(% 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}
180	180
181		-Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
	306	+(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
182	182
183		-−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
	308	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
184	184
185		-Метод запроса: GET
	310	+(% style="color:#000000" %)Параметры в теле запроса (JSON):
186	186
187		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
	312	+(% style="color:#000000" %){
188	188
189		-Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
	314	+ "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
	315	+ "description": "" , ~/~/ описание
	316	+ "data": "" , ~/~/ данные, связанные со сменой статуса
190	190
191		-В заголовках запроса: X-Auth: Токен авторизации
	318	+ (% style="color:#000000" %)}
192	192
193		-Ответ:
	320	+(% style="text-align:left" %)
	321	+(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
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		- ...}}}
	324	+(% class="box errormessage" %)
	325	+(((
	326	+(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
	327	+)))
212	212
213		-}
	329	+(% 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 - «Не эксплуатируется»
	331	+(% style="color:#000000" %)Метод запроса: **DELETE**
216	216
217		- **Добавление пользователя**
	333	+(% 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»)
	335	+(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
220	220
221		-Метод запроса: POST
	337	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
222	222
223		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
	339	+(% style="text-align:left" %)
	340	+(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
224	224
225		-В заголовках запроса: X-Auth: Токен авторизации
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»: [ // группы пользователя «», //названия групп «», «» ] }
	343	+(% class="box" style="text-align: center;" %)
	344	+(((
	345	+(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
	346	+)))
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» //названия групп ] }
	348	+(% class="box infomessage" %)
	349	+(((
	350	+(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
	351	+)))
230	230
231		- **Редактирование пользователя**
	353	+(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
232	232
233		-Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	355	+(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
234	234
235		-Метод запроса: PUT
	357	+(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
236	236
237		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
	359	+(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
238	238
239		-В заголовках запроса: X-Auth: Токен авторизации
	361	+(% style="color:#000000" %)Метод запроса: **GET**
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 - блокирован)
	363	+(% 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>
242	242
243		-{{{ "description": "", // описание
244		- "data": "" // данные, связанные со сменой статуса}}}
	365	+(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
245	245
246		-}
	367	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
247	247
248		-Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	369	+(% style="color:#000000" %)Ответ:
249	249
250		- **Удаление пользователя**
	371	+(% style="color:#000000" %){
251	251
252		-Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	373	+ "vehicleId": "" , ~/~/ идентификатор объекта
	374	+ "name": "" , ~/~/ имя объекта
	375	+ "imei": "" , ~/~/ IMEI объекта
	376	+ "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
	377	+ "deviceTypeName": "" , ~/~/ наименование устройства объекта
	378	+ "parentId": "" , ~/~/ идентификатор клиента-родителя
	379	+ "parentName": "" , ~/~/ наименование клиента-родителя,
	380	+ "modelId": "" , ~/~/ идентификатор модели объекта
	381	+ "modelName": "" , ~/~/ наименование модели объекта,
	382	+ "unitId": "" , ~/~/ идентификатор подразделения
	383	+ "unitName": "" , ~/~/ наименование подразделения
	384	+ "status": "" , ~/~/ статус объекта
253	253
254		-Метод запроса: DELETE
	386	+ }
255	255
256		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
	388	+(% style="text-align:left" %)
	389	+Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
257	257
258		-Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
	391	+(% style="text-align:left" %)
	392	+0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
259	259
260		-Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
261	261
262		- **Добавление объекта**
	395	+(% class="box successmessage" %)
	396	+(((
	397	+(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
	398	+)))
263	263
264		-Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
	400	+(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
265	265
266		-Метод запроса: POST
	402	+(% style="color:#000000" %)Метод запроса: **POST**
267	267
268		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	404	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
269	269
270		-В заголовках запроса: X-Auth: Токен авторизации
	406	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
271	271
272		-Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
	408	+(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
273	273
	410	+(% class="western" %)
274	274	{{{ "parentId": "", // ID клиента
275	275	"name": "", // имя ТС
276	276	"imei": "", // IMEI
...	...	@@ -311,12 +311,13 @@
311	311	},
312	312	]}}}
313	313
314		-… }
	451	+(% style="color:#000000" %)… }
315	315
316		-Ответ:
	453	+(% style="color:#000000" %)Ответ:
317	317
318		-{
	455	+(% style="color:#000000" %){
319	319
	457	+(% class="western" %)
320	320	{{{ "vehicleId": "", //ID ТС
321	321	"parentId": "", //Guid владельца ТС
322	322	"name": "", //Имя объекта
...	...	@@ -351,62 +351,85 @@
351	351	"lastMileage": "", // Пробег (в метрах)
352	352	"motohoursCondition": "", // Условие по моточасам
353	353	"lastMotohours": "", // Моточасы
354		- "periodicCondition": "", // Условие периодичности по времени}}}
355		-
356		-{{{ "kind": "", // Вид периодичности по времени
	492	+ "periodicCondition": "", // Условие периодичности по времени
	493	+ "kind": "", // Вид периодичности по времени
357	357	"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
358	358	}
359	359	]}}}
360	360
361		-}
	498	+(% style="text-align:left" %)
	499	+(% style="color:#000000" %)}
362	362
363		- **Удаление объекта**
364	364
365		-Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	502	+(% class="box successmessage" %)
	503	+(((
	504	+(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
	505	+)))
366	366
367		-Метод запроса: DELETE
	507	+(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
368	368
369		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
	509	+(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
370	370
371		-Параметр запроса: {id} - Guid объекта
	511	+(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
372	372
373		-В заголовках запроса: X-Auth: Токен авторизации
	513	+(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
374	374
375		-Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	515	+(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
376	376
377		- **Редактирование объекта**
	517	+(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
378	378
379		-Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	519	+(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
380	380
381		-Метод запроса: PUT
	521	+(% style="color:#000000" %)Метод запроса: **POST**
382	382
383		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	523	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
384	384
385		-В заголовках запроса: X-Auth: Токен авторизации
	525	+(% style="color:#000000" %)В заголовках запроса:
386	386
387		-Параметры в теле запроса (JSON):
	527	+(% style="color:#000000" %)− Content-Type: application/json
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»: «» //Сколько раз выполнить задание } ] }
	529	+(% style="color:#000000" %)− X-Auth: Токен авторизации
390	390
391		-Ответ:
	531	+(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
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»: «» //Сколько раз выполнить задание } ] }
	533	+(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
394	394
395		- **Изменение статуса объекта**
	535	+(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
396	396
397		-Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
	537	+(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
398	398
399		-Метод запроса: POST
	539	+(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% 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}
	541	+(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
402	402
403		-Параметр запроса: {vehicleId} - ID ТС
	543	+(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
404	404
405		-В заголовках запроса: X-Auth: Токен авторизации
	545	+(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
406	406
407		-Параметры в теле запроса (JSON): {
	547	+0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
408	408
409		-{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
	549	+
	550	+(% class="box successmessage" %)
	551	+(((
	552	+(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
	553	+)))
	554	+
	555	+(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	556	+
	557	+(% style="color:#000000" %)Метод запроса: **POST**
	558	+
	559	+(% 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}
	560	+
	561	+(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
	562	+
	563	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	564	+
	565	+(% style="color:#000000" %)Параметры в теле запроса (JSON): {
	566	+
	567	+(% class="western" %)
	568	+{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
	569	+  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
	570	+  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
410	410	"date": "", // Дата смены статуса (null если сменить немедленно)
411	411	"description": "", // Описание
412	412	"data": "", // Данные
...	...	@@ -413,10 +413,11 @@
413	413	"overwrite": false, // Флаг перезаписи
414	414	"stage": "", // Состояние, может быть null}}}
415	415
416		-}
	577	+(% style="color:#000000" %)}
417	417
418		-Ответ: {
	579	+(% style="color:#000000" %)Ответ: {
419	419
	581	+(% class="western" %)
420	420	{{{ "status": "", // значение статуса
421	421	"date": "", // Дата смены статуса
422	422	"description": "", // Описание
...	...	@@ -424,18 +424,116 @@
424	424	"overwrite": false, // Флаг перезаписи
425	425	"stage": "", // Состояние}}}
426	426
427		-}
	589	+(% style="text-align:left" %)
	590	+(% style="color:#000000" %)}
428	428
429		- **Проверка авторизации**
430	430
431		-Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
	593	+(% class="box warningmessage" %)
	594	+(((
	595	+(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
	596	+)))
432	432
433		-Метод запроса: GET
	598	+(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
434	434
435		-URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
	600	+(% style="color:#000000" %)Метод запроса: **PUT**
436	436
437		-В заголовках запроса: X-Auth: Токен авторизации
	602	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
438	438
439		-Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
	604	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
440	440
441		-**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
	606	+(% style="color:#000000" %)Параметры в теле запроса (JSON):
	607	+
	608	+(% 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»: «» //Сколько раз выполнить задание } ] }
	609	+
	610	+(% style="color:#000000" %)Ответ:
	611	+
	612	+(% lang="en-US" style="text-align:left" %)
	613	+(% 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»: «» //Сколько раз выполнить задание } ] }
	614	+
	615	+
	616	+(% class="box errormessage" %)
	617	+(((
	618	+(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
	619	+)))
	620	+
	621	+(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	622	+
	623	+(% style="color:#000000" %)Метод запроса: **DELETE**
	624	+
	625	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
	626	+
	627	+(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
	628	+
	629	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	630	+
	631	+(% style="text-align:left" %)
	632	+(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
	633	+
	634	+
	635	+(% class="box" lang="en-US" style="text-align: center;" %)
	636	+(((
	637	+(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
	638	+)))
	639	+
	640	+(% class="box infomessage" %)
	641	+(((
	642	+(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
	643	+)))
	644	+
	645	+(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	646	+
	647	+(% style="color:#000000" %)Метод запроса: **GET**
	648	+
	649	+(% 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]]
	650	+
	651	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	652	+
	653	+(% style="color:#000000" %)Ответ: [
	654	+
	655	+(% class="western" %)
	656	+{{{ {
	657	+ "deviceTypeId" : "", // ID типа устройства
	658	+ "deviceTypeName" : "" // Название типа устройства
	659	+ },}}}
	660	+
	661	+(% style="text-align:left" %)
	662	+(% style="color:#000000" %)…** **]
	663	+
	664	+
	665	+(% class="box" style="text-align: center;" %)
	666	+(((
	667	+(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
	668	+)))
	669	+
	670	+(% class="box infomessage" %)
	671	+(((
	672	+(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
	673	+)))
	674	+
	675	+(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	676	+
	677	+(% style="color:#000000" %)Метод запроса: **GET**
	678	+
	679	+(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
	680	+
	681	+(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
	682	+
	683	+(% style="color:#000000" %)Ответ: [
	684	+
	685	+(% class="western" style="margin-bottom:19px" %)
	686	+{{{ {}}}
	687	+
	688	+(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
	689	+
	690	+(% class="western" %)
	691	+{{{ "description": "" // Описание
	692	+ },}}}
	693	+
	694	+(% style="text-align:left" %)
	695	+(% style="color:#000000" %)… ]
	696	+
	697	+
	698	+(% class="box" lang="en-US" style="text-align: center;" %)
	699	+(((
	700	+(% 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]] **
	701	+)))