Комментарий

• Свойства страницы (2 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Название

...	...	@@ -1,1 +1,1 @@
1		-API
	1	+Методы API для работы с ГЛОНАССSoft

Содержимое

...	...	@@ -3,10 +3,14 @@
3	3	== ==
4	4
5	5	**Действующие ограничения**
	6	+
6	6
7		-Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
	8	+- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
8	8
	10	+- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
	11	+
9	9	Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
	13	+\\
10	10
11	11	**Авторизация**
12	12
...	...	@@ -19,6 +19,7 @@
19	19	В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
20	20
21	21	Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
	26	+
22	22
23	23	**Получение списка объектов**
24	24
...	...	@@ -50,7 +50,7 @@
50	50
51	51	Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
52	52
53		-Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов  //}, … ]
	58	+Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
54	54
55	55	Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
56	56
...	...	@@ -81,6 +81,7 @@
81	81	12 - «Проверен»
82	82
83	83	13 - «Не эксплуатируется»
	89	+
84	84
85	85	**Получение списка клиентов.**
86	86
...	...	@@ -103,6 +103,7 @@
103	103	Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
104	104
105	105	Примечание. Возможные значение параметра agentInfoType:
	112	+
106	106
107	107	**Получение списка пользователей.**
108	108
...	...	@@ -128,6 +128,7 @@
128	128	{{{ "sessionDuration": "", // длительность сессии в минутах}}}
129	129
130	130	«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
	138	+
131	131
132	132	**Получение списка типов устройств**
133	133
...	...	@@ -147,6 +147,7 @@
147	147	},}}}
148	148
149	149	… ]
	158	+
150	150
151	151	**Получение списка типов датчиков**
152	152
...	...	@@ -168,6 +168,7 @@
168	168	},}}}
169	169
170	170	… ]
	180	+
171	171
172	172	**Получение информации об объекте**
173	173
...	...	@@ -208,6 +208,7 @@
208	208	}
209	209
210	210	Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
	221	+
211	211
212	212	**Добавление пользователя**
213	213
...	...	@@ -222,6 +222,7 @@
222	222	Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
223	223
224	224	Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
	236	+
225	225
226	226	**Редактирование пользователя**
227	227
...	...	@@ -241,6 +241,7 @@
241	241	}
242	242
243	243	Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	256	+
244	244
245	245	**Удаление пользователя**
246	246
...	...	@@ -253,6 +253,7 @@
253	253	Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
254	254
255	255	Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	269	+
256	256
257	257	**Добавление объекта**
258	258
...	...	@@ -354,6 +354,7 @@
354	354	]}}}
355	355
356	356	}
	371	+
357	357
358	358	**Удаление объекта**
359	359
...	...	@@ -368,6 +368,7 @@
368	368	В заголовках запроса: X-Auth: Токен авторизации
369	369
370	370	Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
	386	+
371	371
372	372	**Редактирование объекта**
373	373
...	...	@@ -386,6 +386,7 @@
386	386	Ответ:
387	387
388	388	{ «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»: «» //Сколько раз выполнить задание } ] }
	405	+
389	389
390	390	**Изменение статуса объекта**
391	391
...	...	@@ -420,6 +420,7 @@
420	420	"stage": "", // Состояние}}}
421	421
422	422	}
	440	+
423	423
424	424	**Проверка авторизации**
425	425