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

Version 58.1 by Илья Крайнов on 2022/11/24 11:29

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

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

Меню