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

Version 66.9 by Илья Крайнов on 2022/11/24 13:34

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

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

Меню