<
From version < 2.1 >
edited by Андрей Калиновский
on 2022/07/21 16:33
To version < 28.9 >
edited by Артем Шемяков
on 2022/09/22 10:20
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -API
1 +Методы API для работы с ГЛОНАССSoft
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.Artem
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,436 +1,846 @@
1 -== Описание ГЛОНАССSoft Public API ==
1 +(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
2 2  
3 3  == ==
4 4  
5 - **Действующие ограничения**
6 +(% class="box" style="text-align: center;" %)
7 +(((
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 +)))
6 6  
7 -Для работы со всеми методами API необходимо в заголовок добавлять X-Auth окен авторизации, получаемый методом auth/login).
11 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
8 8  
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 +
9 9  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 +
10 10  
11 - **Авторизация**
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
12 12  
13 -Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
23 +(% class="box successmessage" %)
24 +(((
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 +)))
14 14  
15 -Метод запроса: GET
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
16 16  
17 -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]]
30 +(% style="color:#000000" %)Метод запроса: **POST**
18 18  
19 -В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
20 20  
21 -Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
22 22  
23 - **Получение списка объектов**
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
24 24  
25 -Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}(%%)
42 +
26 26  
27 -−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
44 +(% style="color:#000000" %)**Ответ:**
28 28  
29 -−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
46 +(% lang="en-US" %)
47 +(% style="color:#000000" %){
30 30  
31 -−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
49 +(% lang="en-US" %)
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
32 32  
33 -−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
53 +(% lang="en-US" %)
54 +}
34 34  
35 -−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
56 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
36 36  
37 -Метод запроса: POST
38 38  
39 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
59 +(% class="box infomessage" %)
60 +(((
61 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +)))
40 40  
41 -В заголовках запроса:
64 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
42 42  
43 -−Content-Type: application/json
66 +(% style="color:#000000" %)Метод запроса: **GET**
44 44  
45 -−X-Auth: Токен авторизации
68 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
46 46  
47 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
70 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
48 48  
49 -{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
72 +(% lang="en-US" %)
73 +(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
50 50  
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//»: «» дата создания объектов  //}, … ]
76 +(% class="box" style="text-align: center;" %)
77 +(((
78 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 +)))
54 54  
55 -Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
81 +(% class="box infomessage" %)
82 +(((
83 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 +)))
56 56  
57 -0 - «Блокировка»
86 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
58 58  
59 -1 - «Активен»,
88 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
60 60  
61 -2 - «Отменен»
90 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
62 62  
63 -3 - «Оборудован»
92 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
64 64  
65 -4 - «Диагностика»
94 +(% style="color:#000000" %)Метод запроса: **GET**
66 66  
67 -5 - «Сервис»
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>
68 68  
69 -6 - «Демонтаж»
98 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
70 70  
71 -7 - «Монтаж»
100 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
72 72  
73 -8 - «Дозаказ»
102 +(% style="color:#000000" %)Ответ:
74 74  
75 -9 - «Обслужен»
104 +(% style="color:#000000" %){
105 + "agentId": "", ~/~/ идентификатор клиента
106 + "parentId": "", ~/~/ идентификатор клиента-родителя
107 + "name": "", ~/~/ наименование клиента
108 + "fullName": "", ~/~/ полное наименование клиента
109 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 +}
76 76  
77 -10 - «Списан»
78 78  
79 -11 - «Неисправен»
114 +(% class="box" style="text-align: center;" %)
115 +(((
116 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
117 +)))
80 80  
81 -12 - «Проверен»
119 +(% class="box successmessage" %)
120 +(((
121 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 +)))
82 82  
83 -13 - «Не эксплуатируется»
124 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
84 84  
85 - **Получение списка клиентов.**
126 +(% style="color:#000000" %)Метод запроса: **POST**
86 86  
87 -Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
128 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
88 88  
89 -−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
130 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
90 90  
91 -−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
92 92  
93 -−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
134 +(% style="color:#000000" %){ 
135 + "lastName": "", ~/~/ фамилия
136 + "firstName": "", ~/~/ имя
137 + "position": "", ~/~/ должность
138 + "phone": "", ~/~/ телефон
139 + "organization": "", ~/~/ организация
140 + "login": "", ~/~/ логин
141 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 + "email": "", ~/~/ email
143 + "description": "", ~/~/ описание
144 + "isEnabled": "", ~/~/ признак включения
145 + "parentId": "", ~/~/ Guid родительского агента
146 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 + "groups": "" , ~/~/ группы пользователя, названия групп
152 +}
94 94  
95 -Метод запроса: GET
154 +(% style="text-align:left" %)
155 +(% style="color:#000000; font-weight:normal" %)Ответ:
96 96  
97 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
157 +(% style="text-align:left" %)
158 +(% style="color:#000000; font-weight:normal" %){    
98 98  
99 -Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
160 +(% style="text-align:left" %)
161 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 + "lastName": "" , ~/~/ Фамилия ,
163 + "firstName": "" , ~/~/ Имя
164 + "position": "" , ~/~/ Должность
165 + "phone": "" , ~/~/ Телефон
166 + "organization": "" , ~/~/ Организация
167 + "login": "" , ~/~/ Логин
168 + "password": "" , ~/~/ Пароль
169 + "email": "" , ~/~/ Email
170 + "description": "" , ~/~/ Описание
171 + "isEnabled": "" , ~/~/ Признак включения
172 + "parentId": "" , ~/~/ Guid родительского агента
173 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 + "kind": "" , ~/~/ тип аутентификации
176 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
100 100  
101 -В заголовках запроса: X-Auth: Токен авторизации
179 +(% style="text-align:left" %)
180 +(% style="color:#000000; font-weight:normal" %)}
102 102  
103 -Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
104 104  
105 -Примечание. Возможные значение параметра agentInfoType:
183 +(% class="box successmessage" %)
184 +(((
185 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
186 +)))
106 106  
107 - **Получение списка пользователей.**
188 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
108 108  
109 -Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
190 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
110 110  
111 -Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
192 +(% style="color:#000000" %)Метод запроса: **POST**
112 112  
113 -Метод запроса: POST
194 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
114 114  
115 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
196 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
116 116  
117 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
198 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
118 118  
119 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
120 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
121 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
122 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
200 +(% style="color:#000000" %){
123 123  
124 -}
202 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
125 125  
126 -Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
207 +(% style="color:#000000" %)}
127 127  
128 -{{{ "sessionDuration": "", // длительность сессии в минутах}}}
209 +(% style="color:#000000" %)Ответ:
129 129  
130 - «status»: 1, //статус пользователя «lastLogge«» //дата/время последней авторизации }, … ]
211 +(% style="color:#000000" %){         (%%)
131 131  
132 - **Получение списка типов устройств**
213 + "id": "" , ~/~/ идентификатор пользователя
214 + "lastName": "" , ~/~/ фамилия
215 + "firstName": "" , ~/~/ имя
216 + "position": "" , ~/~/ должность
217 + "phone": "" , ~/~/ телефон
218 + "parentId": "" , ~/~/ идентификатор клиента-родителя
219 + "parentName": "" , ~/~/ наименование клиента-родителя
220 + "organization": "" , ~/~/ организация
221 + "login": "" , ~/~/ логин
222 + "email": "" , ~/~/ E-mail
223 + "sessionDuration":"", ~/~/ длительность сессии в минутах
224 + "status": "1",  ~/~/ статус пользователя
225 + "astLogged": "", ~/~/ дата/время последней авторизации
133 133  
134 -Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Aut)
227 +(% style="color:#000000" %)}
135 135  
136 -Метод запроса: GET
137 137  
138 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
230 +(% class="box warningmessage" %)
231 +(((
232 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 +)))
139 139  
140 -В заголовках запроса:X-Auth: Токен авторизации
235 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
141 141  
142 -Ответ: [
237 +(% style="color:#000000" %)Метод запроса: **PUT**
143 143  
144 -{{{ {
145 - "deviceTypeId" : "", // ID типа устройства
146 - "deviceTypeName" : "" // Название типа устройства
147 - },}}}
239 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
148 148  
149 - ]
241 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
150 150  
151 - **Получение списка типов датчиков**
243 +(% lang="en-US" style="text-align:left" %)
244 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
152 152  
153 -Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
246 +(% lang="en-US" style="text-align:left" %)
247 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
154 154  
155 -Метод запроса: GET
249 +(% lang="en-US" style="text-align:left" %)
250 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
251 + "lastName": "" , ~/~/ фамилия
252 + "firstName": "" , ~/~/ имя
253 + "position": "" , ~/~/ должность
254 + "phone": "" , ~/~/ телефон
255 + "organization": "" , ~/~/ организация
256 + "login": "" , ~/~/ логин
257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 + "email": "" , ~/~/ email
259 + "description": "" , ~/~/ описание
260 + "isEnabled": "" , ~/~/ признак включения
261 + "parentId": "" , ~/~/ Guid родительского агента
262 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 + "kind": "" , ~/~/ тип аутентификации
266 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
267 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
156 156  
157 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
269 +(% lang="en-US" style="text-align:left" %)
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
158 158  
159 -В заголовках запроса:X-Auth: Токен авторизации
272 +(% lang="en-US" style="text-align:left" %)
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
160 160  
161 -Ответ: [
275 +(% lang="en-US" style="text-align:left" %)
276 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
162 162  
163 -{{{ {}}}
278 +(% lang="en-US" style="text-align:left" %)
279 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
280 + "lastName": "" , ~/~/ фамилия
281 + "firstName": "" , ~/~/ имя
282 + "position": "" , ~/~/ должность
283 + "phone": "" , ~/~/ телефон
284 + "organization": "" , ~/~/ организация
285 + "login": "" , ~/~/ логин
286 + "password": "" , ~/~/ пароль 
287 + "email": "" , ~/~/ email
288 + "description": "" , ~/~/ описание
289 + "isEnabled": "" , ~/~/ признак включения
290 + "parentId": "" , ~/~/ Guid родительского агента
291 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 + "kind": "" , ~/~/ тип аутентификации
294 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
164 164  
165 -«id»: «», //ID типа датчика «name»: «», //Название
297 +(% lang="en-US" style="text-align:left" %)
298 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
166 166  
167 -{{{ "description": "" // Описание
168 - },}}}
169 169  
170 -… ]
301 +(% class="box warningmessage" %)
302 +(((
303 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 +)))
171 171  
172 - **Получение информации об объекте**
306 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
173 173  
174 -Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
308 +(% style="color:#000000" %)Метод запроса: **PUT**
175 175  
176 -Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
310 +(% 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}
177 177  
178 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
312 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
179 179  
180 -Метод запроса: GET
314 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
181 181  
182 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
316 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
183 183  
184 -Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
318 +(% style="color:#000000" %){
185 185  
186 -В заголовках запроса: X-Auth: Токен авторизации
320 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 + "description": "" , ~/~/ описание
322 + "data": "" , ~/~/ данные, связанные со сменой статуса
187 187  
188 -Ответ:
324 +(% style="color:#000000" %)}
189 189  
190 -{
326 +(% style="text-align:left" %)
327 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
191 191  
192 -{{{ "vehicleId": “”, // идентификатор объекта
193 - "name": "", // имя объекта
194 - "imei": "", // IMEI объекта
195 - "deviceTypeId": “”, // идентификатор устройства объекта
196 - "deviceTypeName": "" // наименование устройства объекта
197 - "parentId": "", // идентификатор клиента-родителя
198 - "parentName": "" // наименование клиента-родителя,
199 - "modelId": "", // идентификатор модели объекта
200 - "modelName": "" // наименование модели объекта,
201 - "unitId": "", // идентификатор подразделения
202 - "unitName": "", // наименование подразделения
203 - "status": “”, // статус объекта
204 - ...
205 - },
206 - ...}}}
207 207  
208 -}
330 +(% class="box errormessage" %)
331 +(((
332 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
333 +)))
209 209  
210 -Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
335 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
211 211  
212 - **Добавление пользователя**
337 +(% style="color:#000000" %)Метод запроса: **DELETE**
213 213  
214 -Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
339 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
215 215  
216 -Метод запроса: POST
341 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
217 217  
218 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
343 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
219 219  
220 -В заголовках запроса: X-Auth: Токен авторизации
345 +(% style="text-align:left" %)
346 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
221 221  
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 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
349 +(% class="box" style="text-align: center;" %)
350 +(((
351 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
352 +)))
225 225  
226 - **Редактирование пользователя**
354 +(% class="box infomessage" %)
355 +(((
356 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
357 +)))
227 227  
228 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
359 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
229 229  
230 -Метод запроса: PUT
361 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
231 231  
232 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
363 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
233 233  
234 -В заголовках запроса: X-Auth: Токен авторизации
365 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
235 235  
236 -Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «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»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
367 +(% style="color:#000000" %)Метод запроса: **GET**
237 237  
238 -{{{ "description": "", // описание
239 - "data": "" // данные, связанные со сменой статуса}}}
369 +(% 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>
240 240  
241 -}
371 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
242 242  
243 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
373 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
244 244  
245 - **Удаление пользователя**
375 +(% style="color:#000000" %)Ответ:
246 246  
247 -Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Aut)
377 +(% style="color:#000000" %){
248 248  
249 -Метод запроса: DELETE
379 + "vehicleId": "" , ~/~/ идентификатор объекта
380 + "name": "" , ~/~/ имя объекта
381 + "imei": "" , ~/~/ IMEI объекта
382 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 + "parentId": "" , ~/~/ идентификатор клиента-родителя
385 + "parentName": "" , ~/~/ наименование клиента-родителя,
386 + "modelId": "" , ~/~/ идентификатор модели объекта
387 + "modelName": "" , ~/~/ наименование модели объекта,
388 + "unitId": "" , ~/~/ идентификатор подразделения
389 + "unitName": "" , ~/~/ наименование подразделения
390 + "status": "" , ~/~/ статус объекта
250 250  
251 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
392 +}
252 252  
253 -Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
394 +(% style="text-align:left" %)
395 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
254 254  
255 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
397 +(% style="text-align:left" %)
398 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
256 256  
257 - **Добавление объекта**
258 258  
259 -Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
401 +(% class="box successmessage" %)
402 +(((
403 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
404 +)))
260 260  
261 -Метод запроса: POST
406 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
262 262  
263 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
408 +(% style="color:#000000" %)Метод запроса: **POST**
264 264  
265 -В заголовках запроса: X-Auth: Токен авторизации
410 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
266 266  
267 -Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
412 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
268 268  
269 -{{{ "parentId": "", // ID клиента
270 - "name": "", // имя ТС
271 - "imei": "", // IMEI
272 - "deviceTypeId": "",// ID типа устройства
273 - "modelId": "",
274 - "unitId": "", // ID подразделения
275 - "sim1": "", // Номер SIM 1
276 - "sim2": "", // Номер SIM2
277 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
278 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
279 - "consumptionIdle": "",// Расход топлива на холостом ходу
280 - "counters": {
281 - "mileage": "", // пробег
282 - "mileageEnabled": true, // флаг активности счётчика "пробег"
283 - "motohours":"", // моточасы
284 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
285 - },
286 - "cmsv6Parameters": { // параметры CMSv6
287 - "enabled": true, // флаг включения
288 - //"id": "", // идентификатор
289 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
290 - "login": "", // имя учетной записи
291 - "password": "" // пароль учетной записи
292 - },
293 - "inspectionTasks": [ // задания на ТО
414 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
415 +
416 +(% style="color:#000000" %){
417 +
418 + "parentId": "" , ~/~/ ID клиента
419 + "name": "" , ~/~/ имя ТС
420 + "imei": "" , ~/~/ IMEI
421 + "deviceTypeId": "" , ~/~/ ID типа устройства
422 + "modelId": "" , ~/~/ ID модели
423 + "unitId": "" , ~/~/ ID подразделения
424 + "sim1": "" , ~/~/ Номер SIM 1
425 + "sim2": "" , ~/~/ Номер SIM2
426 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
427 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас сли заполнено, то consumptionPer100Km не может быть заполнено)
428 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
429 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
430 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
431 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
432 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
433 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
434 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
435 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
436 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
437 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
438 + "counters": ~/~/ счетчики
294 294   {
295 - "enabled": "", // Признак включения
296 - "name": "", // Имя задания
297 - "description": "", // Описание задания
298 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
299 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
300 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
301 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
302 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
303 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
304 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
305 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
440 + "mileage": "" , ~/~/ пробег
441 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
442 + "motohours": "" , ~/~/ моточасы
443 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
306 306   },
307 - ]}}}
445 + "cmsv6Parameters": { ~/~/ параметры CMSv6
446 + "enabled": true, ~/~/ флаг включения
447 + "id": "" , ~/~/ идентификатор
448 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
449 + "login": "" , ~/~/ имя учетной записи
450 + "password": "" ~/~/ пароль учетной записи
451 + },
452 + "inspectionTasks": ~/~/ задания на ТО
453 + {
454 + "enabled": "" , ~/~/ Признак включения
455 + "name": "" , ~/~/ Имя задания
456 + "description": "" , ~/~/ Описание задания
457 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
458 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
459 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
460 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
461 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
462 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
463 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
464 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
465 + }
308 308  
309 - }
467 +(% style="color:#000000" %) }
310 310  
311 -Ответ:
469 +(% style="color:#000000" %)Ответ:
312 312  
313 -{
471 +(% style="color:#000000" %){
314 314  
315 -{{{ "vehicleId": "", //ID ТС
316 - "parentId": "", //Guid владельца ТС
317 - "name": "", //Имя объекта
318 - "imei": "", //IMEI
319 - "deviceTypeId": "", //ID типа устройства
320 - "modelId": "", //ID модели
321 - "unitId": "", //ID подразделения
322 - "sim1": "", //SIM1
323 - "sim2": "", //SIM2
324 - "consumptionPer100Km": "", //Расход топлива на 100 км
325 - "consumptionIdle": "", //Расход топлива на холостом ходу
326 - "counters": { //Счётчики
327 - "mileageEnabled": true,
328 - "motohoursEnabled": true,
329 - "mileage": "",
330 - "motohours": 345.0
331 - },
332 - "cmsv6Parameters": { //Параметры CmsV6
333 - "id": null,
334 - "enabled": true, //флаг включения
335 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
336 - "login": "", // имя учетной записи
337 - "password": "" // пароль учетной записи
338 - },
339 - "inspectionTasks": [ // задания на ТО
340 - {
341 - "id": "", // ID задачи
342 - "enabled": false, // Признак включения
343 - "name": "", // Имя задания
344 - "description": "", // Описание задания
345 - "mileageCondition": "", // Условие по пробегу
346 - "lastMileage": "", // Пробег (в метрах)
347 - "motohoursCondition": "", // Условие по моточасам
348 - "lastMotohours": "", // Моточасы
349 - "periodicCondition": "", // Условие периодичности по времени}}}
473 + "vehicleId": "", ~/~/ID ТС 
474 + "parentId": "", ~/~/Guid владельца ТС
475 + "name": "", ~/~/Имя объекта
476 + "imei": "", ~/~/IMEI
477 + "deviceTypeId": "", ~/~/ID типа устройства
478 + "modelId": "", ~/~/ID модели
479 + "unitId": "", ~/~/ID подразделения
480 + "sim1": "", ~/~/SIM1
481 + "sim2": "", ~/~/SIM2
482 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
483 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
484 + "counters": { ~/~/Счётчики
485 + "mileageEnabled": true,
486 + "motohoursEnabled": true,
487 + "mileage": "",
488 + "motohours": 345.0
489 + },
490 + "cmsv6Parameters": { ~/~/Параметры CmsV6
491 + "id": null,
492 + "enabled": true, ~/~/флаг включения
493 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
494 + "login": "", ~/~/ имя учетной записи
495 + "password": "" ~/~/ пароль учетной записи
496 + },
497 + "inspectionTasks": { ~/~/ задания на ТО
498 + "id": "", ~/~/ ID задачи
499 + "enabled": false, ~/~/ Признак включения
500 + "name": "", ~/~/ Имя задания
501 + "description": "", ~/~/ Описание задания
502 + "mileageCondition": "", ~/~/ Условие по пробегу
503 + "lastMileage": "", ~/~/ Пробег (в метрах)
504 + "motohoursCondition": "", ~/~/ Условие по моточасам
505 + "lastMotohours": "", ~/~/ Моточасы
506 + "periodicCondition": "", ~/~/ Условие периодичности по времени
507 + "kind": "", ~/~/ Вид периодичности по времени 
508 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
509 + }
350 350  
351 -{{{ "kind": "", // Вид периодичности по времени
352 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
353 - }
354 - ]}}}
511 +(% style="text-align:left" %)
512 +(% style="color:#000000" %)}
355 355  
356 -}
514 +**Валидация:**
515 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
516 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
517 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
357 357  
358 - **Удаление объекта**
359 359  
360 -Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
520 +(% class="box successmessage" %)
521 +(((
522 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
523 +)))
361 361  
362 -Метод запроса: DELETE
525 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
363 363  
364 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
527 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
365 365  
366 -Параметр запроса: {id} - Guid объекта
529 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
367 367  
368 -В заголовках запроса: X-Auth: Токен авторизации
531 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
369 369  
370 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
533 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
371 371  
372 - **Редактирование объекта**
535 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
373 373  
374 -Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
537 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
375 375  
376 -Метод запроса: PUT
539 +(% style="color:#000000" %)Метод запроса: **POST**
377 377  
378 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
541 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
379 379  
380 -В заголовках запроса: X-Auth: Токен авторизации
543 +(% style="color:#000000" %)В заголовках запроса:
381 381  
382 -Параметры в теле запроса (JSON):
545 +(% style="color:#000000" %)− Content-Type: __**application/json**__
383 383  
384 -//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
547 +(% style="color:#000000" %)− X-Auth: Токен авторизации
385 385  
386 -Ответ:
549 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
387 387  
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»: «» //Сколько раз выполнить задание } ] }
551 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
389 389  
390 - **Изменение статуса объекта**
553 +(% class="western" style="color:#000000" %)##{##
391 391  
392 -Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
555 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
556 + "name": null, ~/~/ Имя ТС (string, опционально) 
557 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
558 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
559 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
560 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
561 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
562 +(% style="color:#000000" %)}
393 393  
394 -Метод запроса: POST
564 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
395 395  
396 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
566 +(% style="color:#000000" %)Ответ:
397 397  
398 -Параметр запроса: {vehicleId} - ID ТС
568 +(% style="color:#000000" %){
399 399  
400 -В заголовках запроса: X-Auth: Токен авторизации
570 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
571 + "name": "" ~/~/ наименование объекта
572 + "imei": "" ~/~/ IMEI объекта
573 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
574 + "deviceTypeName": "" ~/~/ наименование типа устройства
575 + "sim1": "" ~/~/ первый номер телефона
576 + "sim2": "" ~/~/ второй номер телефона
577 + "parentId": "" ~/~/ идентификатор клиента-родителя
578 + "parentName": "" ~/~/ наименование клиента-родителя
579 + "modelId": "" ~/~/ идентификатор модели объекта
580 + "modelName": "" ~/~/ наименование модели объекта
581 + "unitId": "" ~/~/ идентификатор подразделения
582 + "unitName": "" ~/~/ наименование подразделения
583 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
584 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
585 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
586 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
587 +(% style="color:#000000" %)}
401 401  
402 -Параметры в теле запроса (JSON): {
589 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
403 403  
404 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
405 - "date": "", // Дата смены статуса (null если сменить немедленно)
406 - "description": "", // Описание
407 - "data": "", // Данные
408 - "overwrite": false, // Флаг перезаписи
409 - "stage": "", // Состояние, может быть null}}}
410 410  
411 -}
592 +(% class="box successmessage" %)
593 +(((
594 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
595 +)))
412 412  
413 -Ответ: {
597 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
414 414  
415 -{{{ "status": "", // значение статуса
416 - "date": "", // Дата смены статуса
417 - "description": "", // Описание
418 - "data": "", // Данные
419 - "overwrite": false, // Флаг перезаписи
420 - "stage": "", // Состояние}}}
599 +(% style="color:#000000" %)Метод запроса: **POST**
421 421  
422 -}
601 +(% 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}
423 423  
424 - **Проверка авторизации**
603 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
425 425  
426 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
605 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
427 427  
428 -Метод запроса: GET
607 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
429 429  
430 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
609 +(% style="color:#000000" %){
431 431  
432 -В заголовках запроса: X-Auth: Токен авторизации
611 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
612 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
613 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
614 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
615 + "description": "", ~/~/ Описание
616 + "data": "", ~/~/ Данные
617 + "overwrite": false, ~/~/ Флаг перезаписи
618 + "stage": "", ~/~/ Состояние, может быть null
433 433  
434 -Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «40
620 +(% style="color:#000000" %)}
435 435  
436 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
622 +(% style="color:#000000" %)Ответ:
623 +
624 +(% style="color:#000000" %){
625 +
626 + "status": "", ~/~/ значение статуса
627 + "date": "", ~/~/ Дата смены статуса 
628 + "description": "", ~/~/ Описание
629 + "data": "", ~/~/ Данные
630 + "overwrite": false, ~/~/ Флаг перезаписи
631 + "stage": "", ~/~/ Состояние
632 +
633 +(% style="text-align:left" %)
634 +(% style="color:#000000" %) }
635 +
636 +
637 +(% class="box warningmessage" %)
638 +(((
639 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
640 +)))
641 +
642 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
643 +
644 +(% style="color:#000000" %)Метод запроса: **PUT**
645 +
646 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
647 +
648 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
649 +
650 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
651 +
652 +(% style="color:#000000" %){    
653 +
654 +(((
655 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
656 + "parentId": "", ~/~/ ID клиента
657 + "name": "", ~/~/ имя ТС
658 + "imei": "", ~/~/ IMEI
659 + "deviceTypeId": "", ~/~/ ID типа устройства
660 + "modelId": "", ~/~/ , ID модели    
661 + "unitId": "", ~/~/ подразделения
662 + "sim1": "", ~/~/ SIM 1
663 + "sim2": "", ~/~/ SIM2 (%%)
664 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
665 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
666 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
667 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
668 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
669 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
670 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
671 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
672 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
673 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
674 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
675 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
676 +(% style="color:#000000" %) "counters": 
677 + {
678 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
679 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
680 + "mileage": «», пробег
681 + "motohours": «» моточасы
682 + }
683 + "cmsv6Parameters": ~/~/ параметры CMSv6
684 + {       
685 + "id": "", ~/~/ идентификатор
686 + "enabled": true, ~/~/ флаг включения
687 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
688 + "login": "", ~/~/ имя учетной записи
689 + "password": "", ~/~/ пароль учетной записи
690 + }
691 + "inspectionTasks": ~/~/ задания на ТО
692 + {
693 + "id": "", ~/~/ ID задания
694 + "enabled": false, ~/~/ Признак включения
695 + "name": "", ~/~/ Имя задания
696 + "description": "", ~/~/ Описание задания
697 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
698 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
699 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
700 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
701 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
702 + "kind": "", ~/~/ Вид периодичности по времени
703 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
704 + } 
705 +)))
706 +
707 +(% style="color:#000000" %)}
708 +
709 +(% style="color:#000000" %)Ответ:
710 +
711 +(% lang="en-US" style="text-align:left" %)
712 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
713 +
714 +(% lang="en-US" style="text-align:left" %)
715 + "vehicleId": "", ~/~/ ID ТС
716 + "parentId": "", ~/~/ ID клиента
717 + "name": "", ~/~/ имя ТС
718 + "imei": "", ~/~/ IMEI
719 + "deviceTypeId": "", ~/~/ типа устройства
720 + "modelId": "", ~/~/ ID модели
721 + "unitId": "", ~/~/ ID подразделения
722 + "sim1": "", ~/~/ SIM 1
723 + "sim2": "", ~/~/ SIM2
724 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
725 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
726 + "counters": 
727 + {
728 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
729 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
730 + "mileage": "", ~/~/ пробег
731 + "motohours": "", ~/~/ моточасы
732 + }
733 + "cmsv6Parameters": ~/~/ параметры CMSv6
734 + {
735 + "id": ~/~/ идентификатор
736 + "enabled": true, ~/~/ флаг включения
737 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
738 + "login": "", ~/~/ имя учетной записи
739 + "password": "", ~/~/ пароль учетной записи
740 + }
741 + "inspectionTasks": ~/~/ задания на ТО
742 + {
743 + "id": "", ~/~/ ID задания
744 + "enabled": false, ~/~/ Признак включения
745 + "name": "", ~/~/ Имя задания
746 + "description": "", ~/~/ Описание задания
747 + "mileageCondition": "", ~/~/ Условие по пробегу
748 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
749 + "motohoursCondition": "", ~/~/ Условие по моточасам
750 + "lastMotohours": "", ~/~/ Моточасы
751 + "periodicCondition": "", ~/~/ Условие периодичности по времени
752 + "kind": "", ~/~/ Вид периодичности по времени
753 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
754 + }
755 +
756 +(% lang="en-US" style="text-align:left" %)
757 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
758 +
759 +**валидация:**
760 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
761 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
762 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
763 +
764 +
765 +(% class="box errormessage" %)
766 +(((
767 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
768 +)))
769 +
770 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
771 +
772 +(% style="color:#000000" %)Метод запроса: **DELETE**
773 +
774 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
775 +
776 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
777 +
778 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
779 +
780 +(% style="text-align:left" %)
781 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
782 +
783 +
784 +(% class="box" lang="en-US" style="text-align: center;" %)
785 +(((
786 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
787 +)))
788 +
789 +(% class="box infomessage" %)
790 +(((
791 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
792 +)))
793 +
794 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
795 +
796 +(% style="color:#000000" %)Метод запроса: **GET**
797 +
798 +(% 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]]
799 +
800 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
801 +
802 +(% style="color:#000000" %)Ответ:
803 +
804 +(% style="color:#000000" %){
805 +
806 + "deviceTypeId" : "", ~/~/ ID типа устройства
807 + "deviceTypeName" : "" ~/~/ Название типа устройства
808 +
809 +(% style="text-align:left" %)
810 +(% style="color:#000000" %)}
811 +
812 +
813 +(% class="box" style="text-align: center;" %)
814 +(((
815 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
816 +)))
817 +
818 +(% class="box infomessage" %)
819 +(((
820 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
821 +)))
822 +
823 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
824 +
825 +(% style="color:#000000" %)Метод запроса: **GET**
826 +
827 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
828 +
829 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
830 +
831 +(% style="color:#000000" %)Ответ:
832 +
833 +(% style="color:#000000" %){
834 +
835 + "id": "", ~/~/ ID типа датчика 
836 + "name": "", ~/~/ Название
837 + "description": "", ~/~/ Описание
838 +
839 +(% style="text-align:left" %)
840 +(% style="color:#000000" %)}
841 +
842 +
843 +(% class="box" lang="en-US" style="text-align: center;" %)
844 +(((
845 +(% 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]] **
846 +)))

Меню

ГЛОНАССSoft wiki - 2024 г.