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

Summary

Details

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

Меню

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