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

Version 87.1 by Михаил Жучков on 2023/05/10 09:12

version	line-number	content
9.1	1	(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
68.1	2	(((
	3	Содержание страницы:
	4	)))
1.1	5
56.1	6	{{toc/}}
	7
	8
66.4	9	= (% style="color:#000000; font-size:16px" %)Действующие ограничения(%%) =
2.1	10
70.1	11	(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
8.1	12
23.2	13	(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __X-Auth__ (токен авторизации, получаемый методом __auth/login__).
8.1	14
	15	Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
1.1	16
60.1	17	(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
1.1	18
65.1	19	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Авторизация(%%) =
1.1	20
66.3	21	== (% style="color:#000000; font-size:16px" %)Авторизация(%%) ==
60.1	22
	23	(% class="box infomessage" %)
	24	(((
	25	(% lang="en-US" %)POST /api/v3/auth/login
	26	)))
	27
58.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"
67.1	41	}
27.1	42
66.9	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
66.5	58	== (% style="color:#000000; font-size:16px" %)Проверка авторизации(%%) ==
60.1	59
8.1	60	(% class="box infomessage" %)
	61	(((
60.1	62	(% lang="en-US" %)GET /api/v3/auth/check
8.1	63	)))
1.1	64
80.2	65	(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
1.1	66
8.1	67	(% style="color:#000000" %)Метод запроса: GET
1.1	68
16.1	69	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
1.1	70
16.1	71	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	72
8.1	73	(% lang="en-US" %)
16.1	74	(% style="color:#000000" %)Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».
1.1	75
66.1	76	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Клиенты(%%) =
16.2	77
74.1	78	== (% style="color:#000000; font-size:16px" %)Получение информации о клиенте(%%) ==
60.1	79
16.2	80	(% class="box infomessage" %)
	81	(((
72.1	82	GET api/v3/agents/{id}
16.2	83	)))
	84
80.2	85	Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
16.2	86
72.1	87	(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
	88
	89	(% style="color:#000000" %)Метод запроса: GET
	90
	91	(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
	92
	93	Запрос должен содержать данные параметра "agentId"
	94
	95	(% style="color:#000000" %)Ответ:
76.5	96	А
72.1	97	{
78.1	98	"agentId": "", ~/~/ идентификатор клиента (%%)
72.1	99	"parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
	100	"parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
73.1	101	"name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)
72.1	102	"fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
	103	"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
	104	"isForeign": true/false, ~/~/ Иностранный контрагент
	105	"district": "string", ~/~/ округ
	106	"region": "string", ~/~/ регион
	107	"city": "string", ~/~/ город
	108	"inn": "string", ~/~/ ИНН клиента
	109	"kpp": "string", ~/~/ КПП клиента
	110	"address": "string", ~/~/ юридический адрес
	111	"addressFact": "string", ~/~/ фактический адрес
	112	"email": "string", ~/~/ почта
	113	"director": "string", ~/~/ ФИО руководителя
	114	"bankName": "string", ~/~/ Банк
	115	"bankBIK": "string", ~/~/ БИК
	116	"bankRS": "string", ~/~/ Номер счета
	117	"bankKS": "string" ~/~/ Корр. счет
	118	}
	119
	120	== (% style="color:#000000; font-size:16px" %)Получение параметров дочерних клиентов(%%) ==
	121
	122	(% class="box infomessage" %)
	123	(((
	124	(% lang="en-US" %)POST (%%)/(% lang="en-US" %)api/v3/agents/find(%%)
	125	)))
	126
80.2	127	(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
72.1	128
16.2	129	(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
	130
	131	(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
	132
22.3	133	(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__Доступ к партнёрским клиентам__».
16.2	134
72.1	135	(% style="color:#000000" %)Метод запроса: POST
16.2	136
72.1	137	(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
16.2	138
72.1	139	(% style="color:#000000" %)Параметр запроса:
16.2	140
72.1	141	(% style="color:#000000" %){
	142	"parentId": "string"
	143	}
16.2	144
20.4	145	(% style="color:#000000" %)Ответ:
16.2	146
72.1	147	{
73.1	148	"agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%)
72.1	149	"parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
	150	"parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
73.1	151	"name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)
72.1	152	"fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
76.2	153	"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
	154	"status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
	155	}
20.2	156
66.10	157	== (% style="color:#000000; font-size:16px" %)Добавление клиента(%%) ==
20.4	158
50.1	159	(% class="box successmessage" %)
	160	(((
60.1	161	POST /api/v3/agents
50.1	162	)))
	163
80.2	164	Метод позволяет добавить клиента, указанного в запросе.
50.1	165
	166	Метод запроса: POST
	167
	168	URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
	169
	170	В заголовках запроса: X-Auth: Токен авторизации
	171
	172	Параметры в теле запроса (JSON):
	173
	174	{
	175	"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
	176	"name": "string", ~/~/ имя
	177	"fullName": "string", ~/~/ полное наименование
76.2	178	"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
50.1	179	"isForeign": true, ~/~/ иностранный контрагент
	180	"district": "string", ~/~/ округ
	181	"region": "string", ~/~/ регион
	182	"city": "string", ~/~/ город
	183	"inn": "string", ~/~/ ИНН
	184	"kpp": "string", ~/~/ КПП
	185	"address": "string", ~/~/ юридический адрес
	186	"addressFact": "string", ~/~/ фактический адрес
	187	"email": "string", ~/~/ email
	188	"director": "string", ~/~/ ФИО руководителя
	189	"bankName": "string", ~/~/ банк
	190	"bankBIK": "string", ~/~/ БИК
	191	"bankRS": "string", ~/~/ номер счёта
	192	"bankKS": "string" ~/~/ корр. счёт
	193	}
	194
	195
	196	Ответ:
	197
	198	{
	199	"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
	200	"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
	201	"name": "string", ~/~/ имя
	202	"fullName": "string", ~/~/ полное наименование
76.2	203	"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
50.1	204	"isForeign": true, ~/~/ иностранный контрагент
	205	"district": "string", ~/~/ округ
	206	"region": "string", ~/~/ регион
	207	"city": "string", ~/~/ город
	208	"inn": "string", ~/~/ ИНН
	209	"kpp": "string", ~/~/ КПП
	210	"address": "string", ~/~/ юридический адрес
	211	"addressFact": "string", ~/~/ фактический адрес
	212	"email": "string", ~/~/ email
	213	"director": "string", ~/~/ ФИО руководителя
	214	"bankName": "string", ~/~/ банк
	215	"bankBIK": "string", ~/~/ БИК
	216	"bankRS": "string", ~/~/ номер счёта
	217	"bankKS": "string" ~/~/ корр. счёт
	218	}
	219
66.10	220	== (% style="color:#000000; font-size:16px" %)Редактирование клиента(%%) ==
60.1	221
50.1	222	(% class="box warningmessage" %)
	223	(((
60.1	224	PUT /api/v3/agents
50.1	225	)))
	226
80.2	227	Метод позволяет отредактировать клиента, указанного в запросе.
50.1	228
	229	Метод запроса: PUT
	230
	231	URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
	232
	233	В заголовках запроса: X-Auth: Токен авторизации
	234
	235
	236	Параметры в теле запроса (JSON):
	237
	238	{
	239	"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
	240	"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
	241	"name": "string", ~/~/ имя
	242	"fullName": "string", ~/~/ полное наименование
76.3	243	"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
50.1	244	"isForeign": true, ~/~/ иностранный контрагент
	245	"district": "string", ~/~/ округ
	246	"region": "string", ~/~/ регион
	247	"city": "string", ~/~/ город
	248	"inn": "string", ~/~/ ИНН
	249	"kpp": "string", ~/~/ КПП
	250	"address": "string", ~/~/ юридический адрес
	251	"addressFact": "string", ~/~/ фактический адрес
	252	"email": "string", ~/~/ email
	253	"director": "string", ~/~/ ФИО руководителя
	254	"bankName": "string", ~/~/ банк
	255	"bankBIK": "string", ~/~/ БИК
	256	"bankRS": "string", ~/~/ номер счёта
	257	"bankKS": "string" ~/~/ корр. счёт
	258	}
	259
	260
	261	Ответ:
	262
	263	{
	264	"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
	265	"parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
	266	"name": "string", ~/~/ имя
	267	"fullName": "string", ~/~/ полное наименование
	268	"isForeign": true, ~/~/ иностранный контрагент
	269	"district": "string", ~/~/ округ
	270	"region": "string", ~/~/ регион
	271	"city": "string", ~/~/ город
	272	"inn": "string", ~/~/ ИНН
	273	"kpp": "string", ~/~/ КПП
	274	"address": "string", ~/~/ юридический адрес
	275	"addressFact": "string", ~/~/ фактический адрес
	276	"email": "string", ~/~/ email
	277	"director": "string", ~/~/ ФИО руководителя
	278	"bankName": "string", ~/~/ банк
	279	"bankBIK": "string", ~/~/ БИК
	280	"bankRS": "string", ~/~/ номер счёта
	281	"bankKS": "string" ~/~/ корр. счёт
	282	}
	283
66.11	284	== (% style="color:#000000; font-size:16px" %)Удаление клиента(%%) ==
50.1	285
	286	(% class="box errormessage" %)
	287	(((
60.1	288	DELETE /api/v3/agents/{clientId}
50.1	289	)))
	290
80.2	291	Метод позволяет удалить клиента, указанного в строке запроса.
50.1	292
	293	Метод запроса: DELETE
	294
	295	URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]{clientId}
	296
	297	Параметр запроса: {clientId} - Guid пользователя
	298
	299	В заголовках запроса: X-Auth: Токен авторизации
	300
	301	Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
	302
65.1	303	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Пользователи(%%) =
50.1	304
66.11	305	== (% style="color:#000000; font-size:16px" %)Добавление пользователя(%%) ==
1.1	306
8.1	307	(% class="box successmessage" %)
	308	(((
60.1	309	(% lang="en-US" %)POST /api/v3/users
8.1	310	)))
1.1	311
80.2	312	(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
1.1	313
8.1	314	(% style="color:#000000" %)Метод запроса: POST
1.1	315
8.1	316	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1.1	317
8.1	318	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	319
20.3	320	(% style="color:#000000" %)Параметры в теле запроса (JSON):
1.1	321
78.1	322	(% style="color:#000000" %)
	323	{
20.4	324	"lastName": "", ~/~/ фамилия
20.3	325	"firstName": "", ~/~/ имя
	326	"position": "", ~/~/ должность
	327	"phone": "", ~/~/ телефон
	328	"organization": "", ~/~/ организация
40.1	329	"login": "", ~/~/ логин (обязателен)
	330	"password": "", ~/~/ пароль (обязателен)
	331	"email": "", ~/~/ email (обязателен)
78.1	332	"description": "string", ~/~/ Описание
	333	"isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
	334	"isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
	335	"isEnabled": true, ~/~/ Включен, true - включен, false - отключен
20.3	336	"parentId": "", ~/~/ Guid родительского агента
78.1	337	"leaderId": "", ~/~/ Guid руководителя (null - не задан)
	338	"sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
79.1	339	"doubleAuth":
78.1	340	{
	341	"kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
	342	"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
	343	},
79.1	344	"groups":
78.1	345	[
	346	"string" ~/~/ группы пользователя, перечисление названия системных ролей
	347	],
79.1	348	"customGroups":
78.1	349	[
	350	"3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
	351	],
	352	"language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
21.12	353	}
20.3	354
78.1	355	{
	356	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
	357	"lastName": "string",
	358	"firstName": "string",
	359	"position": "string",
	360	"phone": "string",
	361	"organization": "string",
	362	"login": "string",
	363	"password": "string",
	364	"email": "string",
	365
	366
8.1	367	(% style="text-align:left" %)
20.3	368	(% style="color:#000000; font-weight:normal" %)Ответ:
1.1	369
20.3	370	(% style="text-align:left" %)
21.2	371	(% style="color:#000000; font-weight:normal" %){
1.1	372
20.3	373	(% style="text-align:left" %)
20.4	374	(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
20.3	375	"lastName": "" , ~/~/ Фамилия ,
	376	"firstName": "" , ~/~/ Имя
	377	"position": "" , ~/~/ Должность
	378	"phone": "" , ~/~/ Телефон
	379	"organization": "" , ~/~/ Организация
	380	"login": "" , ~/~/ Логин
	381	"password": "" , ~/~/ Пароль
	382	"email": "" , ~/~/ Email
	383	"description": "" , ~/~/ Описание
	384	"isEnabled": "" , ~/~/ Признак включения
	385	"parentId": "" , ~/~/ Guid родительского агента
	386	"sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
	387	"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	388	"kind": "" , ~/~/ тип аутентификации
	389	"target": "" , ~/~/ в случае аутентификации по email - email-адрес
39.1	390	"groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
20.3	391
	392	(% style="text-align:left" %)
21.12	393	(% style="color:#000000; font-weight:normal" %)}
20.3	394
66.12	395	== (% style="color:#000000; font-size:16px" %)Получение списка пользователей(%%) ==
20.3	396
76.1	397	(% class="box infomessage" %)
18.1	398	(((
60.1	399	(% lang="en-US" %)POST /api/v3/users/find
18.1	400	)))
	401
60.1	402	(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
18.1	403
23.2	404	(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права «__Просмотр пользователей__».
18.1	405
	406	(% style="color:#000000" %)Метод запроса: POST
	407
	408	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
	409
22.5	410	(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
18.1	411
22.5	412	(% style="color:#000000" %)Параметры в теле запроса (JSON):
	413
20.4	414	(% style="color:#000000" %){
18.1	415
20.4	416	"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
	417	"userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
	418	"login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
	419	"email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
	420
21.12	421	(% style="color:#000000" %)}
18.1	422
20.4	423	(% style="color:#000000" %)Ответ:
18.1	424
21.2	425	(% style="color:#000000" %){ (%%)
20.4	426
20.5	427	"id": "" , ~/~/ идентификатор пользователя
20.4	428	"lastName": "" , ~/~/ фамилия
	429	"firstName": "" , ~/~/ имя
	430	"position": "" , ~/~/ должность
	431	"phone": "" , ~/~/ телефон
	432	"parentId": "" , ~/~/ идентификатор клиента-родителя
	433	"parentName": "" , ~/~/ наименование клиента-родителя
	434	"organization": "" , ~/~/ организация
	435	"login": "" , ~/~/ логин
	436	"email": "" , ~/~/ E-mail
20.5	437	"sessionDuration":"", ~/~/ длительность сессии в минутах
	438	"status": "1", ~/~/ статус пользователя
87.1	439	"lastLogged": "", ~/~/ дата/время последней авторизации
20.4	440
21.12	441	(% style="color:#000000" %)}
20.4	442
66.12	443	== (% style="color:#000000; font-size:16px" %)Получение информации о пользователе(%%) ==
18.1	444
75.1	445	(% class="box infomessage" %)
41.1	446	(((
60.1	447	(% lang="en-US" %)GET /api/v3/users/{GUID}
41.1	448	)))
	449
60.1	450	(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права «__Просмотр пользователей__».
41.1	451
	452	(% style="color:#000000" %)Метод запроса: GET
	453
	454	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
	455
43.1	456	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	457
41.1	458	(% style="color:#000000" %)Ответ:
	459
	460	(((
41.2	461	(((
41.1	462	{
	463	"id": "", ~/~/ GUID пользователя
47.1	464	"lastName": "", ~/~/ Фамилия
41.1	465	"firstName": "", ~/~/ Имя
	466	"position": "", ~/~/ Должность
	467	"phone": "", ~/~/ Номер телефона
	468	"parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
	469	"parentName": "", Наименование клиента, которому принадлежит пользователь
	470	"organization": "", ~/~/ Организация
	471	"login": "", ~/~/ Логин пользователя
	472	"email": "", ~/~/ Адрес электронной почты
	473	"language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
	474	"isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
	475	"description": "", ~/~/ Описание
	476	"isEnabled": , ~/~/ Включен, true - включен, false - отключен
78.1	477	"doubleAuth":
76.4	478	{
76.7	479	"kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
76.4	480	"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
	481	},
41.1	482	"isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
	483	"sessionDuration": 30, ~/~/ Длительность сессии в минутах
	484	"status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
	485	"lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
	486	"groups": [], ~/~/ Список ролей пользователя
	487	"customGroups": [], ~/~/ Список клиентских ролей пользователя
	488	"authDevices": [ ], ~/~/ Список авторизованных устройств
	489	"mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
	490	"pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
	491	}
	492	)))
41.2	493	)))
41.1	494
66.12	495	== (% style="color:#000000; font-size:16px" %)Редактирование пользователя(%%) ==
41.1	496
8.1	497	(% class="box warningmessage" %)
	498	(((
60.1	499	(% lang="en-US" %)PUT /api/v3/users
8.1	500	)))
1.1	501
80.2	502	(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
1.1	503
8.1	504	(% style="color:#000000" %)Метод запроса: PUT
1.1	505
8.1	506	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1.1	507
8.1	508	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	509
8.1	510	(% lang="en-US" style="text-align:left" %)
20.6	511	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
1.1	512
20.6	513	(% lang="en-US" style="text-align:left" %)
21.2	514	(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
1.1	515
20.6	516	(% lang="en-US" style="text-align:left" %)
	517	(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
	518	"lastName": "" , ~/~/ фамилия
	519	"firstName": "" , ~/~/ имя
	520	"position": "" , ~/~/ должность
	521	"phone": "" , ~/~/ телефон
	522	"organization": "" , ~/~/ организация
41.1	523	"login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%)
77.1	524	(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
	525	"language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
	526	"isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
41.1	527	"email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%)
40.1	528	(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
20.6	529	"isEnabled": "" , ~/~/ признак включения
	530	"parentId": "" , ~/~/ Guid родительского агента
	531	"leaderId": "" , ~/~/ Guid руководителя (null - не задан)
	532	"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
78.1	533	"doubleAuth":
76.5	534	{
	535	"kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
	536	"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
	537	},
77.1	538	"isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
20.6	539	"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
	540
	541	(% lang="en-US" style="text-align:left" %)
21.12	542	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
20.6	543
	544	(% lang="en-US" style="text-align:left" %)
	545	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
	546
	547	(% lang="en-US" style="text-align:left" %)
21.12	548	(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
20.6	549
	550	(% lang="en-US" style="text-align:left" %)
21.12	551	(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
20.6	552	"lastName": "" , ~/~/ фамилия
	553	"firstName": "" , ~/~/ имя
	554	"position": "" , ~/~/ должность
	555	"phone": "" , ~/~/ телефон
	556	"organization": "" , ~/~/ организация
	557	"login": "" , ~/~/ логин
	558	"password": "" , ~/~/ пароль
	559	"email": "" , ~/~/ email
	560	"description": "" , ~/~/ описание
	561	"isEnabled": "" , ~/~/ признак включения
	562	"parentId": "" , ~/~/ Guid родительского агента
	563	"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах
78.1	564	"doubleAuth":
76.5	565	{
	566	"kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
	567	"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
	568	},
77.1	569	"isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
20.6	570	"target": "" , ~/~/ в случае аутентификации по email - email-адрес
21.12	571	"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
20.6	572
	573	(% lang="en-US" style="text-align:left" %)
21.12	574	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
20.6	575
66.12	576	== (% style="color:#000000; font-size:16px" %)Изменение статуса пользователя(%%) ==
20.6	577
8.1	578	(% class="box warningmessage" %)
	579	(((
60.1	580	(% style="color:#000000" %)// //(% lang="en-US" %)PUT /api/v3/users/status/{id}
8.1	581	)))
1.1	582
80.2	583	(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
1.1	584
8.1	585	(% style="color:#000000" %)Метод запроса: PUT
1.1	586
20.7	587	(% 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	588
22.4	589	(% style="color:#000000" %)Параметр запроса: {__id__} - Guid пользователя
1.1	590
20.7	591	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	592
20.7	593	(% style="color:#000000" %)Параметры в теле запроса (JSON):
1.1	594
20.7	595	(% style="color:#000000" %){
	596
	597	"status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
	598	"description": "" , ~/~/ описание
	599	"data": "" , ~/~/ данные, связанные со сменой статуса
	600
21.12	601	(% style="color:#000000" %)}
20.7	602
8.1	603	(% style="text-align:left" %)
	604	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
1.1	605
66.12	606	== (% style="color:#000000; font-size:16px" %)Блокировка пользователей(%%) ==
1.1	607
30.1	608	(% class="box warningmessage" %)
	609	(((
60.1	610	POST /api/v3/users/disable
30.1	611	)))
	612
80.2	613	Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
30.1	614
	615	(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)POST
	616
	617	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
	618
	619	(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
	620
	621	[
	622	"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
	623	"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
	624	]
	625
31.1	626	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
30.1	627
66.12	628	== (% style="color:#000000; font-size:16px" %)Разблокировка пользователей(%%) ==
60.1	629
30.1	630	(% class="box warningmessage" %)
	631	(((
60.1	632	POST /api/v3/users/enable
30.1	633	)))
	634
80.2	635	Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
30.1	636
	637	(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)POST
	638
	639	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
	640
	641	(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
	642
	643	[
	644	"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
	645	"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
	646	]
	647
33.1	648	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»(%%)
	649	\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
30.1	650
41.1	651	(((
33.1	652	В теле ответа:
	653	{
	654	"errorMessages": [
	655	"Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
	656	],
	657	"users": [
	658	"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
	659	]
	660	}
	661	\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
	662	"users" - массив id пользователей, которых не удалось включить или отключить.
41.1	663	)))
31.1	664
66.12	665	== (% style="color:#000000; font-size:16px" %)Удаление пользователя(%%) ==
	666
8.1	667	(% class="box errormessage" %)
	668	(((
60.1	669	(% lang="en-US" %)DELETE /api/v3/users/{id}
8.1	670	)))
1.1	671
80.2	672	(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1.1	673
8.1	674	(% style="color:#000000" %)Метод запроса: DELETE
1.1	675
8.1	676	(% 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	677
22.5	678	(% style="color:#000000" %)Параметр запроса: {__id__} - Guid пользователя
1.1	679
20.8	680	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	681
8.1	682	(% style="text-align:left" %)
	683	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
1.1	684
65.1	685	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Транспортные средства(%%) =
1.1	686
66.14	687	== (% style="color:#000000; font-size:16px" %)Получение информации об объекте(%%) ==
60.1	688
8.1	689	(% class="box infomessage" %)
	690	(((
60.1	691	(% lang="en-US" %)GET /api/v3/vehicles/{vehicleId}
8.1	692	)))
1.1	693
60.1	694	(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1.1	695
80.2	696	(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1.1	697
8.1	698	(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1.1	699
22.5	700	(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на «__Просмотр заданий на техобслуживание__».
1.1	701
8.1	702	(% style="color:#000000" %)Метод запроса: GET
1.1	703
8.1	704	(% 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	705
22.5	706	(% style="color:#000000" %)Параметр запроса: <__vehicleid__> - идентификатор объекта (опционально)
1.1	707
8.1	708	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	709
8.1	710	(% style="color:#000000" %)Ответ:
1.1	711
41.1	712	(((
35.1	713	{
36.1	714	"vehicleId": "", ~/~/ ID объекта
	715	"name": "", ~/~/ Имя объекта
	716	"imei": "", ~/~/ IMEI объекта
	717	"deviceTypeId": , ~/~/ ID типа устройства
	718	"deviceTypeName": "", ~/~/ Название типа устройства
	719	"sim1": "", ~/~/ Номер SIM1
	720	"parentId": "", Номер SIM2
47.1	721	"parentName": "", Наименование клиента-родителя
36.1	722	"modelId": "", ID модели объекта
	723	"modelName": "", Имя модели объекта
	724	"createdAt": "", Дата создания объекта
	725	"mileageCalcMethod": "", Выбранный метод расчета пробега
	726	"counters": { ~/~/ Нормы
	727	"mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
	728	"motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
	729	"mileage": "", ~/~/ Пробег по нормам в метрах
	730	"motohours": "" ~/~/ Моточасы по нормам, в секундах
76.3	731	"mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
	732	"motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
35.1	733	},
36.1	734	"inspectionTasks": [ ~/~/ Задания на тех. обслуживание
35.1	735	{
47.1	736	"id": "", ~/~/ ID задания
37.1	737	"enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
36.1	738	"name": "", ~/~/ Наименование задания
	739	"description": "", ~/~/ Описание задания
	740	"mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
	741	"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
	742	"motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
	743	"lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
	744	"periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
	745	"kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
	746	"lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
	747	"maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
35.1	748	}
	749	]
21.12	750	}
41.1	751	)))
1.1	752
8.1	753	(% style="text-align:left" %)
	754	Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1.1	755
8.1	756	(% style="text-align:left" %)
	757	0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1.1	758
66.14	759	== (% style="color:#000000; font-size:16px" %)Добавление объекта(%%) ==
1.1	760
8.1	761	(% class="box successmessage" %)
	762	(((
60.1	763	(% lang="en-US" %)POST /api/v3/vehicles
8.1	764	)))
1.1	765
86.1	766	(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
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
66.14	879	== (% style="color:#000000; font-size:16px" %)Получение параметров объектов(%%) ==
28.4	880
76.1	881	(% class="box infomessage" %)
8.1	882	(((
60.1	883	(% lang="en-US" %)POST /api/v3/vehicles/find
8.1	884	)))
1.1	885
60.1	886	(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1.1	887
80.2	888	(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1.1	889
8.1	890	(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1.1	891
8.1	892	(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1.1	893
21.7	894	(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «__Видимость объектов заблокированных договоров в панели управления__» или «__Видимость объектов заблокированных договоров в мониторинге__»;
1.1	895
21.7	896	(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «__Просмотр номеров телефонов объектов__»;
1.1	897
21.7	898	(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «__Просмотр статуса объекта__».
1.1	899
8.1	900	(% style="color:#000000" %)Метод запроса: POST
1.1	901
8.1	902	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1.1	903
8.1	904	(% style="color:#000000" %)В заголовках запроса:
1.1	905
22.6	906	(% style="color:#000000" %)− Content-Type: __application/json__
1.1	907
8.1	908	(% style="color:#000000" %)− X-Auth: Токен авторизации
	909
22.7	910	(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
8.1	911
22.7	912	(% style="color:#000000" %)Параметры в теле запроса (JSON):
	913
45.1	914	{
	915	"vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
44.1	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, опционально)
47.1	921	"unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
46.1	922	"customFields": null ~/~/ значение любого из произвольных полей ТС
45.1	923	}
44.1	924
60.1	925	(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__vehicleId__», «__deviceTypeId__», «__parentId__», «__unitId__», и по частичному - «__name__», «__imei__», «__sim__». Фильтрация по значению параметра «__sim__» осуществляется при наличии у авторизованного пользователя права «__Просмотр номеров телефонов объектов__».
8.1	926
21.7	927	(% style="color:#000000" %)Ответ:
8.1	928
21.7	929	(% style="color:#000000" %){
8.1	930
21.7	931	(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
	932	"name": "" ~/~/ наименование объекта
	933	"imei": "" ~/~/ IMEI объекта
	934	"deviceTypeId": "" ~/~/ идентификатор типа устройства
	935	"deviceTypeName": "" ~/~/ наименование типа устройства
	936	"sim1": "" ~/~/ первый номер телефона
	937	"sim2": "" ~/~/ второй номер телефона
	938	"parentId": "" ~/~/ идентификатор клиента-родителя
	939	"parentName": "" ~/~/ наименование клиента-родителя
	940	"modelId": "" ~/~/ идентификатор модели объекта
	941	"modelName": "" ~/~/ наименование модели объекта
	942	"unitId": "" ~/~/ идентификатор подразделения
	943	"unitName": "" ~/~/ наименование подразделения
25.1	944	"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
	945	~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
	946	~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
49.1	947	(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов
	948	"customFields": [
	949	{
	950	"id": "", ~/~/ идентификатор произвольного поля
	951	"name": "", ~/~/ имя произвольного поля
	952	"value": "", ~/~/ значение произвольного поля
	953	"forClient": true, ~/~/ право на отображение у клиента
	954	"forTooltip": false, ~/~/ право на отображение в подсказке
	955	"forReport": false ~/~/ право на отображение в отчетах
	956	}(%%)
21.7	957	(% style="color:#000000" %)}
	958
22.7	959	(% style="color:#000000" %) Параметры «__sim1__» и «__sim2__» содержатся в ответе при наличии у авторизованного пользователя права «__Просмотр номеров телефонов объектов__». Параметр «__status__» содержится в ответе при наличии у авторизованного пользователя права «__Просмотр статуса объекта__».
21.7	960
66.14	961	== (% style="color:#000000; font-size:16px" %)Изменение статуса объекта(%%) ==
22.7	962
8.1	963	(% class="box successmessage" %)
	964	(((
60.1	965	(% lang="en-US" %)POST /api/v3/vehicles/changeStatus/{vehicleId}
8.1	966	)))
	967
80.2	968	(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
8.1	969
	970	(% style="color:#000000" %)Метод запроса: POST
	971
	972	(% 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}
	973
22.8	974	(% style="color:#000000" %)Параметр запроса: {__vehicleId__} - ID ТС
8.1	975
	976	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	977
21.8	978	(% style="color:#000000" %)Параметры в теле запроса (JSON):
8.1	979
21.8	980	(% style="color:#000000" %){
21.7	981
21.8	982	"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
	983	~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
	984	~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
	985	"date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
	986	"description": "", ~/~/ Описание
	987	"data": "", ~/~/ Данные
	988	"overwrite": false, ~/~/ Флаг перезаписи
	989	"stage": "", ~/~/ Состояние, может быть null
1.1	990
21.12	991	(% style="color:#000000" %)}
21.7	992
21.8	993	(% style="color:#000000" %)Ответ:
1.1	994
21.8	995	(% style="color:#000000" %){
1.1	996
21.8	997	"status": "", ~/~/ значение статуса
	998	"date": "", ~/~/ Дата смены статуса
	999	"description": "", ~/~/ Описание
	1000	"data": "", ~/~/ Данные
	1001	"overwrite": false, ~/~/ Флаг перезаписи
	1002	"stage": "", ~/~/ Состояние
1.1	1003
8.1	1004	(% style="text-align:left" %)
21.12	1005	(% style="color:#000000" %) }
1.1	1006
66.14	1007	== (% style="color:#000000; font-size:16px" %)Редактирование объекта(%%) ==
1.1	1008
18.1	1009	(% class="box warningmessage" %)
	1010	(((
60.1	1011	(% lang="en-US" %)PUT /api/v3/vehicles
18.1	1012	)))
	1013
86.1	1014	(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
18.1	1015
	1016	(% style="color:#000000" %)Метод запроса: PUT
	1017
	1018	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	1019
	1020	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	1021
	1022	(% style="color:#000000" %)Параметры в теле запроса (JSON):
	1023
22.2	1024	(% style="color:#000000" %){
18.1	1025
28.8	1026	(((
21.10	1027	(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
	1028	"parentId": "", ~/~/ ID клиента
	1029	"name": "", ~/~/ имя ТС
	1030	"imei": "", ~/~/ IMEI
	1031	"deviceTypeId": "", ~/~/ ID типа устройства
	1032	"modelId": "", ~/~/ , ID модели
	1033	"unitId": "", ~/~/ подразделения
	1034	"sim1": "", ~/~/ SIM 1
30.1	1035	"sim2": "", ~/~/ SIM2 (%%)
28.6	1036	"consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
	1037	"consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
	1038	"consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
	1039	"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
	1040	"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
	1041	"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
	1042	"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
	1043	"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
	1044	"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
	1045	"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
	1046	"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
	1047	"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
	1048	(% style="color:#000000" %) "counters":
21.10	1049	{
	1050	"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
	1051	"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
34.1	1052	"mileage": "", ~/~/ пробег, в метрах
	1053	"motohours": "" ~/~/ моточасы, в секундах
21.10	1054	}
	1055	"cmsv6Parameters": ~/~/ параметры CMSv6
	1056	{
	1057	"id": "", ~/~/ идентификатор
	1058	"enabled": true, ~/~/ флаг включения
	1059	"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
	1060	"login": "", ~/~/ имя учетной записи
	1061	"password": "", ~/~/ пароль учетной записи
	1062	}
	1063	"inspectionTasks": ~/~/ задания на ТО
	1064	{
	1065	"id": "", ~/~/ ID задания
	1066	"enabled": false, ~/~/ Признак включения
	1067	"name": "", ~/~/ Имя задания
	1068	"description": "", ~/~/ Описание задания
	1069	"mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
	1070	"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
	1071	"motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
	1072	"lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
	1073	"periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
	1074	"kind": "", ~/~/ Вид периодичности по времени
	1075	"maxQuantity": "", ~/~/ Сколько раз выполнить задание
22.2	1076	}
28.8	1077	)))
21.9	1078
	1079	(% style="color:#000000" %)}
	1080
18.1	1081	(% style="color:#000000" %)Ответ:
	1082
	1083	(% lang="en-US" style="text-align:left" %)
22.2	1084	(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
18.1	1085
21.11	1086	(% lang="en-US" style="text-align:left" %)
	1087	"vehicleId": "", ~/~/ ID ТС
	1088	"parentId": "", ~/~/ ID клиента
	1089	"name": "", ~/~/ имя ТС
	1090	"imei": "", ~/~/ IMEI
	1091	"deviceTypeId": "", ~/~/ типа устройства
	1092	"modelId": "", ~/~/ ID модели
	1093	"unitId": "", ~/~/ ID подразделения
	1094	"sim1": "", ~/~/ SIM 1
	1095	"sim2": "", ~/~/ SIM2
	1096	"consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
	1097	"consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
	1098	"counters":
	1099	{
	1100	"mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
	1101	"motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
	1102	"mileage": "", ~/~/ пробег
	1103	"motohours": "", ~/~/ моточасы
	1104	}
	1105	"cmsv6Parameters": ~/~/ параметры CMSv6
	1106	{
	1107	"id": ~/~/ идентификатор
	1108	"enabled": true, ~/~/ флаг включения
	1109	"host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
	1110	"login": "", ~/~/ имя учетной записи
	1111	"password": "", ~/~/ пароль учетной записи
	1112	}
	1113	"inspectionTasks": ~/~/ задания на ТО
	1114	{
	1115	"id": "", ~/~/ ID задания
	1116	"enabled": false, ~/~/ Признак включения
	1117	"name": "", ~/~/ Имя задания
	1118	"description": "", ~/~/ Описание задания
	1119	"mileageCondition": "", ~/~/ Условие по пробегу
	1120	"lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
	1121	"motohoursCondition": "", ~/~/ Условие по моточасам
	1122	"lastMotohours": "", ~/~/ Моточасы
	1123	"periodicCondition": "", ~/~/ Условие периодичности по времени
	1124	"kind": "", ~/~/ Вид периодичности по времени
	1125	"maxQuantity": "", ~/~/ Сколько раз выполнить задание
	1126	}
18.1	1127
21.11	1128	(% lang="en-US" style="text-align:left" %)
	1129	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
	1130
80.2	1131	Валидация:
28.7	1132	- сезонный параметр может быть задан только если задана соответствующая обычная норма;
	1133	- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
	1134	- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
21.11	1135
66.14	1136	== (% style="color:#000000; font-size:16px" %)Удаление объекта(%%) ==
28.7	1137
18.1	1138	(% class="box errormessage" %)
	1139	(((
60.1	1140	(% lang="en-US" %)DELETE /api/v3/vehicles/{vehicleId}
18.1	1141	)))
	1142
86.1	1143	(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
18.1	1144
	1145	(% style="color:#000000" %)Метод запроса: DELETE
	1146
	1147	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
	1148
22.8	1149	(% style="color:#000000" %)Параметр запроса: {__id__} - Guid объекта
18.1	1150
	1151	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	1152
	1153	(% style="text-align:left" %)
	1154	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
	1155
66.14	1156	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Устройства(%%) =
18.1	1157
66.14	1158	== (% style="color:#000000; font-size:16px" %)Получение списка типов устройств(%%) ==
17.1	1159
	1160	(% class="box infomessage" %)
	1161	(((
60.1	1162	(% style="color:#000000; line-height:100%" %) (% lang="en-US" %)GET /api/v3/devices/types
17.1	1163	)))
	1164
80.2	1165	(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
17.1	1166
	1167	(% style="color:#000000" %)Метод запроса: GET
	1168
	1169	(% 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]]
	1170
	1171	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	1172
21.12	1173	(% style="color:#000000" %)Ответ:
17.1	1174
21.12	1175	(% style="color:#000000" %){
17.1	1176
21.12	1177	"deviceTypeId" : "", ~/~/ ID типа устройства
	1178	"deviceTypeName" : "" ~/~/ Название типа устройства
	1179
17.1	1180	(% style="text-align:left" %)
21.12	1181	(% style="color:#000000" %)}
17.1	1182
66.15	1183	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Датчики(%%) =
17.1	1184
66.15	1185	== (% style="color:#000000; font-size:16px" %)Получение списка типов датчиков(%%) ==
17.1	1186
	1187	(% class="box infomessage" %)
	1188	(((
60.1	1189	(% style="color:#000000; line-height:100%" %) (% lang="en-US" %)GET /api/v3/sensors/types
17.1	1190	)))
	1191
80.2	1192	(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
17.1	1193
	1194	(% style="color:#000000" %)Метод запроса: GET
	1195
	1196	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
	1197
71.1	1198	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
17.1	1199
21.12	1200	(% style="color:#000000" %)Ответ:
17.1	1201
21.12	1202	(% style="color:#000000" %){
17.1	1203
21.12	1204	"id": "", ~/~/ ID типа датчика
	1205	"name": "", ~/~/ Название
	1206	"description": "", ~/~/ Описание
17.1	1207
	1208	(% style="text-align:left" %)
21.12	1209	(% style="color:#000000" %)}
17.1	1210
79.1	1211	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Сообщения(%%) =
17.1	1212
74.1	1213	== (% style="color:#000000; font-size:16px" %)Данные об активности объекта(%%) ==
71.1	1214
	1215	(% class="box infomessage" style="text-align: left;" %)
	1216	(((
	1217	POST /api/v3/terminalMessages/count
	1218	)))
	1219
	1220	(% style="text-align: left;" %)
80.2	1221	Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
71.1	1222
	1223	(% style="text-align: left;" %)
	1224	Метод запроса POST
	1225
	1226	(% style="text-align: left;" %)
	1227	(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
	1228
	1229	(% style="text-align: left;" %)
	1230	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	1231
	1232	(% style="text-align: left;" %)
	1233	{
76.2	1234	"vehicleIds": [
71.1	1235	id ~/~/ здесь передается список идентификаторов объектов
	1236	],
	1237	"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
	1238	"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
	1239	}
	1240
	1241	(% style="text-align: left;" %)
	1242	Ответ:
	1243
	1244	(% style="text-align: left;" %)
	1245	[
	1246	{
76.2	1247	"vehicleId": 0, ~/~/ идентификатор объекта
71.1	1248	"count": 0 ~/~/ количество сообщений за период
	1249	}
	1250	]
	1251
80.1	1252	== (% style="color:#000000; font-size:16px" %)Запрос списка сообщений(%%) ==
71.1	1253
79.1	1254	(% class="box infomessage" %)
	1255	(((
	1256	POST /api/v3/terminalMessages
	1257	)))
	1258
80.2	1259	Метод возвращает список сообщений терминала объекта за выбранный период.
79.1	1260
	1261	(% style="text-align: left;" %)
	1262	Метод запроса POST
	1263
	1264	(% style="text-align: left;" %)
	1265	(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
	1266
	1267	(% style="text-align: left;" %)
	1268	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	1269
	1270	{
	1271	"vehicleId": 0, ~/~/ id объекта
	1272	"from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
	1273	"to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
	1274	}
	1275
	1276	Ответ:
	1277
	1278	[
	1279	{
	1280	"messages": [
	1281	{
	1282	"deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
	1283	"serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
	1284	"speed": 0, ~/~/ Скорость, км/ч
	1285	"altitude": 0, ~/~/ Высота, м
	1286	"latitude": 0, ~/~/ Широта [-90°;90°]
	1287	"longitude": 0, ~/~/ Долгота [-180°;180°]
	1288	"satellites": 0, ~/~/ Кол-во спутников
	1289	"voltage": 0, ~/~/ Напряжение
	1290	"parameters": { ~/~/ список параметров датчиков передаваемых терминалом
	1291	"additionalProp1": "string",
	1292	"additionalProp2": "string",
	1293	"additionalProp3": "string"
	1294	},
	1295	"photoCount": 0 ~/~/ Кол-во фото
	1296	}
	1297	]
	1298	}
	1299	]
	1300
80.2	1301	= (% style="color:#000000; font-size:18.6667px" %)Раздел: Уведомления(%%) =
79.1	1302
80.2	1303	== (% style="color:#000000; font-size:16px" %)Запрос списка уведомлений клиента(%%) ==
	1304
82.1	1305	(% class="box infomessage" %)
	1306	(((
	1307	POST /api/v3/notifications/find
	1308	)))
80.2	1309
	1310	Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
	1311
	1312	(% style="text-align: left;" %)
	1313	Метод запроса POST
	1314
	1315	(% style="text-align: left;" %)
	1316	(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
	1317
	1318	(% style="text-align: left;" %)
	1319	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	1320
	1321	{
	1322	"parentId": "" ~/~/ id клиента
	1323	}
	1324
	1325	Ответ:
	1326
	1327	[
	1328	{
82.1	1329	"id": 0, ~/~/ ID уведомления
	1330	"name": "string", ~/~/ Название уведомления
	1331	"active": true, ~/~/ Состояние true - активен, false - деактивирован
	1332	"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
	1333	"userId": "", ~/~/ Пользователь, создавший уведомление
	1334	"parentId": "", ~/~/ Идентификатор клиента
	1335	"parentName": "string" ~/~/ Имя клиента
80.2	1336	}
	1337	]
	1338
81.1	1339	== (% style="color:#000000; font-size:16px" %)Запрос настроек уведомления(%%) ==
80.2	1340
82.1	1341	(% class="box infomessage" %)
	1342	(((
	1343	GET /api/v3/notifications/{id}
	1344	)))
80.2	1345
	1346	Метод возвращает данные правил формирования выбранного уведомления.
	1347
	1348	(% style="text-align: left;" %)
	1349	Метод запроса GET
	1350
	1351	(% style="text-align: left;" %)
86.1	1352	(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
80.2	1353
	1354	(% style="text-align: left;" %)
	1355	(% style="color:#000000" %)Параметр запроса: {__id__} - (%%)id уведомления
	1356
	1357	(% style="text-align: left;" %)
	1358	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	1359
	1360	(% style="text-align: left;" %)
	1361	(% style="color:#000000" %)Ответ:
	1362
	1363	(% style="text-align: left;" %)
	1364	(% style="color:#000000" %){
82.1	1365	"id": 0, ~/~/ (%%)id уведомления
	1366	(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
	1367	(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
	1368	(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
	1369	(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
	1370	(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
	1371	(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
	1372	(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
	1373	(% style="color:#000000" %) 0
80.2	1374	],
82.1	1375	"geoids": [ ~/~/ (%%)Список id геообъектов для анализа
	1376	(% style="color:#000000" %) 0
80.2	1377	],
82.1	1378	"fieldids": [ ~/~/ (%%)Список id полей для анализа
	1379	(% style="color:#000000" %) 0
80.2	1380	],
82.1	1381	"settings": { ~/~/ Список параметров уведомления
80.2	1382	"additionalProp1": "string",
	1383	"additionalProp2": "string",
	1384	"additionalProp3": "string"
	1385	},
82.1	1386	"toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
	1387	(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
	1388	(% style="color:#000000" %) ""
80.2	1389	],
82.1	1390	"enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
	1391	(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
	1392	(% style="color:#000000" %) "string"
80.2	1393	],
82.1	1394	"toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
	1395	(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
	1396	(% style="color:#000000" %) {
	1397	"id": 0, ~/~/ (%%)Идентификатор участника чата
	1398	(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
	1399	(% style="color:#000000" %) }
80.2	1400	],
82.1	1401	"toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
	1402	(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
	1403	(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
	1404	(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
	1405	(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
	1406	(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
	1407	(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
	1408	(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
	1409	(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
	1410	(% style="color:#000000" %)}
80.2	1411
83.1	1412	== (% style="color:#000000; font-size:16px" %)Редактирование уведомления(%%) ==
	1413
84.1	1414	(% class="box warningmessage" %)
	1415	(((
	1416	PUT /api/v3/notifications/
	1417	)))
83.1	1418
86.1	1419	Метод позволяет отредактировать уведомление.
85.1	1420
86.1	1421	Метод запроса PUT
	1422
	1423	URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
	1424
	1425	В заголовках запроса: X-Auth: Токен авторизации
	1426
	1427	Тело запроса:
	1428	{
	1429	"id": 0, ~/~/ id уведомления
	1430	"type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
	1431	"userId": "", ~/~/ Пользователь, создавший уведомление
	1432	"parentId": "", ~/~/ Идентификатор клиента
	1433	"parentName": "string", ~/~/ Имя клиента
	1434	"name": "string", ~/~/ Название уведомления
	1435	"active": true, ~/~/ Состояние true - активен, false - деактивирован
	1436	"vehicleIds": [ ~/~/ Список id объектов для анализа
	1437	0
	1438	],
	1439	"geoids": [ ~/~/ Список id геообъектов для анализа
	1440	0
	1441	],
	1442	"fieldids": [ ~/~/ Список id полей для анализа
	1443	0
	1444	],
	1445	"settings": { ~/~/ Список параметров уведомления
	1446	"additionalProp1": "string",
	1447	"additionalProp2": "string",
	1448	"additionalProp3": "string"
	1449	},
	1450	"toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
	1451	"recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
	1452	""
	1453	],
	1454	"enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
	1455	"sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
	1456	"string"
	1457	],
	1458	"toTelegram": true, ~/~/ Флаг активности отправки в Telegram
	1459	"telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
	1460	{
	1461	"id": 0, ~/~/ Идентификатор участника чата
	1462	"info": "string" ~/~/ Дополнительные сведения
	1463	}
	1464	],
	1465	"toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
	1466	"toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
	1467	"stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
	1468	"kind": 0, ~/~/ Определяет вид уведомления
	1469	"activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
	1470	"activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
	1471	"timezone": 0, ~/~/ Сдвиг часового пояса
	1472	"validity": 0, ~/~/ Срок действия в днях (1-90)
	1473	"autoProlongation": true ~/~/ Автопродление срока действия
	1474	}
	1475
	1476	Ответ:
	1477
	1478	Success
	1479
83.1	1480	== (% style="color:#000000; font-size:16px" %)Удаление уведомления(%%) ==
	1481
84.1	1482	(% class="box errormessage" %)
	1483	(((
	1484	DELETE /api/v3/notifications/{id}
	1485	)))
83.1	1486
86.1	1487	Метод позволяет удалить выбранное уведомление.
84.1	1488
86.1	1489	Метод запроса DELETE
85.1	1490
86.1	1491	URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
	1492
	1493	Передаваемый параметр: {id} - id уведомления
	1494
	1495	В заголовках запроса: X-Auth: Токен авторизации
	1496
	1497	Ответ:
	1498
	1499	Success
	1500
17.1	1501	(% class="box" lang="en-US" style="text-align: center;" %)
	1502	(((
14.1	1503	(% 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	1504	)))

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

Меню