<
From version < 17.1 >
edited by Артем Шемяков
on 2022/09/01 16:30
To version < 119.1 >
edited by Илья Крайнов
on 2023/11/23 10:14
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,50 +1,73 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 +{{toc/}}
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14 14  
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 +
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box infomessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box successmessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
30 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 -(% style="color:#000000" %)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]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 +
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}
42 +
43 +(% style="color:#000000" %)**Ответ:**
44 +
36 36  (% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
46 +(% style="color:#000000" %){
38 38  
48 +(% lang="en-US" %)
49 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 + "User": "testuser" , ~/~/ имя пользователя
51 +
52 +(% lang="en-US" %)
53 +}
54 +
39 39  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 40  
57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
41 41  
63 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 +
42 42  (% class="box infomessage" %)
43 43  (((
44 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
67 +(% lang="en-US" %)**GET /api/v3/auth/check**
45 45  )))
46 46  
47 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
70 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
48 48  
49 49  (% style="color:#000000" %)Метод запроса: **GET**
50 50  
... ... @@ -55,49 +55,294 @@
55 55  (% lang="en-US" %)
56 56  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
57 57  
81 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
58 58  
59 -(% class="box" style="text-align: center;" %)
83 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
84 +
85 +(% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
87 +**GET api/v3/agents/{id}**
62 62  )))
63 63  
90 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
91 +
92 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
93 +
94 +(% style="color:#000000" %)Метод запроса: **GET**
95 +
96 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
97 +
98 +Запрос должен содержать данные параметра "**agentId**"
99 +
100 +(% style="color:#000000" %)Ответ:
101 +{
102 + "agentId": "",  (%%)
103 + "parentId": "",
104 + "parentName": "string",
105 + "name": "string",
106 + "fullName": "string",
107 + "agentInfoType": 0,
108 + "isForeign": true/false,
109 + "district": "string", 
110 + "region": "string",
111 + "city": "string",
112 + "inn": "string",
113 + "kpp": "string",
114 + "address": "string",
115 + "addressFact": "string",
116 + "email": "string",
117 + "director": "string",
118 + "bankName": "string",
119 + "bankBIK": "string",
120 + "bankRS": "string",
121 + "bankKS": "string"
122 + }
123 +
124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 +
146 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 +
64 64  (% class="box infomessage" %)
65 65  (((
66 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
150 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
67 67  )))
68 68  
69 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
153 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
70 70  
71 71  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
72 72  
73 73  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
74 74  
75 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
76 76  
77 -(% style="color:#000000" %)Метод запроса: **GET**
161 +(% style="color:#000000" %)Метод запроса: **POST**
78 78  
79 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
163 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
80 80  
81 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
165 +(% style="color:#000000" %)Параметр запроса:
82 82  
83 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
167 +(% style="color:#000000" %){
168 + "parentId": "string"
169 +}
84 84  
85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
171 +(% style="color:#000000" %)Ответ:
86 86  
87 -(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
173 +{
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "parentName": "string",
177 + "name": "string",
178 + "fullName": "string",
179 + "agentInfoType": 0,
180 +(% style="color:#000000" %) "status": "",
181 +}
88 88  
89 89  
90 -(% class="box" style="text-align: center;" %)
184 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
191 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
192 +
193 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
194 +
195 +(% class="box successmessage" %)
91 91  (((
92 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
197 +**POST /api/v3/agents **
93 93  )))
94 94  
200 +Метод позволяет добавить клиента, указанного в запросе.
201 +
202 +Метод запроса: **POST**
203 +
204 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
205 +
206 +В заголовках запроса: X-Auth: Токен авторизации
207 +
208 +Параметры в теле запроса (JSON):
209 +
210 +{
211 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
212 + "name": "string", ~/~/ имя
213 + "fullName": "string", ~/~/ полное наименование
214 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
215 + "isForeign": true, ~/~/ иностранный контрагент
216 + "district": "string", ~/~/ округ
217 + "region": "string", ~/~/ регион
218 + "city": "string", ~/~/ город
219 + "inn": "string", ~/~/ ИНН
220 + "kpp": "string", ~/~/ КПП
221 + "address": "string", ~/~/ юридический адрес
222 + "addressFact": "string", ~/~/ фактический адрес
223 + "email": "string", ~/~/ email
224 + "director": "string", ~/~/ ФИО руководителя
225 + "bankName": "string", ~/~/ банк
226 + "bankBIK": "string", ~/~/ БИК
227 + "bankRS": "string", ~/~/ номер счёта
228 + "bankKS": "string" ~/~/ корр. счёт
229 +}
230 +
231 +
232 +Ответ:
233 +
234 +{
235 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
236 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
237 + "name": "string", ~/~/ имя
238 + "fullName": "string", ~/~/ полное наименование
239 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
240 + "isForeign": true, ~/~/ иностранный контрагент
241 + "district": "string", ~/~/ округ
242 + "region": "string", ~/~/ регион
243 + "city": "string", ~/~/ город
244 + "inn": "string", ~/~/ ИНН
245 + "kpp": "string", ~/~/ КПП
246 + "address": "string", ~/~/ юридический адрес
247 + "addressFact": "string", ~/~/ фактический адрес
248 + "email": "string", ~/~/ email
249 + "director": "string", ~/~/ ФИО руководителя
250 + "bankName": "string", ~/~/ банк
251 + "bankBIK": "string", ~/~/ БИК
252 + "bankRS": "string", ~/~/ номер счёта
253 + "bankKS": "string" ~/~/ корр. счёт
254 +}
255 +
256 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
257 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
258 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
259 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
260 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
261 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
262 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
263 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
264 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
265 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
266 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
267 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
268 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
269 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
270 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
271 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
272 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
273 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
274 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
275 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
276 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
277 +
278 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
279 +
280 +(% class="box warningmessage" %)
281 +(((
282 +**PUT /api/v3/agents**
283 +)))
284 +
285 +Метод позволяет отредактировать клиента, указанного в запросе.
286 +
287 +Метод запроса: **PUT**
288 +
289 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
290 +
291 +В заголовках запроса: X-Auth: Токен авторизации
292 +
293 +Параметры в теле запроса (JSON):
294 +
295 +{
296 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
297 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
298 + "name": "string", ~/~/ имя
299 + "fullName": "string", ~/~/ полное наименование
300 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
301 + "isForeign": true, ~/~/ иностранный контрагент
302 + "district": "string", ~/~/ округ
303 + "region": "string", ~/~/ регион
304 + "city": "string", ~/~/ город
305 + "inn": "string", ~/~/ ИНН
306 + "kpp": "string", ~/~/ КПП
307 + "address": "string", ~/~/ юридический адрес
308 + "addressFact": "string", ~/~/ фактический адрес
309 + "email": "string", ~/~/ email
310 + "director": "string", ~/~/ ФИО руководителя
311 + "bankName": "string", ~/~/ банк
312 + "bankBIK": "string", ~/~/ БИК
313 + "bankRS": "string", ~/~/ номер счёта
314 + "bankKS": "string" ~/~/ корр. счёт
315 +}
316 +
317 +Ответ:
318 +
319 +{
320 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
321 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
322 + "name": "string", ~/~/ имя
323 + "fullName": "string", ~/~/ полное наименование
324 + "isForeign": true, ~/~/ иностранный контрагент
325 + "district": "string", ~/~/ округ
326 + "region": "string", ~/~/ регион
327 + "city": "string", ~/~/ город
328 + "inn": "string", ~/~/ ИНН
329 + "kpp": "string", ~/~/ КПП
330 + "address": "string", ~/~/ юридический адрес
331 + "addressFact": "string", ~/~/ фактический адрес
332 + "email": "string", ~/~/ email
333 + "director": "string", ~/~/ ФИО руководителя
334 + "bankName": "string", ~/~/ банк
335 + "bankBIK": "string", ~/~/ БИК
336 + "bankRS": "string", ~/~/ номер счёта
337 + "bankKS": "string" ~/~/ корр. счёт
338 +}
339 +
340 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
341 +
342 +(% class="box errormessage" %)
343 +(((
344 +**DELETE /api/v3/agents/{clientId}**
345 +)))
346 +
347 +Метод позволяет удалить клиента, указанного в строке запроса.
348 +
349 +Метод запроса: **DELETE**
350 +
351 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
352 +
353 +Параметр запроса: **{clientId}** - Guid пользователя
354 +
355 +В заголовках запроса: X-Auth: Токен авторизации
356 +
357 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
358 +
359 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
360 +
361 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
362 +
95 95  (% class="box successmessage" %)
96 96  (((
97 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
365 +(% lang="en-US" %)**POST /api/v3/users**
98 98  )))
99 99  
100 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
368 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
101 101  
102 102  (% style="color:#000000" %)Метод запроса: **POST**
103 103  
... ... @@ -105,18 +105,189 @@
105 105  
106 106  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
107 107  
108 -(% style="color:#000000" %)Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
376 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
109 109  
378 +(% style="color:#000000" %)
379 +{ 
380 + "lastName": "", ~/~/ фамилия
381 + "firstName": "", ~/~/ имя
382 + "position": "", ~/~/ должность
383 + "phone": "", ~/~/ телефон
384 + "organization": "", ~/~/ организация
385 + "login": "", ~/~/ логин (обязателен)
386 + "password": "", ~/~/ пароль (обязателен)
387 + "email": "", ~/~/ email (обязателен)
388 + "description": "string", ~/~/ Описание
389 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
390 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
391 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
392 + "parentId": "", ~/~/ Guid родительского агента
393 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
394 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
395 + "doubleAuth":
396 + {
397 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
398 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
399 + },
400 + "groups":
401 + [
402 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
403 + ],
404 + "customGroups":
405 + [
406 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
407 + ],
408 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
409 +}
410 +
411 +{
412 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
413 + "lastName": "string",
414 + "firstName": "string",
415 + "position": "string",
416 + "phone": "string",
417 + "organization": "string",
418 + "login": "string",
419 + "password": "string",
420 + "email": "string",
421 +
110 110  (% style="text-align:left" %)
111 -(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
423 +(% style="color:#000000; font-weight:normal" %)Ответ:
112 112  
425 +(% style="text-align:left" %)
426 +(% style="color:#000000; font-weight:normal" %){    
113 113  
428 +(% style="text-align:left" %)
429 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
430 + "lastName": "" , ~/~/ Фамилия ,
431 + "firstName": "" , ~/~/ Имя
432 + "position": "" , ~/~/ Должность
433 + "phone": "" , ~/~/ Телефон
434 + "organization": "" , ~/~/ Организация
435 + "login": "" , ~/~/ Логин
436 + "password": "" , ~/~/ Пароль
437 + "email": "" , ~/~/ Email
438 + "description": "" , ~/~/ Описание
439 + "isEnabled": "" , ~/~/ Признак включения
440 + "parentId": "" , ~/~/ Guid родительского агента
441 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
442 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
443 + "kind": "" , ~/~/ тип аутентификации
444 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
445 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
446 +
447 +(% style="text-align:left" %)
448 +(% style="color:#000000; font-weight:normal" %)}
449 +
450 +
451 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
452 +
453 +(% class="box infomessage" %)
454 +(((
455 +(% lang="en-US" %)**POST /api/v3/users/find**
456 +)))
457 +
458 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
459 +
460 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
461 +
462 +(% style="color:#000000" %)Метод запроса: **POST**
463 +
464 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
465 +
466 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
467 +
468 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
469 +
470 +(% style="color:#000000" %){
471 +
472 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
473 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
474 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
475 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
476 +
477 +(% style="color:#000000" %)}
478 +
479 +(% style="color:#000000" %)Ответ:
480 +
481 +(% style="color:#000000" %){         (%%)
482 +
483 + "id": "" , ~/~/ идентификатор пользователя
484 + "lastName": "" , ~/~/ фамилия
485 + "firstName": "" , ~/~/ имя
486 + "position": "" , ~/~/ должность
487 + "phone": "" , ~/~/ телефон
488 + "parentId": "" , ~/~/ идентификатор клиента-родителя
489 + "parentName": "" , ~/~/ наименование клиента-родителя
490 + "organization": "" , ~/~/ организация
491 + "login": "" , ~/~/ логин
492 + "email": "" , ~/~/ E-mail
493 + "sessionDuration":"", ~/~/ длительность сессии в минутах
494 + "status": "1",  ~/~/ статус пользователя
495 + "lastLogged": "", ~/~/ дата/время последней авторизации
496 +
497 +(% style="color:#000000" %)}
498 +
499 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
500 +
501 +(% class="box infomessage" %)
502 +(((
503 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
504 +)))
505 +
506 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
507 +
508 +(% style="color:#000000" %)Метод запроса: **GET**
509 +
510 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
511 +
512 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
513 +
514 +(% style="color:#000000" %)Ответ:
515 +
516 +(((
517 +(((
518 +{
519 + "id": "", ~/~/ GUID пользователя
520 + "lastName": "", ~/~/ Фамилия 
521 + "firstName": "", ~/~/ Имя
522 + "position": "", ~/~/ Должность
523 + "phone": "", ~/~/ Номер телефона
524 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
525 + "parentName": "", Наименование клиента, которому принадлежит пользователь
526 + "organization": "", ~/~/ Организация
527 + "login": "", ~/~/ Логин пользователя
528 + "email": "", ~/~/ Адрес электронной почты
529 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
530 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
531 + "description": "", ~/~/ Описание
532 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
540 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
541 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
542 + "groups": [], ~/~/ Список ролей пользователя
543 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
544 + "authDevices": [ ], ~/~/ Список авторизованных устройств
545 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
546 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
547 +}
548 +)))
549 +)))
550 +
551 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
552 +
114 114  (% class="box warningmessage" %)
115 115  (((
116 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
555 +(% lang="en-US" %)**PUT /api/v3/users**
117 117  )))
118 118  
119 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
558 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
120 120  
121 121  (% style="color:#000000" %)Метод запроса: **PUT**
122 122  
... ... @@ -125,149 +125,629 @@
125 125  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
126 126  
127 127  (% lang="en-US" style="text-align:left" %)
128 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (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» //названия групп ] }  //
567 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
129 129  
569 +(% lang="en-US" style="text-align:left" %)
570 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
130 130  
572 +(% lang="en-US" style="text-align:left" %)
573 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
574 + "lastName": "" , ~/~/ фамилия
575 + "firstName": "" , ~/~/ имя
576 + "position": "" , ~/~/ должность
577 + "phone": "" , ~/~/ телефон
578 + "organization": "" , ~/~/ организация
579 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
580 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
581 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
582 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
583 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
584 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
585 + "isEnabled": "" , ~/~/ признак включения
586 + "parentId": "" , ~/~/ Guid родительского агента
587 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
588 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
589 + "doubleAuth":
590 + {
591 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
592 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
593 + },
594 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
595 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
596 +
597 +(% lang="en-US" style="text-align:left" %)
598 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
599 +
600 +(% lang="en-US" style="text-align:left" %)
601 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
602 +
603 +(% lang="en-US" style="text-align:left" %)
604 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
605 +
606 +(% lang="en-US" style="text-align:left" %)
607 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
608 + "lastName": "" , ~/~/ фамилия
609 + "firstName": "" , ~/~/ имя
610 + "position": "" , ~/~/ должность
611 + "phone": "" , ~/~/ телефон
612 + "organization": "" , ~/~/ организация
613 + "login": "" , ~/~/ логин
614 + "password": "" , ~/~/ пароль 
615 + "email": "" , ~/~/ email
616 + "description": "" , ~/~/ описание
617 + "isEnabled": "" , ~/~/ признак включения
618 + "parentId": "" , ~/~/ Guid родительского агента
619 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
620 + "doubleAuth":
621 + {
622 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
623 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
624 + },
625 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
626 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
627 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
628 +
629 +(% lang="en-US" style="text-align:left" %)
630 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
631 +
632 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
633 +
131 131  (% class="box warningmessage" %)
132 132  (((
133 -(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
636 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
134 134  )))
135 135  
136 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
639 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
137 137  
138 138  (% style="color:#000000" %)Метод запроса: **PUT**
139 139  
140 -(% 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} Параметр запроса:
643 +(% 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}
141 141  
142 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
645 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
143 143  
144 -(% class="western" %)
145 -{{{ "description": "", // описание
146 - "data": "" // данные, связанные со сменой статуса}}}
647 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
147 147  
649 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
650 +
651 +(% style="color:#000000" %){
652 +
653 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
654 + "description": "" , ~/~/ описание
655 + "data": "" , ~/~/ данные, связанные со сменой статуса
656 +
148 148  (% style="color:#000000" %)}
149 149  
150 150  (% style="text-align:left" %)
151 151  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
152 152  
662 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
153 153  
154 -(% class="box successmessage" %)
664 +(% class="box warningmessage" %)
155 155  (((
156 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
666 +**POST /api/v3/users/disable**
157 157  )))
158 158  
159 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
669 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
160 160  
161 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
671 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
162 162  
163 -(% style="color:#000000" %)Метод запроса: **POST**
673 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
164 164  
165 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
675 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
166 166  
167 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
677 + [ 
678 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
679 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
680 + ]
168 168  
169 -(% class="western" %)
170 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
171 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
172 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
173 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
682 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
174 174  
175 -(% style="color:#000000" %)}
684 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
176 176  
177 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
686 +(% class="box warningmessage" %)
687 +(((
688 +**POST /api/v3/users/enable**
689 +)))
178 178  
179 -(% class="western" style="margin-bottom:19px" %)
180 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
691 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
181 181  
182 -(% lang="en-US" style="text-align:left" %)
183 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
693 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
184 184  
695 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
185 185  
697 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
698 +
699 + [ 
700 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
701 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
702 + ]
703 +
704 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
705 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
706 +
707 +(((
708 +В теле ответа:
709 +{
710 + "errorMessages": [
711 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
712 + ],
713 + "users": [
714 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
715 + ]
716 +}
717 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
718 +"users" - массив id пользователей, которых не удалось включить или отключить.
719 +)))
720 +
721 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
722 +
186 186  (% class="box errormessage" %)
187 187  (((
188 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
725 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
189 189  )))
190 190  
191 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
728 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
192 192  
193 193  (% style="color:#000000" %)Метод запроса: **DELETE**
194 194  
195 195  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
196 196  
197 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
734 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
198 198  
736 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
737 +
199 199  (% style="text-align:left" %)
200 200  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
201 201  
741 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
202 202  
203 -(% class="box" style="text-align: center;" %)
743 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
744 +
745 +(% class="box infomessage" %)
204 204  (((
205 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
747 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
206 206  )))
207 207  
750 +Метод возвращает полную информацию о модели объекта.
751 +
752 +(% style="color:#000000" %)Метод запроса: **GET**
753 +
754 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
755 +
756 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
757 +
758 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
759 +
760 +(% style="color:#000000" %)Ответ:
761 +
762 +(% style="color:#000000" %){
763 + "parentName": "string",
764 + "name": "string",
765 + "picture": "string",
766 + "minspeed": 0,
767 + "maxspeed": 0,
768 + "width": 0,
769 + "imbeddedtrailer": true,
770 + "hoppercapacity": 0,
771 + "hopperdischargespeed": 0,
772 + "modelType": 0,
773 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
774 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
775 + "deleted": true
776 +}
777 +
778 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
779 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
780 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
781 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
782 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
783 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
784 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
785 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
786 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
787 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
788 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
789 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
790 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
791 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
792 +
793 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
794 +
795 +(% class="box successmessage" %)
796 +(((
797 +(% lang="en-US" %)**POST /api/v3/models/find**
798 +)))
799 +
800 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
801 +
802 +(% style="color:#000000" %)Метод запроса: **POST**
803 +
804 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
805 +
806 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
807 +
808 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
809 +
810 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
811 +}
812 +
813 +(% style="color:#000000" %)Ответ:
814 +
815 +(% style="color:#000000" %)[
816 + {
817 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
818 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
819 + "parentName": "string",
820 + "name": "string",
821 + "modelType": 0
822 + }
823 +]
824 +
825 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
826 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
827 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
828 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
829 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
830 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
831 +
832 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
833 +
834 +(% class="box successmessage" %)
835 +(((
836 +(% lang="en-US" %)**POST /api/v3/models**
837 +)))
838 +
839 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
840 +
841 +(% style="color:#000000" %)Метод запроса: **POST**
842 +
843 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
844 +
845 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
846 +
847 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
848 +
849 +{
850 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
851 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
852 + "deleted": true,
853 + "extId": "string",
854 + "name": "string",
855 + "picture": "string",
856 + "minspeed": 0,
857 + "maxspeed": 0,
858 + "width": 0,
859 + "imbeddedtrailer": true,
860 + "fueloutlay": 0,
861 + "hoppercapacity": 0,
862 + "hopperdischargespeed": 0,
863 + "modelType": 0
864 +}
865 +
866 +Ответ:
867 +
868 +{
869 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
870 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
871 + "deleted": true,
872 + "extId": "string",
873 + "name": "string",
874 + "picture": "string",
875 + "minspeed": 0,
876 + "maxspeed": 0,
877 + "width": 0,
878 + "imbeddedtrailer": true,
879 + "hoppercapacity": 0,
880 + "hopperdischargespeed": 0,
881 + "modelType": 0
882 +}
883 +
884 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
885 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
886 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
887 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
888 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
889 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
890 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
891 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
892 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
893 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
894 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
895 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
896 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
897 +
898 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
899 +
900 +(% class="box warningmessage" %)
901 +(((
902 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
903 +)))
904 +
905 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
906 +
907 +(% style="color:#000000" %)Метод запроса: **PUT**
908 +
909 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
910 +
911 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
912 +
913 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
914 +
915 +{
916 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
917 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
918 + "deleted": true,
919 + "extId": "string",
920 + "name": "string",
921 + "picture": "string",
922 + "minspeed": 0,
923 + "maxspeed": 0,
924 + "width": 0,
925 + "imbeddedtrailer": true,
926 + "fueloutlay": 0,
927 + "hoppercapacity": 0,
928 + "hopperdischargespeed": 0,
929 + "modelType": 0
930 +}
931 +
932 +Ответ:
933 +
934 +{
935 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
936 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
937 + "deleted": true,
938 + "extId": "string",
939 + "name": "string",
940 + "picture": "string",
941 + "minspeed": 0,
942 + "maxspeed": 0,
943 + "width": 0,
944 + "imbeddedtrailer": true,
945 + "fueloutlay": 0,
946 + "hoppercapacity": 0,
947 + "hopperdischargespeed": 0,
948 + "modelType": 0
949 +}
950 +
951 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
952 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
953 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
954 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
955 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
956 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
957 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
958 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
959 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
960 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
961 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
962 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
963 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
964 +
965 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
966 +
208 208  (% class="box errormessage" %)
209 209  (((
210 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
969 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
211 211  )))
212 212  
213 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
972 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
214 214  
215 215  (% style="color:#000000" %)Метод запроса: **DELETE**
216 216  
217 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
976 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
218 218  
219 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
978 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
220 220  
221 221  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
222 222  
223 -(% style="text-align:left" %)
224 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
982 +Ответ: В случае успеха **Success 200**
225 225  
984 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
226 226  
986 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
987 +
227 227  (% class="box infomessage" %)
228 228  (((
229 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
990 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
230 230  )))
231 231  
232 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
993 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
233 233  
234 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
995 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
235 235  
236 236  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
237 237  
238 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
999 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
239 239  
240 240  (% style="color:#000000" %)Метод запроса: **GET**
241 241  
242 -(% 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>
1003 +(% 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}
243 243  
244 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
1005 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
245 245  
246 246  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
247 247  
248 248  (% style="color:#000000" %)Ответ:
249 249  
250 -(% style="color:#000000" %){
1011 +(((
1012 +{
1013 + "vehicleId": "", ~/~/ ID объекта
1014 + "name": "", ~/~/ Имя объекта
1015 + "imei": "", ~/~/ IMEI объекта
1016 + "deviceTypeId": , ~/~/ ID типа устройства
1017 + "deviceTypeName": "", ~/~/ Название типа устройства
1018 + "sim1": "", ~/~/ Номер SIM1
1019 + "sim2": "", ~/~/ Номер SIM2
251 251  
252 -(% class="western" %)
253 -{{{ "vehicleId": “”, // идентификатор объекта
254 - "name": "", // имя объекта
255 - "imei": "", // IMEI объекта
256 - "deviceTypeId": “”, // идентификатор устройства объекта
257 - "deviceTypeName": "" // наименование устройства объекта
258 - "parentId": "", // идентификатор клиента-родителя
259 - "parentName": "" // наименование клиента-родителя,
260 - "modelId": "", // идентификатор модели объекта
261 - "modelName": "" // наименование модели объекта,
262 - "unitId": "", // идентификатор подразделения
263 - "unitName": "", // наименование подразделения
264 - "status": “”, // статус объекта
265 - ...
1021 + "parentId": "", ~/~/ ID клиента-родителя
1022 + "parentName": "", ~/~/ Наименование клиента-родителя
1023 + "modelId": "", ~/~/ ID модели объекта
1024 + "modelName": "", ~/~/ Имя модели объекта
1025 +
1026 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1027 + "unitName": "string", ~/~/ Наименование подразделения
1028 + "status": 0, ~/~/ Статус объекта
1029 +
1030 + "createdAt": "", ~/~/ Дата создания объекта
1031 + },
1032 +
1033 +"customFields": [ ~/~/ Произвольные поля
1034 + {
1035 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1036 + "name": "string", ~/~/ Имя поля
1037 + "value": "string", ~/~/ Значение поля
1038 + "forClient": true, ~/~/ Не используемая функция
1039 + "forTooltip": true, ~/~/ Отображать в подсказке
1040 + "forReport": true ~/~/ Отображать в отчете
1041 + }
1042 +
1043 +], ~/~/ Данные с вкладки нормы
1044 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1045 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1046 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1047 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1048 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1049 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1050 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1051 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1052 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1053 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1054 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1055 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
1056 +
1057 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1058 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1059 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1060 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1061 + "counters": { ~/~/ Счетчики
1062 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1063 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1064 + "mileage": 0, ~/~/ Текущий пробег
1065 + "motohours": 0, ~/~/ Текущие моточасы
1066 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1067 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
266 266   },
267 - ...}}}
268 268  
269 -(% style="color:#000000" %)}
1070 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1071 + "id": "string", ~/~/ ID объекта
1072 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1073 + "host": "string", ~/~/ CMSV6 Web Host
1074 + "login": "string", ~/~/ CMSV6 Account
1075 + "password": "string" ~/~/ CMSV6 Password
1076 + },
270 270  
1078 +"commandTemplates": [ ~/~/ Шаблоны команд
1079 + {
1080 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1081 + "name": "string", ~/~/ Наименование команды
1082 + "command": "string", ~/~/ Текст команды
1083 + "retries": 0 ~/~/ Количество попыток
1084 + }
1085 + ],
1086 +
1087 + "sensors": [ ~/~/ Датчики
1088 + {
1089 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1090 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1091 + "type": 0, ~/~/ Тип датчика
1092 + "name": "string", ~/~/ Имя датчика
1093 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1094 + "inputNumber": 0, ~/~/ Номер входа
1095 + "pseudonym": "string", ~/~/ Псевдоним
1096 + "medianDegree": 0, ~/~/ Медианная фильтрация
1097 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1098 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1099 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1100 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1101 + {
1102 + "grades": [ ~/~/ Таблица тарировки 1
1103 + {
1104 + "input": 0, ~/~/ Входящее значение
1105 + "output": 0 ~/~/ Выходящее значение
1106 + }
1107 + ],
1108 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1109 + }
1110 + ],
1111 + "showInTooltip": true, ~/~/ Отображать в подсказке
1112 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1113 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1114 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1115 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1116 + "expr": "string", ~/~/ Формула
1117 + "children": [ ~/~/ массив дочерних датчиков
1118 + "string"
1119 + ],
1120 + "customParams": { ~/~/ прочие произвольные параметры
1121 + "additionalProp1": "string",
1122 + "additionalProp2": "string",
1123 + "additionalProp3": "string"
1124 + },
1125 +
1126 +~/~/ Характерные для произвольного:
1127 +
1128 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1129 +
1130 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1131 +
1132 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1133 +
1134 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1135 +
1136 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1137 +
1138 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1139 +
1140 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1141 +
1142 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1143 +
1144 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1145 +
1146 +~/~/ "ValueOn": "Вкл.",
1147 +
1148 +~/~/ "ValueOff": "Выкл."
1149 + "summaryMaxValue": 0 ~/~/ Макс. значение
1150 + }
1151 +
1152 + "drivers": [ ~/~/ Водители
1153 + {
1154 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1155 + "name": "string", ~/~/ Наименование
1156 + "description": "string",
1157 + "isDefault": true ~/~/ По умолчанию
1158 + }
1159 + ],
1160 +
1161 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1162 + {
1163 + "id": "", ~/~/ ID  задания
1164 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1165 + "name": "", ~/~/ Наименование задания
1166 + "description": "", ~/~/ Описание задания
1167 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1168 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1169 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1170 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1171 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1172 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1173 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1174 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1175 + }
1176 + ],
1177 +
1178 + "statusHistory": [ ~/~/ История статусов
1179 + {
1180 + "status": 0,
1181 + "date": "2023-05-22T09:57:39.562Z",
1182 + "description": "string",
1183 + "additionalInfo": "string"
1184 + }
1185 + ]
1186 +
1187 +}
1188 +)))
1189 +
271 271  (% style="text-align:left" %)
272 272  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
273 273  
... ... @@ -274,13 +274,14 @@
274 274  (% style="text-align:left" %)
275 275  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
276 276  
1196 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
277 277  
278 278  (% class="box successmessage" %)
279 279  (((
280 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
1200 +(% lang="en-US" %)**POST /api/v3/vehicles**
281 281  )))
282 282  
283 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
1203 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
284 284  
285 285  (% style="color:#000000" %)Метод запроса: **POST**
286 286  
... ... @@ -288,106 +288,342 @@
288 288  
289 289  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
290 290  
291 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1211 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
292 292  
293 -(% class="western" %)
294 -{{{ "parentId": "", // ID клиента
295 - "name": "", // имя ТС
296 - "imei": "", // IMEI
297 - "deviceTypeId": "",// ID типа устройства
298 - "modelId": "",
299 - "unitId": "", // ID подразделения
300 - "sim1": "", // Номер SIM 1
301 - "sim2": "", // Номер SIM2
302 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
303 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
304 - "consumptionIdle": "",// Расход топлива на холостом ходу
305 - "counters": {
306 - "mileage": "", // пробег
307 - "mileageEnabled": true, // флаг активности счётчика "пробег"
308 - "motohours":"", // моточасы
309 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
310 - },
311 - "cmsv6Parameters": { // параметры CMSv6
312 - "enabled": true, // флаг включения
313 - //"id": "", // идентификатор
314 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
315 - "login": "", // имя учетной записи
316 - "password": "" // пароль учетной записи
1213 +(% style="color:#000000" %){
1214 +
1215 + "parentId": "" , ~/~/ ID клиента
1216 + "name": "" , ~/~/ имя ТС
1217 + "imei": "" , ~/~/ IMEI
1218 + "deviceTypeId": "" , ~/~/ ID типа устройства
1219 + "modelId": "" , ~/~/ ID модели
1220 + "unitId": "" , ~/~/ ID подразделения
1221 + "sim1": "" , ~/~/ Номер SIM 1
1222 + "sim2": "" , ~/~/ Номер SIM2
1223 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1224 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1225 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1226 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1227 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1228 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1229 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1230 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1231 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1232 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1233 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1234 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1235 +
1236 + "mileageCalcMethod": 0,
1237 + "mileageCoeff": 0,
1238 + "locationByCellId": true,
1239 + "dottedLineTrackWhenNoCoords": true,
1240 + "counters": ~/~/ счетчики
1241 + {
1242 + "mileage": "" , ~/~/ пробег
1243 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1244 + "motohours": "" , ~/~/ моточасы
1245 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
317 317   },
318 - "inspectionTasks": [ // задания на ТО
1247 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1248 + "enabled": true, ~/~/ флаг включения
1249 + "id": "" , ~/~/ идентификатор
1250 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1251 + "login": "" , ~/~/ имя учетной записи
1252 + "password": "" ~/~/ пароль учетной записи
1253 + },
1254 + "inspectionTasks": ~/~/ задания на ТО
319 319   {
320 - "enabled": "", // Признак включения
321 - "name": "", // Имя задания
322 - "description": "", // Описание задания
323 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
324 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
325 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
326 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
327 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
328 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
329 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
330 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1256 + "enabled": "" , ~/~/ Признак включения
1257 + "name": "" , ~/~/ Имя задания
1258 + "description": "" , ~/~/ Описание задания
1259 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1260 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1261 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1262 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1263 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1264 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1265 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1266 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1267 + }
1268 +
1269 +"drivers": [ ~/~/ Водители
1270 + {
1271 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1272 + "isDefault": true
1273 + }
1274 + ],
1275 + "commandTemplates": [ ~/~/ Шаблон команды
1276 + {
1277 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1278 + "name": "string",
1279 + "command": "string",
1280 + "retries": 0
1281 + }
1282 + ],
1283 +
1284 + "sensors": [ ~/~/ Датчики
1285 + {
1286 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1287 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1288 + "type": 0, ~/~/ Тип датчика
1289 + "name": "string", ~/~/ Имя датчика
1290 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1291 + "inputNumber": 0, ~/~/ Номер входа
1292 + "pseudonym": "string", ~/~/ Псевдоним
1293 + "medianDegree": 0, ~/~/ Медианная фильтрация
1294 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1295 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1296 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1297 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1298 + {
1299 + "grades": [ ~/~/ Таблица тарировки 1
1300 + {
1301 + "input": 0, ~/~/ Входящее значение
1302 + "output": 0 ~/~/ Выходящее значение
1303 + }
1304 + ],
1305 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1306 + }
1307 + ],
1308 + "showInTooltip": true, ~/~/ Отображать в подсказке
1309 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1310 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1311 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1312 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1313 + "expr": "string", ~/~/ Формула
1314 + "children": [ ~/~/ массив дочерних датчиков
1315 + "string"
1316 + ],
1317 + "customParams": { ~/~/ прочие произвольные параметры
1318 + "additionalProp1": "string",
1319 + "additionalProp2": "string",
1320 + "additionalProp3": "string"
331 331   },
332 - ]}}}
333 333  
334 -(% style="color:#000000" %)… }
1323 +~/~/ Характерные для произвольного:
335 335  
1325 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1326 +
1327 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1328 +
1329 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1330 +
1331 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1332 +
1333 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1334 +
1335 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1336 +
1337 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1338 +
1339 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1340 +
1341 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1342 +
1343 +~/~/ "ValueOn": "Вкл.",
1344 +
1345 +~/~/ "ValueOff": "Выкл."
1346 + "summaryMaxValue": 0 ~/~/ Макс. значение
1347 + }
1348 + ],
1349 + "customFields": [ ~/~/ Произвольные поля
1350 + {
1351 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1352 + "name": "string",
1353 + "value": "string",
1354 + "forClient": true,
1355 + "forTooltip": true,
1356 + "forReport": true
1357 + }
1358 + ]
1359 +}
1360 +
336 336  (% style="color:#000000" %)Ответ:
337 337  
338 338  (% style="color:#000000" %){
339 339  
340 -(% class="western" %)
341 -{{{ "vehicleId": "", //ID ТС
342 - "parentId": "", //Guid владельца ТС
343 - "name": "", //Имя объекта
344 - "imei": "", //IMEI
345 - "deviceTypeId": "", //ID типа устройства
346 - "modelId": "", //ID модели
347 - "unitId": "", //ID подразделения
348 - "sim1": "", //SIM1
349 - "sim2": "", //SIM2
350 - "consumptionPer100Km": "", //Расход топлива на 100 км
351 - "consumptionIdle": "", //Расход топлива на холостом ходу
352 - "counters": { //Счётчики
353 - "mileageEnabled": true,
354 - "motohoursEnabled": true,
355 - "mileage": "",
356 - "motohours": 345.0
357 - },
358 - "cmsv6Parameters": { //Параметры CmsV6
359 - "id": null,
360 - "enabled": true, //флаг включения
361 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
362 - "login": "", // имя учетной записи
363 - "password": "" // пароль учетной записи
364 - },
365 - "inspectionTasks": [ // задания на ТО
366 - {
367 - "id": "", // ID задачи
368 - "enabled": false, // Признак включения
369 - "name": "", // Имя задания
370 - "description": "", // Описание задания
371 - "mileageCondition": "", // Условие по пробегу
372 - "lastMileage": "", // Пробег (в метрах)
373 - "motohoursCondition": "", // Условие по моточасам
374 - "lastMotohours": "", // Моточасы
375 - "periodicCondition": "", // Условие периодичности по времени
376 - "kind": "", // Вид периодичности по времени
377 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
378 - }
379 - ]}}}
1365 + "vehicleId": "", ~/~/ID ТС 
1366 + "parentId": "", ~/~/Guid владельца ТС
1367 + "name": "", ~/~/Имя объекта
1368 + "imei": "", ~/~/IMEI
1369 + "deviceTypeId": "", ~/~/ID типа устройства
1370 + "modelId": "", ~/~/ID модели
1371 + "unitId": "", ~/~/ID подразделения
1372 + "sim1": "", ~/~/SIM1
1373 + "sim2": "", ~/~/SIM2
1374 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1375 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1376 + "counters": { ~/~/Счётчики
1377 + "mileageEnabled": true,
1378 + "motohoursEnabled": true,
1379 + "mileage": "",
1380 + "motohours": 345.0
1381 + },
1382 + "cmsv6Parameters": { ~/~/Параметры CmsV6
1383 + "id": null,
1384 + "enabled": true, ~/~/флаг включения
1385 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1386 + "login": "", ~/~/ имя учетной записи
1387 + "password": "" ~/~/ пароль учетной записи
1388 + },
1389 + "inspectionTasks": { ~/~/ задания на ТО
1390 + "id": "", ~/~/ ID задачи
1391 + "enabled": false, ~/~/ Признак включения
1392 + "name": "", ~/~/ Имя задания
1393 + "description": "", ~/~/ Описание задания
1394 + "mileageCondition": "", ~/~/ Условие по пробегу
1395 + "lastMileage": "", ~/~/ Пробег (в метрах)
1396 + "motohoursCondition": "", ~/~/ Условие по моточасам
1397 + "lastMotohours": "", ~/~/ Моточасы
1398 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1399 + "kind": "", ~/~/ Вид периодичности по времени 
1400 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1401 + }
380 380  
381 381  (% style="text-align:left" %)
382 382  (% style="color:#000000" %)}
383 383  
1406 +**Валидация:**
1407 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1408 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1409 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
384 384  
1411 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1412 +
1413 +(% class="box infomessage" %)
1414 +(((
1415 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
1416 +)))
1417 +
1418 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1419 +
1420 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1421 +
1422 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1423 +
1424 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1425 +
1426 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1427 +
1428 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1429 +
1430 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1431 +
1432 +(% style="color:#000000" %)Метод запроса: **POST**
1433 +
1434 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1435 +
1436 +(% style="color:#000000" %)В заголовках запроса:
1437 +
1438 +(% style="color:#000000" %)− Content-Type: __**application/json**__
1439 +
1440 +(% style="color:#000000" %)− X-Auth: Токен авторизации
1441 +
1442 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1443 +
1444 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
1445 +
1446 +{
1447 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1448 + "name": null, ~/~/ Имя ТС (string, опционально)
1449 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1450 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1451 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1452 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1453 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1454 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1455 +}
1456 +
1457 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1458 +
1459 +(% style="color:#000000" %)Ответ:
1460 +
1461 +(% style="color:#000000" %){
1462 +
1463 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1464 + "name": "" ~/~/ наименование объекта
1465 + "imei": "" ~/~/ IMEI объекта
1466 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
1467 + "deviceTypeName": "" ~/~/ наименование типа устройства
1468 + "sim1": "" ~/~/ первый номер телефона
1469 + "sim2": "" ~/~/ второй номер телефона
1470 + "parentId": "" ~/~/ идентификатор клиента-родителя
1471 + "parentName": "" ~/~/ наименование клиента-родителя
1472 + "modelId": "" ~/~/ идентификатор модели объекта
1473 + "modelName": "" ~/~/ наименование модели объекта
1474 + "unitId": "" ~/~/ идентификатор подразделения
1475 + "unitName": "" ~/~/ наименование подразделения
1476 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1477 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1478 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1479 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1480 + "customFields": [ 
1481 + {
1482 + "id": "", ~/~/ идентификатор произвольного поля
1483 + "name": "", ~/~/ имя произвольного поля
1484 + "value": "", ~/~/ значение произвольного поля
1485 + "forClient": true, ~/~/ право на отображение у клиента
1486 + "forTooltip": false, ~/~/ право на отображение в подсказке
1487 + "forReport": false ~/~/ право на отображение в отчетах
1488 + }(%%)
1489 +(% style="color:#000000" %)}
1490 +
1491 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1492 +
1493 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1494 +
1495 +(% class="box successmessage" %)
1496 +(((
1497 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1498 +)))
1499 +
1500 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1501 +
1502 +(% style="color:#000000" %)Метод запроса: **POST**
1503 +
1504 +(% 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}
1505 +
1506 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1507 +
1508 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1509 +
1510 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
1511 +
1512 +(% style="color:#000000" %){
1513 +
1514 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1515 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1516 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1517 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1518 + "description": "", ~/~/ Описание
1519 + "data": "", ~/~/ Данные
1520 + "overwrite": false, ~/~/ Флаг перезаписи
1521 + "stage": "", ~/~/ Состояние, может быть null
1522 +
1523 +(% style="color:#000000" %)}
1524 +
1525 +(% style="color:#000000" %)Ответ:
1526 +
1527 +(% style="color:#000000" %){
1528 +
1529 + "status": "", ~/~/ значение статуса
1530 + "date": "", ~/~/ Дата смены статуса 
1531 + "description": "", ~/~/ Описание
1532 + "data": "", ~/~/ Данные
1533 + "overwrite": false, ~/~/ Флаг перезаписи
1534 + "stage": "", ~/~/ Состояние
1535 +
1536 +(% style="text-align:left" %)
1537 +(% style="color:#000000" %) }
1538 +
1539 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1540 +
385 385  (% class="box warningmessage" %)
386 386  (((
387 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1543 +(% lang="en-US" %)**PUT /api/v3/vehicles**
388 388  )))
389 389  
390 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1546 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
391 391  
392 392  (% style="color:#000000" %)Метод запроса: **PUT**
393 393  
... ... @@ -397,193 +397,2150 @@
397 397  
398 398  (% style="color:#000000" %)Параметры в теле запроса (JSON):
399 399  
400 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
1556 +(% style="color:#000000" %){
1557 + "vehicleId": , ~/~/ ID объекта
1558 + "parentId": "" , ~/~/ ID клиента
1559 + "name": "" , ~/~/ имя ТС
1560 + "imei": "" , ~/~/ IMEI
1561 + "deviceTypeId": "" , ~/~/ ID типа устройства
1562 + "modelId": "" , ~/~/ ID модели
1563 + "unitId": "" , ~/~/ ID подразделения
1564 + "sim1": "" , ~/~/ Номер SIM 1
1565 + "sim2": "" , ~/~/ Номер SIM2
1566 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1567 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1568 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1569 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1570 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1571 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1572 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1573 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1574 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1575 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1576 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1577 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
401 401  
1579 + "mileageCalcMethod": 0,
1580 + "mileageCoeff": 0,
1581 + "locationByCellId": true,
1582 + "dottedLineTrackWhenNoCoords": true,
1583 + "counters": ~/~/ счетчики
1584 + {
1585 + "mileage": "" , ~/~/ пробег
1586 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1587 + "motohours": "" , ~/~/ моточасы
1588 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1589 + },
1590 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1591 + "enabled": true, ~/~/ флаг включения
1592 + "id": "" , ~/~/ идентификатор
1593 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1594 + "login": "" , ~/~/ имя учетной записи
1595 + "password": "" ~/~/ пароль учетной записи
1596 + },
1597 + "inspectionTasks": ~/~/ задания на ТО
1598 + {
1599 + "enabled": "" , ~/~/ Признак включения
1600 + "name": "" , ~/~/ Имя задания
1601 + "description": "" , ~/~/ Описание задания
1602 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1603 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1604 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1605 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1606 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1607 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1608 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1609 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1610 + }
1611 +
1612 +"drivers": [ ~/~/ Водители
1613 + {
1614 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1615 + "isDefault": true
1616 + }
1617 + ],
1618 + "commandTemplates": [ ~/~/ Шаблон команды
1619 + {
1620 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1621 + "name": "string",
1622 + "command": "string",
1623 + "retries": 0
1624 + }
1625 + ],
1626 +
1627 + "sensors": [ ~/~/ Датчики
1628 + {
1629 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1630 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1631 + "type": 0, ~/~/ Тип датчика
1632 + "name": "string", ~/~/ Имя датчика
1633 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1634 + "inputNumber": 0, ~/~/ Номер входа
1635 + "pseudonym": "string", ~/~/ Псевдоним
1636 + "medianDegree": 0, ~/~/ Медианная фильтрация
1637 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1638 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1639 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1640 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1641 + {
1642 + "grades": [ ~/~/ Таблица тарировки 1
1643 + {
1644 + "input": 0, ~/~/ Входящее значение
1645 + "output": 0 ~/~/ Выходящее значение
1646 + }
1647 + ],
1648 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1649 + }
1650 + ],
1651 + "showInTooltip": true, ~/~/ Отображать в подсказке
1652 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1653 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1654 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1655 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1656 + "expr": "string", ~/~/ Формула
1657 + "children": [ ~/~/ массив дочерних датчиков
1658 + "string"
1659 + ],
1660 + "customParams": { ~/~/ прочие произвольные параметры
1661 + "additionalProp1": "string",
1662 + "additionalProp2": "string",
1663 + "additionalProp3": "string"
1664 + },
1665 +
1666 +~/~/ Характерные для произвольного:
1667 +
1668 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1669 +
1670 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1671 +
1672 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1673 +
1674 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1675 +
1676 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1677 +
1678 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1679 +
1680 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1681 +
1682 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1683 +
1684 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1685 +
1686 +~/~/ "ValueOn": "Вкл.",
1687 +
1688 +~/~/ "ValueOff": "Выкл."
1689 + "summaryMaxValue": 0 ~/~/ Макс. значение
1690 + }
1691 + ],
1692 + "customFields": [ ~/~/ Произвольные поля
1693 + {
1694 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1695 + "name": "string",
1696 + "value": "string",
1697 + "forClient": true,
1698 + "forTooltip": true,
1699 + "forReport": true
1700 + }
1701 + ]
1702 +}
1703 +
402 402  (% style="color:#000000" %)Ответ:
403 403  
404 404  (% lang="en-US" style="text-align:left" %)
405 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «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»: «» //Сколько раз выполнить задание } ] }
1707 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
406 406  
1709 +(% lang="en-US" style="text-align:left" %)
1710 + "vehicleId": "", ~/~/ ID ТС
1711 + "parentId": "", ~/~/ ID клиента
1712 + "name": "", ~/~/ имя ТС
1713 + "imei": "", ~/~/ IMEI
1714 + "deviceTypeId": "", ~/~/ типа устройства
1715 + "modelId": "", ~/~/ ID модели
1716 + "unitId": "", ~/~/ ID подразделения
1717 + "sim1": "", ~/~/ SIM 1
1718 + "sim2": "", ~/~/ SIM2
1719 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1720 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1721 + "counters": 
1722 + {
1723 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1724 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1725 + "mileage": "", ~/~/ пробег
1726 + "motohours": "", ~/~/ моточасы
1727 + }
1728 + "cmsv6Parameters": ~/~/ параметры CMSv6
1729 + {
1730 + "id": ~/~/ идентификатор
1731 + "enabled": true, ~/~/ флаг включения
1732 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1733 + "login": "", ~/~/ имя учетной записи
1734 + "password": "", ~/~/ пароль учетной записи
1735 + }
1736 + "inspectionTasks": ~/~/ задания на ТО
1737 + {
1738 + "id": "", ~/~/ ID задания
1739 + "enabled": false, ~/~/ Признак включения
1740 + "name": "", ~/~/ Имя задания
1741 + "description": "", ~/~/ Описание задания
1742 + "mileageCondition": "", ~/~/ Условие по пробегу
1743 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1744 + "motohoursCondition": "", ~/~/ Условие по моточасам
1745 + "lastMotohours": "", ~/~/ Моточасы
1746 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1747 + "kind": "", ~/~/ Вид периодичности по времени
1748 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1749 + }
407 407  
408 -(% class="box successmessage" %)
1751 +(% lang="en-US" style="text-align:left" %)
1752 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1753 +
1754 +**Валидация:**
1755 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1756 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1757 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1758 +
1759 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1760 +
1761 +(% class="box errormessage" %)
409 409  (((
410 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
1763 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
411 411  )))
412 412  
413 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1766 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
414 414  
415 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
1768 +(% style="color:#000000" %)Метод запроса: **DELETE**
416 416  
417 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1770 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
418 418  
419 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1772 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
420 420  
421 -(% style="color:#000000" %) информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
1774 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
422 422  
423 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
1776 +(% style="text-align:left" %)
1777 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
424 424  
425 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
1779 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
426 426  
427 -(% style="color:#000000" %)Метод запроса: **POST**
1781 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
428 428  
429 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1783 +(% class="box infomessage" %)
1784 +(((
1785 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1786 +)))
430 430  
431 -(% style="color:#000000" %)В заголовках запроса:
1788 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
432 432  
433 -(% style="color:#000000" %) Content-Type: application/json
1790 +(% style="color:#000000" %)Метод запроса: **GET**
434 434  
435 -(% style="color:#000000" %) X-Auth: Токен авторизации
1792 +(% 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]]
436 436  
437 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
1794 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
438 438  
439 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
1796 +(% style="color:#000000" %)Ответ:
440 440  
441 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
1798 +(% style="color:#000000" %){
442 442  
443 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
1800 + "deviceTypeId" : "", ~/~/ ID типа устройства
1801 + "deviceTypeName" : "" ~/~/ Название типа устройства
444 444  
445 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
1803 +(% style="text-align:left" %)
1804 +(% style="color:#000000" %)}
446 446  
447 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «si. Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
1806 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
448 448  
449 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «ime: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
1808 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
450 450  
451 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1810 +(% class="box infomessage" %)
1811 +(((
1812 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1813 +)))
452 452  
453 -(% style="color:#000000" %)0 - «Блокировка»
1815 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
454 454  
455 -(% style="color:#000000" %)1 - «Активен»,
1817 +(% style="color:#000000" %)Метод запроса: **GET**
456 456  
457 -(% style="color:#000000" %)2 - «Отменен»
1819 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
458 458  
459 -(% style="color:#000000" %)3 - «Оборудован»
1821 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
460 460  
461 -(% style="color:#000000" %)4 - «Диагностика»
1823 +(% style="color:#000000" %)Ответ:
462 462  
463 -(% style="color:#000000" %)5 - «Сервис»
1825 +(% style="color:#000000" %){
464 464  
465 -(% style="color:#000000" %)6 - «Демонтаж»
1827 + "id": "", ~/~/ ID типа датчика 
1828 + "name": "", ~/~/ Название
1829 + "description": "", ~/~/ Описание
466 466  
467 -(% style="color:#000000" %)7 - «Монтаж»
1831 +(% style="text-align:left" %)
1832 +(% style="color:#000000" %)}
468 468  
469 -(% style="color:#000000" %)8 - «Дозаказ»
1834 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
470 470  
471 -(% style="color:#000000" %)9 - «Обслужен»
1836 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
472 472  
473 -(% style="color:#000000" %)10 - «Списан»
1838 +(% class="box infomessage" style="text-align: left;" %)
1839 +(((
1840 +**POST /api/v3/terminalMessages/count**
1841 +)))
474 474  
475 -(% style="color:#000000" %)11 - «Неисправен»
1843 +(% style="text-align: left;" %)
1844 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
476 476  
477 -(% style="color:#000000" %)12 - «Проверен»
1846 +(% style="text-align: left;" %)
1847 +Метод запроса **POST**
478 478  
479 -(% style="text-align:left" %)
480 -(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
1849 +(% style="text-align: left;" %)
1850 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
481 481  
1852 +(% style="text-align: left;" %)
1853 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
482 482  
483 -(% class="box successmessage" %)
1855 +(% style="text-align: left;" %)
1856 +{
1857 + "vehicleIds": [
1858 + id ~/~/ здесь передается список идентификаторов объектов
1859 + ],
1860 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1861 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1862 +}
1863 +
1864 +(% style="text-align: left;" %)
1865 +Ответ:
1866 +
1867 +(% style="text-align: left;" %)
1868 +[
1869 + {
1870 + "vehicleId": 0, ~/~/ идентификатор объекта
1871 + "count": 0 ~/~/ количество сообщений за период
1872 + }
1873 +]
1874 +
1875 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1876 +
1877 +(% class="box infomessage" %)
484 484  (((
485 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1879 +**POST /api/v3/terminalMessages**
486 486  )))
487 487  
488 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1882 +Метод возвращает список сообщений терминала объекта за выбранный период.
489 489  
1884 +(% style="text-align: left;" %)
1885 +Метод запроса **POST**
1886 +
1887 +(% style="text-align: left;" %)
1888 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1889 +
1890 +(% style="text-align: left;" %)
1891 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1892 +
1893 +{
1894 + "vehicleId": 0, ~/~/ id объекта
1895 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1896 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1897 +}
1898 +
1899 +Ответ:
1900 +
1901 +[
1902 + {
1903 + "messages": [
1904 + {
1905 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1906 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1907 + "speed": 0, ~/~/ Скорость, км/ч
1908 + "altitude": 0, ~/~/ Высота, м
1909 + "latitude": 0, ~/~/ Широта [-90°;90°]
1910 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1911 + "satellites": 0, ~/~/ Кол-во спутников
1912 + "voltage": 0, ~/~/ Напряжение
1913 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1914 + "additionalProp1": "string",
1915 + "additionalProp2": "string",
1916 + "additionalProp3": "string"
1917 + },
1918 + "photoCount": 0 ~/~/ Кол-во фото
1919 + }
1920 + ]
1921 + }
1922 +]
1923 +
1924 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1925 +
1926 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1927 +
1928 +(% class="box infomessage" %)
1929 +(((
1930 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
1931 +)))
1932 +
490 490  (% style="color:#000000" %)Метод запроса: **POST**
491 491  
492 -(% 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}
1935 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
493 493  
494 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
1937 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
495 495  
1939 +(% style="text-align:left" %)
1940 +Тело запроса:
1941 +
1942 +{
1943 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1944 + "vehicleIds": [0], ~/~/ Список ID объектов
1945 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1946 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
1947 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
1948 +}
1949 +
1950 +Ответ:
1951 +
1952 +[
1953 + {
1954 + "vehicleId": 0, ~/~/ ID объекта
1955 + "name": "string", ~/~/ Имя ТС
1956 + "periods": [ ~/~/ Периоды
1957 + {
1958 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1959 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1960 + "mileageBegin": 0, ~/~/ Пробег на начало периода
1961 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
1962 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1963 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
1964 + }
1965 + ]
1966 + }
1967 +]
1968 +
1969 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
1970 +
1971 +(% class="box infomessage" %)
1972 +(((
1973 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
1974 +)))
1975 +
1976 +(% style="color:#000000" %)Метод запроса: **POST**
1977 +
1978 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
1979 +
496 496  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
497 497  
498 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
1982 +(% style="text-align:left" %)
1983 +Тело запроса:
499 499  
500 -(% class="western" %)
501 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
502 - "date": "", // Дата смены статуса (null если сменить немедленно)
503 - "description": "", // Описание
504 - "data": "", // Данные
505 - "overwrite": false, // Флаг перезаписи
506 - "stage": "", // Состояние, может быть null}}}
1985 +{
1986 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1987 + "vehicleIds": [0], ~/~/ Список ID объектов
1988 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1989 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
1990 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
1991 +}
507 507  
508 -(% style="color:#000000" %)}
1993 +Ответ:
509 509  
510 -(% style="color:#000000" %)Ответ: {
1995 +[
1996 + {
1997 + "vehicleId": 0, ~/~/ ID объекта
1998 + "name": "string", ~/~/ Имя ТС
1999 + "periods": [ ~/~/ Периоды
2000 + {
2001 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2002 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2003 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2004 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2005 + "fuelConsumption": 0, ~/~/ Расход топлива
2006 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2007 + }
2008 + ]
2009 + }
2010 +]
511 511  
512 -(% class="western" %)
513 -{{{ "status": "", // значение статуса
514 - "date": "", // Дата смены статуса
515 - "description": "", // Описание
516 - "data": "", // Данные
517 - "overwrite": false, // Флаг перезаписи
518 - "stage": "", // Состояние}}}
2012 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
519 519  
2014 +(% class="box infomessage" %)
2015 +(((
2016 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2017 +)))
2018 +
2019 +(% style="color:#000000" %)Метод запроса: **POST**
2020 +
2021 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2022 +
2023 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2024 +
520 520  (% style="text-align:left" %)
521 -(% style="color:#000000" %)}
2026 +Тело запроса:
522 522  
2028 +{
2029 + "vehicleIds": [0], ~/~/ Список ID объектов
2030 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2031 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2032 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2033 +}
523 523  
524 -(% class="box" lang="en-US" style="text-align: center;" %)
2035 +Ответ:
2036 +
2037 +[
2038 + {
2039 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2040 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2041 + "vehicleId": 0, ~/~/ ID объекта
2042 + "name": "string", ~/~/ Имя объекта
2043 + "model": "string", ~/~/ Модель объекта
2044 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2045 + {
2046 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2047 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2048 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2049 + "valueFuel": 0, ~/~/ Количество
2050 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2051 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2052 + }
2053 + ]
2054 + }
2055 +]
2056 +
2057 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2058 +
2059 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2060 +
2061 +(% class="box infomessage" %)
525 525  (((
526 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
2063 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
527 527  )))
528 528  
2066 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2067 +
2068 +(% style="color:#000000" %)Метод запроса: **POST**
2069 +
2070 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2071 +
2072 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2073 +
2074 +(% style="text-align:left" %)
2075 +Тело запроса:
2076 +
2077 +(% style="text-align:left" %)
2078 +{
2079 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2080 +}
2081 +
2082 +(% style="text-align:left" %)
2083 +Ответ:
2084 +
2085 +[
2086 + {
2087 + "id": 0, ~/~/ Идентификатор объекта геозоны
2088 + "name": "string", ~/~/ Название объекта геозоны
2089 + "type": 0, ~/~/ Тип объекта геозоны
2090 + "fname": "string", ~/~/ Имя файла
2091 + "parentId": "string", ~/~/ Идентификатор клиента
2092 + "radius": 0, ~/~/ Радиус геообъекта
2093 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2094 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2095 + "description": "string", ~/~/ Описание
2096 + "area": 0, ~/~/ Площадь, м^^2^^
2097 + "perimetr": 0, ~/~/ Периметр, м
2098 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2099 + }
2100 +]
2101 +
2102 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2103 +
529 529  (% class="box infomessage" %)
530 530  (((
531 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
2106 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
532 532  )))
533 533  
534 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе бязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
2109 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
535 535  
536 -(% style="color:#000000" %)Метод запроса: **GET**
2111 +(% style="color:#000000" %)Метод запроса: **POST**
537 537  
538 -(% 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]]
2113 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
539 539  
540 540  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
541 541  
542 -(% style="color:#000000" %)Ответ: [
2117 +(% style="text-align:left" %)
2118 +Тело запроса:
543 543  
544 -(% class="western" %)
545 -{{{ {
546 - "deviceTypeId" : "", // ID типа устройства
547 - "deviceTypeName" : "" // Название типа устройства
548 - },}}}
2120 +{
2121 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2122 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2123 + "ids": [ ], ~/~/ Массив id объектов
2124 + "byTime": 0, ~/~/ Объединение событий по времени 
2125 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2126 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2127 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2128 +}
549 549  
2130 +Ответ:
2131 +[
2132 + {
2133 + "geozoneId": 0, ~/~/ ID геообъекта
2134 + "geozoneName": "string", ~/~/ Название геообъекта
2135 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2136 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2137 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2138 + "vehicleId": 0, ~/~/ ID объекта
2139 + "vehicleName": "string" ~/~/ Имя объекта
2140 + }
2141 +]
2142 +
2143 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2144 +
2145 +(% class="box infomessage" %)
2146 +(((
2147 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2148 +)))
2149 +
2150 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2151 +
2152 +(% style="color:#000000" %)Метод запроса: **POST**
2153 +
2154 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2155 +
2156 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2157 +
550 550  (% style="text-align:left" %)
551 -(% style="color:#000000" %)…** **]
2159 +Тело запроса:
552 552  
2161 +{
2162 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2163 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2164 + "ids": [ ], ~/~/ Массив id геообъектов
2165 + "byTime": 0, ~/~/ Объединение событий по времени 
2166 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2167 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2168 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2169 +}
553 553  
554 -(% class="box" style="text-align: center;" %)
2171 +Ответ:
2172 +
2173 +[
2174 + {
2175 + "geozoneId": 0, ~/~/ ID геообъекта
2176 + "geozoneName": "string", ~/~/ Название геообъекта
2177 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2178 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2179 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2180 + "vehicleId": 0, ~/~/ ID объекта
2181 + "vehicleName": "string" ~/~/ Имя объекта
2182 + }
2183 +]
2184 +
2185 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2186 +
2187 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2188 +
2189 +(% class="box infomessage" %)
555 555  (((
556 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
2191 +**POST /api/v3/notifications/find**
557 557  )))
558 558  
2194 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2195 +
2196 +(% style="text-align: left;" %)
2197 +Метод запроса **POST**
2198 +
2199 +(% style="text-align: left;" %)
2200 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2201 +
2202 +(% style="text-align: left;" %)
2203 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2204 +
2205 +{
2206 + "parentId": "" ~/~/ id клиента
2207 +}
2208 +
2209 +Ответ:
2210 +
2211 +[
2212 + {
2213 + "id": 0, ~/~/ ID уведомления
2214 + "name": "string", ~/~/ Название уведомления
2215 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2216 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2217 + "userId": "", ~/~/ Пользователь, создавший уведомление
2218 + "parentId": "", ~/~/ Идентификатор клиента
2219 + "parentName": "string" ~/~/ Имя клиента
2220 + }
2221 +]
2222 +
2223 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2224 +
559 559  (% class="box infomessage" %)
560 560  (((
561 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
2227 +**GET /api/v3/notifications/{id}**
562 562  )))
563 563  
564 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
2230 +Метод возвращает данные правил формирования выбранного уведомления.
565 565  
566 -(% style="color:#000000" %)Метод запроса: **GET**
2232 +(% style="text-align: left;" %)
2233 +Метод запроса **GET**
567 567  
568 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2235 +(% style="text-align: left;" %)
2236 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
569 569  
570 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
2238 +(% style="text-align: left;" %)
2239 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
571 571  
572 -(% style="color:#000000" %)Ответ: [
2241 +(% style="text-align: left;" %)
2242 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
573 573  
574 -(% class="western" style="margin-bottom:19px" %)
575 -{{{ {}}}
2244 +(% style="text-align: left;" %)
2245 +(% style="color:#000000" %)Ответ:
576 576  
577 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
2247 +(% style="text-align: left;" %)
2248 +(% style="color:#000000" %){
2249 + "id": 0, ~/~/ (%%)id уведомления
2250 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2251 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2252 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2253 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2254 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2255 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2256 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2257 +(% style="color:#000000" %) 0
2258 + ],
2259 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2260 +(% style="color:#000000" %) 0
2261 + ],
2262 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
2263 +(% style="color:#000000" %) 0
2264 + ],
2265 + "settings": { ~/~/ Список параметров уведомления
2266 + "additionalProp1": "string",
2267 + "additionalProp2": "string",
2268 + "additionalProp3": "string"
2269 + },
2270 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2271 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2272 +(% style="color:#000000" %) ""
2273 + ],
2274 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2275 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2276 +(% style="color:#000000" %) "string"
2277 + ],
2278 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2279 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2280 +(% style="color:#000000" %) {
2281 + "id": 0, ~/~/ (%%)Идентификатор участника чата
2282 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2283 +(% style="color:#000000" %) }
2284 + ],
2285 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2286 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2287 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2288 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2289 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2290 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2291 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2292 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2293 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2294 +(% style="color:#000000" %)}
578 578  
579 -(% class="western" %)
580 -{{{ "description": "" // Описание
581 - },}}}
2296 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
582 582  
583 -(% style="text-align:left" %)
584 -(% style="color:#000000" %)… ]
2298 +(% class="box warningmessage" %)
2299 +(((
2300 +**PUT /api/v3/notifications/**
2301 +)))
585 585  
2303 +Метод позволяет отредактировать уведомление.
586 586  
2305 +Метод запроса **PUT**
2306 +
2307 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2308 +
2309 +В заголовках запроса: X-Auth: Токен авторизации
2310 +
2311 +Тело запроса:
2312 +{
2313 + "id": 0, ~/~/ id уведомления
2314 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2315 + "userId": "", ~/~/ Пользователь, создавший уведомление
2316 + "parentId": "", ~/~/ Идентификатор клиента
2317 + "parentName": "string", ~/~/ Имя клиента
2318 + "name": "string", ~/~/ Название уведомления
2319 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2320 + "vehicleIds": [ ~/~/ Список id объектов для анализа
2321 + 0
2322 + ],
2323 + "geoids": [ ~/~/ Список id геообъектов для анализа
2324 + 0
2325 + ],
2326 + "fieldids": [ ~/~/ Список id полей для анализа
2327 + 0
2328 + ],
2329 + "settings": { ~/~/ Список параметров уведомления
2330 + "additionalProp1": "string",
2331 + "additionalProp2": "string",
2332 + "additionalProp3": "string"
2333 + },
2334 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2335 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2336 + ""
2337 + ],
2338 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2339 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2340 + "string"
2341 + ],
2342 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2343 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2344 + {
2345 + "id": 0, ~/~/ Идентификатор участника чата
2346 + "info": "string" ~/~/ Дополнительные сведения
2347 + }
2348 + ],
2349 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2350 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2351 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2352 + "kind": 0, ~/~/ Определяет вид уведомления
2353 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2354 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2355 + "timezone": 0, ~/~/ Сдвиг часового пояса
2356 + "validity": 0, ~/~/ Срок действия в днях (1-90)
2357 + "autoProlongation": true ~/~/ Автопродление срока действия
2358 +}
2359 +
2360 +Ответ:
2361 +
2362 +Success
2363 +
2364 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2365 +
2366 +(% class="box errormessage" %)
2367 +(((
2368 +**DELETE /api/v3/notifications/{id}**
2369 +)))
2370 +
2371 +Метод позволяет удалить выбранное уведомление.
2372 +
2373 +Метод запроса **DELETE**
2374 +
2375 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2376 +
2377 +Передаваемый параметр: {id} - id уведомления
2378 +
2379 +В заголовках запроса: X-Auth: Токен авторизации
2380 +
2381 +Ответ:
2382 +
2383 +Success
2384 +
2385 +
2386 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2387 +
2388 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2389 +
2390 +(% class="box infomessage" %)
2391 +(((
2392 +**POST /api/v3/Drivers/find**
2393 +)))
2394 +
2395 +Передается параметр: parentId - ID клиента-родителя
2396 +
2397 +Ответ:
2398 +
2399 +[
2400 + {
2401 + "name": "string", ~/~/ Определяет наименование
2402 + "description": "string", ~/~/ Определяет описание
2403 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2404 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2405 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2406 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2407 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2408 + "deleted": true ~/~/ Признак удаления
2409 + }
2410 +]
2411 +
2412 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2413 +
2414 +(% class="box infomessage" %)
2415 +(((
2416 +**GET /api/v3/Drivers/{driverGuid}**
2417 +)))
2418 +
2419 +Передается параметр: ID водителя
2420 +
2421 +Ответ:
2422 +
2423 +{
2424 + "name": "string", ~/~/ Определяет наименование
2425 + "description": "string", ~/~/ Определяет описание
2426 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2427 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2428 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2429 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2430 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2431 + "deleted": true ~/~/ Признак удаления
2432 +}
2433 +
2434 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2435 +
2436 +(% class="box successmessage" %)
2437 +(((
2438 +**POST /api/v3/Drivers**
2439 +)))
2440 +
2441 +Запрос:
2442 +
2443 +{
2444 + "name": "string",
2445 + "description": "string",
2446 + "hiredate": "2023-06-30T12:50:54.020Z",
2447 + "chopdate": "2023-06-30T12:50:54.020Z",
2448 + "exclusive": true,
2449 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2450 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2451 + "deleted": true
2452 +}
2453 +
2454 +Ответ:
2455 +
2456 +{
2457 + "name": "string",
2458 + "description": "string",
2459 + "hiredate": "2023-06-30T12:50:54.051Z",
2460 + "chopdate": "2023-06-30T12:50:54.051Z",
2461 + "exclusive": true,
2462 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2463 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2464 + "deleted": true
2465 +}
2466 +
2467 +
2468 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2469 +
2470 +(% class="box warningmessage" %)
2471 +(((
2472 +**PUT /api/v3/Drivers**
2473 +)))
2474 +
2475 +Запрос:
2476 +
2477 +{
2478 + "name": "string",
2479 + "description": "string",
2480 + "hiredate": "2023-06-30T12:50:27.910Z",
2481 + "chopdate": "2023-06-30T12:50:27.910Z",
2482 + "exclusive": true,
2483 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2484 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2485 + "deleted": true
2486 +}
2487 +
2488 +Ответ:
2489 +
2490 +{
2491 + "name": "string",
2492 + "description": "string",
2493 + "hiredate": "2023-06-30T12:50:27.929Z",
2494 + "chopdate": "2023-06-30T12:50:27.929Z",
2495 + "exclusive": true,
2496 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2497 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2498 + "deleted": true
2499 +}
2500 +
2501 +
2502 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2503 +
2504 +(% class="box errormessage" %)
2505 +(((
2506 +**DELETE /api/v3/Drivers/{driverGuid}**
2507 +)))
2508 +
2509 +Передается параметр: ID водителя
2510 +
2511 +Ответ:
2512 +
2513 +Success
2514 +
2515 +
2516 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2517 +
2518 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2519 +
2520 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2521 +
2522 +(% class="box infomessage" %)
2523 +(((
2524 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2525 +)))
2526 +
2527 +Запрос:
2528 +
2529 +{
2530 + "Ids": [
2531 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2532 + ],
2533 + "BeginTime": "2023-06-30T12:49:04.365Z",
2534 + "EndTime": "2023-06-30T12:49:04.365Z"
2535 +}
2536 +
2537 +Ответ:
2538 +
2539 +[
2540 + {
2541 + "VehicleId": 0,
2542 + "CreateTime": "2023-06-30T09:52:31.240Z",
2543 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2544 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2545 + "BeginTime": "2023-06-30T09:52:31.240Z",
2546 + "EndTime": "2023-06-30T09:52:31.240Z"
2547 + }
2548 +]
2549 +
2550 +
2551 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2552 +
2553 +(% class="box infomessage" %)
2554 +(((
2555 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2556 +)))
2557 +
2558 +Запрос:
2559 +
2560 +{
2561 + "Ids": [
2562 + 0
2563 + ],
2564 + "BeginTime": "2023-06-30T12:48:39.419Z",
2565 + "EndTime": "2023-06-30T12:48:39.419Z"
2566 +}
2567 +
2568 +Ответ:
2569 +
2570 +[
2571 + {
2572 + "VehicleId": 0,
2573 + "CreateTime": "2023-06-30T09:54:01.631Z",
2574 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2575 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2576 + "BeginTime": "2023-06-30T09:54:01.631Z",
2577 + "EndTime": "2023-06-30T09:54:01.631Z"
2578 + }
2579 +]
2580 +
2581 +
2582 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2583 +
2584 +(% class="box successmessage" %)
2585 +(((
2586 +**POST /api/v3/DriversVehiclesAssignments**
2587 +)))
2588 +
2589 +Передается массив назначений
2590 +
2591 +Запрос:
2592 +
2593 +[
2594 + {
2595 + "VehicleId": 0, ~/~/ Идентификатор объекта
2596 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2597 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2598 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2599 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2600 + }
2601 +]
2602 +
2603 +Ответ:
2604 +
2605 +[
2606 + {
2607 + "VehicleId": 0,
2608 + "CreateTime": "2023-06-30T11:04:46.903Z",
2609 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2610 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2611 + "BeginTime": "2023-06-30T11:04:46.903Z",
2612 + "EndTime": "2023-06-30T11:04:46.903Z"
2613 + }
2614 +]
2615 +
2616 +
2617 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2618 +
2619 +(% class="box warningmessage" %)
2620 +(((
2621 +**PUT /api/v3/DriversVehiclesAssignments**
2622 +)))
2623 +
2624 +Запрос:
2625 +
2626 +[
2627 + {
2628 + "VehicleId": 0,
2629 + "CreateTime": "2023-06-30T11:14:08.117Z",
2630 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2631 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2632 + "BeginTime": "2023-06-30T11:14:08.117Z",
2633 + "EndTime": "2023-06-30T11:14:08.117Z"
2634 + }
2635 +]
2636 +
2637 +Ответ:
2638 +
2639 +[
2640 + {
2641 + "VehicleId": 0,
2642 + "CreateTime": "2023-06-30T11:14:53.349Z",
2643 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2644 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2645 + "BeginTime": "2023-06-30T11:14:53.349Z",
2646 + "EndTime": "2023-06-30T11:14:53.349Z"
2647 + }
2648 +]
2649 +
2650 +
2651 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2652 +
2653 +(% class="box errormessage" %)
2654 +(((
2655 +**DELETE /api/v3/DriversVehiclesAssignments**
2656 +)))
2657 +
2658 +Запрос:
2659 +
2660 +[
2661 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2662 +]
2663 +
2664 +Ответ:
2665 +
2666 +Success
2667 +
2668 +
2669 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2670 +
2671 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2672 +
2673 +(% class="box infomessage" %)
2674 +(((
2675 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2676 +)))
2677 +
2678 +Запрос:
2679 +
2680 +{
2681 + "Ids": [
2682 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2683 + ],
2684 + "BeginTime": "2023-06-30T12:47:12.162Z",
2685 + "EndTime": "2023-06-30T12:47:12.162Z"
2686 +}
2687 +
2688 +Ответ:
2689 +
2690 +[
2691 + {
2692 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2693 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2694 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2695 + "BeginTime": "2023-06-30T11:19:40.703Z",
2696 + "EndTime": "2023-06-30T11:19:40.703Z"
2697 + }
2698 +]
2699 +
2700 +
2701 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2702 +
2703 +(% class="box infomessage" %)
2704 +(((
2705 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2706 +)))
2707 +
2708 +Запрос:
2709 +
2710 +{
2711 + "Ids": [
2712 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2713 + ],
2714 + "BeginTime": "2023-06-30T12:47:12.162Z",
2715 + "EndTime": "2023-06-30T12:47:12.162Z"
2716 +}
2717 +
2718 +Ответ:
2719 +
2720 +[
2721 + {
2722 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2723 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2724 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2725 + "BeginTime": "2023-06-30T11:19:40.703Z",
2726 + "EndTime": "2023-06-30T11:19:40.703Z"
2727 + }
2728 +]
2729 +
2730 +
2731 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2732 +
2733 +(% class="box successmessage" %)
2734 +(((
2735 +**POST /api/v3/DriversRfidsAssignments**
2736 +)))
2737 +
2738 +Запрос:
2739 +
2740 +[
2741 + {
2742 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2743 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2744 + "BeginTime": "2023-06-30T11:27:08.635Z",
2745 + "EndTime": "2023-06-30T11:27:08.635Z"
2746 + }
2747 +]
2748 +
2749 +Ответ:
2750 +
2751 +[
2752 + {
2753 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2754 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2755 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2756 + "BeginTime": "2023-06-30T11:27:08.677Z",
2757 + "EndTime": "2023-06-30T11:27:08.677Z"
2758 + }
2759 +]
2760 +
2761 +
2762 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2763 +
2764 +(% class="box warningmessage" %)
2765 +(((
2766 +**PUT /api/v3/DriversRfidsAssignments**
2767 +)))
2768 +
2769 +Запрос:
2770 +
2771 +[
2772 + {
2773 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2774 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2775 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2776 + "BeginTime": "2023-06-30T11:28:43.330Z",
2777 + "EndTime": "2023-06-30T11:28:43.330Z"
2778 + }
2779 +]
2780 +
2781 +Ответ:
2782 +
2783 +[
2784 + {
2785 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2786 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2788 + "BeginTime": "2023-06-30T11:28:43.331Z",
2789 + "EndTime": "2023-06-30T11:28:43.331Z"
2790 + }
2791 +]
2792 +
2793 +
2794 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2795 +
2796 +(% class="box errormessage" %)
2797 +(((
2798 +**DELETE /api/v3/DriversRfidsAssignments**
2799 +)))
2800 +
2801 +Запрос:
2802 +
2803 +[
2804 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2805 +]
2806 +
2807 +Ответ:
2808 +
2809 +Success
2810 +
2811 +
2812 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2813 +
2814 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2815 +
2816 +(% class="box infomessage" %)
2817 +(((
2818 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2819 +)))
2820 +
2821 +Запрос:
2822 +
2823 +{
2824 + "Ids": [
2825 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2826 + ],
2827 + "BeginTime": "2023-06-30T12:45:10.852Z",
2828 + "EndTime": "2023-06-30T12:45:10.852Z"
2829 +}
2830 +
2831 +Ответ:
2832 +
2833 +[
2834 + {
2835 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2836 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2837 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2838 + "BeginTime": "2023-06-30T11:58:04.695Z",
2839 + "EndTime": "2023-06-30T11:58:04.695Z"
2840 + }
2841 +]
2842 +
2843 +
2844 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2845 +
2846 +(% class="box infomessage" %)
2847 +(((
2848 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2849 +)))
2850 +
2851 +Запрос:
2852 +
2853 +{
2854 + "Ids": [
2855 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2856 + ],
2857 + "BeginTime": "2023-06-30T12:45:10.852Z",
2858 + "EndTime": "2023-06-30T12:45:10.852Z"
2859 +}
2860 +
2861 +Ответ:
2862 +
2863 +[
2864 + {
2865 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2866 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2867 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2868 + "BeginTime": "2023-06-30T11:58:04.695Z",
2869 + "EndTime": "2023-06-30T11:58:04.695Z"
2870 + }
2871 +]
2872 +
2873 +
2874 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2875 +
2876 +(% class="box successmessage" %)
2877 +(((
2878 +**POST /api/v3/DriversFuelCardsAssignments**
2879 +)))
2880 +
2881 +Запрос:
2882 +
2883 +[
2884 + {
2885 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2886 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2887 + "BeginTime": "2023-06-30T12:09:53.175Z",
2888 + "EndTime": "2023-06-30T12:09:53.175Z"
2889 + }
2890 +]
2891 +
2892 +Ответ:
2893 +
2894 +[
2895 + {
2896 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2897 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2898 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2899 + "BeginTime": "2023-06-30T12:09:53.201Z",
2900 + "EndTime": "2023-06-30T12:09:53.201Z"
2901 + }
2902 +]
2903 +
2904 +
2905 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2906 +
2907 +(% class="box warningmessage" %)
2908 +(((
2909 +**PUT /api/v3/DriversFuelCardsAssignments**
2910 +)))
2911 +
2912 +Запрос:
2913 +
2914 +[
2915 + {
2916 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2917 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2918 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2919 + "BeginTime": "2023-06-30T12:09:53.201Z",
2920 + "EndTime": "2023-06-30T12:09:53.201Z"
2921 + }
2922 +]
2923 +
2924 +Ответ:
2925 +
2926 +[
2927 + {
2928 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2929 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2930 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2931 + "BeginTime": "2023-06-30T12:09:53.201Z",
2932 + "EndTime": "2023-06-30T12:09:53.201Z"
2933 + }
2934 +]
2935 +
2936 +
2937 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2938 +
2939 +(% class="box errormessage" %)
2940 +(((
2941 +**DELETE /api/v3/DriversFuelCardsAssignments**
2942 +)))
2943 +
2944 +Запрос:
2945 +
2946 +[
2947 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2948 +]
2949 +
2950 +Ответ:
2951 +
2952 +Success
2953 +
2954 +
2955 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
2956 +
2957 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
2958 +
2959 +(% class="box infomessage" %)
2960 +(((
2961 +**POST /api/v3/Trailers**
2962 +)))
2963 +
2964 +Пример запроса:
2965 +
2966 +{
2967 + "startDate": "2023-11-14T10:48:03.671Z",
2968 + "endDate": "2023-11-14T10:48:03.671Z",
2969 + "ids": [ 0 ],
2970 + "timezone": 0
2971 +}
2972 +
2973 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2974 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
2975 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
2976 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
2977 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
2978 +
2979 +Пример ответа:
2980 +
2981 +[
2982 + {
2983 + "SD": "2023-11-14T10:48:03.717Z",
2984 + "ED": "2023-11-14T10:48:03.717Z", 
2985 + "id": 0,
2986 + "SLat": 0,
2987 + "SLon": 0,
2988 + "ELat": 0,
2989 + "ELon": 0,
2990 + "mileage": 0
2991 + "Duration": 0
2992 + "Address": "string",
2993 + "Address2": "string",
2994 + "name": "string",
2995 + "rid": "string",
2996 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2997 + "trailer": {
2998 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2999 + "Number": "string",
3000 + "Description": "string",
3001 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3002 + "ExternalID": "string",
3003 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3004 + "CreateTime": "2023-11-14T10:48:03.717Z",
3005 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3006 + "IsDeleted": true
3007 + },
3008 + "filesCount": 0,
3009 + }
3010 +]
3011 +
3012 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3013 +|SD|Дата и время начала события
3014 +|ED|Дата и время окончания события
3015 +|id|ID объекта
3016 +|SLat|Широта начальной координаты
3017 +|SLon|Долгота начальной координаты
3018 +|ELat|Широта конечной координаты
3019 +|ELon|Долгота конечной координаты
3020 +|mileage|Пробег
3021 +|Duration|Продолжительность
3022 +|Address|Адрес начального местоположения
3023 +|Address2|Адрес конечного местоположения
3024 +|name|Имя радиометки
3025 +|rid|Номер радиометки
3026 +|rguid|ID радиометки
3027 +|trailer|Информация об агрегате
3028 +|ModelGuid|ID агрегата
3029 +|Number|Название/номер агрегата
3030 +|Description|Текст примечания агрегата
3031 +
3032 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3033 +
3034 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3035 +
3036 +(% class="box infomessage" %)
3037 +(((
3038 +**POST /api/v3/Rfids/find**
3039 +)))
3040 +
3041 +Запрос:
3042 +
3043 +{
3044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3045 +}
3046 +
3047 +Ответ:
3048 +
3049 +[
3050 + {
3051 + "name": "string",
3052 + "number": 0,
3053 + "period": 0,
3054 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3055 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3056 + }
3057 +]
3058 +
3059 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3060 +|parentId|ID клиента
3061 +|name|Название карты-метки
3062 +|number|Номер
3063 +|period|Период запросов в секундах (работает только для агрегатов)
3064 +|id|ID карты-метки
3065 +
3066 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3067 +
3068 +(% class="box infomessage" %)
3069 +(((
3070 +**GET /api/v3/Rfids/{rfidGuid}**
3071 +)))
3072 +
3073 +Передаем параметр rfidGuid - идентификатор карты-метки
3074 +
3075 +Ответ:
3076 +
3077 +[
3078 + {
3079 + "name": "string",
3080 + "number": 0,
3081 + "period": 0,
3082 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 + }
3085 +]
3086 +
3087 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3088 +|name|Название карты-метки
3089 +|number|Номер
3090 +|period|Период запросов в секундах (работает только для агрегатов)
3091 +|id|ID карты-метки
3092 +|parentId|ID клиента
3093 +
3094 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3095 +
3096 +(% class="box successmessage" %)
3097 +(((
3098 +**POST /api/v3/Rfids**
3099 +)))
3100 +
3101 +Запрос:
3102 +
3103 +{
3104 + "name": "string",
3105 + "number": 0,
3106 + "period": 0,
3107 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3108 +}
3109 +
3110 +Ответ:
3111 +
3112 +{
3113 + "name": "string",
3114 + "number": 0,
3115 + "period": 0,
3116 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3117 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3118 +}
3119 +
3120 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3121 +|name|Название карты-метки
3122 +|number|Номер
3123 +|period|Период запросов в секундах (работает только для агрегатов)
3124 +|id|ID карты-метки
3125 +|parentId|ID клиента
3126 +
3127 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3128 +
3129 +(% class="box warningmessage" %)
3130 +(((
3131 +**PUT /api/v3/Rfids**
3132 +)))
3133 +
3134 +Запрос:
3135 +
3136 +{
3137 + "name": "string",
3138 + "number": 0,
3139 + "period": 0,
3140 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3141 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3142 +}
3143 +
3144 +Ответ:
3145 +
3146 +{
3147 + "name": "string",
3148 + "number": 0,
3149 + "period": 0,
3150 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 +}
3153 +
3154 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3155 +|name|Название карты-метки
3156 +|number|Номер
3157 +|period|Период запросов в секундах (работает только для агрегатов)
3158 +|id|ID карты-метки
3159 +|parentId|ID клиента
3160 +
3161 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3162 +
3163 +(% class="box errormessage" %)
3164 +(((
3165 +**DELETE /api/v3/Rfids/{rfidGuid}**
3166 +)))
3167 +
3168 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3169 +
3170 +Ответ:
3171 +
3172 +Success
3173 +
3174 +
3175 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3176 +
3177 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3178 +
3179 +(% class="box infomessage" %)
3180 +(((
3181 +**GET /api/v3/Billing/client/balance/{clientId}**
3182 +)))
3183 +
3184 +Параметр запроса: **clientId **- идентификатор клиента.
3185 +
3186 +Ответ:
3187 +
3188 +{
3189 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3190 + "Balance": 0
3191 +}
3192 +
3193 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3194 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3195 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3196 +
3197 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3198 +
3199 +(% class="box infomessage" %)
3200 +(((
3201 +**GET /api/v3/Billing/client/constraint/{clientId}**
3202 +)))
3203 +
3204 +Параметр запроса: **clientId **- идентификатор клиента.
3205 +
3206 +Ответ:
3207 +
3208 +{
3209 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3210 + "CalculationType": 0,
3211 + "PermissibleBalance": 0,
3212 + "DefermentDays": 0,
3213 + "SendUiNotifications": true,
3214 + "SendEmailNotifications": true,
3215 + "IsPrivate": true,
3216 +}
3217 +
3218 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3219 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3220 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3221 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3222 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3223 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3224 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3225 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3226 +
3227 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3228 +
3229 +(% class="box infomessage" %)
3230 +(((
3231 +**GET /api/v3/Billing/client/plan/{clientId}**
3232 +)))
3233 +
3234 +Параметры запроса:
3235 +
3236 +**clientId **- идентификатор клиента.
3237 +
3238 +**planId **- идентификатор тарифного плана.
3239 +
3240 +Ответ:
3241 +
3242 +{
3243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3244 + "Plan": { **~/~/ Описание тарифного плана**
3245 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 + "Name": "string",
3248 + "IsArchived": true,
3249 + "Constraint": {
3250 + "CalculationType": 0,
3251 + "PermissibleBalance": 0,
3252 + "DefermentDays": 0
3253 + },
3254 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3255 + {
3256 + "Feature": "string",
3257 + "IsFactual": true,
3258 + "Limit": 0,
3259 + "Price": 0,
3260 + "PeriodValue": 0,
3261 + "PeriodType": 0
3262 + }
3263 + ]
3264 + },
3265 + "DebitDate": "2023-10-18T12:46:24.213Z",
3266 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3267 + {
3268 + "Feature": "string",
3269 + "IsEnabled": true,
3270 + "IsPrivate": true,
3271 + "IsFactual": true,
3272 + "Limit": 0,
3273 + "Price": 0,
3274 + "DebitDate": "2023-10-18T12:46:24.213Z",
3275 + "PeriodValue": 0,
3276 + "PeriodType": 0
3277 + }
3278 + ]
3279 +}
3280 +
3281 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3282 +|ClientId|Идентификатор клиента
3283 +|Id|Идентификатор тарифного плана
3284 +|OwnerId|Идентификатор клиента-владельца
3285 +|Name|Наименование тарифного плана
3286 +|IsArchived|Признак, определяющий архивный тарифный план
3287 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3288 +|PermissibleBalance|Допустимый баланс
3289 +|DefermentDays|Отсрочка, количество дней
3290 +|Feature|Код услуги
3291 +|IsEnabled|Признак, определяющий активирована ли услуга
3292 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3293 +|IsFactual|Признак, определяющий расчёт по факту
3294 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3295 +|Price|Цена за единицу.
3296 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3297 +|PeriodValue|Значение периода.
3298 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3299 +
3300 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3301 +
3302 +(% class="box infomessage" %)
3303 +(((
3304 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3305 +)))
3306 +
3307 +Параметр запроса: **clientId **- идентификатор клиента.
3308 +
3309 +Ответ:
3310 +
3311 +[
3312 + {
3313 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3314 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 + "Name": "string",
3316 + "IsArchived": true,
3317 + "Constraint": {
3318 + "CalculationType": 0,
3319 + "PermissibleBalance": 0,
3320 + "DefermentDays": 0
3321 + },
3322 + "Features": [
3323 + {
3324 + "Feature": "string",
3325 + "IsFactual": true,
3326 + "Limit": 0,
3327 + "Price": 0,
3328 + "PeriodValue": 0,
3329 + "PeriodType": 0
3330 + }
3331 + ]
3332 + }
3333 +]
3334 +
3335 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3336 +|ClientId|Идентификатор клиента
3337 +|Id|Идентификатор тарифного плана
3338 +|OwnerId|Идентификатор клиента-владельца
3339 +|Name|Наименование тарифного плана
3340 +|IsArchived|Признак, определяющий архивный тарифный план
3341 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3342 +|PermissibleBalance|Допустимый баланс
3343 +|DefermentDays|Отсрочка, количество дней
3344 +|Feature|Код услуги
3345 +|IsFactual|Признак, определяющий расчёт по факту
3346 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3347 +|Price|Цена за единицу.
3348 +|PeriodValue|Значение периода.
3349 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3350 +
3351 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3352 +
3353 +(% class="box infomessage" %)
3354 +(((
3355 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3356 +)))
3357 +
3358 +Параметр запроса: **clientId **- идентификатор клиента.
3359 +
3360 +Ответ:
3361 +
3362 +[
3363 + {
3364 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3365 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3366 + "Name": "string",
3367 + "IsArchived": true,
3368 + "Constraint": {
3369 + "CalculationType": 0,
3370 + "PermissibleBalance": 0,
3371 + "DefermentDays": 0
3372 + },
3373 + "Features": [
3374 + {
3375 + "Feature": "string",
3376 + "IsFactual": true,
3377 + "Limit": 0,
3378 + "Price": 0,
3379 + "PeriodValue": 0,
3380 + "PeriodType": 0
3381 + }
3382 + ]
3383 + }
3384 +]
3385 +
3386 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3387 +|ClientId|Идентификатор клиента
3388 +|Id|Идентификатор тарифного плана
3389 +|OwnerId|Идентификатор клиента-владельца
3390 +|Name|Наименование тарифного плана
3391 +|IsArchived|Признак, определяющий архивный тарифный план
3392 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3393 +|PermissibleBalance|Допустимый баланс
3394 +|DefermentDays|Отсрочка, количество дней
3395 +|Feature|Код услуги
3396 +|IsFactual|Признак, определяющий расчёт по факту
3397 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3398 +|Price|Цена за единицу.
3399 +|PeriodValue|Значение периода.
3400 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3401 +
3402 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3403 +
3404 +(% class="box warningmessage" %)
3405 +(((
3406 +**PUT /api/v3/Billing/client/balance**
3407 +)))
3408 +
3409 +Тело запроса:
3410 +
3411 +{
3412 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 + "Balance": 0
3414 +}
3415 +
3416 +Ответ: Success
3417 +
3418 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3419 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3420 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3421 +
3422 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3423 +
3424 +(% class="box warningmessage" %)
3425 +(((
3426 +**PUT /api/v3/Billing/client/constraint**
3427 +)))
3428 +
3429 +Тело запроса:
3430 +
3431 +{
3432 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3433 + "CalculationType": 0,
3434 + "PermissibleBalance": 0,
3435 + "DefermentDays": 0,
3436 + "SendUiNotifications": true,
3437 + "SendEmailNotifications": true,
3438 + "IsPrivate": true,
3439 +}
3440 +
3441 +Ответ: Success
3442 +
3443 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3444 +|ClientId|Идентификатор клиента
3445 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3446 +|PermissibleBalance|Допустимый баланс
3447 +|DefermentDays|(((
3448 +Отсрочка, количество дней
3449 +)))
3450 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3451 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3452 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3453 +
3454 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3455 +
3456 +(% class="box warningmessage" %)
3457 +(((
3458 +**PUT /api/v3/Billing/client/plan**
3459 +)))
3460 +
3461 +Тело запроса:
3462 +
3463 +{
3464 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3466 + "Features": [
3467 + {
3468 + "Feature": "string",
3469 + "IsEnabled": true,
3470 + "IsFactual": true,
3471 + "Limit": 0,
3472 + "Price": 0,
3473 + "DebitDate": "2023-10-18T13:26:58.987Z",
3474 + "PeriodValue": 0,
3475 + "PeriodType": 0
3476 + }
3477 + ]
3478 +}
3479 +
3480 +Ответ: Success
3481 +
3482 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3483 +|ClientId|Идентификатор клиента
3484 +|PlanId|Идентификатор тарифного плана
3485 +|Feature|Код услуги
3486 +|IsEnabled|Признак, определяющий активирована ли услуга
3487 +|IsFactual|Признак, определяющий расчёт по факту
3488 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3489 +|Price|Цена за единицу.
3490 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3491 +|PeriodValue|Значение периода.
3492 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3493 +
3494 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3495 +
3496 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3497 +
3498 +(% class="box infomessage" %)
3499 +(((
3500 +**POST /api/v3/vehicles/import/{agentId}**
3501 +)))
3502 +
3503 +**agentId** - id клиента.
3504 +
3505 +
3506 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3507 +
3508 +(% class="box infomessage" %)
3509 +(((
3510 +**POST /api/v3/vehicles/import/history/{vehicleId}**
3511 +)))
3512 +
3513 +(% class="wikigeneratedid" %)
3514 +**vehicleId **- id объекта.
3515 +
3516 +
3517 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3518 +
3519 +(% class="box infomessage" %)
3520 +(((
3521 +**GET /api/v3/vehicles/import/history/status**
3522 +)))
3523 +
3524 +
3525 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3526 +
3527 +(% class="box infomessage" %)
3528 +(((
3529 +**POST /api/v3/vehicles/export**
3530 +)))
3531 +
3532 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3533 +
3534 +Тело запроса:
3535 +
3536 +[
3537 + id
3538 +]
3539 +
3540 +Ответ: Success 200, получаете файлы с настройками.
3541 +
3542 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3543 +
3544 +(% class="box infomessage" %)
3545 +(((
3546 +**POST /api/v3/vehicles/export/history**
3547 +)))
3548 +
3549 +Метод возвращает список сообщений терминала объекта за выбранный период.
3550 +
3551 +Тело запроса:
3552 +
3553 +{
3554 + "vehicleId": 0,
3555 + "asArchive": true,
3556 + "from": "2023-09-27T12:17:45.973Z",
3557 + "to": "2023-09-27T12:17:45.973Z"
3558 +}
3559 +
3560 +Ответ:
3561 +
3562 +Получаете файл. Сообщение: Code 200/Success
3563 +
3564 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3565 +|vehicleId|ID объекта
3566 +|asArchive|true - Архивировать файл, False - не архивировать
3567 +|from|Дата и время начала запроса
3568 +|to|Дата и время окончания запроса
3569 +
3570 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3571 +
3572 +(% class="box infomessage" %)
3573 +(((
3574 +**GET /api/v3/vehicles/export/history/status**
3575 +)))
3576 +
3577 +Метод возвращает список сообщений терминала объекта за выбранный период.
3578 +
3579 +Ответ:
3580 +
3581 +{
3582 + "activity": true,
3583 + "progress": 0,
3584 + "message": "string"
3585 +}
3586 +
3587 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3588 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3589 +|progress|Прогресс экспорта, от 0 до 100%
3590 +|message|Текст описывающий статус
3591 +
3592 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3593 +
3594 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3595 +
3596 +(% class="box infomessage" %)
3597 +(((
3598 +**POST /api/v3/EcoDriving/rating**
3599 +)))
3600 +
3601 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3602 +
3603 +Тело запроса:
3604 +
3605 +{
3606 + "vehicleIds": [vehicleId],
3607 + "from": "2023-11-22T09:29:48.051Z",
3608 + "to": "2023-11-22T09:29:48.051Z"
3609 +}
3610 +
3611 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3612 +|vehicleIds|Массив ID объектов
3613 +|from|Дата начала запроса
3614 +|to|Дата окончания запроса
3615 +
3616 +Ответ:
3617 +
3618 +{
3619 + "items": [
3620 + {
3621 + "from": "2023-11-22T09:29:48.052Z",
3622 + "to": "2023-11-22T09:29:48.052Z",
3623 + "vehicleId": 0,
3624 + "vehicleName": "string",
3625 + "vehicleModel": "string",
3626 + "penalty": 0,
3627 + "score": 0,
3628 + "totalViolations": 0,
3629 + "violationsByType": {
3630 + "overspeedingViolations": 0,
3631 + "accelerationViolations": 0,
3632 + "brakingViolations": 0,
3633 + "turningViolations": 0,
3634 + "dangerousDrivingViolations": 0,
3635 + "sensorViolations": 0
3636 + },
3637 + "moveTime": 0,
3638 + "mileage": 0,
3639 + "tripsCount": 0,
3640 + "trips": [
3641 + {
3642 + "penalty": 0,
3643 + "score": 0,
3644 + "violationsCount": 0,
3645 + "violationsByType": {
3646 + "overspeedingViolations": 0,
3647 + "accelerationViolations": 0,
3648 + "brakingViolations": 0,
3649 + "turningViolations": 0,
3650 + "dangerousDrivingViolations": 0,
3651 + "sensorViolations": 0
3652 + },
3653 + "moveTime": 0,
3654 + "mileage": 0,
3655 + "motohours": 0,
3656 + "maxSpeed": 0,
3657 + "startAddress": "string",
3658 + "endAddress": "string",
3659 + "drivers": [
3660 + {
3661 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3662 + "driverName": "string",
3663 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3664 + }
3665 + ]
3666 + }
3667 + ]
3668 + }
3669 + ]
3670 +}
3671 +
3672 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3673 +|from|Дата начала запроса
3674 +|to|Дата  окончания
3675 +|vehicleId|ID объекта
3676 +|vehicleName|Имя объекта
3677 +|vehicleModel|Модель объекта
3678 +|penalty|Сумма штрафных баллов
3679 +|score|Оценка
3680 +|totalViolations|Суммарное количество нарушений
3681 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3682 +|overspeedingViolations|Превышение скорости
3683 +|accelerationViolations|Ускорение
3684 +|brakingViolations|Торможение
3685 +|turningViolations|Резкий поворот
3686 +|dangerousDrivingViolations|Резкое вождение
3687 +|sensorViolations|Нарушение по датчику
3688 +|moveTime|Время в движении
3689 +|mileage|Пробег
3690 +|tripsCount|Количество рейсов
3691 +|motohours|Моточасы
3692 +|maxSpeed|Максимальная скорость
3693 +|startAddress|Адрес начала рейса
3694 +|endAddress|Адрес окончания рейса
3695 +|drivers|Список водителей, которые были на объекте в течениии рейса
3696 +|driverGuid|Guid водителя
3697 +|driverName|Имя водителя
3698 +|driverRfid|Номер Карты-метки
3699 +
587 587  (% class="box" lang="en-US" style="text-align: center;" %)
588 588  (((
589 589  (% 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]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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