Last modified by Андрей Калиновский on 2025/04/21 14:13
<
From version < 67.1 >
edited by Илья Крайнов
on 2022/11/24 13:52
To version < 2.1 >
edited by Андрей Калиновский
on 2022/07/21 16:33
>
Change comment: There is no comment for this version

Summary

Details

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

Меню

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