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

Summary

Details

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

Меню

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