Last modified by Андрей Калиновский on 2025/04/21 14:13
<
From version < 109.1 >
edited by Илья Крайнов
on 2023/10/17 11:01
To version < 7.1 >
edited by Андрей Калиновский
on 2022/08/31 14:14
>
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,3051 +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" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
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 -{
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 -
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/models/{Id}**
692 -)))
693 -
694 -Метод возвращает полную информацию о модели объекта.
695 -
696 -(% style="color:#000000" %)Метод запроса: **GET**
697 -
698 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
699 -
700 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
701 -
702 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
703 -
704 -(% style="color:#000000" %)Ответ:
705 -
706 -(% style="color:#000000" %){
707 - "parentName": "string",
708 - "name": "string",
709 - "picture": "string",
710 - "minspeed": 0,
711 - "maxspeed": 0,
712 - "width": 0,
713 - "imbeddedtrailer": true,
714 - "fueloutlay": 0,
715 - "hoppercapacity": 0,
716 - "hopperdischargespeed": 0,
717 - "modelType": 0,
718 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
719 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
720 - "deleted": true
721 -}
722 -
723 -|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание
724 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
725 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
726 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
727 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
728 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
729 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
730 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
732 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
734 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
735 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
736 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
737 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
738 -
739 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
740 -
741 -(% class="box successmessage" %)
742 -(((
743 -(% lang="en-US" %)**POST /api/v3/models/find**
744 -)))
745 -
746 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
747 -
748 -(% style="color:#000000" %)Метод запроса: **POST**
749 -
750 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
751 -
752 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
753 -
754 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
755 -
756 -(% style="color:#000000" %){
757 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
758 -}
759 -
760 -(% style="color:#000000" %)Ответ:
761 -
762 -(% style="color:#000000" %)[
763 - {
764 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
765 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
766 - "parentName": "string",
767 - "name": "string",
768 - "modelType": 0
769 - }
770 -]
771 -
772 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
773 -
774 -(% class="box successmessage" %)
775 -(((
776 -(% lang="en-US" %)**POST /api/v3/models**
777 -)))
778 -
779 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
780 -
781 -(% style="color:#000000" %)Метод запроса: **POST**
782 -
783 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
784 -
785 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
786 -
787 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
788 -
789 -{
790 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
791 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
792 - "deleted": true,
793 - "extId": "string",
794 - "name": "string",
795 - "picture": "string",
796 - "minspeed": 0,
797 - "maxspeed": 0,
798 - "width": 0,
799 - "imbeddedtrailer": true,
800 - "fueloutlay": 0,
801 - "hoppercapacity": 0,
802 - "hopperdischargespeed": 0,
803 - "modelType": 0
804 -}
805 -
806 806  Ответ:
807 807  
808 808  {
809 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
810 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
811 - "deleted": true,
812 - "extId": "string",
813 - "name": "string",
814 - "picture": "string",
815 - "minspeed": 0,
816 - "maxspeed": 0,
817 - "width": 0,
818 - "imbeddedtrailer": true,
819 - "fueloutlay": 0,
820 - "hoppercapacity": 0,
821 - "hopperdischargespeed": 0,
822 - "modelType": 0
823 -}
824 824  
825 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
826 -
827 -(% class="box warningmessage" %)
828 -(((
829 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
830 -)))
831 -
832 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
833 -
834 -(% style="color:#000000" %)Метод запроса: **PUT**
835 -
836 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
837 -
838 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
839 -
840 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
841 -
842 -{
843 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
844 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
845 - "deleted": true,
846 - "extId": "string",
847 - "name": "string",
848 - "picture": "string",
849 - "minspeed": 0,
850 - "maxspeed": 0,
851 - "width": 0,
852 - "imbeddedtrailer": true,
853 - "fueloutlay": 0,
854 - "hoppercapacity": 0,
855 - "hopperdischargespeed": 0,
856 - "modelType": 0
857 -}
858 -
859 -Ответ:
860 -
861 -{
862 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
864 - "deleted": true,
865 - "extId": "string",
866 - "name": "string",
867 - "picture": "string",
868 - "minspeed": 0,
869 - "maxspeed": 0,
870 - "width": 0,
871 - "imbeddedtrailer": true,
872 - "fueloutlay": 0,
873 - "hoppercapacity": 0,
874 - "hopperdischargespeed": 0,
875 - "modelType": 0
876 -}
877 -
878 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
879 -
880 -(% class="box errormessage" %)
881 -(((
882 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
883 -)))
884 -
885 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
886 -
887 -(% style="color:#000000" %)Метод запроса: **DELETE**
888 -
889 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
890 -
891 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
892 -
893 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
894 -
895 -Ответ: В случае успеха **Success 200**
896 -
897 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
898 -
899 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
900 -
901 -(% class="box infomessage" %)
902 -(((
903 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
904 -)))
905 -
906 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
907 -
908 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
909 -
910 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
911 -
912 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
913 -
914 -(% style="color:#000000" %)Метод запроса: **GET**
915 -
916 -(% 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}
917 -
918 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
919 -
920 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
921 -
922 -(% style="color:#000000" %)Ответ:
923 -
924 -(((
925 -{
926 - "vehicleId": "", ~/~/ ID объекта
927 - "name": "", ~/~/ Имя объекта
928 - "imei": "", ~/~/ IMEI объекта
929 - "deviceTypeId": , ~/~/ ID типа устройства
930 - "deviceTypeName": "", ~/~/ Название типа устройства
931 - "sim1": "", ~/~/ Номер SIM1
932 - "sim2": "", ~/~/ Номер SIM2
933 -
934 - "parentId": "", ~/~/ ID клиента-родителя
935 - "parentName": "", ~/~/ Наименование клиента-родителя
936 - "modelId": "", ~/~/ ID модели объекта
937 - "modelName": "", ~/~/ Имя модели объекта
938 -
939 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
940 - "unitName": "string", ~/~/ Наименование подразделения
941 - "status": 0, ~/~/ Статус объекта
942 -
943 - "createdAt": "", ~/~/ Дата создания объекта
944 - },
945 -
946 -"customFields": [ ~/~/ Произвольные поля
947 - {
948 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
949 - "name": "string", ~/~/ Имя поля
950 - "value": "string", ~/~/ Значение поля
951 - "forClient": true, ~/~/ Не используемая функция
952 - "forTooltip": true, ~/~/ Отображать в подсказке
953 - "forReport": true ~/~/ Отображать в отчете
954 - }
955 -
956 -], ~/~/ Данные с вкладки нормы
957 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
958 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
959 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
960 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
961 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
962 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
963 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
964 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
965 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
966 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
967 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
968 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
969 -
970 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
971 - "mileageCoeff": 0, ~/~/ коэффициент пробега
972 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
973 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
974 - "counters": { ~/~/ Счетчики
975 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
976 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
977 - "mileage": 0, ~/~/ Текущий пробег
978 - "motohours": 0, ~/~/ Текущие моточасы
979 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
980 - "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 + ...
981 981   },
216 + ...}}}
982 982  
983 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
984 - "id": "string", ~/~/ ID объекта
985 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
986 - "host": "string", ~/~/ CMSV6 Web Host
987 - "login": "string", ~/~/ CMSV6 Account
988 - "password": "string" ~/~/ CMSV6 Password
989 - },
990 -
991 -"commandTemplates": [ ~/~/ Шаблоны команд
992 - {
993 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
994 - "name": "string", ~/~/ Наименование команды
995 - "command": "string", ~/~/ Текст команды
996 - "retries": 0 ~/~/ Количество попыток
997 - }
998 - ],
999 -
1000 - "sensors": [ ~/~/ Датчики
1001 - {
1002 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1003 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1004 - "type": 0, ~/~/ Тип датчика
1005 - "name": "string", ~/~/ Имя датчика
1006 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1007 - "inputNumber": 0, ~/~/ Номер входа
1008 - "pseudonym": "string", ~/~/ Псевдоним
1009 - "medianDegree": 0, ~/~/ Медианная фильтрация
1010 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1011 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1012 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1013 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1014 - {
1015 - "grades": [ ~/~/ Таблица тарировки 1
1016 - {
1017 - "input": 0, ~/~/ Входящее значение
1018 - "output": 0 ~/~/ Выходящее значение
1019 - }
1020 - ],
1021 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1022 - }
1023 - ],
1024 - "showInTooltip": true, ~/~/ Отображать в подсказке
1025 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1026 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1027 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1028 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1029 - "expr": "string", ~/~/ Формула
1030 - "children": [ ~/~/ массив дочерних датчиков
1031 - "string"
1032 - ],
1033 - "customParams": { ~/~/ прочие произвольные параметры
1034 - "additionalProp1": "string",
1035 - "additionalProp2": "string",
1036 - "additionalProp3": "string"
1037 - },
1038 -
1039 -~/~/ Характерные для произвольного:
1040 -
1041 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1042 -
1043 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1044 -
1045 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1046 -
1047 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1048 -
1049 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1050 -
1051 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1052 -
1053 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1054 -
1055 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1056 -
1057 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1058 -
1059 -~/~/ "ValueOn": "Вкл.",
1060 -
1061 -~/~/ "ValueOff": "Выкл."
1062 - "summaryMaxValue": 0 ~/~/ Макс. значение
1063 - }
1064 -
1065 - "drivers": [ ~/~/ Водители
1066 - {
1067 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1068 - "name": "string", ~/~/ Наименование
1069 - "description": "string",
1070 - "isDefault": true ~/~/ По умолчанию
1071 - }
1072 - ],
1073 -
1074 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1075 - {
1076 - "id": "", ~/~/ ID  задания
1077 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1078 - "name": "", ~/~/ Наименование задания
1079 - "description": "", ~/~/ Описание задания
1080 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1081 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1082 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1083 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1084 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1085 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1086 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1087 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1088 - }
1089 - ],
1090 -
1091 - "statusHistory": [ ~/~/ История статусов
1092 - {
1093 - "status": 0,
1094 - "date": "2023-05-22T09:57:39.562Z",
1095 - "description": "string",
1096 - "additionalInfo": "string"
1097 - }
1098 - ]
1099 -
1100 1100  }
1101 -)))
1102 1102  
1103 -(% style="text-align:left" %)
1104 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
1105 1105  
1106 -(% style="text-align:left" %)
1107 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
223 + **Добавление пользователя**
1108 1108  
1109 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1110 1110  
1111 -(% class="box successmessage" %)
1112 -(((
1113 -(% lang="en-US" %)**POST /api/v3/vehicles**
1114 -)))
227 +Метод запроса: POST
1115 1115  
1116 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1117 1117  
1118 -(% style="color:#000000" %)Метод запроса: **POST**
231 +В заголовках запроса: X-Auth: Токен авторизации
1119 1119  
1120 -(% 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»: [ // группы пользователя «», //названия групп «», «» ] }
1121 1121  
1122 -(% 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 +
1123 1123  
1124 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
238 + **Редактирование пользователя**
1125 1125  
1126 -(% style="color:#000000" %){
240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1127 1127  
1128 - "parentId": "" , ~/~/ ID клиента
1129 - "name": "" , ~/~/ имя ТС
1130 - "imei": "" , ~/~/ IMEI
1131 - "deviceTypeId": "" , ~/~/ ID типа устройства
1132 - "modelId": "" , ~/~/ ID модели
1133 - "unitId": "" , ~/~/ ID подразделения
1134 - "sim1": "" , ~/~/ Номер SIM 1
1135 - "sim2": "" , ~/~/ Номер SIM2
1136 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1137 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1138 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1139 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1140 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1141 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1142 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1143 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1144 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1145 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1146 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1147 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
242 +Метод запроса: PUT
1148 1148  
1149 - "mileageCalcMethod": 0,
1150 - "mileageCoeff": 0,
1151 - "locationByCellId": true,
1152 - "dottedLineTrackWhenNoCoords": true,
1153 - "counters": ~/~/ счетчики
1154 - {
1155 - "mileage": "" , ~/~/ пробег
1156 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1157 - "motohours": "" , ~/~/ моточасы
1158 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1159 - },
1160 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1161 - "enabled": true, ~/~/ флаг включения
1162 - "id": "" , ~/~/ идентификатор
1163 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1164 - "login": "" , ~/~/ имя учетной записи
1165 - "password": "" ~/~/ пароль учетной записи
1166 - },
1167 - "inspectionTasks": ~/~/ задания на ТО
1168 - {
1169 - "enabled": "" , ~/~/ Признак включения
1170 - "name": "" , ~/~/ Имя задания
1171 - "description": "" , ~/~/ Описание задания
1172 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1173 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1174 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1175 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1176 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1177 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1178 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1179 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1180 - }
244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1181 1181  
1182 -"drivers": [ ~/~/ Водители
1183 - {
1184 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1185 - "isDefault": true
1186 - }
1187 - ],
1188 - "commandTemplates": [ ~/~/ Шаблон команды
1189 - {
1190 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1191 - "name": "string",
1192 - "command": "string",
1193 - "retries": 0
1194 - }
1195 - ],
246 +В заголовках запроса: X-Auth: Токен авторизации
1196 1196  
1197 - "sensors": [ ~/~/ Датчики
1198 - {
1199 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1200 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1201 - "type": 0, ~/~/ Тип датчика
1202 - "name": "string", ~/~/ Имя датчика
1203 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1204 - "inputNumber": 0, ~/~/ Номер входа
1205 - "pseudonym": "string", ~/~/ Псевдоним
1206 - "medianDegree": 0, ~/~/ Медианная фильтрация
1207 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1208 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1209 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1210 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1211 - {
1212 - "grades": [ ~/~/ Таблица тарировки 1
1213 - {
1214 - "input": 0, ~/~/ Входящее значение
1215 - "output": 0 ~/~/ Выходящее значение
1216 - }
1217 - ],
1218 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1219 - }
1220 - ],
1221 - "showInTooltip": true, ~/~/ Отображать в подсказке
1222 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1223 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1224 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1225 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1226 - "expr": "string", ~/~/ Формула
1227 - "children": [ ~/~/ массив дочерних датчиков
1228 - "string"
1229 - ],
1230 - "customParams": { ~/~/ прочие произвольные параметры
1231 - "additionalProp1": "string",
1232 - "additionalProp2": "string",
1233 - "additionalProp3": "string"
1234 - },
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 - блокирован)
1235 1235  
1236 -~/~/ Характерные для произвольного:
250 +{{{ "description": "", // описание
251 + "data": "" // данные, связанные со сменой статуса}}}
1237 1237  
1238 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1239 -
1240 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1241 -
1242 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1243 -
1244 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1245 -
1246 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1247 -
1248 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1249 -
1250 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1251 -
1252 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1253 -
1254 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1255 -
1256 -~/~/ "ValueOn": "Вкл.",
1257 -
1258 -~/~/ "ValueOff": "Выкл."
1259 - "summaryMaxValue": 0 ~/~/ Макс. значение
1260 - }
1261 - ],
1262 - "customFields": [ ~/~/ Произвольные поля
1263 - {
1264 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1265 - "name": "string",
1266 - "value": "string",
1267 - "forClient": true,
1268 - "forTooltip": true,
1269 - "forReport": true
1270 - }
1271 - ]
1272 1272  }
1273 1273  
1274 -(% style="color:#000000" %)Ответ:
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
1275 1275  
1276 -(% style="color:#000000" %){
258 + **Удаление пользователя**
1277 1277  
1278 - "vehicleId": "", ~/~/ID ТС 
1279 - "parentId": "", ~/~/Guid владельца ТС
1280 - "name": "", ~/~/Имя объекта
1281 - "imei": "", ~/~/IMEI
1282 - "deviceTypeId": "", ~/~/ID типа устройства
1283 - "modelId": "", ~/~/ID модели
1284 - "unitId": "", ~/~/ID подразделения
1285 - "sim1": "", ~/~/SIM1
1286 - "sim2": "", ~/~/SIM2
1287 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1288 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1289 - "counters": { ~/~/Счётчики
1290 - "mileageEnabled": true,
1291 - "motohoursEnabled": true,
1292 - "mileage": "",
1293 - "motohours": 345.0
1294 - },
1295 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1296 - "id": null,
1297 - "enabled": true, ~/~/флаг включения
1298 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1299 - "login": "", ~/~/ имя учетной записи
1300 - "password": "" ~/~/ пароль учетной записи
1301 - },
1302 - "inspectionTasks": { ~/~/ задания на ТО
1303 - "id": "", ~/~/ ID задачи
1304 - "enabled": false, ~/~/ Признак включения
1305 - "name": "", ~/~/ Имя задания
1306 - "description": "", ~/~/ Описание задания
1307 - "mileageCondition": "", ~/~/ Условие по пробегу
1308 - "lastMileage": "", ~/~/ Пробег (в метрах)
1309 - "motohoursCondition": "", ~/~/ Условие по моточасам
1310 - "lastMotohours": "", ~/~/ Моточасы
1311 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1312 - "kind": "", ~/~/ Вид периодичности по времени 
1313 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1314 - }
260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1315 1315  
1316 -(% style="text-align:left" %)
1317 -(% style="color:#000000" %)}
262 +Метод запроса: DELETE
1318 1318  
1319 -**Валидация:**
1320 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1321 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1322 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
264 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
1323 1323  
1324 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
1325 1325  
1326 -(% class="box infomessage" %)
1327 -(((
1328 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
1329 -)))
268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
1330 1330  
1331 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
271 + **Добавление объекта**
1332 1332  
1333 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
1334 1334  
1335 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
275 +Метод запроса: POST
1336 1336  
1337 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1338 1338  
1339 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
279 +В заголовках запроса: X-Auth: Токен авторизации
1340 1340  
1341 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1342 1342  
1343 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1344 -
1345 -(% style="color:#000000" %)Метод запроса: **POST**
1346 -
1347 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1348 -
1349 -(% style="color:#000000" %)В заголовках запроса:
1350 -
1351 -(% style="color:#000000" %)− Content-Type: __**application/json**__
1352 -
1353 -(% style="color:#000000" %)− X-Auth: Токен авторизации
1354 -
1355 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1356 -
1357 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1358 -
1359 -{
1360 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1361 - "name": null, ~/~/ Имя ТС (string, опционально)
1362 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1363 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1364 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1365 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1366 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1367 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1368 -}
1369 -
1370 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1371 -
1372 -(% style="color:#000000" %)Ответ:
1373 -
1374 -(% style="color:#000000" %){
1375 -
1376 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1377 - "name": "" ~/~/ наименование объекта
1378 - "imei": "" ~/~/ IMEI объекта
1379 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1380 - "deviceTypeName": "" ~/~/ наименование типа устройства
1381 - "sim1": "" ~/~/ первый номер телефона
1382 - "sim2": "" ~/~/ второй номер телефона
1383 - "parentId": "" ~/~/ идентификатор клиента-родителя
1384 - "parentName": "" ~/~/ наименование клиента-родителя
1385 - "modelId": "" ~/~/ идентификатор модели объекта
1386 - "modelName": "" ~/~/ наименование модели объекта
1387 - "unitId": "" ~/~/ идентификатор подразделения
1388 - "unitName": "" ~/~/ наименование подразделения
1389 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1390 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1391 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1392 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1393 - "customFields": [ 
1394 - {
1395 - "id": "", ~/~/ идентификатор произвольного поля
1396 - "name": "", ~/~/ имя произвольного поля
1397 - "value": "", ~/~/ значение произвольного поля
1398 - "forClient": true, ~/~/ право на отображение у клиента
1399 - "forTooltip": false, ~/~/ право на отображение в подсказке
1400 - "forReport": false ~/~/ право на отображение в отчетах
1401 - }(%%)
1402 -(% style="color:#000000" %)}
1403 -
1404 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1405 -
1406 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1407 -
1408 -(% class="box successmessage" %)
1409 -(((
1410 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1411 -)))
1412 -
1413 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1414 -
1415 -(% style="color:#000000" %)Метод запроса: **POST**
1416 -
1417 -(% 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}
1418 -
1419 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1420 -
1421 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1422 -
1423 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1424 -
1425 -(% style="color:#000000" %){
1426 -
1427 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1428 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1429 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1430 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1431 - "description": "", ~/~/ Описание
1432 - "data": "", ~/~/ Данные
1433 - "overwrite": false, ~/~/ Флаг перезаписи
1434 - "stage": "", ~/~/ Состояние, может быть null
1435 -
1436 -(% style="color:#000000" %)}
1437 -
1438 -(% style="color:#000000" %)Ответ:
1439 -
1440 -(% style="color:#000000" %){
1441 -
1442 - "status": "", ~/~/ значение статуса
1443 - "date": "", ~/~/ Дата смены статуса 
1444 - "description": "", ~/~/ Описание
1445 - "data": "", ~/~/ Данные
1446 - "overwrite": false, ~/~/ Флаг перезаписи
1447 - "stage": "", ~/~/ Состояние
1448 -
1449 -(% style="text-align:left" %)
1450 -(% style="color:#000000" %) }
1451 -
1452 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1453 -
1454 -(% class="box warningmessage" %)
1455 -(((
1456 -(% lang="en-US" %)**PUT /api/v3/vehicles**
1457 -)))
1458 -
1459 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1460 -
1461 -(% style="color:#000000" %)Метод запроса: **PUT**
1462 -
1463 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1464 -
1465 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1466 -
1467 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1468 -
1469 -(% style="color:#000000" %){
1470 - "vehicleId": , ~/~/ ID объекта
1471 - "parentId": "" , ~/~/ ID клиента
1472 - "name": "" , ~/~/ имя ТС
1473 - "imei": "" , ~/~/ IMEI
1474 - "deviceTypeId": "" , ~/~/ ID типа устройства
1475 - "modelId": "" , ~/~/ ID модели
1476 - "unitId": "" , ~/~/ ID подразделения
1477 - "sim1": "" , ~/~/ Номер SIM 1
1478 - "sim2": "" , ~/~/ Номер SIM2
1479 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1480 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1481 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1482 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1483 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1484 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1485 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1486 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1487 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1488 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1489 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1490 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1491 -
1492 - "mileageCalcMethod": 0,
1493 - "mileageCoeff": 0,
1494 - "locationByCellId": true,
1495 - "dottedLineTrackWhenNoCoords": true,
1496 - "counters": ~/~/ счетчики
1497 - {
1498 - "mileage": "" , ~/~/ пробег
1499 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1500 - "motohours": "" , ~/~/ моточасы
1501 - "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": "" // пароль учетной записи
1502 1502   },
1503 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1504 - "enabled": true, ~/~/ флаг включения
1505 - "id": "" , ~/~/ идентификатор
1506 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1507 - "login": "" , ~/~/ имя учетной записи
1508 - "password": "" ~/~/ пароль учетной записи
1509 - },
1510 - "inspectionTasks": ~/~/ задания на ТО
307 + "inspectionTasks": [ // задания на ТО
1511 1511   {
1512 - "enabled": "" , ~/~/ Признак включения
1513 - "name": "" , ~/~/ Имя задания
1514 - "description": "" , ~/~/ Описание задания
1515 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1516 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1517 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1518 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1519 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1520 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1521 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1522 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1523 - }
1524 -
1525 -"drivers": [ ~/~/ Водители
1526 - {
1527 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1528 - "isDefault": true
1529 - }
1530 - ],
1531 - "commandTemplates": [ ~/~/ Шаблон команды
1532 - {
1533 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1534 - "name": "string",
1535 - "command": "string",
1536 - "retries": 0
1537 - }
1538 - ],
1539 -
1540 - "sensors": [ ~/~/ Датчики
1541 - {
1542 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1543 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1544 - "type": 0, ~/~/ Тип датчика
1545 - "name": "string", ~/~/ Имя датчика
1546 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1547 - "inputNumber": 0, ~/~/ Номер входа
1548 - "pseudonym": "string", ~/~/ Псевдоним
1549 - "medianDegree": 0, ~/~/ Медианная фильтрация
1550 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1551 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1552 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1553 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1554 - {
1555 - "grades": [ ~/~/ Таблица тарировки 1
1556 - {
1557 - "input": 0, ~/~/ Входящее значение
1558 - "output": 0 ~/~/ Выходящее значение
1559 - }
1560 - ],
1561 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1562 - }
1563 - ],
1564 - "showInTooltip": true, ~/~/ Отображать в подсказке
1565 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1566 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1567 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1568 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1569 - "expr": "string", ~/~/ Формула
1570 - "children": [ ~/~/ массив дочерних датчиков
1571 - "string"
1572 - ],
1573 - "customParams": { ~/~/ прочие произвольные параметры
1574 - "additionalProp1": "string",
1575 - "additionalProp2": "string",
1576 - "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 - однократно)
1577 1577   },
321 + ]}}}
1578 1578  
1579 -~/~/ Характерные для произвольного:
323 +… }
1580 1580  
1581 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1582 -
1583 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1584 -
1585 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1586 -
1587 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1588 -
1589 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1590 -
1591 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1592 -
1593 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1594 -
1595 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1596 -
1597 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1598 -
1599 -~/~/ "ValueOn": "Вкл.",
1600 -
1601 -~/~/ "ValueOff": "Выкл."
1602 - "summaryMaxValue": 0 ~/~/ Макс. значение
1603 - }
1604 - ],
1605 - "customFields": [ ~/~/ Произвольные поля
1606 - {
1607 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1608 - "name": "string",
1609 - "value": "string",
1610 - "forClient": true,
1611 - "forTooltip": true,
1612 - "forReport": true
1613 - }
1614 - ]
1615 -}
1616 -
1617 -(% style="color:#000000" %)Ответ:
1618 -
1619 -(% lang="en-US" style="text-align:left" %)
1620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1621 -
1622 -(% lang="en-US" style="text-align:left" %)
1623 - "vehicleId": "", ~/~/ ID ТС
1624 - "parentId": "", ~/~/ ID клиента
1625 - "name": "", ~/~/ имя ТС
1626 - "imei": "", ~/~/ IMEI
1627 - "deviceTypeId": "", ~/~/ типа устройства
1628 - "modelId": "", ~/~/ ID модели
1629 - "unitId": "", ~/~/ ID подразделения
1630 - "sim1": "", ~/~/ SIM 1
1631 - "sim2": "", ~/~/ SIM2
1632 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1633 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1634 - "counters": 
1635 - {
1636 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1637 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1638 - "mileage": "", ~/~/ пробег
1639 - "motohours": "", ~/~/ моточасы
1640 - }
1641 - "cmsv6Parameters": ~/~/ параметры CMSv6
1642 - {
1643 - "id": ~/~/ идентификатор
1644 - "enabled": true, ~/~/ флаг включения
1645 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1646 - "login": "", ~/~/ имя учетной записи
1647 - "password": "", ~/~/ пароль учетной записи
1648 - }
1649 - "inspectionTasks": ~/~/ задания на ТО
1650 - {
1651 - "id": "", ~/~/ ID задания
1652 - "enabled": false, ~/~/ Признак включения
1653 - "name": "", ~/~/ Имя задания
1654 - "description": "", ~/~/ Описание задания
1655 - "mileageCondition": "", ~/~/ Условие по пробегу
1656 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1657 - "motohoursCondition": "", ~/~/ Условие по моточасам
1658 - "lastMotohours": "", ~/~/ Моточасы
1659 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1660 - "kind": "", ~/~/ Вид периодичности по времени
1661 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1662 - }
1663 -
1664 -(% lang="en-US" style="text-align:left" %)
1665 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1666 -
1667 -**Валидация:**
1668 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1669 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1670 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1671 -
1672 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1673 -
1674 -(% class="box errormessage" %)
1675 -(((
1676 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1677 -)))
1678 -
1679 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1680 -
1681 -(% style="color:#000000" %)Метод запроса: **DELETE**
1682 -
1683 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1684 -
1685 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1686 -
1687 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1688 -
1689 -(% style="text-align:left" %)
1690 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1691 -
1692 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1693 -
1694 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1695 -
1696 -(% class="box infomessage" %)
1697 -(((
1698 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1699 -)))
1700 -
1701 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1702 -
1703 -(% style="color:#000000" %)Метод запроса: **GET**
1704 -
1705 -(% 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]]
1706 -
1707 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1708 -
1709 -(% style="color:#000000" %)Ответ:
1710 -
1711 -(% style="color:#000000" %){
1712 -
1713 - "deviceTypeId" : "", ~/~/ ID типа устройства
1714 - "deviceTypeName" : "" ~/~/ Название типа устройства
1715 -
1716 -(% style="text-align:left" %)
1717 -(% style="color:#000000" %)}
1718 -
1719 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1720 -
1721 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1722 -
1723 -(% class="box infomessage" %)
1724 -(((
1725 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1726 -)))
1727 -
1728 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1729 -
1730 -(% style="color:#000000" %)Метод запроса: **GET**
1731 -
1732 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1733 -
1734 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1735 -
1736 -(% style="color:#000000" %)Ответ:
1737 -
1738 -(% style="color:#000000" %){
1739 -
1740 - "id": "", ~/~/ ID типа датчика 
1741 - "name": "", ~/~/ Название
1742 - "description": "", ~/~/ Описание
1743 -
1744 -(% style="text-align:left" %)
1745 -(% style="color:#000000" %)}
1746 -
1747 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1748 -
1749 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1750 -
1751 -(% class="box infomessage" style="text-align: left;" %)
1752 -(((
1753 -**POST /api/v3/terminalMessages/count**
1754 -)))
1755 -
1756 -(% style="text-align: left;" %)
1757 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1758 -
1759 -(% style="text-align: left;" %)
1760 -Метод запроса **POST**
1761 -
1762 -(% style="text-align: left;" %)
1763 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1764 -
1765 -(% style="text-align: left;" %)
1766 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1767 -
1768 -(% style="text-align: left;" %)
1769 -{
1770 - "vehicleIds": [
1771 - id ~/~/ здесь передается список идентификаторов объектов
1772 - ],
1773 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1774 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1775 -}
1776 -
1777 -(% style="text-align: left;" %)
1778 1778  Ответ:
1779 1779  
1780 -(% style="text-align: left;" %)
1781 -[
1782 - {
1783 - "vehicleId": 0, ~/~/ идентификатор объекта
1784 - "count": 0 ~/~/ количество сообщений за период
1785 - }
1786 -]
1787 -
1788 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1789 -
1790 -(% class="box infomessage" %)
1791 -(((
1792 -**POST /api/v3/terminalMessages**
1793 -)))
1794 -
1795 -Метод возвращает список сообщений терминала объекта за выбранный период.
1796 -
1797 -(% style="text-align: left;" %)
1798 -Метод запроса **POST**
1799 -
1800 -(% style="text-align: left;" %)
1801 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1802 -
1803 -(% style="text-align: left;" %)
1804 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1805 -
1806 1806  {
1807 - "vehicleId": 0, ~/~/ id объекта
1808 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1809 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1810 -}
1811 1811  
1812 -Ответ:
1813 -
1814 -[
1815 - {
1816 - "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": [ // задания на ТО
1817 1817   {
1818 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1819 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1820 - "speed": 0, ~/~/ Скорость, км/ч
1821 - "altitude": 0, ~/~/ Высота, м
1822 - "latitude": 0, ~/~/ Широта [-90°;90°]
1823 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1824 - "satellites": 0, ~/~/ Кол-во спутников
1825 - "voltage": 0, ~/~/ Напряжение
1826 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1827 - "additionalProp1": "string",
1828 - "additionalProp2": "string",
1829 - "additionalProp3": "string"
1830 - },
1831 - "photoCount": 0 ~/~/ Кол-во фото
1832 - }
1833 - ]
1834 - }
1835 -]
355 + "id": "", // ID задачи
356 + "enabled": false, // Признак включения
357 + "name": "", // Имя задания
358 + "description": "", // Описание задания
359 + "mileageCondition": "", // Условие по пробегу
360 + "lastMileage": "", // Пробег (в метрах)
361 + "motohoursCondition": "", // Условие по моточасам
362 + "lastMotohours": "", // Моточасы
363 + "periodicCondition": "", // Условие периодичности по времени}}}
1836 1836  
1837 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1838 -
1839 -(% class="box infomessage" %)
1840 -(((
1841 -**POST /api/v3/vehicles/export/history**
1842 -)))
1843 -
1844 -Метод возвращает список сообщений терминала объекта за выбранный период.
1845 -
1846 -(% style="text-align: left;" %)
1847 -Метод запроса **POST**
1848 -
1849 -(% style="text-align: left;" %)
1850 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1851 -
1852 -(% style="text-align: left;" %)
1853 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1854 -
1855 -{
1856 - "vehicleId": 0, ~/~/ ID объекта
1857 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1858 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1859 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1860 -}
1861 -
1862 -Ответ:
1863 -
1864 -Получаете файл. Сообщение: Code 200/Success
1865 -
1866 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1867 -
1868 -(% class="box infomessage" %)
1869 -(((
1870 -**GET /api/v3/vehicles/export/history/status**
1871 -)))
1872 -
1873 -Метод возвращает список сообщений терминала объекта за выбранный период.
1874 -
1875 -(% style="text-align: left;" %)
1876 -Метод запроса **GET**
1877 -
1878 -(% style="text-align: left;" %)
1879 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1880 -
1881 -(% style="text-align: left;" %)
1882 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1883 -
1884 -Ответ:
1885 -
1886 -{
1887 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1888 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1889 - "message": "string" ~/~/ текст описывающий статус.
1890 -}
1891 -
1892 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1893 -
1894 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1895 -
1896 -(% class="box infomessage" %)
1897 -(((
1898 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
1899 -)))
1900 -
1901 -(% style="color:#000000" %)Метод запроса: **POST**
1902 -
1903 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
1904 -
1905 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1906 -
1907 -(% style="text-align:left" %)
1908 -Тело запроса:
1909 -
1910 -{
1911 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1912 - "vehicleIds": [0], ~/~/ Список ID объектов
1913 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1914 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
1915 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
1916 -}
1917 -
1918 -Ответ:
1919 -
1920 -[
1921 - {
1922 - "vehicleId": 0, ~/~/ ID объекта
1923 - "name": "string", ~/~/ Имя ТС
1924 - "periods": [ ~/~/ Периоды
1925 - {
1926 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1927 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1928 - "mileageBegin": 0, ~/~/ Пробег на начало периода
1929 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
1930 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1931 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
365 +{{{ "kind": "", // Вид периодичности по времени
366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1932 1932   }
1933 - ]
1934 - }
1935 -]
368 + ]}}}
1936 1936  
1937 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
1938 -
1939 -(% class="box infomessage" %)
1940 -(((
1941 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
1942 -)))
1943 -
1944 -(% style="color:#000000" %)Метод запроса: **POST**
1945 -
1946 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
1947 -
1948 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1949 -
1950 -(% style="text-align:left" %)
1951 -Тело запроса:
1952 -
1953 -{
1954 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1955 - "vehicleIds": [0], ~/~/ Список ID объектов
1956 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1957 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
1958 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
1959 1959  }
371 +
1960 1960  
1961 -Ответ:
373 + **Удаление объекта**
1962 1962  
1963 -[
1964 - {
1965 - "vehicleId": 0, ~/~/ ID объекта
1966 - "name": "string", ~/~/ Имя ТС
1967 - "periods": [ ~/~/ Периоды
1968 - {
1969 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1970 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1971 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
1972 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
1973 - "fuelConsumption": 0, ~/~/ Расход топлива
1974 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
1975 - }
1976 - ]
1977 - }
1978 -]
375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1979 1979  
1980 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
377 +Метод запроса: DELETE
1981 1981  
1982 -(% class="box infomessage" %)
1983 -(((
1984 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
1985 -)))
379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
1986 1986  
1987 -(% style="color:#000000" %)Метод запроса: **POST**
381 +Параметр запроса: {id} - Guid объекта
1988 1988  
1989 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
1990 -
1991 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1992 -
1993 -(% style="text-align:left" %)
1994 -Тело запроса:
1995 -
1996 -{
1997 - "vehicleIds": [0], ~/~/ Список ID объектов
1998 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
1999 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2000 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2001 -}
2002 -
2003 -Ответ:
2004 -
2005 -[
2006 - {
2007 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2008 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2009 - "vehicleId": 0, ~/~/ ID объекта
2010 - "name": "string", ~/~/ Имя объекта
2011 - "model": "string", ~/~/ Модель объекта
2012 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2013 - {
2014 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2015 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2016 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2017 - "valueFuel": 0, ~/~/ Количество
2018 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2019 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2020 - }
2021 - ]
2022 - }
2023 -]
2024 -
2025 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2026 -
2027 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2028 -
2029 -(% class="box infomessage" %)
2030 -(((
2031 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2032 -)))
2033 -
2034 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2035 -
2036 -(% style="color:#000000" %)Метод запроса: **POST**
2037 -
2038 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2039 -
2040 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2041 -
2042 -(% style="text-align:left" %)
2043 -Тело запроса:
2044 -
2045 -(% style="text-align:left" %)
2046 -{
2047 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2048 -}
2049 -
2050 -(% style="text-align:left" %)
2051 -Ответ:
2052 -
2053 -[
2054 - {
2055 - "id": 0, ~/~/ Идентификатор объекта геозоны
2056 - "name": "string", ~/~/ Название объекта геозоны
2057 - "type": 0, ~/~/ Тип объекта геозоны
2058 - "fname": "string", ~/~/ Имя файла
2059 - "parentId": "string", ~/~/ Идентификатор клиента
2060 - "radius": 0, ~/~/ Радиус геообъекта
2061 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2062 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2063 - "description": "string", ~/~/ Описание
2064 - "area": 0, ~/~/ Площадь, м^^2^^
2065 - "perimetr": 0, ~/~/ Периметр, м
2066 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2067 - }
2068 -]
2069 -
2070 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2071 -
2072 -(% class="box infomessage" %)
2073 -(((
2074 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2075 -)))
2076 -
2077 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2078 -
2079 -(% style="color:#000000" %)Метод запроса: **POST**
2080 -
2081 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2082 -
2083 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2084 -
2085 -(% style="text-align:left" %)
2086 -Тело запроса:
2087 -
2088 -{
2089 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2090 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2091 - "ids": [ ], ~/~/ Массив id объектов
2092 - "byTime": 0, ~/~/ Объединение событий по времени 
2093 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2094 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2095 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2096 -}
2097 -
2098 -Ответ:
2099 -[
2100 - {
2101 - "geozoneId": 0, ~/~/ ID геообъекта
2102 - "geozoneName": "string", ~/~/ Название геообъекта
2103 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2104 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2105 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2106 - "vehicleId": 0, ~/~/ ID объекта
2107 - "vehicleName": "string" ~/~/ Имя объекта
2108 - }
2109 -]
2110 -
2111 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2112 -
2113 -(% class="box infomessage" %)
2114 -(((
2115 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2116 -)))
2117 -
2118 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2119 -
2120 -(% style="color:#000000" %)Метод запроса: **POST**
2121 -
2122 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2123 -
2124 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2125 -
2126 -(% style="text-align:left" %)
2127 -Тело запроса:
2128 -
2129 -{
2130 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2131 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2132 - "ids": [ ], ~/~/ Массив id геообъектов
2133 - "byTime": 0, ~/~/ Объединение событий по времени 
2134 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2135 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2136 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2137 -}
2138 -
2139 -Ответ:
2140 -
2141 -[
2142 - {
2143 - "geozoneId": 0, ~/~/ ID геообъекта
2144 - "geozoneName": "string", ~/~/ Название геообъекта
2145 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2146 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2147 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2148 - "vehicleId": 0, ~/~/ ID объекта
2149 - "vehicleName": "string" ~/~/ Имя объекта
2150 - }
2151 -]
2152 -
2153 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2154 -
2155 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2156 -
2157 -(% class="box infomessage" %)
2158 -(((
2159 -**POST /api/v3/notifications/find**
2160 -)))
2161 -
2162 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2163 -
2164 -(% style="text-align: left;" %)
2165 -Метод запроса **POST**
2166 -
2167 -(% style="text-align: left;" %)
2168 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2169 -
2170 -(% style="text-align: left;" %)
2171 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2172 -
2173 -{
2174 - "parentId": "" ~/~/ id клиента
2175 -}
2176 -
2177 -Ответ:
2178 -
2179 -[
2180 - {
2181 - "id": 0, ~/~/ ID уведомления
2182 - "name": "string", ~/~/ Название уведомления
2183 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2184 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2185 - "userId": "", ~/~/ Пользователь, создавший уведомление
2186 - "parentId": "", ~/~/ Идентификатор клиента
2187 - "parentName": "string" ~/~/ Имя клиента
2188 - }
2189 -]
2190 -
2191 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2192 -
2193 -(% class="box infomessage" %)
2194 -(((
2195 -**GET /api/v3/notifications/{id}**
2196 -)))
2197 -
2198 -Метод возвращает данные правил формирования выбранного уведомления.
2199 -
2200 -(% style="text-align: left;" %)
2201 -Метод запроса **GET**
2202 -
2203 -(% style="text-align: left;" %)
2204 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2205 -
2206 -(% style="text-align: left;" %)
2207 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2208 -
2209 -(% style="text-align: left;" %)
2210 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2211 -
2212 -(% style="text-align: left;" %)
2213 -(% style="color:#000000" %)Ответ:
2214 -
2215 -(% style="text-align: left;" %)
2216 -(% style="color:#000000" %){
2217 - "id": 0, ~/~/ (%%)id уведомления
2218 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2219 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2220 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2221 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2222 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2223 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2224 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2225 -(% style="color:#000000" %) 0
2226 - ],
2227 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2228 -(% style="color:#000000" %) 0
2229 - ],
2230 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2231 -(% style="color:#000000" %) 0
2232 - ],
2233 - "settings": { ~/~/ Список параметров уведомления
2234 - "additionalProp1": "string",
2235 - "additionalProp2": "string",
2236 - "additionalProp3": "string"
2237 - },
2238 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2239 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2240 -(% style="color:#000000" %) ""
2241 - ],
2242 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2243 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2244 -(% style="color:#000000" %) "string"
2245 - ],
2246 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2247 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2248 -(% style="color:#000000" %) {
2249 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2250 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2251 -(% style="color:#000000" %) }
2252 - ],
2253 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2254 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2255 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2256 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2257 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2258 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2259 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2260 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2261 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2262 -(% style="color:#000000" %)}
2263 -
2264 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2265 -
2266 -(% class="box warningmessage" %)
2267 -(((
2268 -**PUT /api/v3/notifications/**
2269 -)))
2270 -
2271 -Метод позволяет отредактировать уведомление.
2272 -
2273 -Метод запроса **PUT**
2274 -
2275 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2276 -
2277 2277  В заголовках запроса: X-Auth: Токен авторизации
2278 2278  
2279 -Тело запроса:
2280 -{
2281 - "id": 0, ~/~/ id уведомления
2282 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2283 - "userId": "", ~/~/ Пользователь, создавший уведомление
2284 - "parentId": "", ~/~/ Идентификатор клиента
2285 - "parentName": "string", ~/~/ Имя клиента
2286 - "name": "string", ~/~/ Название уведомления
2287 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2288 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2289 - 0
2290 - ],
2291 - "geoids": [ ~/~/ Список id геообъектов для анализа
2292 - 0
2293 - ],
2294 - "fieldids": [ ~/~/ Список id полей для анализа
2295 - 0
2296 - ],
2297 - "settings": { ~/~/ Список параметров уведомления
2298 - "additionalProp1": "string",
2299 - "additionalProp2": "string",
2300 - "additionalProp3": "string"
2301 - },
2302 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2303 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2304 - ""
2305 - ],
2306 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2307 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2308 - "string"
2309 - ],
2310 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2311 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2312 - {
2313 - "id": 0, ~/~/ Идентификатор участника чата
2314 - "info": "string" ~/~/ Дополнительные сведения
2315 - }
2316 - ],
2317 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2318 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2319 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2320 - "kind": 0, ~/~/ Определяет вид уведомления
2321 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2322 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2323 - "timezone": 0, ~/~/ Сдвиг часового пояса
2324 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2325 - "autoProlongation": true ~/~/ Автопродление срока действия
2326 -}
385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
386 +
2327 2327  
2328 -Ответ:
388 + **Редактирование объекта**
2329 2329  
2330 -Success
390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2331 2331  
2332 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
392 +Метод запроса: PUT
2333 2333  
2334 -(% class="box errormessage" %)
2335 -(((
2336 -**DELETE /api/v3/notifications/{id}**
2337 -)))
394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
2338 2338  
2339 -Метод позволяет удалить выбранное уведомление.
2340 -
2341 -Метод запроса **DELETE**
2342 -
2343 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2344 -
2345 -Передаваемый параметр: {id} - id уведомления
2346 -
2347 2347  В заголовках запроса: X-Auth: Токен авторизации
2348 2348  
2349 -Ответ:
398 +Параметры в теле запроса (JSON):
2350 2350  
2351 -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»: «» //Сколько раз выполнить задание } ] }
2352 2352  
2353 -
2354 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2355 -
2356 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2357 -
2358 -(% class="box infomessage" %)
2359 -(((
2360 -**POST /api/v3/Drivers/find**
2361 -)))
2362 -
2363 -Передается параметр: parentId - ID клиента-родителя
2364 -
2365 2365  Ответ:
2366 2366  
2367 -[
2368 - {
2369 - "name": "string", ~/~/ Определяет наименование
2370 - "description": "string", ~/~/ Определяет описание
2371 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2372 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2373 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2374 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2375 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2376 - "deleted": true ~/~/ Признак удаления
2377 - }
2378 -]
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 +
2379 2379  
2380 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
407 + **Изменение статуса объекта**
2381 2381  
2382 -(% class="box infomessage" %)
2383 -(((
2384 -**GET /api/v3/Drivers/{driverGuid}**
2385 -)))
409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2386 2386  
2387 -Передается параметр: ID водителя
411 +Метод запроса: POST
2388 2388  
2389 -Ответ:
413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
2390 2390  
2391 -{
2392 - "name": "string", ~/~/ Определяет наименование
2393 - "description": "string", ~/~/ Определяет описание
2394 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2395 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2396 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2397 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2398 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2399 - "deleted": true ~/~/ Признак удаления
2400 -}
415 +Параметр запроса: {vehicleId} - ID ТС
2401 2401  
2402 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
417 +В заголовках запроса: X-Auth: Токен авторизации
2403 2403  
2404 -(% class="box successmessage" %)
2405 -(((
2406 -**POST /api/v3/Drivers**
2407 -)))
419 +Параметры в теле запроса (JSON): {
2408 2408  
2409 -Запрос:
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}}}
2410 2410  
2411 -{
2412 - "name": "string",
2413 - "description": "string",
2414 - "hiredate": "2023-06-30T12:50:54.020Z",
2415 - "chopdate": "2023-06-30T12:50:54.020Z",
2416 - "exclusive": true,
2417 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2418 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2419 - "deleted": true
2420 2420  }
2421 2421  
2422 -Ответ:
430 +Ответ: {
2423 2423  
2424 -{
2425 - "name": "string",
2426 - "description": "string",
2427 - "hiredate": "2023-06-30T12:50:54.051Z",
2428 - "chopdate": "2023-06-30T12:50:54.051Z",
2429 - "exclusive": true,
2430 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2431 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2432 - "deleted": true
2433 -}
432 +{{{ "status": "", // значение статуса
433 + "date": "", // Дата смены статуса
434 + "description": "", // Описание
435 + "data": "", // Данные
436 + "overwrite": false, // Флаг перезаписи
437 + "stage": "", // Состояние}}}
2434 2434  
2435 -
2436 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2437 -
2438 -(% class="box warningmessage" %)
2439 -(((
2440 -**PUT /api/v3/Drivers**
2441 -)))
2442 -
2443 -Запрос:
2444 -
2445 -{
2446 - "name": "string",
2447 - "description": "string",
2448 - "hiredate": "2023-06-30T12:50:27.910Z",
2449 - "chopdate": "2023-06-30T12:50:27.910Z",
2450 - "exclusive": true,
2451 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2452 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2453 - "deleted": true
2454 2454  }
440 +
2455 2455  
2456 -Ответ:
442 + **Проверка авторизации**
2457 2457  
2458 -{
2459 - "name": "string",
2460 - "description": "string",
2461 - "hiredate": "2023-06-30T12:50:27.929Z",
2462 - "chopdate": "2023-06-30T12:50:27.929Z",
2463 - "exclusive": true,
2464 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2465 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2466 - "deleted": true
2467 -}
444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
2468 2468  
446 +Метод запроса: GET
2469 2469  
2470 -== (% 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]]
2471 2471  
2472 -(% class="box errormessage" %)
2473 -(((
2474 -**DELETE /api/v3/Drivers/{driverGuid}**
2475 -)))
450 +В заголовках запроса: X-Auth: Токен авторизации
2476 2476  
2477 -Передается параметр: ID водителя
452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
2478 2478  
2479 -Ответ:
2480 -
2481 -Success
2482 -
2483 -
2484 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2485 -
2486 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2487 -
2488 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2489 -
2490 -(% class="box infomessage" %)
2491 -(((
2492 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2493 -)))
2494 -
2495 -Запрос:
2496 -
2497 -{
2498 - "Ids": [
2499 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2500 - ],
2501 - "BeginTime": "2023-06-30T12:49:04.365Z",
2502 - "EndTime": "2023-06-30T12:49:04.365Z"
2503 -}
2504 -
2505 -Ответ:
2506 -
2507 -[
2508 - {
2509 - "VehicleId": 0,
2510 - "CreateTime": "2023-06-30T09:52:31.240Z",
2511 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2512 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2513 - "BeginTime": "2023-06-30T09:52:31.240Z",
2514 - "EndTime": "2023-06-30T09:52:31.240Z"
2515 - }
2516 -]
2517 -
2518 -
2519 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2520 -
2521 -(% class="box infomessage" %)
2522 -(((
2523 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2524 -)))
2525 -
2526 -Запрос:
2527 -
2528 -{
2529 - "Ids": [
2530 - 0
2531 - ],
2532 - "BeginTime": "2023-06-30T12:48:39.419Z",
2533 - "EndTime": "2023-06-30T12:48:39.419Z"
2534 -}
2535 -
2536 -Ответ:
2537 -
2538 -[
2539 - {
2540 - "VehicleId": 0,
2541 - "CreateTime": "2023-06-30T09:54:01.631Z",
2542 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2543 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2544 - "BeginTime": "2023-06-30T09:54:01.631Z",
2545 - "EndTime": "2023-06-30T09:54:01.631Z"
2546 - }
2547 -]
2548 -
2549 -
2550 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2551 -
2552 -(% class="box successmessage" %)
2553 -(((
2554 -**POST /api/v3/DriversVehiclesAssignments**
2555 -)))
2556 -
2557 -Передается массив назначений
2558 -
2559 -Запрос:
2560 -
2561 -[
2562 - {
2563 - "VehicleId": 0, ~/~/ Идентификатор объекта
2564 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2565 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2566 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2567 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2568 - }
2569 -]
2570 -
2571 -Ответ:
2572 -
2573 -[
2574 - {
2575 - "VehicleId": 0,
2576 - "CreateTime": "2023-06-30T11:04:46.903Z",
2577 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2578 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2579 - "BeginTime": "2023-06-30T11:04:46.903Z",
2580 - "EndTime": "2023-06-30T11:04:46.903Z"
2581 - }
2582 -]
2583 -
2584 -
2585 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2586 -
2587 -(% class="box warningmessage" %)
2588 -(((
2589 -**PUT /api/v3/DriversVehiclesAssignments**
2590 -)))
2591 -
2592 -Запрос:
2593 -
2594 -[
2595 - {
2596 - "VehicleId": 0,
2597 - "CreateTime": "2023-06-30T11:14:08.117Z",
2598 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2599 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2600 - "BeginTime": "2023-06-30T11:14:08.117Z",
2601 - "EndTime": "2023-06-30T11:14:08.117Z"
2602 - }
2603 -]
2604 -
2605 -Ответ:
2606 -
2607 -[
2608 - {
2609 - "VehicleId": 0,
2610 - "CreateTime": "2023-06-30T11:14:53.349Z",
2611 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2612 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2613 - "BeginTime": "2023-06-30T11:14:53.349Z",
2614 - "EndTime": "2023-06-30T11:14:53.349Z"
2615 - }
2616 -]
2617 -
2618 -
2619 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2620 -
2621 -(% class="box errormessage" %)
2622 -(((
2623 -**DELETE /api/v3/DriversVehiclesAssignments**
2624 -)))
2625 -
2626 -Запрос:
2627 -
2628 -[
2629 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2630 -]
2631 -
2632 -Ответ:
2633 -
2634 -Success
2635 -
2636 -
2637 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2638 -
2639 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2640 -
2641 -(% class="box infomessage" %)
2642 -(((
2643 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2644 -)))
2645 -
2646 -Запрос:
2647 -
2648 -{
2649 - "Ids": [
2650 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2651 - ],
2652 - "BeginTime": "2023-06-30T12:47:12.162Z",
2653 - "EndTime": "2023-06-30T12:47:12.162Z"
2654 -}
2655 -
2656 -Ответ:
2657 -
2658 -[
2659 - {
2660 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2661 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2662 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2663 - "BeginTime": "2023-06-30T11:19:40.703Z",
2664 - "EndTime": "2023-06-30T11:19:40.703Z"
2665 - }
2666 -]
2667 -
2668 -
2669 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2670 -
2671 -(% class="box infomessage" %)
2672 -(((
2673 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2674 -)))
2675 -
2676 -Запрос:
2677 -
2678 -{
2679 - "Ids": [
2680 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2681 - ],
2682 - "BeginTime": "2023-06-30T12:47:12.162Z",
2683 - "EndTime": "2023-06-30T12:47:12.162Z"
2684 -}
2685 -
2686 -Ответ:
2687 -
2688 -[
2689 - {
2690 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2691 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2692 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2693 - "BeginTime": "2023-06-30T11:19:40.703Z",
2694 - "EndTime": "2023-06-30T11:19:40.703Z"
2695 - }
2696 -]
2697 -
2698 -
2699 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2700 -
2701 -(% class="box successmessage" %)
2702 -(((
2703 -**POST /api/v3/DriversRfidsAssignments**
2704 -)))
2705 -
2706 -Запрос:
2707 -
2708 -[
2709 - {
2710 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2711 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2712 - "BeginTime": "2023-06-30T11:27:08.635Z",
2713 - "EndTime": "2023-06-30T11:27:08.635Z"
2714 - }
2715 -]
2716 -
2717 -Ответ:
2718 -
2719 -[
2720 - {
2721 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2723 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2724 - "BeginTime": "2023-06-30T11:27:08.677Z",
2725 - "EndTime": "2023-06-30T11:27:08.677Z"
2726 - }
2727 -]
2728 -
2729 -
2730 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2731 -
2732 -(% class="box warningmessage" %)
2733 -(((
2734 -**PUT /api/v3/DriversRfidsAssignments**
2735 -)))
2736 -
2737 -Запрос:
2738 -
2739 -[
2740 - {
2741 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2742 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2743 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2744 - "BeginTime": "2023-06-30T11:28:43.330Z",
2745 - "EndTime": "2023-06-30T11:28:43.330Z"
2746 - }
2747 -]
2748 -
2749 -Ответ:
2750 -
2751 -[
2752 - {
2753 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2754 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2755 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2756 - "BeginTime": "2023-06-30T11:28:43.331Z",
2757 - "EndTime": "2023-06-30T11:28:43.331Z"
2758 - }
2759 -]
2760 -
2761 -
2762 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2763 -
2764 -(% class="box errormessage" %)
2765 -(((
2766 -**DELETE /api/v3/DriversRfidsAssignments**
2767 -)))
2768 -
2769 -Запрос:
2770 -
2771 -[
2772 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2773 -]
2774 -
2775 -Ответ:
2776 -
2777 -Success
2778 -
2779 -
2780 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2781 -
2782 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2783 -
2784 -(% class="box infomessage" %)
2785 -(((
2786 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2787 -)))
2788 -
2789 -Запрос:
2790 -
2791 -{
2792 - "Ids": [
2793 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2794 - ],
2795 - "BeginTime": "2023-06-30T12:45:10.852Z",
2796 - "EndTime": "2023-06-30T12:45:10.852Z"
2797 -}
2798 -
2799 -Ответ:
2800 -
2801 -[
2802 - {
2803 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2804 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2805 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2806 - "BeginTime": "2023-06-30T11:58:04.695Z",
2807 - "EndTime": "2023-06-30T11:58:04.695Z"
2808 - }
2809 -]
2810 -
2811 -
2812 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2813 -
2814 -(% class="box infomessage" %)
2815 -(((
2816 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2817 -)))
2818 -
2819 -Запрос:
2820 -
2821 -{
2822 - "Ids": [
2823 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2824 - ],
2825 - "BeginTime": "2023-06-30T12:45:10.852Z",
2826 - "EndTime": "2023-06-30T12:45:10.852Z"
2827 -}
2828 -
2829 -Ответ:
2830 -
2831 -[
2832 - {
2833 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2834 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2835 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2836 - "BeginTime": "2023-06-30T11:58:04.695Z",
2837 - "EndTime": "2023-06-30T11:58:04.695Z"
2838 - }
2839 -]
2840 -
2841 -
2842 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2843 -
2844 -(% class="box successmessage" %)
2845 -(((
2846 -**POST /api/v3/DriversFuelCardsAssignments**
2847 -)))
2848 -
2849 -Запрос:
2850 -
2851 -[
2852 - {
2853 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2854 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2855 - "BeginTime": "2023-06-30T12:09:53.175Z",
2856 - "EndTime": "2023-06-30T12:09:53.175Z"
2857 - }
2858 -]
2859 -
2860 -Ответ:
2861 -
2862 -[
2863 - {
2864 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2865 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2866 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2867 - "BeginTime": "2023-06-30T12:09:53.201Z",
2868 - "EndTime": "2023-06-30T12:09:53.201Z"
2869 - }
2870 -]
2871 -
2872 -
2873 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2874 -
2875 -(% class="box warningmessage" %)
2876 -(((
2877 -**PUT /api/v3/DriversFuelCardsAssignments**
2878 -)))
2879 -
2880 -Запрос:
2881 -
2882 -[
2883 - {
2884 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2885 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2886 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2887 - "BeginTime": "2023-06-30T12:09:53.201Z",
2888 - "EndTime": "2023-06-30T12:09:53.201Z"
2889 - }
2890 -]
2891 -
2892 -Ответ:
2893 -
2894 -[
2895 - {
2896 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2897 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2898 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2899 - "BeginTime": "2023-06-30T12:09:53.201Z",
2900 - "EndTime": "2023-06-30T12:09:53.201Z"
2901 - }
2902 -]
2903 -
2904 -
2905 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2906 -
2907 -(% class="box errormessage" %)
2908 -(((
2909 -**DELETE /api/v3/DriversFuelCardsAssignments**
2910 -)))
2911 -
2912 -Запрос:
2913 -
2914 -[
2915 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2916 -]
2917 -
2918 -Ответ:
2919 -
2920 -Success
2921 -
2922 -
2923 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2924 -
2925 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2926 -
2927 -(% class="box infomessage" %)
2928 -(((
2929 -**POST /api/v3/Rfids/find**
2930 -)))
2931 -
2932 -Запрос:
2933 -
2934 -{
2935 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2936 -}
2937 -
2938 -Ответ:
2939 -
2940 -[
2941 - {
2942 - "name": "string",
2943 - "number": 0,
2944 - "period": 0, ~/~/ Частота трансляции радиометки
2945 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2946 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2947 - "deleted": true
2948 - }
2949 -]
2950 -
2951 -
2952 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2953 -
2954 -(% class="box infomessage" %)
2955 -(((
2956 -**GET /api/v3/Rfids/{rfidGuid}**
2957 -)))
2958 -
2959 -Передаем параметр rfidGuid - идентификатор карты-метки
2960 -
2961 -Ответ:
2962 -
2963 -[
2964 - {
2965 - "name": "string",
2966 - "number": 0,
2967 - "period": 0, ~/~/ Частота трансляции радиометки
2968 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2969 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2970 - "deleted": true
2971 - }
2972 -]
2973 -
2974 -
2975 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2976 -
2977 -(% class="box successmessage" %)
2978 -(((
2979 -**POST /api/v3/Rfids**
2980 -)))
2981 -
2982 -Запрос:
2983 -
2984 -{
2985 - "name": "string",
2986 - "number": 0,
2987 - "period": 0,
2988 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2989 - "deleted": true
2990 -}
2991 -
2992 -Ответ:
2993 -
2994 -{
2995 - "name": "string",
2996 - "number": 0,
2997 - "period": 0,
2998 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2999 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000 - "deleted": true
3001 -}
3002 -
3003 -
3004 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3005 -
3006 -(% class="box warningmessage" %)
3007 -(((
3008 -**PUT /api/v3/Rfids**
3009 -)))
3010 -
3011 -Запрос:
3012 -
3013 -{
3014 - "name": "string",
3015 - "number": 0,
3016 - "period": 0,
3017 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3018 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3019 - "deleted": true
3020 -}
3021 -
3022 -Ответ:
3023 -
3024 -{
3025 - "name": "string",
3026 - "number": 0,
3027 - "period": 0,
3028 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3029 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3030 - "deleted": true
3031 -}
3032 -
3033 -
3034 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3035 -
3036 -(% class="box errormessage" %)
3037 -(((
3038 -**DELETE /api/v3/Rfids/{rfidGuid}**
3039 -)))
3040 -
3041 -Передаем параметр rfidGuid - идентификатор карты-метки
3042 -
3043 -Ответ:
3044 -
3045 -Success
3046 -
3047 -
3048 -(% class="box" lang="en-US" style="text-align: center;" %)
3049 -(((
3050 -(% 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]] **
3051 -)))
454 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**

Меню

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