<
From version < 20.8 >
edited by Артем Шемяков
on 2022/09/01 17:44
To version < 131.1 >
edited by Андрей Калиновский
on 2024/01/30 15:09
>
Change comment: There is no comment for this version

Summary

Details

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