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

Version 20.9 by Артем Шемяков on 2022/09/01 17:46

version	line-number	content
9.1	1	(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
16.2	2	== Описание ГЛОНАССSoft Public API 3.0 ==
1.1	3
9.1	4	== ==
	5
11.1	6	(% class="box" style="text-align: center;" %)
8.1	7	(((
12.1	8	(% style="color:#000000; font-size:18.6667px" %)Действующие ограничения
8.1	9	)))
2.1	10
8.1	11	(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
	12
	13	(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
	14
	15	Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
3.1	16
1.1	17
8.1	18	(% class="box" style="text-align: center;" %)
	19	(((
9.1	20	(% style="color:#000000; font-size:14pt" %)Раздел Авторизация
8.1	21	)))
1.1	22
8.1	23	(% class="box infomessage" %)
	24	(((
16.1	25	(% style="color:#000000; line-height:100%" %)Авторизация (% style="color:#000000" %)— (% lang="en-US" %)GET /api/v3/auth/login
8.1	26	)))
1.1	27
16.1	28	(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
1.1	29
8.1	30	(% style="color:#000000" %)Метод запроса: GET
1.1	31
16.1	32	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
1.1	33
16.1	34	(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
1.1	35
8.1	36	(% lang="en-US" %)
20.4	37	(% style="color:#000000" %)Ответ:
1.1	38
20.4	39	(% lang="en-US" %)
	40	(% style="color:#000000" %){
	41
	42	(% lang="en-US" %)
	43	(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
	44	"User": "" , ~/~/ имя пользователя
	45
	46	(% lang="en-US" %)
20.5	47	}
20.4	48
16.1	49	Примечание: Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
1.1	50
16.1	51
8.1	52	(% class="box infomessage" %)
	53	(((
16.1	54	(% style="color:#000000; line-height:100%" %)Проверка авторизации (% style="color:#000000" %)— (% lang="en-US" %)GET /api/v3/auth/check
8.1	55	)))
1.1	56
16.1	57	(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
1.1	58
8.1	59	(% style="color:#000000" %)Метод запроса: GET
1.1	60
16.1	61	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
1.1	62
16.1	63	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	64
8.1	65	(% lang="en-US" %)
16.1	66	(% style="color:#000000" %)Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».
1.1	67
	68
16.2	69	(% class="box" style="text-align: center;" %)
	70	(((
	71	(% style="color:#000000; font-size:14pt" %)Раздел Клиенты
	72	)))
	73
	74	(% class="box infomessage" %)
	75	(((
	76	(% style="color:#000000" %)Получение основных параметров клиента — (% lang="en-US" %)GET (%%)/(% lang="en-US" %)api/v3/agents(%%)
	77	)))
	78
	79	(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
	80
	81	(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
	82
	83	(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
	84
	85	(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
	86
	87	(% style="color:#000000" %)Метод запроса: GET
	88
	89	(% 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>
	90
	91	(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
	92
	93	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	94
20.4	95	(% style="color:#000000" %)Ответ:
16.2	96
20.4	97	(% style="color:#000000" %){
	98	"agentId": "", ~/~/ идентификатор клиента
	99	"parentId": "", ~/~/ идентификатор клиента-родителя
	100	"name": "", ~/~/ наименование клиента
	101	"fullName": "", ~/~/ полное наименование клиента
	102	"agentInfoType": "", ~/~/ тип клиента1
	103	"status": "", ~/~/ статус клиента
	104	}
20.2	105
20.4	106
18.1	107	(% style="color:#000000" %)Примечание: возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
16.2	108
	109
8.1	110	(% class="box" style="text-align: center;" %)
	111	(((
9.1	112	(% style="color:#000000; font-size:14pt" %)Раздел Пользователи
8.1	113	)))
1.1	114
8.1	115	(% class="box successmessage" %)
	116	(((
9.1	117	(% style="color:#000000; line-height:100%" %)Добавление пользователя — (% lang="en-US" %)POST /api/v3/users
8.1	118	)))
1.1	119
8.1	120	(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
1.1	121
8.1	122	(% style="color:#000000" %)Метод запроса: POST
1.1	123
8.1	124	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1.1	125
8.1	126	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	127
20.3	128	(% style="color:#000000" %)Параметры в теле запроса (JSON):
1.1	129
20.3	130	(% style="color:#000000" %){
20.4	131	"lastName": "", ~/~/ фамилия
20.3	132	"firstName": "", ~/~/ имя
	133	"position": "", ~/~/ должность
	134	"phone": "", ~/~/ телефон
	135	"organization": "", ~/~/ организация
	136	"login": "", ~/~/ логин
	137	"password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
	138	"email": "", ~/~/ email
	139	"description": "", ~/~/ описание
	140	"isEnabled": "", ~/~/ признак включения
	141	"parentId": "", ~/~/ Guid родительского агента
	142	"leaderId": "", ~/~/ Guid руководителя (null - не задан)
	143	"sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
	144	"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	145	"kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
	146	"target": "" , ~/~/ в случае аутентификации по email - email-адрес
	147	"groups": "" , ~/~/ группы пользователя, названия групп
	148	}
	149
8.1	150	(% style="text-align:left" %)
20.3	151	(% style="color:#000000; font-weight:normal" %)Ответ:
1.1	152
20.3	153	(% style="text-align:left" %)
	154	(% style="color:#000000; font-weight:normal" %){
1.1	155
20.3	156	(% style="text-align:left" %)
20.4	157	(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
20.3	158	"lastName": "" , ~/~/ Фамилия ,
	159	"firstName": "" , ~/~/ Имя
	160	"position": "" , ~/~/ Должность
	161	"phone": "" , ~/~/ Телефон
	162	"organization": "" , ~/~/ Организация
	163	"login": "" , ~/~/ Логин
	164	"password": "" , ~/~/ Пароль
	165	"email": "" , ~/~/ Email
	166	"description": "" , ~/~/ Описание
	167	"isEnabled": "" , ~/~/ Признак включения
	168	"parentId": "" , ~/~/ Guid родительского агента
	169	"sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
	170	"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	171	"kind": "" , ~/~/ тип аутентификации
	172	"target": "" , ~/~/ в случае аутентификации по email - email-адрес
	173	"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
	174
	175	(% style="text-align:left" %)
20.5	176	(% style="color:#000000; font-weight:normal" %) }
20.3	177
	178
18.1	179	(% class="box successmessage" %)
	180	(((
	181	(% style="color:#000000; line-height:100%" %)Получение списка пользователей — (% lang="en-US" %)POST /api/v3/users/find
	182	)))
	183
	184	(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
	185
	186	(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права «Просмотр пользователей».
	187
	188	(% style="color:#000000" %)Метод запроса: POST
	189
	190	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
	191
20.4	192	(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
18.1	193
20.4	194	(% style="color:#000000" %){
18.1	195
20.4	196	"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
	197	"userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
	198	"login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
	199	"email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
	200
20.5	201	(% style="color:#000000" %) }
18.1	202
20.4	203	(% style="color:#000000" %)Ответ:
18.1	204
20.5	205	(% style="color:#000000" %){ (%%)
20.4	206
20.5	207	"id": "" , ~/~/ идентификатор пользователя
20.4	208	"lastName": "" , ~/~/ фамилия
	209	"firstName": "" , ~/~/ имя
	210	"position": "" , ~/~/ должность
	211	"phone": "" , ~/~/ телефон
	212	"parentId": "" , ~/~/ идентификатор клиента-родителя
	213	"parentName": "" , ~/~/ наименование клиента-родителя
	214	"organization": "" , ~/~/ организация
	215	"login": "" , ~/~/ логин
	216	"email": "" , ~/~/ E-mail
20.5	217	"sessionDuration":"", ~/~/ длительность сессии в минутах
	218	"status": "1", ~/~/ статус пользователя
	219	"astLogged": "", ~/~/ дата/время последней авторизации
20.4	220
20.5	221	(% style="color:#000000" %) }
20.4	222
18.1	223
8.1	224	(% class="box warningmessage" %)
	225	(((
9.1	226	(% style="color:#000000; line-height:100%" %)Редактирование пользователя — (% lang="en-US" %)PUT /api/v3/users
8.1	227	)))
1.1	228
8.1	229	(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
1.1	230
8.1	231	(% style="color:#000000" %)Метод запроса: PUT
1.1	232
8.1	233	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1.1	234
8.1	235	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	236
8.1	237	(% lang="en-US" style="text-align:left" %)
20.6	238	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
1.1	239
20.6	240	(% lang="en-US" style="text-align:left" %)
	241	(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
1.1	242
20.6	243	(% lang="en-US" style="text-align:left" %)
	244	(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
	245	"lastName": "" , ~/~/ фамилия
	246	"firstName": "" , ~/~/ имя
	247	"position": "" , ~/~/ должность
	248	"phone": "" , ~/~/ телефон
	249	"organization": "" , ~/~/ организация
	250	"login": "" , ~/~/ логин
	251	"password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
	252	"email": "" , ~/~/ email
	253	"description": "" , ~/~/ описание
	254	"isEnabled": "" , ~/~/ признак включения
	255	"parentId": "" , ~/~/ Guid родительского агента
	256	"leaderId": "" , ~/~/ Guid руководителя (null - не задан)
	257	"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
	258	"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	259	"kind": "" , ~/~/ тип аутентификации
	260	"target": "" , ~/~/ в случае аутентификации по email - email-адрес
	261	"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
	262
	263	(% lang="en-US" style="text-align:left" %)
	264	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
	265
	266	(% lang="en-US" style="text-align:left" %)
	267	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
	268
	269	(% lang="en-US" style="text-align:left" %)
	270	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ //
	271
	272	(% lang="en-US" style="text-align:left" %)
	273	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
	274	"lastName": "" , ~/~/ фамилия
	275	"firstName": "" , ~/~/ имя
	276	"position": "" , ~/~/ должность
	277	"phone": "" , ~/~/ телефон
	278	"organization": "" , ~/~/ организация
	279	"login": "" , ~/~/ логин
	280	"password": "" , ~/~/ пароль
	281	"email": "" , ~/~/ email
	282	"description": "" , ~/~/ описание
	283	"isEnabled": "" , ~/~/ признак включения
	284	"parentId": "" , ~/~/ Guid родительского агента
	285	"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах
	286	"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
	287	"kind": "" , ~/~/ тип аутентификации
	288	"target": "" , ~/~/ в случае аутентификации по email - email-адрес
	289	"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
	290
	291	(% lang="en-US" style="text-align:left" %)
	292	(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
	293
	294
8.1	295	(% class="box warningmessage" %)
	296	(((
18.1	297	(% style="color:#000000" %)Изменение статуса пользователя// //— (% lang="en-US" %)PUT /api/v3/users/status/{id}
8.1	298	)))
1.1	299
8.1	300	(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
1.1	301
8.1	302	(% style="color:#000000" %)Метод запроса: PUT
1.1	303
20.7	304	(% 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	305
20.7	306	(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
1.1	307
20.7	308	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	309
20.7	310	(% style="color:#000000" %)Параметры в теле запроса (JSON):
1.1	311
20.7	312	(% style="color:#000000" %){
	313
	314	"status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
	315	"description": "" , ~/~/ описание
	316	"data": "" , ~/~/ данные, связанные со сменой статуса
	317
	318	(% style="color:#000000" %)}
	319
8.1	320	(% style="text-align:left" %)
	321	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
1.1	322
	323
8.1	324	(% class="box errormessage" %)
	325	(((
9.1	326	(% style="color:#000000; line-height:100%" %)Удаление пользователя — (% lang="en-US" %)DELETE /api/v3/users/{id}
8.1	327	)))
1.1	328
8.1	329	(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
1.1	330
8.1	331	(% style="color:#000000" %)Метод запроса: DELETE
1.1	332
8.1	333	(% 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	334
20.8	335	(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
1.1	336
20.8	337	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	338
8.1	339	(% style="text-align:left" %)
	340	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
1.1	341
	342
8.1	343	(% class="box" style="text-align: center;" %)
	344	(((
9.1	345	(% style="color:#000000; font-size:14pt" %)Раздел Транспортные средства
8.1	346	)))
1.1	347
8.1	348	(% class="box infomessage" %)
	349	(((
9.1	350	(% style="color:#000000; line-height:100%" %)Получение информации об объекте — (% lang="en-US" %)GET /api/v3/vehicles/{vehicleId}
8.1	351	)))
1.1	352
8.1	353	(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1.1	354
8.1	355	(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
1.1	356
8.1	357	(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1.1	358
8.1	359	(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
1.1	360
8.1	361	(% style="color:#000000" %)Метод запроса: GET
1.1	362
8.1	363	(% 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	364
8.1	365	(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
1.1	366
8.1	367	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1.1	368
8.1	369	(% style="color:#000000" %)Ответ:
1.1	370
8.1	371	(% style="color:#000000" %){
1.1	372
20.9	373	"vehicleId": "" , ~/~/ идентификатор объекта
	374	"name": "" , ~/~/ имя объекта
	375	"imei": "" , ~/~/ IMEI объекта
	376	"deviceTypeId": "" , ~/~/ идентификатор устройства объекта
	377	"deviceTypeName": "" , ~/~/ наименование устройства объекта
	378	"parentId": "" , ~/~/ идентификатор клиента-родителя
	379	"parentName": "" , ~/~/ наименование клиента-родителя,
	380	"modelId": "" , ~/~/ идентификатор модели объекта
	381	"modelName": "" , ~/~/ наименование модели объекта,
	382	"unitId": "" , ~/~/ идентификатор подразделения
	383	"unitName": "" , ~/~/ наименование подразделения
	384	"status": "" , ~/~/ статус объекта
1.1	385
20.9	386	}
1.1	387
8.1	388	(% style="text-align:left" %)
	389	Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1.1	390
8.1	391	(% style="text-align:left" %)
	392	0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1.1	393
	394
8.1	395	(% class="box successmessage" %)
	396	(((
9.1	397	(% style="color:#000000; line-height:100%" %)Добавление объекта — (% lang="en-US" %)POST /api/v3/vehicles
8.1	398	)))
1.1	399
8.1	400	(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», //Content-Type//: application/json; //charset//=utf-8).
1.1	401
8.1	402	(% style="color:#000000" %)Метод запроса: POST
	403
	404	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	405
	406	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	407
	408	(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
	409
	410	(% class="western" %)
1.1	411	{{{ "parentId": "", // ID клиента
	412	"name": "", // имя ТС
	413	"imei": "", // IMEI
	414	"deviceTypeId": "",// ID типа устройства
	415	"modelId": "",
	416	"unitId": "", // ID подразделения
	417	"sim1": "", // Номер SIM 1
	418	"sim2": "", // Номер SIM2
	419	"consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
	420	"consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
	421	"consumptionIdle": "",// Расход топлива на холостом ходу
	422	"counters": {
	423	"mileage": "", // пробег
	424	"mileageEnabled": true, // флаг активности счётчика "пробег"
	425	"motohours":"", // моточасы
	426	"motohoursEnabled": true // флаг активности счётчика "моточасы"
	427	},
	428	"cmsv6Parameters": { // параметры CMSv6
	429	"enabled": true, // флаг включения
	430	//"id": "", // идентификатор
	431	"host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
	432	"login": "", // имя учетной записи
	433	"password": "" // пароль учетной записи
	434	},
	435	"inspectionTasks": [ // задания на ТО
	436	{
	437	"enabled": "", // Признак включения
	438	"name": "", // Имя задания
	439	"description": "", // Описание задания
	440	"mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
	441	"lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
	442	"motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
	443	"lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
	444	"periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
	445	"kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
	446	"lastInspectionDate": "", // Дата последнего ТО (null - не указано)
	447	"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
	448	},
	449	]}}}
	450
8.1	451	(% style="color:#000000" %)… }
1.1	452
8.1	453	(% style="color:#000000" %)Ответ:
1.1	454
8.1	455	(% style="color:#000000" %){
1.1	456
8.1	457	(% class="western" %)
1.1	458	{{{ "vehicleId": "", //ID ТС
	459	"parentId": "", //Guid владельца ТС
	460	"name": "", //Имя объекта
	461	"imei": "", //IMEI
	462	"deviceTypeId": "", //ID типа устройства
	463	"modelId": "", //ID модели
	464	"unitId": "", //ID подразделения
	465	"sim1": "", //SIM1
	466	"sim2": "", //SIM2
	467	"consumptionPer100Km": "", //Расход топлива на 100 км
	468	"consumptionIdle": "", //Расход топлива на холостом ходу
	469	"counters": { //Счётчики
	470	"mileageEnabled": true,
	471	"motohoursEnabled": true,
	472	"mileage": "",
	473	"motohours": 345.0
	474	},
	475	"cmsv6Parameters": { //Параметры CmsV6
	476	"id": null,
	477	"enabled": true, //флаг включения
	478	"host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
	479	"login": "", // имя учетной записи
	480	"password": "" // пароль учетной записи
	481	},
	482	"inspectionTasks": [ // задания на ТО
	483	{
	484	"id": "", // ID задачи
	485	"enabled": false, // Признак включения
	486	"name": "", // Имя задания
	487	"description": "", // Описание задания
	488	"mileageCondition": "", // Условие по пробегу
	489	"lastMileage": "", // Пробег (в метрах)
	490	"motohoursCondition": "", // Условие по моточасам
	491	"lastMotohours": "", // Моточасы
8.1	492	"periodicCondition": "", // Условие периодичности по времени
	493	"kind": "", // Вид периодичности по времени
1.1	494	"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
	495	}
	496	]}}}
	497
8.1	498	(% style="text-align:left" %)
	499	(% style="color:#000000" %)}
1.1	500
	501
8.1	502	(% class="box successmessage" %)
	503	(((
18.1	504	(% style="color:#000000; line-height:100%" %)Получение параметров объектов — (% lang="en-US" %)POST /api/v3/vehicles/find
8.1	505	)))
1.1	506
8.1	507	(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1.1	508
8.1	509	(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
1.1	510
8.1	511	(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1.1	512
8.1	513	(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1.1	514
8.1	515	(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
1.1	516
8.1	517	(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
1.1	518
8.1	519	(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
1.1	520
8.1	521	(% style="color:#000000" %)Метод запроса: POST
1.1	522
8.1	523	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1.1	524
8.1	525	(% style="color:#000000" %)В заголовках запроса:
1.1	526
8.1	527	(% style="color:#000000" %)− Content-Type: application/json
1.1	528
8.1	529	(% style="color:#000000" %)− X-Auth: Токен авторизации
	530
	531	(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
	532
14.1	533	(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
8.1	534
14.1	535	(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
	536
15.1	537	(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
14.1	538
15.1	539	(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
	540
8.1	541	(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
	542
	543	(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]
	544
	545	(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
	546
18.2	547	0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
8.1	548
	549
	550	(% class="box successmessage" %)
	551	(((
9.1	552	(% style="color:#000000; line-height:100%" %)Изменение статуса объекта — (% lang="en-US" %)POST /api/v3/vehicles/changeStatus/{vehicleId}
8.1	553	)))
	554
	555	(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
	556
	557	(% style="color:#000000" %)Метод запроса: POST
	558
	559	(% 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}
	560
	561	(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
	562
	563	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	564
	565	(% style="color:#000000" %)Параметры в теле запроса (JSON): {
	566
	567	(% class="western" %)
20.1	568	{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
	569	// 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
	570	// 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1.1	571	"date": "", // Дата смены статуса (null если сменить немедленно)
	572	"description": "", // Описание
	573	"data": "", // Данные
	574	"overwrite": false, // Флаг перезаписи
	575	"stage": "", // Состояние, может быть null}}}
	576
8.1	577	(% style="color:#000000" %)}
1.1	578
8.1	579	(% style="color:#000000" %)Ответ: {
1.1	580
8.1	581	(% class="western" %)
1.1	582	{{{ "status": "", // значение статуса
	583	"date": "", // Дата смены статуса
	584	"description": "", // Описание
	585	"data": "", // Данные
	586	"overwrite": false, // Флаг перезаписи
	587	"stage": "", // Состояние}}}
	588
8.1	589	(% style="text-align:left" %)
	590	(% style="color:#000000" %)}
1.1	591
	592
18.1	593	(% class="box warningmessage" %)
	594	(((
	595	(% style="color:#000000; line-height:100%" %)Редактирование объекта — (% lang="en-US" %)PUT /api/v3/vehicles
	596	)))
	597
	598	(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
	599
	600	(% style="color:#000000" %)Метод запроса: PUT
	601
	602	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
	603
	604	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	605
	606	(% style="color:#000000" %)Параметры в теле запроса (JSON):
	607
	608	(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
	609
	610	(% style="color:#000000" %)Ответ:
	611
	612	(% lang="en-US" style="text-align:left" %)
	613	(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
	614
	615
	616	(% class="box errormessage" %)
	617	(((
	618	(% style="color:#000000; line-height:100%" %)Удаление объекта — (% lang="en-US" %)DELETE /api/v3/vehicles/{vehicleId}
	619	)))
	620
	621	(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
	622
	623	(% style="color:#000000" %)Метод запроса: DELETE
	624
	625	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
	626
	627	(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
	628
	629	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	630
	631	(% style="text-align:left" %)
	632	(% style="color:#000000" %)Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
	633
	634
8.1	635	(% class="box" lang="en-US" style="text-align: center;" %)
	636	(((
17.1	637	(% style="color:#000000; font-size:14pt" %)Раздел Устройства
	638	)))
	639
	640	(% class="box infomessage" %)
	641	(((
	642	(% style="color:#000000; line-height:100%" %)Получение списка типов устройств (% style="color:#000000" %)— (% lang="en-US" %)GET /api/v3/devices/types
	643	)))
	644
	645	(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
	646
	647	(% style="color:#000000" %)Метод запроса: GET
	648
	649	(% 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]]
	650
	651	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	652
	653	(% style="color:#000000" %)Ответ: [
	654
	655	(% class="western" %)
	656	{{{ {
	657	"deviceTypeId" : "", // ID типа устройства
	658	"deviceTypeName" : "" // Название типа устройства
	659	},}}}
	660
	661	(% style="text-align:left" %)
	662	(% style="color:#000000" %)… ]
	663
	664
	665	(% class="box" style="text-align: center;" %)
	666	(((
	667	(% style="color:#000000; font-size:14pt" %)Раздел Датчики
	668	)))
	669
	670	(% class="box infomessage" %)
	671	(((
	672	(% style="color:#000000; line-height:100%" %)Получение списка типов датчиков (% style="color:#000000" %)— (% lang="en-US" %)GET /api/v3/sensors/types
	673	)))
	674
	675	(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»).
	676
	677	(% style="color:#000000" %)Метод запроса: GET
	678
	679	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
	680
	681	(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
	682
	683	(% style="color:#000000" %)Ответ: [
	684
	685	(% class="western" style="margin-bottom:19px" %)
	686	{{{ {}}}
	687
	688	(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
	689
	690	(% class="western" %)
	691	{{{ "description": "" // Описание
	692	},}}}
	693
	694	(% style="text-align:left" %)
	695	(% style="color:#000000" %)… ]
	696
	697
	698	(% class="box" lang="en-US" style="text-align: center;" %)
	699	(((
14.1	700	(% 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	701	)))

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

Меню