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

Версия 66.11 от Илья Крайнов на 2022/11/24 13:36

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

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

Меню