Исходный код вики Методы API для работы с ГЛОНАССSoft

Версия 41.2 от Илья Крайнов на 2022/11/18 17:35

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

Исходный код вики Методы API для работы с ГЛОНАССSoft

Меню