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

Summary

Details

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

Меню

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