Wiki source code of Методы API для работы с ГЛОНАССSoft

Version 45.1 by Илья Крайнов on 2022/11/21 10:27

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

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню