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

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

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

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

Меню