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

Меню

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