<
From version < 2.1 >
edited by Андрей Калиновский
on 2022/07/21 16:33
To version < 103.3 >
edited by Илья Крайнов
on 2023/08/03 17:32
>
Change comment: There is no comment for this version

Summary

Details

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

Меню

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