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

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

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

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

Меню