Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Tags

...	...	@@ -1,1 +1,0 @@
1		-Public API|API

Content

...	...	@@ -20,27 +20,20 @@
20	20	(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21	21	)))
22	22
23		-(% class="box successmessage" %)
	23	+(% class="box infomessage" %)
24	24	(((
25		- (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
	25	+ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26	26	)))
27	27
28	28	(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29	29
30		-(% style="color:#000000" %)Метод запроса: **POST**
	30	+(% style="color:#000000" %)Метод запроса: **GET**
31	31
32		-(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
	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]]
33	33
34		-(% style="color:#000000" %)В случае успешного выполнения метода, поле «(% style="color: rgb(0, 0, 0);" %)__**AuthId**__(% style="color:#000000" %)» содержит токен авторизации «(% style="color: rgb(0, 0, 0);" %)__**X-Auth**__(% style="color:#000000" %)».
	34	+(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35	35
36		-(% style="color:#000000" %)Параметры в теле запроса (JSON):
37		-
38		-(% style="color:#000000" %){
39		- "login": "testuser",
40		- "password": "testuser"
41		-}(%%)
42		-
43		-
	36	+(% lang="en-US" %)
44	44	(% style="color:#000000" %)**Ответ:**
45	45
46	46	(% lang="en-US" %)
...	...	@@ -47,8 +47,8 @@
47	47	(% style="color:#000000" %){
48	48
49	49	(% lang="en-US" %)
50		-(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51		- "User": "testuser" , ~/~/ имя пользователя
	43	+(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
	44	+ "User": "" , ~/~/ имя пользователя
52	52
53	53	(% lang="en-US" %)
54	54	}
...	...	@@ -107,7 +107,7 @@
107	107	"name": "", ~/~/ наименование клиента
108	108	"fullName": "", ~/~/ полное наименование клиента
109	109	"agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110		- "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
	103	+ "status": "", ~/~/ статус клиента
111	111	}
112	112
113	113
...	...	@@ -537,13 +537,13 @@
537	537
538	538	(% class="western" style="color:#000000" %)##{##
539	539
540		-(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
	533	+(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
541	541	"name": null, ~/~/ Имя ТС (string, опционально)
542	542	"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
543	543	"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
544	544	"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
545	545	"parentId": null, ~/~/ ID клиента (Guid, опционально)
546		- "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
	539	+ "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
547	547	(% style="color:#000000" %)}
548	548
549	549	(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
...	...	@@ -565,15 +565,17 @@
565	565	"modelName": "" ~/~/ наименование модели объекта
566	566	"unitId": "" ~/~/ идентификатор подразделения
567	567	"unitName": "" ~/~/ наименование подразделения
568		- "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
569		- ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
570		- ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
571		-(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
	561	+ "status": "" ~/~/ статус объекта
	562	+ "createdAt": "" ~/~/ дата создания объектов  (%%)
572	572	(% style="color:#000000" %)}
573	573
574	574	(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
575	575
	567	+(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
576	576
	569	+0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
	570	+
	571	+
577	577	(% class="box successmessage" %)
578	578	(((
579	579	(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**