Last modified by Андрей Калиновский on 2025/04/21 14:13
<
From version < 101.1 >
edited by Илья Крайнов
on 2023/07/04 09:57
To version < 6.1 >
edited by Андрей Калиновский
on 2022/08/31 14:13
>
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,2523 +1,454 @@
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»: «», // имя пользователя }, … ]
26 +
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
28 + **Получение списка объектов**
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
30 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
32 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
37 37  
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}
34 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
42 42  
36 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
43 43  
44 -(% style="color:#000000" %)**Ответ:**
38 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
45 45  
46 -(% lang="en-US" %)
47 -(% style="color:#000000" %){
40 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
48 48  
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
42 +Метод запроса: POST
52 52  
53 -(% lang="en-US" %)
54 -}
44 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
55 55  
56 -**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
46 +В заголовках запроса:
57 57  
58 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
48 +−Content-Type: application/json
59 59  
60 -(% class="box infomessage" %)
61 -(((
62 -(% lang="en-US" %)**GET /api/v3/auth/check**
63 -)))
50 +−X-Auth: Токен авторизации
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
52 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
66 66  
67 -(% style="color:#000000" %)Метод запроса: **GET**
54 +{{{{"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]]
56 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
70 70  
71 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
58 +Ответ: [ { «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».**
60 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
75 75  
76 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
62 +0 - «Блокировка»
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
64 +1 - «Активен»,
79 79  
80 -(% class="box infomessage" %)
81 -(((
82 -**GET api/v3/agents/{id}**
83 -)))
66 +2 - «Отменен»
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
68 +3 - «Оборудован»
86 86  
87 -(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
70 +4 - «Диагностика»
88 88  
89 -(% style="color:#000000" %)Метод запроса: **GET**
72 +5 - «Сервис»
90 90  
91 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
74 +6 - «Демонтаж»
92 92  
93 -Запрос должен содержать данные параметра "**agentId**"
76 +7 - «Монтаж»
94 94  
95 -(% style="color:#000000" %)Ответ:
96 -А
97 -{
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
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 - }
78 +8 - «Дозаказ»
119 119  
120 -== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
80 +9 - «Обслужен»
121 121  
122 -(% class="box infomessage" %)
123 -(((
124 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
125 -)))
82 +10 - «Списан»
126 126  
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
84 +11 - «Неисправен»
128 128  
129 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
86 +12 - «Проверен»
130 130  
131 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
88 +13 - «Не эксплуатируется»
89 +
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
91 + **Получение списка клиентов.**
134 134  
135 -(% style="color:#000000" %)Метод запроса: **POST**
93 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
95 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
138 138  
139 -(% style="color:#000000" %)Параметр запроса:
97 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
99 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
144 144  
145 -(% style="color:#000000" %)Ответ:
101 +Метод запроса: 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 -}
103 +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" %)**Добавление клиента**(%%) ==
105 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
158 158  
159 -(% class="box successmessage" %)
160 -(((
161 -**POST /api/v3/agents **
162 -)))
163 -
164 -Метод позволяет добавить клиента, указанного в запросе.
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):
109 +Ответ: [ { «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 -}
111 +Примечание. Возможные значение параметра agentInfoType:
112 +
194 194  
114 + **Получение списка пользователей.**
195 195  
196 -Ответ:
116 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
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 -}
118 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
219 219  
220 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
120 +Метод запроса: POST
221 221  
222 -(% class="box warningmessage" %)
223 -(((
224 -**PUT /api/v3/agents**
225 -)))
122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
226 226  
227 -Метод позволяет отредактировать клиента, указанного в запросе.
124 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
228 228  
229 -Метод запроса: **PUT**
126 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
127 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
128 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
129 + //"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  
133 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
260 260  
261 -Ответ:
135 +{{{ "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 -}
137 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
138 +
283 283  
284 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
140 + **Получение списка типов устройств**
285 285  
286 -(% class="box errormessage" %)
287 -(((
288 -**DELETE /api/v3/agents/{clientId}**
289 -)))
142 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
290 290  
291 -Метод позволяет удалить клиента, указанного в строке запроса.
144 +Метод запроса: GET
292 292  
293 -Метод запроса: **DELETE**
146 +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}**
148 +В заголовках запроса:X-Auth: Токен авторизации
296 296  
297 -Параметр запроса: **{clientId}** - Guid пользователя
150 +Ответ: [
298 298  
299 -В заголовках запроса: X-Auth: Токен авторизации
152 +{{{ {
153 + "deviceTypeId" : "", // ID типа устройства
154 + "deviceTypeName" : "" // Название типа устройства
155 + },}}}
300 300  
301 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
157 +… ]
158 +
302 302  
303 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
160 + **Получение списка типов датчиков**
304 304  
305 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
162 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
306 306  
307 -(% class="box successmessage" %)
308 -(((
309 -(% lang="en-US" %)**POST /api/v3/users**
310 -)))
164 +Метод запроса: GET
311 311  
312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
166 +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**
168 +В заголовках запроса:X-Auth: Токен авторизации
315 315  
316 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
170 +Ответ: [
317 317  
318 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
172 +{{{ {}}}
319 319  
320 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
174 +«id»: «», //ID типа датчика «name»: «», //Название
321 321  
322 -(% style="color:#000000" %)
323 -{ 
324 - "lastName": "", ~/~/ фамилия
325 - "firstName": "", ~/~/ имя
326 - "position": "", ~/~/ должность
327 - "phone": "", ~/~/ телефон
328 - "organization": "", ~/~/ организация
329 - "login": "", ~/~/ логин (обязателен)
330 - "password": "", ~/~/ пароль (обязателен)
331 - "email": "", ~/~/ email (обязателен)
332 - "description": "string", ~/~/ Описание
333 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
336 - "parentId": "", ~/~/ Guid родительского агента
337 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
338 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
339 - "doubleAuth":
340 - {
341 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
342 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
343 - },
344 - "groups":
345 - [
346 - "string" ~/~/ группы пользователя, перечисление названия системных ролей
347 - ],
348 - "customGroups":
349 - [
350 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 - ],
352 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
353 -}
176 +{{{ "description": "" // Описание
177 + },}}}
354 354  
355 -{
356 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 - "lastName": "string",
358 - "firstName": "string",
359 - "position": "string",
360 - "phone": "string",
361 - "organization": "string",
362 - "login": "string",
363 - "password": "string",
364 - "email": "string",
179 +… ]
180 +
365 365  
182 + **Получение информации об объекте**
366 366  
367 -(% style="text-align:left" %)
368 -(% style="color:#000000; font-weight:normal" %)Ответ:
184 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
369 369  
370 -(% style="text-align:left" %)
371 -(% style="color:#000000; font-weight:normal" %){    
186 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
372 372  
373 -(% style="text-align:left" %)
374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
375 - "lastName": "" , ~/~/ Фамилия ,
376 - "firstName": "" , ~/~/ Имя
377 - "position": "" , ~/~/ Должность
378 - "phone": "" , ~/~/ Телефон
379 - "organization": "" , ~/~/ Организация
380 - "login": "" , ~/~/ Логин
381 - "password": "" , ~/~/ Пароль
382 - "email": "" , ~/~/ Email
383 - "description": "" , ~/~/ Описание
384 - "isEnabled": "" , ~/~/ Признак включения
385 - "parentId": "" , ~/~/ Guid родительского агента
386 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
387 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
388 - "kind": "" , ~/~/ тип аутентификации
389 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
390 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
188 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
391 391  
392 -(% style="text-align:left" %)
393 -(% style="color:#000000; font-weight:normal" %)}
190 +Метод запроса: GET
394 394  
395 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
192 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
396 396  
397 -(% class="box infomessage" %)
398 -(((
399 -(% lang="en-US" %)**POST /api/v3/users/find**
400 -)))
194 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
401 401  
402 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
196 +В заголовках запроса: X-Auth: Токен авторизации
403 403  
404 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
198 +Ответ:
405 405  
406 -(% style="color:#000000" %)Метод запроса: **POST**
407 -
408 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
409 -
410 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
411 -
412 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
413 -
414 -(% style="color:#000000" %){
415 -
416 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
417 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
418 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
419 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 -
421 -(% style="color:#000000" %)}
422 -
423 -(% style="color:#000000" %)Ответ:
424 -
425 -(% style="color:#000000" %){         (%%)
426 -
427 - "id": "" , ~/~/ идентификатор пользователя
428 - "lastName": "" , ~/~/ фамилия
429 - "firstName": "" , ~/~/ имя
430 - "position": "" , ~/~/ должность
431 - "phone": "" , ~/~/ телефон
432 - "parentId": "" , ~/~/ идентификатор клиента-родителя
433 - "parentName": "" , ~/~/ наименование клиента-родителя
434 - "organization": "" , ~/~/ организация
435 - "login": "" , ~/~/ логин
436 - "email": "" , ~/~/ E-mail
437 - "sessionDuration":"", ~/~/ длительность сессии в минутах
438 - "status": "1",  ~/~/ статус пользователя
439 - "lastLogged": "", ~/~/ дата/время последней авторизации
440 -
441 -(% style="color:#000000" %)}
442 -
443 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
444 -
445 -(% class="box infomessage" %)
446 -(((
447 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
448 -)))
449 -
450 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
451 -
452 -(% style="color:#000000" %)Метод запроса: **GET**
453 -
454 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
455 -
456 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
457 -
458 -(% style="color:#000000" %)Ответ:
459 -
460 -(((
461 -(((
462 462  {
463 - "id": "", ~/~/ GUID пользователя
464 - "lastName": "", ~/~/ Фамилия 
465 - "firstName": "", ~/~/ Имя
466 - "position": "", ~/~/ Должность
467 - "phone": "", ~/~/ Номер телефона
468 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
469 - "parentName": "", Наименование клиента, которому принадлежит пользователь
470 - "organization": "", ~/~/ Организация
471 - "login": "", ~/~/ Логин пользователя
472 - "email": "", ~/~/ Адрес электронной почты
473 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
474 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
475 - "description": "", ~/~/ Описание
476 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
477 - "doubleAuth":
478 - {
479 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 - },
482 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
483 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
484 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
485 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
486 - "groups": [], ~/~/ Список ролей пользователя
487 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
488 - "authDevices": [ ], ~/~/ Список авторизованных устройств
489 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
490 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
491 -}
492 -)))
493 -)))
494 494  
495 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
496 -
497 -(% class="box warningmessage" %)
498 -(((
499 -(% lang="en-US" %)**PUT /api/v3/users**
500 -)))
501 -
502 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
503 -
504 -(% style="color:#000000" %)Метод запроса: **PUT**
505 -
506 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
507 -
508 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
509 -
510 -(% lang="en-US" style="text-align:left" %)
511 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
512 -
513 -(% lang="en-US" style="text-align:left" %)
514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 -
516 -(% lang="en-US" style="text-align:left" %)
517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
518 - "lastName": "" , ~/~/ фамилия
519 - "firstName": "" , ~/~/ имя
520 - "position": "" , ~/~/ должность
521 - "phone": "" , ~/~/ телефон
522 - "organization": "" , ~/~/ организация
523 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
524 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
527 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
528 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
529 - "isEnabled": "" , ~/~/ признак включения
530 - "parentId": "" , ~/~/ Guid родительского агента
531 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
532 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
533 - "doubleAuth":
534 - {
535 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 - },
538 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 -
541 -(% lang="en-US" style="text-align:left" %)
542 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
543 -
544 -(% lang="en-US" style="text-align:left" %)
545 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
546 -
547 -(% lang="en-US" style="text-align:left" %)
548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 -
550 -(% lang="en-US" style="text-align:left" %)
551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
552 - "lastName": "" , ~/~/ фамилия
553 - "firstName": "" , ~/~/ имя
554 - "position": "" , ~/~/ должность
555 - "phone": "" , ~/~/ телефон
556 - "organization": "" , ~/~/ организация
557 - "login": "" , ~/~/ логин
558 - "password": "" , ~/~/ пароль 
559 - "email": "" , ~/~/ email
560 - "description": "" , ~/~/ описание
561 - "isEnabled": "" , ~/~/ признак включения
562 - "parentId": "" , ~/~/ Guid родительского агента
563 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
564 - "doubleAuth":
565 - {
566 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 - },
569 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
570 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
571 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
572 -
573 -(% lang="en-US" style="text-align:left" %)
574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 -
576 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
577 -
578 -(% class="box warningmessage" %)
579 -(((
580 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
581 -)))
582 -
583 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
584 -
585 -(% style="color:#000000" %)Метод запроса: **PUT**
586 -
587 -(% 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}
588 -
589 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
590 -
591 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
592 -
593 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
594 -
595 -(% style="color:#000000" %){
596 -
597 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 - "description": "" , ~/~/ описание
599 - "data": "" , ~/~/ данные, связанные со сменой статуса
600 -
601 -(% style="color:#000000" %)}
602 -
603 -(% style="text-align:left" %)
604 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
605 -
606 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
607 -
608 -(% class="box warningmessage" %)
609 -(((
610 -**POST /api/v3/users/disable**
611 -)))
612 -
613 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
614 -
615 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
616 -
617 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
618 -
619 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
620 -
621 - [ 
622 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 - ]
625 -
626 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
627 -
628 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
629 -
630 -(% class="box warningmessage" %)
631 -(((
632 -**POST /api/v3/users/enable**
633 -)))
634 -
635 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
636 -
637 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
638 -
639 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
640 -
641 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
642 -
643 - [ 
644 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
645 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
646 - ]
647 -
648 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
649 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
650 -
651 -(((
652 -В теле ответа:
653 -{
654 - "errorMessages": [
655 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
656 - ],
657 - "users": [
658 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
659 - ]
660 -}
661 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
662 -"users" - массив id пользователей, которых не удалось включить или отключить.
663 -)))
664 -
665 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 -
667 -(% class="box errormessage" %)
668 -(((
669 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
670 -)))
671 -
672 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
673 -
674 -(% style="color:#000000" %)Метод запроса: **DELETE**
675 -
676 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
677 -
678 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
679 -
680 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
681 -
682 -(% style="text-align:left" %)
683 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 -
685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 -
687 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
688 -
689 -(% class="box infomessage" %)
690 -(((
691 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
692 -)))
693 -
694 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
695 -
696 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
697 -
698 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
699 -
700 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
701 -
702 -(% style="color:#000000" %)Метод запроса: **GET**
703 -
704 -(% 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}
705 -
706 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
707 -
708 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 -
710 -(% style="color:#000000" %)Ответ:
711 -
712 -(((
713 -{
714 - "vehicleId": "", ~/~/ ID объекта
715 - "name": "", ~/~/ Имя объекта
716 - "imei": "", ~/~/ IMEI объекта
717 - "deviceTypeId": , ~/~/ ID типа устройства
718 - "deviceTypeName": "", ~/~/ Название типа устройства
719 - "sim1": "", ~/~/ Номер SIM1
720 - "sim2": "", ~/~/ Номер SIM2
721 -
722 - "parentId": "", ~/~/ ID клиента-родителя
723 - "parentName": "", ~/~/ Наименование клиента-родителя
724 - "modelId": "", ~/~/ ID модели объекта
725 - "modelName": "", ~/~/ Имя модели объекта
726 -
727 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 - "unitName": "string", ~/~/ Наименование подразделения
729 - "status": 0, ~/~/ Статус объекта
730 -
731 - "createdAt": "", ~/~/ Дата создания объекта
732 - },
733 -
734 -"customFields": [ ~/~/ Произвольные поля
735 - {
736 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
737 - "name": "string", ~/~/ Имя поля
738 - "value": "string", ~/~/ Значение поля
739 - "forClient": true, ~/~/ Не используемая функция
740 - "forTooltip": true, ~/~/ Отображать в подсказке
741 - "forReport": true ~/~/ Отображать в отчете
742 - }
743 -
744 -], ~/~/ Данные с вкладки нормы
745 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
746 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
747 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
748 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
749 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
750 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
751 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
752 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
753 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 -
758 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 - "mileageCoeff": 0, ~/~/ коэффициент пробега
760 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
761 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
762 - "counters": { ~/~/ Счетчики
763 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
764 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
765 - "mileage": 0, ~/~/ Текущий пробег
766 - "motohours": 0, ~/~/ Текущие моточасы
767 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
768 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
202 +{{{ "vehicleId": “”, // идентификатор объекта
203 + "name": "", // имя объекта
204 + "imei": "", // IMEI объекта
205 + "deviceTypeId": “”, // идентификатор устройства объекта
206 + "deviceTypeName": "" // наименование устройства объекта
207 + "parentId": "", // идентификатор клиента-родителя
208 + "parentName": "" // наименование клиента-родителя,
209 + "modelId": "", // идентификатор модели объекта
210 + "modelName": "" // наименование модели объекта,
211 + "unitId": "", // идентификатор подразделения
212 + "unitName": "", // наименование подразделения
213 + "status": “”, // статус объекта
214 + ...
769 769   },
216 + ...}}}
770 770  
771 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
772 - "id": "string", ~/~/ ID объекта
773 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
774 - "host": "string", ~/~/ CMSV6 Web Host
775 - "login": "string", ~/~/ CMSV6 Account
776 - "password": "string" ~/~/ CMSV6 Password
777 - },
778 -
779 -"commandTemplates": [ ~/~/ Шаблоны команд
780 - {
781 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 - "name": "string", ~/~/ Наименование команды
783 - "command": "string", ~/~/ Текст команды
784 - "retries": 0 ~/~/ Количество попыток
785 - }
786 - ],
787 -
788 - "sensors": [ ~/~/ Датчики
789 - {
790 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
792 - "type": 0, ~/~/ Тип датчика
793 - "name": "string", ~/~/ Имя датчика
794 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
795 - "inputNumber": 0, ~/~/ Номер входа
796 - "pseudonym": "string", ~/~/ Псевдоним
797 - "medianDegree": 0, ~/~/ Медианная фильтрация
798 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
801 - "gradesTables": [ ~/~/ Массив таблиц тарировки
802 - {
803 - "grades": [ ~/~/ Таблица тарировки 1
804 - {
805 - "input": 0, ~/~/ Входящее значение
806 - "output": 0 ~/~/ Выходящее значение
807 - }
808 - ],
809 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
810 - }
811 - ],
812 - "showInTooltip": true, ~/~/ Отображать в подсказке
813 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
814 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
817 - "expr": "string", ~/~/ Формула
818 - "children": [ ~/~/ массив дочерних датчиков
819 - "string"
820 - ],
821 - "customParams": { ~/~/ прочие произвольные параметры
822 - "additionalProp1": "string",
823 - "additionalProp2": "string",
824 - "additionalProp3": "string"
825 - },
826 -
827 -~/~/ Характерные для произвольного:
828 -
829 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 -
831 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 -
833 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 -
835 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 -
837 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 -
839 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 -
841 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 -
843 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 -
845 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 -
847 -~/~/ "ValueOn": "Вкл.",
848 -
849 -~/~/ "ValueOff": "Выкл."
850 - "summaryMaxValue": 0 ~/~/ Макс. значение
851 - }
852 -
853 - "drivers": [ ~/~/ Водители
854 - {
855 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
856 - "name": "string", ~/~/ Наименование
857 - "description": "string",
858 - "isDefault": true ~/~/ По умолчанию
859 - }
860 - ],
861 -
862 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
863 - {
864 - "id": "", ~/~/ ID  задания
865 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
866 - "name": "", ~/~/ Наименование задания
867 - "description": "", ~/~/ Описание задания
868 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
869 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
870 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
871 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
872 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
873 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
874 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
875 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
876 - }
877 - ],
878 -
879 - "statusHistory": [ ~/~/ История статусов
880 - {
881 - "status": 0,
882 - "date": "2023-05-22T09:57:39.562Z",
883 - "description": "string",
884 - "additionalInfo": "string"
885 - }
886 - ]
887 -
888 888  }
889 -)))
890 890  
891 -(% style="text-align:left" %)
892 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
893 893  
894 -(% style="text-align:left" %)
895 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
223 + **Добавление пользователя**
896 896  
897 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
898 898  
899 -(% class="box successmessage" %)
900 -(((
901 -(% lang="en-US" %)**POST /api/v3/vehicles**
902 -)))
227 +Метод запроса: POST
903 903  
904 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
905 905  
906 -(% style="color:#000000" %)Метод запроса: **POST**
231 +В заголовках запроса: X-Auth: Токен авторизации
907 907  
908 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
233 +Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
909 909  
910 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
236 +
911 911  
912 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
238 + **Редактирование пользователя**
913 913  
914 -(% style="color:#000000" %){
240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
915 915  
916 - "parentId": "" , ~/~/ ID клиента
917 - "name": "" , ~/~/ имя ТС
918 - "imei": "" , ~/~/ IMEI
919 - "deviceTypeId": "" , ~/~/ ID типа устройства
920 - "modelId": "" , ~/~/ ID модели
921 - "unitId": "" , ~/~/ ID подразделения
922 - "sim1": "" , ~/~/ Номер SIM 1
923 - "sim2": "" , ~/~/ Номер SIM2
924 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
925 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
926 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
927 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
928 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
929 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
930 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
931 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
932 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
933 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
934 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
935 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
242 +Метод запроса: PUT
936 936  
937 - "mileageCalcMethod": 0,
938 - "mileageCoeff": 0,
939 - "locationByCellId": true,
940 - "dottedLineTrackWhenNoCoords": true,
941 - "counters": ~/~/ счетчики
942 - {
943 - "mileage": "" , ~/~/ пробег
944 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
945 - "motohours": "" , ~/~/ моточасы
946 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
947 - },
948 - "cmsv6Parameters": { ~/~/ параметры CMSv6
949 - "enabled": true, ~/~/ флаг включения
950 - "id": "" , ~/~/ идентификатор
951 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
952 - "login": "" , ~/~/ имя учетной записи
953 - "password": "" ~/~/ пароль учетной записи
954 - },
955 - "inspectionTasks": ~/~/ задания на ТО
956 - {
957 - "enabled": "" , ~/~/ Признак включения
958 - "name": "" , ~/~/ Имя задания
959 - "description": "" , ~/~/ Описание задания
960 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
961 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
962 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
963 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
964 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
965 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
966 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
967 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
968 - }
244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
969 969  
970 -"drivers": [ ~/~/ Водители
971 - {
972 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
973 - "isDefault": true
974 - }
975 - ],
976 - "commandTemplates": [ ~/~/ Шаблон команды
977 - {
978 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
979 - "name": "string",
980 - "command": "string",
981 - "retries": 0
982 - }
983 - ],
246 +В заголовках запроса: X-Auth: Токен авторизации
984 984  
985 - "sensors": [ ~/~/ Датчики
986 - {
987 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
988 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
989 - "type": 0, ~/~/ Тип датчика
990 - "name": "string", ~/~/ Имя датчика
991 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
992 - "inputNumber": 0, ~/~/ Номер входа
993 - "pseudonym": "string", ~/~/ Псевдоним
994 - "medianDegree": 0, ~/~/ Медианная фильтрация
995 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
996 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
997 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
998 - "gradesTables": [ ~/~/ Массив таблиц тарировки
999 - {
1000 - "grades": [ ~/~/ Таблица тарировки 1
1001 - {
1002 - "input": 0, ~/~/ Входящее значение
1003 - "output": 0 ~/~/ Выходящее значение
1004 - }
1005 - ],
1006 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1007 - }
1008 - ],
1009 - "showInTooltip": true, ~/~/ Отображать в подсказке
1010 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1011 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1012 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1013 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1014 - "expr": "string", ~/~/ Формула
1015 - "children": [ ~/~/ массив дочерних датчиков
1016 - "string"
1017 - ],
1018 - "customParams": { ~/~/ прочие произвольные параметры
1019 - "additionalProp1": "string",
1020 - "additionalProp2": "string",
1021 - "additionalProp3": "string"
1022 - },
248 +Параметры в теле запроса (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 - блокирован)
1023 1023  
1024 -~/~/ Характерные для произвольного:
250 +{{{ "description": "", // описание
251 + "data": "" // данные, связанные со сменой статуса}}}
1025 1025  
1026 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 -
1028 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 -
1030 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 -
1032 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 -
1034 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 -
1036 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 -
1038 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 -
1040 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 -
1042 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 -
1044 -~/~/ "ValueOn": "Вкл.",
1045 -
1046 -~/~/ "ValueOff": "Выкл."
1047 - "summaryMaxValue": 0 ~/~/ Макс. значение
1048 - }
1049 - ],
1050 - "customFields": [ ~/~/ Произвольные поля
1051 - {
1052 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1053 - "name": "string",
1054 - "value": "string",
1055 - "forClient": true,
1056 - "forTooltip": true,
1057 - "forReport": true
1058 - }
1059 - ]
1060 1060  }
1061 1061  
1062 -(% style="color:#000000" %)Ответ:
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
1063 1063  
1064 -(% style="color:#000000" %){
258 + **Удаление пользователя**
1065 1065  
1066 - "vehicleId": "", ~/~/ID ТС 
1067 - "parentId": "", ~/~/Guid владельца ТС
1068 - "name": "", ~/~/Имя объекта
1069 - "imei": "", ~/~/IMEI
1070 - "deviceTypeId": "", ~/~/ID типа устройства
1071 - "modelId": "", ~/~/ID модели
1072 - "unitId": "", ~/~/ID подразделения
1073 - "sim1": "", ~/~/SIM1
1074 - "sim2": "", ~/~/SIM2
1075 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1076 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1077 - "counters": { ~/~/Счётчики
1078 - "mileageEnabled": true,
1079 - "motohoursEnabled": true,
1080 - "mileage": "",
1081 - "motohours": 345.0
1082 - },
1083 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1084 - "id": null,
1085 - "enabled": true, ~/~/флаг включения
1086 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1087 - "login": "", ~/~/ имя учетной записи
1088 - "password": "" ~/~/ пароль учетной записи
1089 - },
1090 - "inspectionTasks": { ~/~/ задания на ТО
1091 - "id": "", ~/~/ ID задачи
1092 - "enabled": false, ~/~/ Признак включения
1093 - "name": "", ~/~/ Имя задания
1094 - "description": "", ~/~/ Описание задания
1095 - "mileageCondition": "", ~/~/ Условие по пробегу
1096 - "lastMileage": "", ~/~/ Пробег (в метрах)
1097 - "motohoursCondition": "", ~/~/ Условие по моточасам
1098 - "lastMotohours": "", ~/~/ Моточасы
1099 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1100 - "kind": "", ~/~/ Вид периодичности по времени 
1101 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1102 - }
260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1103 1103  
1104 -(% style="text-align:left" %)
1105 -(% style="color:#000000" %)}
262 +Метод запроса: DELETE
1106 1106  
1107 -**Валидация:**
1108 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1109 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1110 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
264 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
1111 1111  
1112 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
1113 1113  
1114 -(% class="box infomessage" %)
1115 -(((
1116 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 -)))
268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
271 + **Добавление объекта**
1120 1120  
1121 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
1122 1122  
1123 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
275 +Метод запроса: POST
1124 1124  
1125 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1126 1126  
1127 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
279 +В заголовках запроса: X-Auth: Токен авторизации
1128 1128  
1129 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1130 1130  
1131 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1132 -
1133 -(% style="color:#000000" %)Метод запроса: **POST**
1134 -
1135 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1136 -
1137 -(% style="color:#000000" %)В заголовках запроса:
1138 -
1139 -(% style="color:#000000" %)− Content-Type: __**application/json**__
1140 -
1141 -(% style="color:#000000" %)− X-Auth: Токен авторизации
1142 -
1143 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1144 -
1145 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1146 -
1147 -{
1148 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1149 - "name": null, ~/~/ Имя ТС (string, опционально)
1150 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1151 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1152 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1153 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1154 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1155 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1156 -}
1157 -
1158 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1159 -
1160 -(% style="color:#000000" %)Ответ:
1161 -
1162 -(% style="color:#000000" %){
1163 -
1164 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1165 - "name": "" ~/~/ наименование объекта
1166 - "imei": "" ~/~/ IMEI объекта
1167 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1168 - "deviceTypeName": "" ~/~/ наименование типа устройства
1169 - "sim1": "" ~/~/ первый номер телефона
1170 - "sim2": "" ~/~/ второй номер телефона
1171 - "parentId": "" ~/~/ идентификатор клиента-родителя
1172 - "parentName": "" ~/~/ наименование клиента-родителя
1173 - "modelId": "" ~/~/ идентификатор модели объекта
1174 - "modelName": "" ~/~/ наименование модели объекта
1175 - "unitId": "" ~/~/ идентификатор подразделения
1176 - "unitName": "" ~/~/ наименование подразделения
1177 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1178 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1179 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1180 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1181 - "customFields": [ 
1182 - {
1183 - "id": "", ~/~/ идентификатор произвольного поля
1184 - "name": "", ~/~/ имя произвольного поля
1185 - "value": "", ~/~/ значение произвольного поля
1186 - "forClient": true, ~/~/ право на отображение у клиента
1187 - "forTooltip": false, ~/~/ право на отображение в подсказке
1188 - "forReport": false ~/~/ право на отображение в отчетах
1189 - }(%%)
1190 -(% style="color:#000000" %)}
1191 -
1192 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1193 -
1194 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1195 -
1196 -(% class="box successmessage" %)
1197 -(((
1198 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1199 -)))
1200 -
1201 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1202 -
1203 -(% style="color:#000000" %)Метод запроса: **POST**
1204 -
1205 -(% 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}
1206 -
1207 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1208 -
1209 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1210 -
1211 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1212 -
1213 -(% style="color:#000000" %){
1214 -
1215 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1216 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1217 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1218 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1219 - "description": "", ~/~/ Описание
1220 - "data": "", ~/~/ Данные
1221 - "overwrite": false, ~/~/ Флаг перезаписи
1222 - "stage": "", ~/~/ Состояние, может быть null
1223 -
1224 -(% style="color:#000000" %)}
1225 -
1226 -(% style="color:#000000" %)Ответ:
1227 -
1228 -(% style="color:#000000" %){
1229 -
1230 - "status": "", ~/~/ значение статуса
1231 - "date": "", ~/~/ Дата смены статуса 
1232 - "description": "", ~/~/ Описание
1233 - "data": "", ~/~/ Данные
1234 - "overwrite": false, ~/~/ Флаг перезаписи
1235 - "stage": "", ~/~/ Состояние
1236 -
1237 -(% style="text-align:left" %)
1238 -(% style="color:#000000" %) }
1239 -
1240 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1241 -
1242 -(% class="box warningmessage" %)
1243 -(((
1244 -(% lang="en-US" %)**PUT /api/v3/vehicles**
1245 -)))
1246 -
1247 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1248 -
1249 -(% style="color:#000000" %)Метод запроса: **PUT**
1250 -
1251 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1252 -
1253 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1254 -
1255 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1256 -
1257 -(% style="color:#000000" %){
1258 -
1259 - "parentId": "" , ~/~/ ID клиента
1260 - "name": "" , ~/~/ имя ТС
1261 - "imei": "" , ~/~/ IMEI
1262 - "deviceTypeId": "" , ~/~/ ID типа устройства
1263 - "modelId": "" , ~/~/ ID модели
1264 - "unitId": "" , ~/~/ ID подразделения
1265 - "sim1": "" , ~/~/ Номер SIM 1
1266 - "sim2": "" , ~/~/ Номер SIM2
1267 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1268 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1269 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1270 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1271 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1272 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1273 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1274 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1275 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1276 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1277 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1278 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1279 -
1280 - "mileageCalcMethod": 0,
1281 - "mileageCoeff": 0,
1282 - "locationByCellId": true,
1283 - "dottedLineTrackWhenNoCoords": true,
1284 - "counters": ~/~/ счетчики
1285 - {
1286 - "mileage": "" , ~/~/ пробег
1287 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1288 - "motohours": "" , ~/~/ моточасы
1289 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
283 +{{{ "parentId": "", // ID клиента
284 + "name": "", // имя ТС
285 + "imei": "", // IMEI
286 + "deviceTypeId": "",// ID типа устройства
287 + "modelId": "",
288 + "unitId": "", // ID подразделения
289 + "sim1": "", // Номер SIM 1
290 + "sim2": "", // Номер SIM2
291 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
292 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
293 + "consumptionIdle": "",// Расход топлива на холостом ходу
294 + "counters": {
295 + "mileage": "", // пробег
296 + "mileageEnabled": true, // флаг активности счётчика "пробег"
297 + "motohours":"", // моточасы
298 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
299 + },
300 + "cmsv6Parameters": { // параметры CMSv6
301 + "enabled": true, // флаг включения
302 + //"id": "", // идентификатор
303 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
304 + "login": "", // имя учетной записи
305 + "password": "" // пароль учетной записи
1290 1290   },
1291 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1292 - "enabled": true, ~/~/ флаг включения
1293 - "id": "" , ~/~/ идентификатор
1294 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1295 - "login": "" , ~/~/ имя учетной записи
1296 - "password": "" ~/~/ пароль учетной записи
1297 - },
1298 - "inspectionTasks": ~/~/ задания на ТО
307 + "inspectionTasks": [ // задания на ТО
1299 1299   {
1300 - "enabled": "" , ~/~/ Признак включения
1301 - "name": "" , ~/~/ Имя задания
1302 - "description": "" , ~/~/ Описание задания
1303 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1304 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1305 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1306 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1307 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1308 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1309 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1310 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1311 - }
1312 -
1313 -"drivers": [ ~/~/ Водители
1314 - {
1315 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1316 - "isDefault": true
1317 - }
1318 - ],
1319 - "commandTemplates": [ ~/~/ Шаблон команды
1320 - {
1321 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1322 - "name": "string",
1323 - "command": "string",
1324 - "retries": 0
1325 - }
1326 - ],
1327 -
1328 - "sensors": [ ~/~/ Датчики
1329 - {
1330 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1331 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1332 - "type": 0, ~/~/ Тип датчика
1333 - "name": "string", ~/~/ Имя датчика
1334 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1335 - "inputNumber": 0, ~/~/ Номер входа
1336 - "pseudonym": "string", ~/~/ Псевдоним
1337 - "medianDegree": 0, ~/~/ Медианная фильтрация
1338 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1339 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1340 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1341 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1342 - {
1343 - "grades": [ ~/~/ Таблица тарировки 1
1344 - {
1345 - "input": 0, ~/~/ Входящее значение
1346 - "output": 0 ~/~/ Выходящее значение
1347 - }
1348 - ],
1349 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1350 - }
1351 - ],
1352 - "showInTooltip": true, ~/~/ Отображать в подсказке
1353 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1354 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1355 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1356 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1357 - "expr": "string", ~/~/ Формула
1358 - "children": [ ~/~/ массив дочерних датчиков
1359 - "string"
1360 - ],
1361 - "customParams": { ~/~/ прочие произвольные параметры
1362 - "additionalProp1": "string",
1363 - "additionalProp2": "string",
1364 - "additionalProp3": "string"
309 + "enabled": "", // Признак включения
310 + "name": "", // Имя задания
311 + "description": "", // Описание задания
312 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
313 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
314 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
315 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
316 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
317 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
318 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
319 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1365 1365   },
321 + ]}}}
1366 1366  
1367 -~/~/ Характерные для произвольного:
323 +… }
1368 1368  
1369 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1370 -
1371 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1372 -
1373 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1374 -
1375 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1376 -
1377 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1378 -
1379 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1380 -
1381 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 -
1383 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1384 -
1385 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1386 -
1387 -~/~/ "ValueOn": "Вкл.",
1388 -
1389 -~/~/ "ValueOff": "Выкл."
1390 - "summaryMaxValue": 0 ~/~/ Макс. значение
1391 - }
1392 - ],
1393 - "customFields": [ ~/~/ Произвольные поля
1394 - {
1395 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1396 - "name": "string",
1397 - "value": "string",
1398 - "forClient": true,
1399 - "forTooltip": true,
1400 - "forReport": true
1401 - }
1402 - ]
1403 -}
1404 -
1405 -(% style="color:#000000" %)Ответ:
1406 -
1407 -(% lang="en-US" style="text-align:left" %)
1408 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1409 -
1410 -(% lang="en-US" style="text-align:left" %)
1411 - "vehicleId": "", ~/~/ ID ТС
1412 - "parentId": "", ~/~/ ID клиента
1413 - "name": "", ~/~/ имя ТС
1414 - "imei": "", ~/~/ IMEI
1415 - "deviceTypeId": "", ~/~/ типа устройства
1416 - "modelId": "", ~/~/ ID модели
1417 - "unitId": "", ~/~/ ID подразделения
1418 - "sim1": "", ~/~/ SIM 1
1419 - "sim2": "", ~/~/ SIM2
1420 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1421 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1422 - "counters": 
1423 - {
1424 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1425 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1426 - "mileage": "", ~/~/ пробег
1427 - "motohours": "", ~/~/ моточасы
1428 - }
1429 - "cmsv6Parameters": ~/~/ параметры CMSv6
1430 - {
1431 - "id": ~/~/ идентификатор
1432 - "enabled": true, ~/~/ флаг включения
1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1434 - "login": "", ~/~/ имя учетной записи
1435 - "password": "", ~/~/ пароль учетной записи
1436 - }
1437 - "inspectionTasks": ~/~/ задания на ТО
1438 - {
1439 - "id": "", ~/~/ ID задания
1440 - "enabled": false, ~/~/ Признак включения
1441 - "name": "", ~/~/ Имя задания
1442 - "description": "", ~/~/ Описание задания
1443 - "mileageCondition": "", ~/~/ Условие по пробегу
1444 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1445 - "motohoursCondition": "", ~/~/ Условие по моточасам
1446 - "lastMotohours": "", ~/~/ Моточасы
1447 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1448 - "kind": "", ~/~/ Вид периодичности по времени
1449 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1450 - }
1451 -
1452 -(% lang="en-US" style="text-align:left" %)
1453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1454 -
1455 -**Валидация:**
1456 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1457 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1458 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1459 -
1460 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1461 -
1462 -(% class="box errormessage" %)
1463 -(((
1464 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1465 -)))
1466 -
1467 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1468 -
1469 -(% style="color:#000000" %)Метод запроса: **DELETE**
1470 -
1471 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1472 -
1473 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1474 -
1475 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1476 -
1477 -(% style="text-align:left" %)
1478 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1479 -
1480 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1481 -
1482 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1483 -
1484 -(% class="box infomessage" %)
1485 -(((
1486 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1487 -)))
1488 -
1489 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1490 -
1491 -(% style="color:#000000" %)Метод запроса: **GET**
1492 -
1493 -(% 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]]
1494 -
1495 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 -
1497 -(% style="color:#000000" %)Ответ:
1498 -
1499 -(% style="color:#000000" %){
1500 -
1501 - "deviceTypeId" : "", ~/~/ ID типа устройства
1502 - "deviceTypeName" : "" ~/~/ Название типа устройства
1503 -
1504 -(% style="text-align:left" %)
1505 -(% style="color:#000000" %)}
1506 -
1507 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1508 -
1509 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1510 -
1511 -(% class="box infomessage" %)
1512 -(((
1513 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1514 -)))
1515 -
1516 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1517 -
1518 -(% style="color:#000000" %)Метод запроса: **GET**
1519 -
1520 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1521 -
1522 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1523 -
1524 -(% style="color:#000000" %)Ответ:
1525 -
1526 -(% style="color:#000000" %){
1527 -
1528 - "id": "", ~/~/ ID типа датчика 
1529 - "name": "", ~/~/ Название
1530 - "description": "", ~/~/ Описание
1531 -
1532 -(% style="text-align:left" %)
1533 -(% style="color:#000000" %)}
1534 -
1535 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1536 -
1537 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1538 -
1539 -(% class="box infomessage" style="text-align: left;" %)
1540 -(((
1541 -**POST /api/v3/terminalMessages/count**
1542 -)))
1543 -
1544 -(% style="text-align: left;" %)
1545 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1546 -
1547 -(% style="text-align: left;" %)
1548 -Метод запроса **POST**
1549 -
1550 -(% style="text-align: left;" %)
1551 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1552 -
1553 -(% style="text-align: left;" %)
1554 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1555 -
1556 -(% style="text-align: left;" %)
1557 -{
1558 - "vehicleIds": [
1559 - id ~/~/ здесь передается список идентификаторов объектов
1560 - ],
1561 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1562 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1563 -}
1564 -
1565 -(% style="text-align: left;" %)
1566 1566  Ответ:
1567 1567  
1568 -(% style="text-align: left;" %)
1569 -[
1570 - {
1571 - "vehicleId": 0, ~/~/ идентификатор объекта
1572 - "count": 0 ~/~/ количество сообщений за период
1573 - }
1574 -]
1575 -
1576 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 -
1578 -(% class="box infomessage" %)
1579 -(((
1580 -**POST /api/v3/terminalMessages**
1581 -)))
1582 -
1583 -Метод возвращает список сообщений терминала объекта за выбранный период.
1584 -
1585 -(% style="text-align: left;" %)
1586 -Метод запроса **POST**
1587 -
1588 -(% style="text-align: left;" %)
1589 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1590 -
1591 -(% style="text-align: left;" %)
1592 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1593 -
1594 1594  {
1595 - "vehicleId": 0, ~/~/ id объекта
1596 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1597 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 -}
1599 1599  
1600 -Ответ:
1601 -
1602 -[
1603 - {
1604 - "messages": [
329 +{{{ "vehicleId": "", //ID ТС
330 + "parentId": "", //Guid владельца ТС
331 + "name": "", //Имя объекта
332 + "imei": "", //IMEI
333 + "deviceTypeId": "", //ID типа устройства
334 + "modelId": "", //ID модели
335 + "unitId": "", //ID подразделения
336 + "sim1": "", //SIM1
337 + "sim2": "", //SIM2
338 + "consumptionPer100Km": "", //Расход топлива на 100 км
339 + "consumptionIdle": "", //Расход топлива на холостом ходу
340 + "counters": { //Счётчики
341 + "mileageEnabled": true,
342 + "motohoursEnabled": true,
343 + "mileage": "",
344 + "motohours": 345.0
345 + },
346 + "cmsv6Parameters": { //Параметры CmsV6
347 + "id": null,
348 + "enabled": true, //флаг включения
349 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
350 + "login": "", // имя учетной записи
351 + "password": "" // пароль учетной записи
352 + },
353 + "inspectionTasks": [ // задания на ТО
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1615 - "additionalProp1": "string",
1616 - "additionalProp2": "string",
1617 - "additionalProp3": "string"
1618 - },
1619 - "photoCount": 0 ~/~/ Кол-во фото
355 + "id": "", // ID задачи
356 + "enabled": false, // Признак включения
357 + "name": "", // Имя задания
358 + "description": "", // Описание задания
359 + "mileageCondition": "", // Условие по пробегу
360 + "lastMileage": "", // Пробег (в метрах)
361 + "motohoursCondition": "", // Условие по моточасам
362 + "lastMotohours": "", // Моточасы
363 + "periodicCondition": "", // Условие периодичности по времени}}}
364 +
365 +{{{ "kind": "", // Вид периодичности по времени
366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1620 1620   }
1621 - ]
1622 - }
1623 -]
368 + ]}}}
1624 1624  
1625 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1626 -
1627 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1628 -
1629 -(% class="box infomessage" %)
1630 -(((
1631 -**POST /api/v3/notifications/find**
1632 -)))
1633 -
1634 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1635 -
1636 -(% style="text-align: left;" %)
1637 -Метод запроса **POST**
1638 -
1639 -(% style="text-align: left;" %)
1640 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1641 -
1642 -(% style="text-align: left;" %)
1643 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1644 -
1645 -{
1646 - "parentId": "" ~/~/ id клиента
1647 1647  }
371 +
1648 1648  
1649 -Ответ:
373 + **Удаление объекта**
1650 1650  
1651 -[
1652 - {
1653 - "id": 0, ~/~/ ID уведомления
1654 - "name": "string", ~/~/ Название уведомления
1655 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1656 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1657 - "userId": "", ~/~/ Пользователь, создавший уведомление
1658 - "parentId": "", ~/~/ Идентификатор клиента
1659 - "parentName": "string" ~/~/ Имя клиента
1660 - }
1661 -]
375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1662 1662  
1663 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
377 +Метод запроса: DELETE
1664 1664  
1665 -(% class="box infomessage" %)
1666 -(((
1667 -**GET /api/v3/notifications/{id}**
1668 -)))
379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
1669 1669  
1670 -Метод возвращает данные правил формирования выбранного уведомления.
381 +Параметр запроса: {id} - Guid объекта
1671 1671  
1672 -(% style="text-align: left;" %)
1673 -Метод запроса **GET**
1674 -
1675 -(% style="text-align: left;" %)
1676 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1677 -
1678 -(% style="text-align: left;" %)
1679 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1680 -
1681 -(% style="text-align: left;" %)
1682 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1683 -
1684 -(% style="text-align: left;" %)
1685 -(% style="color:#000000" %)Ответ:
1686 -
1687 -(% style="text-align: left;" %)
1688 -(% style="color:#000000" %){
1689 - "id": 0, ~/~/ (%%)id уведомления
1690 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1691 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1692 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1693 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1694 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1695 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1696 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1697 -(% style="color:#000000" %) 0
1698 - ],
1699 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1700 -(% style="color:#000000" %) 0
1701 - ],
1702 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
1703 -(% style="color:#000000" %) 0
1704 - ],
1705 - "settings": { ~/~/ Список параметров уведомления
1706 - "additionalProp1": "string",
1707 - "additionalProp2": "string",
1708 - "additionalProp3": "string"
1709 - },
1710 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1711 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1712 -(% style="color:#000000" %) ""
1713 - ],
1714 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1715 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1716 -(% style="color:#000000" %) "string"
1717 - ],
1718 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1719 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1720 -(% style="color:#000000" %) {
1721 - "id": 0, ~/~/ (%%)Идентификатор участника чата
1722 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1723 -(% style="color:#000000" %) }
1724 - ],
1725 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1726 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1727 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1728 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1729 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1730 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1731 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1732 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1733 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1734 -(% style="color:#000000" %)}
1735 -
1736 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1737 -
1738 -(% class="box warningmessage" %)
1739 -(((
1740 -**PUT /api/v3/notifications/**
1741 -)))
1742 -
1743 -Метод позволяет отредактировать уведомление.
1744 -
1745 -Метод запроса **PUT**
1746 -
1747 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1748 -
1749 1749  В заголовках запроса: X-Auth: Токен авторизации
1750 1750  
1751 -Тело запроса:
1752 -{
1753 - "id": 0, ~/~/ id уведомления
1754 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1755 - "userId": "", ~/~/ Пользователь, создавший уведомление
1756 - "parentId": "", ~/~/ Идентификатор клиента
1757 - "parentName": "string", ~/~/ Имя клиента
1758 - "name": "string", ~/~/ Название уведомления
1759 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1760 - "vehicleIds": [ ~/~/ Список id объектов для анализа
1761 - 0
1762 - ],
1763 - "geoids": [ ~/~/ Список id геообъектов для анализа
1764 - 0
1765 - ],
1766 - "fieldids": [ ~/~/ Список id полей для анализа
1767 - 0
1768 - ],
1769 - "settings": { ~/~/ Список параметров уведомления
1770 - "additionalProp1": "string",
1771 - "additionalProp2": "string",
1772 - "additionalProp3": "string"
1773 - },
1774 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1775 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1776 - ""
1777 - ],
1778 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1779 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1780 - "string"
1781 - ],
1782 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1783 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1784 - {
1785 - "id": 0, ~/~/ Идентификатор участника чата
1786 - "info": "string" ~/~/ Дополнительные сведения
1787 - }
1788 - ],
1789 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1790 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1791 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1792 - "kind": 0, ~/~/ Определяет вид уведомления
1793 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1794 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1795 - "timezone": 0, ~/~/ Сдвиг часового пояса
1796 - "validity": 0, ~/~/ Срок действия в днях (1-90)
1797 - "autoProlongation": true ~/~/ Автопродление срока действия
1798 -}
385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
386 +
1799 1799  
1800 -Ответ:
388 + **Редактирование объекта**
1801 1801  
1802 -Success
390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1803 1803  
1804 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
392 +Метод запроса: PUT
1805 1805  
1806 -(% class="box errormessage" %)
1807 -(((
1808 -**DELETE /api/v3/notifications/{id}**
1809 -)))
394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1810 1810  
1811 -Метод позволяет удалить выбранное уведомление.
1812 -
1813 -Метод запроса **DELETE**
1814 -
1815 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1816 -
1817 -Передаваемый параметр: {id} - id уведомления
1818 -
1819 1819  В заголовках запроса: X-Auth: Токен авторизации
1820 1820  
1821 -Ответ:
398 +Параметры в теле запроса (JSON):
1822 1822  
1823 -Success
400 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
1824 1824  
1825 -
1826 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
1827 -
1828 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
1829 -
1830 -(% class="box infomessage" %)
1831 -(((
1832 -**POST /api/v3/Drivers/find**
1833 -)))
1834 -
1835 -Передается параметр: parentId - ID клиента-родителя
1836 -
1837 1837  Ответ:
1838 1838  
1839 -[
1840 - {
1841 - "name": "string", ~/~/ Определяет наименование
1842 - "description": "string", ~/~/ Определяет описание
1843 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
1844 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
1845 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
1846 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
1847 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
1848 - "deleted": true ~/~/ Признак удаления
1849 - }
1850 -]
404 +{ «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»: «» //Сколько раз выполнить задание } ] }
405 +
1851 1851  
1852 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
407 + **Изменение статуса объекта**
1853 1853  
1854 -(% class="box infomessage" %)
1855 -(((
1856 -**GET /api/v3/Drivers/{driverGuid}**
1857 -)))
409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1858 1858  
1859 -Передается параметр: ID водителя
411 +Метод запроса: POST
1860 1860  
1861 -Ответ:
413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
1862 1862  
1863 -{
1864 - "name": "string", ~/~/ Определяет наименование
1865 - "description": "string", ~/~/ Определяет описание
1866 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
1867 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
1868 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
1869 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
1870 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
1871 - "deleted": true ~/~/ Признак удаления
1872 -}
415 +Параметр запроса: {vehicleId} - ID ТС
1873 1873  
1874 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
417 +В заголовках запроса: X-Auth: Токен авторизации
1875 1875  
1876 -(% class="box successmessage" %)
1877 -(((
1878 -**POST /api/v3/Drivers**
1879 -)))
419 +Параметры в теле запроса (JSON): {
1880 1880  
1881 -Запрос:
421 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
422 + "date": "", // Дата смены статуса (null если сменить немедленно)
423 + "description": "", // Описание
424 + "data": "", // Данные
425 + "overwrite": false, // Флаг перезаписи
426 + "stage": "", // Состояние, может быть null}}}
1882 1882  
1883 -{
1884 - "name": "string",
1885 - "description": "string",
1886 - "hiredate": "2023-06-30T12:50:54.020Z",
1887 - "chopdate": "2023-06-30T12:50:54.020Z",
1888 - "exclusive": true,
1889 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1890 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1891 - "deleted": true
1892 1892  }
1893 1893  
1894 -Ответ:
430 +Ответ: {
1895 1895  
1896 -{
1897 - "name": "string",
1898 - "description": "string",
1899 - "hiredate": "2023-06-30T12:50:54.051Z",
1900 - "chopdate": "2023-06-30T12:50:54.051Z",
1901 - "exclusive": true,
1902 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1903 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1904 - "deleted": true
1905 -}
432 +{{{ "status": "", // значение статуса
433 + "date": "", // Дата смены статуса
434 + "description": "", // Описание
435 + "data": "", // Данные
436 + "overwrite": false, // Флаг перезаписи
437 + "stage": "", // Состояние}}}
1906 1906  
1907 -
1908 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
1909 -
1910 -(% class="box warningmessage" %)
1911 -(((
1912 -**PUT /api/v3/Drivers**
1913 -)))
1914 -
1915 -Запрос:
1916 -
1917 -{
1918 - "name": "string",
1919 - "description": "string",
1920 - "hiredate": "2023-06-30T12:50:27.910Z",
1921 - "chopdate": "2023-06-30T12:50:27.910Z",
1922 - "exclusive": true,
1923 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1924 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1925 - "deleted": true
1926 1926  }
440 +
1927 1927  
1928 -Ответ:
442 + **Проверка авторизации**
1929 1929  
1930 -{
1931 - "name": "string",
1932 - "description": "string",
1933 - "hiredate": "2023-06-30T12:50:27.929Z",
1934 - "chopdate": "2023-06-30T12:50:27.929Z",
1935 - "exclusive": true,
1936 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1937 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1938 - "deleted": true
1939 -}
444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
1940 1940  
446 +Метод запроса: GET
1941 1941  
1942 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
448 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
1943 1943  
1944 -(% class="box errormessage" %)
1945 -(((
1946 -**DELETE /api/v3/Drivers/{driverGuid}**
1947 -)))
450 +В заголовках запроса: X-Auth: Токен авторизации
1948 1948  
1949 -Передается параметр: ID водителя
452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
1950 1950  
1951 -Ответ:
1952 -
1953 -Success
1954 -
1955 -
1956 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
1957 -
1958 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
1959 -
1960 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
1961 -
1962 -(% class="box infomessage" %)
1963 -(((
1964 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
1965 -)))
1966 -
1967 -Запрос:
1968 -
1969 -{
1970 - "Ids": [
1971 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
1972 - ],
1973 - "BeginTime": "2023-06-30T12:49:04.365Z",
1974 - "EndTime": "2023-06-30T12:49:04.365Z"
1975 -}
1976 -
1977 -Ответ:
1978 -
1979 -[
1980 - {
1981 - "VehicleId": 0,
1982 - "CreateTime": "2023-06-30T09:52:31.240Z",
1983 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1984 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1985 - "BeginTime": "2023-06-30T09:52:31.240Z",
1986 - "EndTime": "2023-06-30T09:52:31.240Z"
1987 - }
1988 -]
1989 -
1990 -
1991 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
1992 -
1993 -(% class="box infomessage" %)
1994 -(((
1995 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
1996 -)))
1997 -
1998 -Запрос:
1999 -
2000 -{
2001 - "Ids": [
2002 - 0
2003 - ],
2004 - "BeginTime": "2023-06-30T12:48:39.419Z",
2005 - "EndTime": "2023-06-30T12:48:39.419Z"
2006 -}
2007 -
2008 -Ответ:
2009 -
2010 -[
2011 - {
2012 - "VehicleId": 0,
2013 - "CreateTime": "2023-06-30T09:54:01.631Z",
2014 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2015 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2016 - "BeginTime": "2023-06-30T09:54:01.631Z",
2017 - "EndTime": "2023-06-30T09:54:01.631Z"
2018 - }
2019 -]
2020 -
2021 -
2022 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2023 -
2024 -(% class="box successmessage" %)
2025 -(((
2026 -**POST /api/v3/DriversVehiclesAssignments**
2027 -)))
2028 -
2029 -Передается массив назначений
2030 -
2031 -Запрос:
2032 -
2033 -[
2034 - {
2035 - "VehicleId": 0, ~/~/ Идентификатор объекта
2036 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2037 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2038 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2039 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2040 - }
2041 -]
2042 -
2043 -Ответ:
2044 -
2045 -[
2046 - {
2047 - "VehicleId": 0,
2048 - "CreateTime": "2023-06-30T11:04:46.903Z",
2049 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2050 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2051 - "BeginTime": "2023-06-30T11:04:46.903Z",
2052 - "EndTime": "2023-06-30T11:04:46.903Z"
2053 - }
2054 -]
2055 -
2056 -
2057 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2058 -
2059 -(% class="box warningmessage" %)
2060 -(((
2061 -**PUT /api/v3/DriversVehiclesAssignments**
2062 -)))
2063 -
2064 -Запрос:
2065 -
2066 -[
2067 - {
2068 - "VehicleId": 0,
2069 - "CreateTime": "2023-06-30T11:14:08.117Z",
2070 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2071 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2072 - "BeginTime": "2023-06-30T11:14:08.117Z",
2073 - "EndTime": "2023-06-30T11:14:08.117Z"
2074 - }
2075 -]
2076 -
2077 -Ответ:
2078 -
2079 -[
2080 - {
2081 - "VehicleId": 0,
2082 - "CreateTime": "2023-06-30T11:14:53.349Z",
2083 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2084 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2085 - "BeginTime": "2023-06-30T11:14:53.349Z",
2086 - "EndTime": "2023-06-30T11:14:53.349Z"
2087 - }
2088 -]
2089 -
2090 -
2091 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2092 -
2093 -(% class="box errormessage" %)
2094 -(((
2095 -**DELETE /api/v3/DriversVehiclesAssignments**
2096 -)))
2097 -
2098 -Запрос:
2099 -
2100 -[
2101 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2102 -]
2103 -
2104 -Ответ:
2105 -
2106 -Success
2107 -
2108 -
2109 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2110 -
2111 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2112 -
2113 -(% class="box infomessage" %)
2114 -(((
2115 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2116 -)))
2117 -
2118 -Запрос:
2119 -
2120 -{
2121 - "Ids": [
2122 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2123 - ],
2124 - "BeginTime": "2023-06-30T12:47:12.162Z",
2125 - "EndTime": "2023-06-30T12:47:12.162Z"
2126 -}
2127 -
2128 -Ответ:
2129 -
2130 -[
2131 - {
2132 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2133 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2134 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2135 - "BeginTime": "2023-06-30T11:19:40.703Z",
2136 - "EndTime": "2023-06-30T11:19:40.703Z"
2137 - }
2138 -]
2139 -
2140 -
2141 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2142 -
2143 -(% class="box infomessage" %)
2144 -(((
2145 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2146 -)))
2147 -
2148 -Запрос:
2149 -
2150 -{
2151 - "Ids": [
2152 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2153 - ],
2154 - "BeginTime": "2023-06-30T12:47:12.162Z",
2155 - "EndTime": "2023-06-30T12:47:12.162Z"
2156 -}
2157 -
2158 -Ответ:
2159 -
2160 -[
2161 - {
2162 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2163 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2164 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2165 - "BeginTime": "2023-06-30T11:19:40.703Z",
2166 - "EndTime": "2023-06-30T11:19:40.703Z"
2167 - }
2168 -]
2169 -
2170 -
2171 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2172 -
2173 -(% class="box successmessage" %)
2174 -(((
2175 -**POST /api/v3/DriversRfidsAssignments**
2176 -)))
2177 -
2178 -Запрос:
2179 -
2180 -[
2181 - {
2182 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2183 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2184 - "BeginTime": "2023-06-30T11:27:08.635Z",
2185 - "EndTime": "2023-06-30T11:27:08.635Z"
2186 - }
2187 -]
2188 -
2189 -Ответ:
2190 -
2191 -[
2192 - {
2193 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2194 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2195 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2196 - "BeginTime": "2023-06-30T11:27:08.677Z",
2197 - "EndTime": "2023-06-30T11:27:08.677Z"
2198 - }
2199 -]
2200 -
2201 -
2202 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2203 -
2204 -(% class="box warningmessage" %)
2205 -(((
2206 -**PUT /api/v3/DriversRfidsAssignments**
2207 -)))
2208 -
2209 -Запрос:
2210 -
2211 -[
2212 - {
2213 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2214 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2215 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2216 - "BeginTime": "2023-06-30T11:28:43.330Z",
2217 - "EndTime": "2023-06-30T11:28:43.330Z"
2218 - }
2219 -]
2220 -
2221 -Ответ:
2222 -
2223 -[
2224 - {
2225 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2226 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2227 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2228 - "BeginTime": "2023-06-30T11:28:43.331Z",
2229 - "EndTime": "2023-06-30T11:28:43.331Z"
2230 - }
2231 -]
2232 -
2233 -
2234 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2235 -
2236 -(% class="box errormessage" %)
2237 -(((
2238 -**DELETE /api/v3/DriversRfidsAssignments**
2239 -)))
2240 -
2241 -Запрос:
2242 -
2243 -[
2244 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2245 -]
2246 -
2247 -Ответ:
2248 -
2249 -Success
2250 -
2251 -
2252 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2253 -
2254 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2255 -
2256 -(% class="box infomessage" %)
2257 -(((
2258 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2259 -)))
2260 -
2261 -Запрос:
2262 -
2263 -{
2264 - "Ids": [
2265 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2266 - ],
2267 - "BeginTime": "2023-06-30T12:45:10.852Z",
2268 - "EndTime": "2023-06-30T12:45:10.852Z"
2269 -}
2270 -
2271 -Ответ:
2272 -
2273 -[
2274 - {
2275 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2276 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2277 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2278 - "BeginTime": "2023-06-30T11:58:04.695Z",
2279 - "EndTime": "2023-06-30T11:58:04.695Z"
2280 - }
2281 -]
2282 -
2283 -
2284 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2285 -
2286 -(% class="box infomessage" %)
2287 -(((
2288 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2289 -)))
2290 -
2291 -Запрос:
2292 -
2293 -{
2294 - "Ids": [
2295 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2296 - ],
2297 - "BeginTime": "2023-06-30T12:45:10.852Z",
2298 - "EndTime": "2023-06-30T12:45:10.852Z"
2299 -}
2300 -
2301 -Ответ:
2302 -
2303 -[
2304 - {
2305 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2306 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2307 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2308 - "BeginTime": "2023-06-30T11:58:04.695Z",
2309 - "EndTime": "2023-06-30T11:58:04.695Z"
2310 - }
2311 -]
2312 -
2313 -
2314 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2315 -
2316 -(% class="box successmessage" %)
2317 -(((
2318 -**POST /api/v3/DriversFuelCardsAssignments**
2319 -)))
2320 -
2321 -Запрос:
2322 -
2323 -[
2324 - {
2325 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2326 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2327 - "BeginTime": "2023-06-30T12:09:53.175Z",
2328 - "EndTime": "2023-06-30T12:09:53.175Z"
2329 - }
2330 -]
2331 -
2332 -Ответ:
2333 -
2334 -[
2335 - {
2336 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2337 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2338 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2339 - "BeginTime": "2023-06-30T12:09:53.201Z",
2340 - "EndTime": "2023-06-30T12:09:53.201Z"
2341 - }
2342 -]
2343 -
2344 -
2345 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2346 -
2347 -(% class="box warningmessage" %)
2348 -(((
2349 -**PUT /api/v3/DriversFuelCardsAssignments**
2350 -)))
2351 -
2352 -Запрос:
2353 -
2354 -[
2355 - {
2356 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2357 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2358 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2359 - "BeginTime": "2023-06-30T12:09:53.201Z",
2360 - "EndTime": "2023-06-30T12:09:53.201Z"
2361 - }
2362 -]
2363 -
2364 -Ответ:
2365 -
2366 -[
2367 - {
2368 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2369 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2370 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2371 - "BeginTime": "2023-06-30T12:09:53.201Z",
2372 - "EndTime": "2023-06-30T12:09:53.201Z"
2373 - }
2374 -]
2375 -
2376 -
2377 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2378 -
2379 -(% class="box errormessage" %)
2380 -(((
2381 -**DELETE /api/v3/DriversFuelCardsAssignments**
2382 -)))
2383 -
2384 -Запрос:
2385 -
2386 -[
2387 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2388 -]
2389 -
2390 -Ответ:
2391 -
2392 -Success
2393 -
2394 -
2395 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2396 -
2397 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2398 -
2399 -(% class="box infomessage" %)
2400 -(((
2401 -**POST /api/v3/Rfids/find**
2402 -)))
2403 -
2404 -Запрос:
2405 -
2406 -{
2407 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2408 -}
2409 -
2410 -Ответ:
2411 -
2412 -[
2413 - {
2414 - "name": "string",
2415 - "number": 0,
2416 - "period": 0, ~/~/ Частота трансляции радиометки
2417 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2418 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2419 - "deleted": true
2420 - }
2421 -]
2422 -
2423 -
2424 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2425 -
2426 -(% class="box infomessage" %)
2427 -(((
2428 -**GET /api/v3/Rfids/{rfidGuid}**
2429 -)))
2430 -
2431 -Передаем параметр rfidGuid - идентификатор карты-метки
2432 -
2433 -Ответ:
2434 -
2435 -[
2436 - {
2437 - "name": "string",
2438 - "number": 0,
2439 - "period": 0, ~/~/ Частота трансляции радиометки
2440 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2441 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2442 - "deleted": true
2443 - }
2444 -]
2445 -
2446 -
2447 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2448 -
2449 -(% class="box successmessage" %)
2450 -(((
2451 -**POST /api/v3/Rfids**
2452 -)))
2453 -
2454 -Запрос:
2455 -
2456 -{
2457 - "name": "string",
2458 - "number": 0,
2459 - "period": 0,
2460 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2461 - "deleted": true
2462 -}
2463 -
2464 -Ответ:
2465 -
2466 -{
2467 - "name": "string",
2468 - "number": 0,
2469 - "period": 0,
2470 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2471 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2472 - "deleted": true
2473 -}
2474 -
2475 -
2476 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2477 -
2478 -(% class="box warningmessage" %)
2479 -(((
2480 -**PUT /api/v3/Rfids**
2481 -)))
2482 -
2483 -Запрос:
2484 -
2485 -{
2486 - "name": "string",
2487 - "number": 0,
2488 - "period": 0,
2489 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2490 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2491 - "deleted": true
2492 -}
2493 -
2494 -Ответ:
2495 -
2496 -{
2497 - "name": "string",
2498 - "number": 0,
2499 - "period": 0,
2500 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2501 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2502 - "deleted": true
2503 -}
2504 -
2505 -
2506 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2507 -
2508 -(% class="box errormessage" %)
2509 -(((
2510 -**DELETE /api/v3/Rfids/{rfidGuid}**
2511 -)))
2512 -
2513 -Передаем параметр rfidGuid - идентификатор карты-метки
2514 -
2515 -Ответ:
2516 -
2517 -Success
2518 -
2519 -
2520 -(% class="box" lang="en-US" style="text-align: center;" %)
2521 -(((
2522 -(% 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]] **
2523 -)))
454 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**

Меню

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