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

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

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

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

Меню