Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 49.1 >
edited by Илья Крайнов
on 2022/11/21 11:03
To version < 155.1 >
edited by Андрей Калиновский
on 2024/07/19 14:12
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -1,42 +1,37 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
2 +(((
3 +**Содержание страницы:**
4 +)))
3 3  
4 -== ==
6 +{{toc/}}
5 5  
6 -[[ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**>>Авторизация — POST /api/v3/auth/login||anchor="Авторизация — POST /api/v3/auth/login"]]
7 7  
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 8  
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
9 9  
10 -
11 -(% class="box" style="text-align: center;" %)
12 -(((
13 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
14 -)))
15 -
16 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
17 -
18 18  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
19 19  
20 20  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
21 -
22 22  
23 -(% class="box" style="text-align: center;" %)
24 -(((
25 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
26 -)))
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
27 27  
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
28 28  (% class="box successmessage" %)
29 29  (((
30 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
31 31  )))
32 32  
33 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
34 34  
35 35  (% style="color:#000000" %)Метод запроса: **POST**
36 36  
37 37  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
38 38  
39 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
40 40  
41 41  (% style="color:#000000" %)Параметры в теле запроса (JSON):
42 42  
... ... @@ -43,8 +43,7 @@
43 43  (% style="color:#000000" %){
44 44   "login": "testuser",
45 45   "password": "testuser"
46 -}(%%)
47 -
41 +}
48 48  
49 49  (% style="color:#000000" %)**Ответ:**
50 50  
... ... @@ -60,13 +60,23 @@
60 60  
61 61  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
62 62  
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" %)Логин пользователя
63 63  
63 +(% class="wikigeneratedid" %)
64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
65 +
66 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
67 +
64 64  (% class="box infomessage" %)
65 65  (((
66 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
70 +(% lang="en-US" %)**GET /api/v3/auth/check**
67 67  )))
68 68  
69 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
73 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
70 70  
71 71  (% style="color:#000000" %)Метод запроса: **GET**
72 72  
... ... @@ -77,56 +77,307 @@
77 77  (% lang="en-US" %)
78 78  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
79 79  
84 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
80 80  
81 -(% class="box" style="text-align: center;" %)
86 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
87 +
88 +(% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
90 +**GET api/v3/agents/{id}**
84 84  )))
85 85  
93 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
94 +
95 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
96 +
97 +(% style="color:#000000" %)Метод запроса: **GET**
98 +
99 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
100 +
101 +Запрос должен содержать данные параметра "**agentId**"
102 +
103 +(% style="color:#000000" %)Ответ:
104 +{
105 + "agentId": "",  (%%)
106 + "parentId": "",
107 + "parentName": "string",
108 + "name": "string",
109 + "fullName": "string",
110 + "agentInfoType": 0,
111 + "isForeign": true/false,
112 + "district": "string", 
113 + "region": "string",
114 + "city": "string",
115 + "inn": "string",
116 + "kpp": "string",
117 + "address": "string",
118 + "addressFact": "string",
119 + "email": "string",
120 + "director": "string",
121 + "bankName": "string",
122 + "bankBIK": "string",
123 + "bankRS": "string",
124 + "bankKS": "string"
125 + }
126 +
127 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
128 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
129 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
130 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
131 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
132 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
133 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
134 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
135 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
136 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
137 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
138 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
139 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
140 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
141 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
142 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
143 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
144 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
145 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
146 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
147 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
148 +
149 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
150 +
86 86  (% class="box infomessage" %)
87 87  (((
88 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
153 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
89 89  )))
90 90  
91 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
156 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
92 92  
93 93  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
94 94  
95 95  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
96 96  
97 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
162 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
98 98  
99 -(% style="color:#000000" %)Метод запроса: **GET**
164 +(% style="color:#000000" %)Метод запроса: **POST**
100 100  
101 -(% 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>
166 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
102 102  
103 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
168 +(% style="color:#000000" %)Параметр запроса:
104 104  
105 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
170 +(% style="color:#000000" %){
171 + "parentId": "string"
172 +}
106 106  
107 107  (% style="color:#000000" %)Ответ:
108 108  
109 -(% style="color:#000000" %){
110 - "agentId": "", ~/~/ идентификатор клиента
111 - "parentId": "", ~/~/ идентификатор клиента-родителя
112 - "name": "", ~/~/ наименование клиента
113 - "fullName": "", ~/~/ полное наименование клиента
114 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
115 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
176 +{
177 + "agentId": "",(% style="color:#000000" %)   (%%)
178 + "parentId": "",
179 + "name": "string",
180 + "fullName": "string",
181 + "agentInfoType": 0,
182 +(% style="color:#000000" %) "status": "",
116 116  }
117 117  
118 118  
119 -(% class="box" style="text-align: center;" %)
186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
187 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
188 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
189 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
190 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
191 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
192 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
193 +
194 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
195 +
196 +(% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
198 +**POST /api/v3/agents **
122 122  )))
123 123  
201 +Метод позволяет добавить клиента, указанного в запросе.
202 +
203 +Метод запроса: **POST**
204 +
205 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
206 +
207 +В заголовках запроса: X-Auth: Токен авторизации
208 +
209 +Параметры в теле запроса (JSON):
210 +
211 +{
212 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
213 + "name": "string", ~/~/ имя
214 + "fullName": "string", ~/~/ полное наименование
215 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
216 + "isForeign": true, ~/~/ иностранный контрагент
217 + "district": "string", ~/~/ округ
218 + "region": "string", ~/~/ регион
219 + "city": "string", ~/~/ город
220 + "inn": "string", ~/~/ ИНН
221 + "kpp": "string", ~/~/ КПП
222 + "address": "string", ~/~/ юридический адрес
223 + "addressFact": "string", ~/~/ фактический адрес
224 + "email": "string", ~/~/ email
225 + "director": "string", ~/~/ ФИО руководителя
226 + "bankName": "string", ~/~/ банк
227 + "bankBIK": "string", ~/~/ БИК
228 + "bankRS": "string", ~/~/ номер счёта
229 + "bankKS": "string" ~/~/ корр. счёт
230 +}
231 +
232 +
233 +Ответ:
234 +
235 +{
236 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
237 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
238 + "name": "string", ~/~/ имя
239 + "fullName": "string", ~/~/ полное наименование
240 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
241 + "isForeign": true, ~/~/ иностранный контрагент
242 + "district": "string", ~/~/ округ
243 + "region": "string", ~/~/ регион
244 + "city": "string", ~/~/ город
245 + "inn": "string", ~/~/ ИНН
246 + "kpp": "string", ~/~/ КПП
247 + "address": "string", ~/~/ юридический адрес
248 + "addressFact": "string", ~/~/ фактический адрес
249 + "email": "string", ~/~/ email
250 + "director": "string", ~/~/ ФИО руководителя
251 + "bankName": "string", ~/~/ банк
252 + "bankBIK": "string", ~/~/ БИК
253 + "bankRS": "string", ~/~/ номер счёта
254 + "bankKS": "string" ~/~/ корр. счёт
255 +}
256 +
257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
278 +
279 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
280 +
281 +(% class="box warningmessage" %)
282 +(((
283 +**PUT /api/v3/agents**
284 +)))
285 +
286 +Метод позволяет отредактировать клиента, указанного в запросе.
287 +
288 +Метод запроса: **PUT**
289 +
290 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
291 +
292 +В заголовках запроса: X-Auth: Токен авторизации
293 +
294 +Параметры в теле запроса (JSON):
295 +
296 +{
297 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
298 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
299 + "name": "string", ~/~/ имя
300 + "fullName": "string", ~/~/ полное наименование
301 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
302 + "isForeign": true, ~/~/ иностранный контрагент
303 + "district": "string", ~/~/ округ
304 + "region": "string", ~/~/ регион
305 + "city": "string", ~/~/ город
306 + "inn": "string", ~/~/ ИНН
307 + "kpp": "string", ~/~/ КПП
308 + "address": "string", ~/~/ юридический адрес
309 + "addressFact": "string", ~/~/ фактический адрес
310 + "email": "string", ~/~/ email
311 + "director": "string", ~/~/ ФИО руководителя
312 + "bankName": "string", ~/~/ банк
313 + "bankBIK": "string", ~/~/ БИК
314 + "bankRS": "string", ~/~/ номер счёта
315 + "bankKS": "string" ~/~/ корр. счёт
316 +}
317 +
318 +Ответ:
319 +
320 +{
321 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
322 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
323 + "name": "string", ~/~/ имя
324 + "fullName": "string", ~/~/ полное наименование
325 + "isForeign": true, ~/~/ иностранный контрагент
326 + "district": "string", ~/~/ округ
327 + "region": "string", ~/~/ регион
328 + "city": "string", ~/~/ город
329 + "inn": "string", ~/~/ ИНН
330 + "kpp": "string", ~/~/ КПП
331 + "address": "string", ~/~/ юридический адрес
332 + "addressFact": "string", ~/~/ фактический адрес
333 + "email": "string", ~/~/ email
334 + "director": "string", ~/~/ ФИО руководителя
335 + "bankName": "string", ~/~/ банк
336 + "bankBIK": "string", ~/~/ БИК
337 + "bankRS": "string", ~/~/ номер счёта
338 + "bankKS": "string" ~/~/ корр. счёт
339 +}
340 +
341 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
342 +
343 +(% class="box errormessage" %)
344 +(((
345 +**DELETE /api/v3/agents/{clientId}**
346 +)))
347 +
348 +Метод позволяет удалить клиента, указанного в строке запроса.
349 +
350 +Метод запроса: **DELETE**
351 +
352 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
353 +
354 +Параметр запроса: **{clientId}** - Guid пользователя
355 +
356 +В заголовках запроса: X-Auth: Токен авторизации
357 +
358 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
359 +
360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 +
362 +(% class="box warningmessage" %)
363 +(((
364 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 +)))
366 +
367 +Метод позволяет изменить статус клиента, указанного в запросе.
368 +
369 +В пути указывается GUID клиента и статус клиента.
370 +
371 +**status **- значение 0 - заблокирован, 1 - активен.
372 +
373 +Ответ: Code 204
374 +
375 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
376 +
377 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
378 +
124 124  (% class="box successmessage" %)
125 125  (((
126 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
381 +(% lang="en-US" %)**POST /api/v3/users**
127 127  )))
128 128  
129 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
384 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
130 130  
131 131  (% style="color:#000000" %)Метод запроса: **POST**
132 132  
... ... @@ -136,7 +136,8 @@
136 136  
137 137  (% style="color:#000000" %)Параметры в теле запроса (JSON):
138 138  
139 -(% style="color:#000000" %){ 
394 +(% style="color:#000000" %)
395 +{ 
140 140   "lastName": "", ~/~/ фамилия
141 141   "firstName": "", ~/~/ имя
142 142   "position": "", ~/~/ должность
... ... @@ -145,17 +145,40 @@
145 145   "login": "", ~/~/ логин (обязателен)
146 146   "password": "", ~/~/ пароль (обязателен)
147 147   "email": "", ~/~/ email (обязателен)
148 - "description": "", ~/~/ описание
149 - "isEnabled": "", ~/~/ признак включения
404 + "description": "string", ~/~/ Описание
405 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
406 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
407 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
150 150   "parentId": "", ~/~/ Guid родительского агента
151 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
152 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
153 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
154 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
155 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
156 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
409 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
410 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
411 + "doubleAuth":
412 + {
413 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
414 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
415 + },
416 + "groups":
417 + [
418 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
419 + ],
420 + "customGroups":
421 + [
422 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
423 + ],
424 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
157 157  }
158 158  
427 +{
428 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
429 + "lastName": "string",
430 + "firstName": "string",
431 + "position": "string",
432 + "phone": "string",
433 + "organization": "string",
434 + "login": "string",
435 + "password": "string",
436 + "email": "string",
437 +
159 159  (% style="text-align:left" %)
160 160  (% style="color:#000000; font-weight:normal" %)Ответ:
161 161  
... ... @@ -185,12 +185,14 @@
185 185  (% style="color:#000000; font-weight:normal" %)}
186 186  
187 187  
188 -(% class="box successmessage" %)
467 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
468 +
469 +(% class="box infomessage" %)
189 189  (((
190 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
471 +(% lang="en-US" %)**POST /api/v3/users/find**
191 191  )))
192 192  
193 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
474 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
194 194  
195 195  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
196 196  
... ... @@ -227,17 +227,18 @@
227 227   "email": "" , ~/~/ E-mail
228 228   "sessionDuration":"", ~/~/ длительность сессии в минутах
229 229   "status": "1",  ~/~/ статус пользователя
230 - "astLogged": "", ~/~/ дата/время последней авторизации
511 + "lastLogged": "", ~/~/ дата/время последней авторизации
231 231  
232 232  (% style="color:#000000" %)}
233 233  
515 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
234 234  
235 -(% class="box successmessage" %)
517 +(% class="box infomessage" %)
236 236  (((
237 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
519 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
238 238  )))
239 239  
240 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
522 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
241 241  
242 242  (% style="color:#000000" %)Метод запроса: **GET**
243 243  
... ... @@ -264,8 +264,11 @@
264 264   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
265 265   "description": "", ~/~/ Описание
266 266   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
267 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
268 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
549 + "doubleAuth":
550 + {
551 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
552 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
553 + },
269 269   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
270 270   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
271 271   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -279,13 +279,14 @@
279 279  )))
280 280  )))
281 281  
567 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
282 282  
283 283  (% class="box warningmessage" %)
284 284  (((
285 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
571 +(% lang="en-US" %)**PUT /api/v3/users**
286 286  )))
287 287  
288 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
574 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
289 289  
290 290  (% style="color:#000000" %)Метод запроса: **PUT**
291 291  
... ... @@ -293,8 +293,6 @@
293 293  
294 294  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
295 295  
296 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
297 -
298 298  (% lang="en-US" style="text-align:left" %)
299 299  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
300 300  
... ... @@ -309,7 +309,9 @@
309 309   "phone": "" , ~/~/ телефон
310 310   "organization": "" , ~/~/ организация
311 311   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
312 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
596 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
597 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
598 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
313 313   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
314 314  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
315 315   "isEnabled": "" , ~/~/ признак включения
... ... @@ -316,9 +316,12 @@
316 316   "parentId": "" , ~/~/ Guid родительского агента
317 317   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
318 318   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
319 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
320 - "kind": "" , ~/~/ тип аутентификации
321 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
605 + "doubleAuth":
606 + {
607 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
608 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
609 + },
610 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
322 322   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
323 323  
324 324  (% lang="en-US" style="text-align:left" %)
... ... @@ -344,8 +344,12 @@
344 344   "isEnabled": "" , ~/~/ признак включения
345 345   "parentId": "" , ~/~/ Guid родительского агента
346 346   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
347 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
348 - "kind": "" , ~/~/ тип аутентификации
636 + "doubleAuth":
637 + {
638 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
639 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
640 + },
641 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
349 349   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
350 350   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
351 351  
... ... @@ -352,13 +352,14 @@
352 352  (% lang="en-US" style="text-align:left" %)
353 353  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
354 354  
648 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
355 355  
356 356  (% class="box warningmessage" %)
357 357  (((
358 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
652 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
359 359  )))
360 360  
361 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
655 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
362 362  
363 363  (% style="color:#000000" %)Метод запроса: **PUT**
364 364  
... ... @@ -381,13 +381,14 @@
381 381  (% style="text-align:left" %)
382 382  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
383 383  
678 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
384 384  
385 385  (% class="box warningmessage" %)
386 386  (((
387 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
682 +**POST /api/v3/users/disable**
388 388  )))
389 389  
390 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
685 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
391 391  
392 392  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
393 393  
... ... @@ -402,13 +402,14 @@
402 402  
403 403  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
404 404  
700 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
405 405  
406 406  (% class="box warningmessage" %)
407 407  (((
408 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
704 +**POST /api/v3/users/enable**
409 409  )))
410 410  
411 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
707 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
412 412  
413 413  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
414 414  
... ... @@ -436,15 +436,16 @@
436 436  }
437 437  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
438 438  "users" - массив id пользователей, которых не удалось включить или отключить.
439 -
440 440  )))
441 441  
737 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
738 +
442 442  (% class="box errormessage" %)
443 443  (((
444 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
741 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
445 445  )))
446 446  
447 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
744 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
448 448  
449 449  (% style="color:#000000" %)Метод запроса: **DELETE**
450 450  
... ... @@ -457,20 +457,261 @@
457 457  (% style="text-align:left" %)
458 458  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
459 459  
757 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
460 460  
461 -(% class="box" style="text-align: center;" %)
759 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
760 +
761 +(% class="box infomessage" %)
462 462  (((
463 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
763 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
464 464  )))
465 465  
766 +Метод возвращает полную информацию о модели объекта.
767 +
768 +(% style="color:#000000" %)Метод запроса: **GET**
769 +
770 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
771 +
772 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
773 +
774 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
775 +
776 +(% style="color:#000000" %)Ответ:
777 +
778 +(% style="color:#000000" %){
779 + "parentName": "string",
780 + "name": "string",
781 + "picture": "string",
782 + "minspeed": 0,
783 + "maxspeed": 0,
784 + "width": 0,
785 + "imbeddedtrailer": true,
786 + "hoppercapacity": 0,
787 + "hopperdischargespeed": 0,
788 + "modelType": 0,
789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
790 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
791 + "deleted": true
792 +}
793 +
794 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
795 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
796 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
797 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
798 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
799 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
800 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
801 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
802 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
803 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
804 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
805 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
806 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
807 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
808 +
809 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
810 +
811 +(% class="box successmessage" %)
812 +(((
813 +(% lang="en-US" %)**POST /api/v3/models/find**
814 +)))
815 +
816 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
817 +
818 +(% style="color:#000000" %)Метод запроса: **POST**
819 +
820 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
821 +
822 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
823 +
824 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
825 +
826 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
827 +}
828 +
829 +(% style="color:#000000" %)Ответ:
830 +
831 +(% style="color:#000000" %)[
832 + {
833 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
834 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
835 + "parentName": "string",
836 + "name": "string",
837 + "modelType": 0
838 + }
839 +]
840 +
841 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
842 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
844 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
845 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
846 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
847 +
848 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
849 +
850 +(% class="box successmessage" %)
851 +(((
852 +(% lang="en-US" %)**POST /api/v3/models**
853 +)))
854 +
855 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
856 +
857 +(% style="color:#000000" %)Метод запроса: **POST**
858 +
859 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
860 +
861 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
862 +
863 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
864 +
865 +{
866 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
868 + "deleted": true,
869 + "extId": "string",
870 + "name": "string",
871 + "picture": "string",
872 + "minspeed": 0,
873 + "maxspeed": 0,
874 + "width": 0,
875 + "imbeddedtrailer": true,
876 + "fueloutlay": 0,
877 + "hoppercapacity": 0,
878 + "hopperdischargespeed": 0,
879 + "modelType": 0
880 +}
881 +
882 +Ответ:
883 +
884 +{
885 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
886 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
887 + "deleted": true,
888 + "extId": "string",
889 + "name": "string",
890 + "picture": "string",
891 + "minspeed": 0,
892 + "maxspeed": 0,
893 + "width": 0,
894 + "imbeddedtrailer": true,
895 + "hoppercapacity": 0,
896 + "hopperdischargespeed": 0,
897 + "modelType": 0
898 +}
899 +
900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
901 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
903 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
904 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
905 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
906 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
907 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
908 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
909 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
910 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
911 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
912 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
913 +
914 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
915 +
916 +(% class="box warningmessage" %)
917 +(((
918 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
919 +)))
920 +
921 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
922 +
923 +(% style="color:#000000" %)Метод запроса: **PUT**
924 +
925 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
926 +
927 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
928 +
929 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
930 +
931 +{
932 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
933 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
934 + "deleted": true,
935 + "extId": "string",
936 + "name": "string",
937 + "picture": "string",
938 + "minspeed": 0,
939 + "maxspeed": 0,
940 + "width": 0,
941 + "imbeddedtrailer": true,
942 + "fueloutlay": 0,
943 + "hoppercapacity": 0,
944 + "hopperdischargespeed": 0,
945 + "modelType": 0
946 +}
947 +
948 +Ответ:
949 +
950 +{
951 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
952 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
953 + "deleted": true,
954 + "extId": "string",
955 + "name": "string",
956 + "picture": "string",
957 + "minspeed": 0,
958 + "maxspeed": 0,
959 + "width": 0,
960 + "imbeddedtrailer": true,
961 + "fueloutlay": 0,
962 + "hoppercapacity": 0,
963 + "hopperdischargespeed": 0,
964 + "modelType": 0
965 +}
966 +
967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
968 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
970 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
971 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
972 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
973 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
974 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
975 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
976 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
977 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
978 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
979 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
980 +
981 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
982 +
983 +(% class="box errormessage" %)
984 +(((
985 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
986 +)))
987 +
988 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
989 +
990 +(% style="color:#000000" %)Метод запроса: **DELETE**
991 +
992 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
993 +
994 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
995 +
996 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
997 +
998 +Ответ: В случае успеха **Success 200**
999 +
1000 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
1001 +
1002 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1003 +
466 466  (% class="box infomessage" %)
467 467  (((
468 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1006 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
469 469  )))
470 470  
471 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1009 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
472 472  
473 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1011 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
474 474  
475 475  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
476 476  
... ... @@ -478,9 +478,9 @@
478 478  
479 479  (% style="color:#000000" %)Метод запроса: **GET**
480 480  
481 -(% 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>
1019 +(% 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}
482 482  
483 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
1021 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
484 484  
485 485  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
486 486  
... ... @@ -494,18 +494,148 @@
494 494   "deviceTypeId": , ~/~/ ID типа устройства
495 495   "deviceTypeName": "", ~/~/ Название типа устройства
496 496   "sim1": "", ~/~/ Номер SIM1
497 - "parentId": "", Номер SIM2
498 - "parentName": "", Наименование клиента-родителя
499 - "modelId": "", ID модели объекта
500 - "modelName": "", Имя модели объекта
501 - "createdAt": "", Дата создания объекта
502 - "mileageCalcMethod": "", Выбранный метод расчета пробега
503 - "counters": { ~/~/ Нормы
504 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
505 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
506 - "mileage": "", ~/~/ Пробег по нормам в метрах
507 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
1035 + "sim2": "", ~/~/ Номер SIM2
1036 +
1037 + "parentId": "", ~/~/ ID клиента-родителя
1038 + "parentName": "", ~/~/ Наименование клиента-родителя
1039 + "modelId": "", ~/~/ ID модели объекта
1040 + "modelName": "", ~/~/ Имя модели объекта
1041 +
1042 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1043 + "unitName": "string", ~/~/ Наименование подразделения
1044 + "status": 0, ~/~/ Статус объекта
1045 +
1046 + "createdAt": "", ~/~/ Дата создания объекта
508 508   },
1048 +
1049 +"customFields": [ ~/~/ Произвольные поля
1050 + {
1051 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1052 + "name": "string", ~/~/ Имя поля
1053 + "value": "string", ~/~/ Значение поля
1054 + "forClient": true, ~/~/ Не используемая функция
1055 + "forTooltip": true, ~/~/ Отображать в подсказке
1056 + "forReport": true ~/~/ Отображать в отчете
1057 + }
1058 +
1059 +], ~/~/ Данные с вкладки нормы
1060 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1061 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1062 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1063 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1064 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1065 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1066 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1067 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1068 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1069 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1070 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1071 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
1072 +
1073 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1074 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1075 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1076 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1077 + "counters": { ~/~/ Счетчики
1078 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1079 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1080 + "mileage": 0, ~/~/ Текущий пробег
1081 + "motohours": 0, ~/~/ Текущие моточасы
1082 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1083 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1084 + },
1085 +
1086 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1087 + "id": "string", ~/~/ ID объекта
1088 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1089 + "host": "string", ~/~/ CMSV6 Web Host
1090 + "login": "string", ~/~/ CMSV6 Account
1091 + "password": "string" ~/~/ CMSV6 Password
1092 + },
1093 +
1094 +"commandTemplates": [ ~/~/ Шаблоны команд
1095 + {
1096 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1097 + "name": "string", ~/~/ Наименование команды
1098 + "command": "string", ~/~/ Текст команды
1099 + "retries": 0 ~/~/ Количество попыток
1100 + }
1101 + ],
1102 +
1103 + "sensors": [ ~/~/ Датчики
1104 + {
1105 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1106 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1107 + "type": 0, ~/~/ Тип датчика
1108 + "name": "string", ~/~/ Имя датчика
1109 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1110 + "inputNumber": 0, ~/~/ Номер входа
1111 + "pseudonym": "string", ~/~/ Псевдоним
1112 + "medianDegree": 0, ~/~/ Медианная фильтрация
1113 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1114 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1115 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1116 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1117 + {
1118 + "grades": [ ~/~/ Таблица тарировки 1
1119 + {
1120 + "input": 0, ~/~/ Входящее значение
1121 + "output": 0 ~/~/ Выходящее значение
1122 + }
1123 + ],
1124 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1125 + }
1126 + ],
1127 + "showInTooltip": true, ~/~/ Отображать в подсказке
1128 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1130 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1131 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1132 + "expr": "string", ~/~/ Формула
1133 + "children": [ ~/~/ массив дочерних датчиков
1134 + "string"
1135 + ],
1136 + "customParams": { ~/~/ прочие произвольные параметры
1137 + "additionalProp1": "string",
1138 + "additionalProp2": "string",
1139 + "additionalProp3": "string"
1140 + },
1141 +
1142 +~/~/ Характерные для произвольного:
1143 +
1144 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1145 +
1146 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1147 +
1148 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1149 +
1150 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1151 +
1152 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1153 +
1154 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1155 +
1156 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1157 +
1158 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1159 +
1160 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1161 +
1162 +~/~/ "ValueOn": "Вкл.",
1163 +
1164 +~/~/ "ValueOff": "Выкл."
1165 + "summaryMaxValue": 0 ~/~/ Макс. значение
1166 + }
1167 +
1168 + "drivers": [ ~/~/ Водители
1169 + {
1170 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1171 + "name": "string", ~/~/ Наименование
1172 + "description": "string",
1173 + "isDefault": true ~/~/ По умолчанию
1174 + }
1175 + ],
1176 +
509 509   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
510 510   {
511 511   "id": "", ~/~/ ID  задания
... ... @@ -521,7 +521,17 @@
521 521   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
522 522   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
523 523   }
524 - ]
1192 + ],
1193 +
1194 + "statusHistory": [ ~/~/ История статусов
1195 + {
1196 + "status": 0,
1197 + "date": "2023-05-22T09:57:39.562Z",
1198 + "description": "string",
1199 + "additionalInfo": "string"
1200 + }
1201 + ]
1202 +
525 525  }
526 526  )))
527 527  
... ... @@ -531,13 +531,95 @@
531 531  (% style="text-align:left" %)
532 532  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
533 533  
1212 +(% class="wikigeneratedid" %)
1213 +===== =====
534 534  
1215 +(% class="wikigeneratedid" %)
1216 +===== **Получить ответ на отправленную на ТС команду** =====
1217 +
1218 +(% class="box infomessage" %)
1219 +(((
1220 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1221 +)))
1222 +
1223 +Идентификатор команды: cmdid
1224 +
1225 +
1226 +Запрос от терминала на ответ команды
1227 +
1228 +
1229 +Пример ответ от терминала:
1230 +
1231 +
1232 +ID= "" ~/~/ идентификатор произвольного поля
1233 +
1234 +Soft="" ~/~/ версия софта
1235 +
1236 +GPS=4 ~/~/ тип трекера
1237 +
1238 +Time=11:05:43 28.06.24 ~/~/ время запроса
1239 +
1240 +Lat=45.056221 ~/~/ широта
1241 +
1242 +Lon=39.035938 ~/~/ долгота
1243 +
1244 +Speed=0.0 ~/~/ скорость
1245 +
1246 +Course=181.4 ~/~/направление
1247 +
1248 +
1249 +
1250 +(((
1251 +(% class="wikigeneratedid" %)
1252 +===== **Список отправленных объекту команд с ответами** =====
1253 +
1254 +(% class="box infomessage" %)
1255 +(((
1256 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1257 +)))
1258 +
1259 +Идентификатор ТС: vehicleId
1260 +
1261 +
1262 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1263 +
1264 +
1265 +Пример ответа терминала
1266 +
1267 +
1268 +[
1269 +
1270 +{
1271 +
1272 +"id": "", ~/~/ идентификатор пользователя
1273 +
1274 +"commandText": "", ~/~/Текст команды.
1275 +
1276 +"templateId": "", ~/~/Идентификатор шаблона
1277 +
1278 +"updated": "", ~/~/ Время отправки 
1279 +
1280 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1281 +
1282 +"answer": "", ~/~/ Ответ терминала.
1283 +
1284 +"status": "" ~/~/ Статус отправки
1285 +
1286 +}
1287 +
1288 +]
1289 +
1290 +
1291 +)))
1292 +
1293 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1294 +
535 535  (% class="box successmessage" %)
536 536  (((
537 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
1297 +(% lang="en-US" %)**POST /api/v3/vehicles**
538 538  )))
539 539  
540 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1300 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
541 541  
542 542  (% style="color:#000000" %)Метод запроса: **POST**
543 543  
... ... @@ -569,6 +569,11 @@
569 569   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
570 570   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
571 571   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1332 +
1333 + "mileageCalcMethod": 0,
1334 + "mileageCoeff": 0,
1335 + "locationByCellId": true,
1336 + "dottedLineTrackWhenNoCoords": true,
572 572   "counters": ~/~/ счетчики
573 573   {
574 574   "mileage": "" , ~/~/ пробег
... ... @@ -598,8 +598,98 @@
598 598   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
599 599   }
600 600  
601 -(% style="color:#000000" %) }
1366 +"drivers": [ ~/~/ Водители
1367 + {
1368 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1369 + "isDefault": true
1370 + }
1371 + ],
1372 + "commandTemplates": [ ~/~/ Шаблон команды
1373 + {
1374 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1375 + "name": "string",
1376 + "command": "string",
1377 + "retries": 0
1378 + }
1379 + ],
602 602  
1381 + "sensors": [ ~/~/ Датчики
1382 + {
1383 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1384 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1385 + "type": 0, ~/~/ Тип датчика
1386 + "name": "string", ~/~/ Имя датчика
1387 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1388 + "inputNumber": 0, ~/~/ Номер входа
1389 + "pseudonym": "string", ~/~/ Псевдоним
1390 + "medianDegree": 0, ~/~/ Медианная фильтрация
1391 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1392 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1393 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1394 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1395 + {
1396 + "grades": [ ~/~/ Таблица тарировки 1
1397 + {
1398 + "input": 0, ~/~/ Входящее значение
1399 + "output": 0 ~/~/ Выходящее значение
1400 + }
1401 + ],
1402 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1403 + }
1404 + ],
1405 + "showInTooltip": true, ~/~/ Отображать в подсказке
1406 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1407 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1408 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1409 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1410 + "expr": "string", ~/~/ Формула
1411 + "children": [ ~/~/ массив дочерних датчиков
1412 + "string"
1413 + ],
1414 + "customParams": { ~/~/ прочие произвольные параметры
1415 + "additionalProp1": "string",
1416 + "additionalProp2": "string",
1417 + "additionalProp3": "string"
1418 + },
1419 +
1420 +~/~/ Характерные для произвольного:
1421 +
1422 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1423 +
1424 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1425 +
1426 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1427 +
1428 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1429 +
1430 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1431 +
1432 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1433 +
1434 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1435 +
1436 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1437 +
1438 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1439 +
1440 +~/~/ "ValueOn": "Вкл.",
1441 +
1442 +~/~/ "ValueOff": "Выкл."
1443 + "summaryMaxValue": 0 ~/~/ Макс. значение
1444 + }
1445 + ],
1446 + "customFields": [ ~/~/ Произвольные поля
1447 + {
1448 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1449 + "name": "string",
1450 + "value": "string",
1451 + "forClient": true,
1452 + "forTooltip": true,
1453 + "forReport": true
1454 + }
1455 + ]
1456 +}
1457 +
603 603  (% style="color:#000000" %)Ответ:
604 604  
605 605  (% style="color:#000000" %){
... ... @@ -650,15 +650,16 @@
650 650  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
651 651  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
652 652  
1508 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
653 653  
654 -(% class="box successmessage" %)
1510 +(% class="box infomessage" %)
655 655  (((
656 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1512 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
657 657  )))
658 658  
659 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1515 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
660 660  
661 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1517 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
662 662  
663 663  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
664 664  
... ... @@ -695,7 +695,7 @@
695 695   "customFields": null ~/~/ значение любого из произвольных полей ТС
696 696  }
697 697  
698 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1554 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
699 699  
700 700  (% style="color:#000000" %)Ответ:
701 701  
... ... @@ -731,13 +731,14 @@
731 731  
732 732  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
733 733  
1590 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
734 734  
735 735  (% class="box successmessage" %)
736 736  (((
737 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1594 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
738 738  )))
739 739  
740 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1597 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
741 741  
742 742  (% style="color:#000000" %)Метод запроса: **POST**
743 743  
... ... @@ -776,13 +776,38 @@
776 776  (% style="text-align:left" %)
777 777  (% style="color:#000000" %) }
778 778  
1636 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
1637 +**Отправить команду на терминал**
779 779  
1639 +(% class="box successmessage" %)
1640 +(((
1641 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1642 +)))
1643 +
1644 +Команда для отправки на тс.
1645 +
1646 +
1647 +{
1648 +
1649 +"id": "", ~/~/идентификатор произвольного поля
1650 +
1651 +"command": "", ~/~/ Текст команды
1652 +
1653 +"retries": "", ~/~/ Количество попыток
1654 +
1655 +"idTemplate": "" ~/~/ ID шаблона команды
1656 +
1657 +}
1658 +
1659 +
1660 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1661 +
780 780  (% class="box warningmessage" %)
781 781  (((
782 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1664 +(% lang="en-US" %)**PUT /api/v3/vehicles**
783 783  )))
784 784  
785 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1667 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
786 786  
787 787  (% style="color:#000000" %)Метод запроса: **PUT**
788 788  
... ... @@ -792,18 +792,16 @@
792 792  
793 793  (% style="color:#000000" %)Параметры в теле запроса (JSON):
794 794  
795 -(% style="color:#000000" %){    
796 -
797 -(((
798 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
799 - "parentId": "", ~/~/ ID клиента
800 - "name": "", ~/~/ имя ТС
801 - "imei": "", ~/~/ IMEI
802 - "deviceTypeId": "", ~/~/ ID типа устройства
803 - "modelId": "", ~/~/ , ID модели    
804 - "unitId": "", ~/~/ подразделения
805 - "sim1": "", ~/~/ SIM 1
806 - "sim2": "", ~/~/ SIM2     (%%)
1677 +(% style="color:#000000" %){
1678 + "vehicleId": , ~/~/ ID объекта
1679 + "parentId": "" , ~/~/ ID клиента
1680 + "name": "" , ~/~/ имя ТС
1681 + "imei": "" , ~/~/ IMEI
1682 + "deviceTypeId": "" , ~/~/ ID типа устройства
1683 + "modelId": "" , ~/~/ ID модели
1684 + "unitId": "" , ~/~/ ID подразделения
1685 + "sim1": "" , ~/~/ Номер SIM 1
1686 + "sim2": "" , ~/~/ Номер SIM2
807 807   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
808 808   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
809 809   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -816,39 +816,132 @@
816 816   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
817 817   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
818 818   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
819 -(% style="color:#000000" %) "counters": 
820 - {
821 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
822 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
823 - "mileage": "", ~/~/ пробег, в метрах 
824 - "motohours": "" ~/~/ моточасы, в секундах
825 - }
826 - "cmsv6Parameters": ~/~/ параметры CMSv6
827 - {       
828 - "id": "", ~/~/ идентификатор
829 - "enabled": true, ~/~/ флаг включения
830 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
831 - "login": "", ~/~/ имя учетной записи
832 - "password": "", ~/~/ пароль учетной записи
833 - }
834 - "inspectionTasks": ~/~/ задания на ТО
835 - {
836 - "id": "", ~/~/ ID задания
837 - "enabled": false, ~/~/ Признак включения
838 - "name": "", ~/~/ Имя задания
839 - "description": "", ~/~/ Описание задания
840 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
841 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
842 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
843 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
844 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
845 - "kind": "", ~/~/ Вид периодичности по времени
846 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
847 - } 
848 -)))
849 849  
850 -(% style="color:#000000" %)}
1700 + "mileageCalcMethod": 0,
1701 + "mileageCoeff": 0,
1702 + "locationByCellId": true,
1703 + "dottedLineTrackWhenNoCoords": true,
1704 + "counters": ~/~/ счетчики
1705 + {
1706 + "mileage": "" , ~/~/ пробег
1707 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1708 + "motohours": "" , ~/~/ моточасы
1709 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1710 + },
1711 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1712 + "enabled": true, ~/~/ флаг включения
1713 + "id": "" , ~/~/ идентификатор
1714 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1715 + "login": "" , ~/~/ имя учетной записи
1716 + "password": "" ~/~/ пароль учетной записи
1717 + },
1718 + "inspectionTasks": ~/~/ задания на ТО
1719 + {
1720 + "enabled": "" , ~/~/ Признак включения
1721 + "name": "" , ~/~/ Имя задания
1722 + "description": "" , ~/~/ Описание задания
1723 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1724 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1725 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1726 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1727 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1728 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1729 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1730 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1731 + }
851 851  
1733 +"drivers": [ ~/~/ Водители
1734 + {
1735 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1736 + "isDefault": true
1737 + }
1738 + ],
1739 + "commandTemplates": [ ~/~/ Шаблон команды
1740 + {
1741 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1742 + "name": "string",
1743 + "command": "string",
1744 + "retries": 0
1745 + }
1746 + ],
1747 +
1748 + "sensors": [ ~/~/ Датчики
1749 + {
1750 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1751 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1752 + "type": 0, ~/~/ Тип датчика
1753 + "name": "string", ~/~/ Имя датчика
1754 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1755 + "inputNumber": 0, ~/~/ Номер входа
1756 + "pseudonym": "string", ~/~/ Псевдоним
1757 + "medianDegree": 0, ~/~/ Медианная фильтрация
1758 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1759 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1760 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1761 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1762 + {
1763 + "grades": [ ~/~/ Таблица тарировки 1
1764 + {
1765 + "input": 0, ~/~/ Входящее значение
1766 + "output": 0 ~/~/ Выходящее значение
1767 + }
1768 + ],
1769 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1770 + }
1771 + ],
1772 + "showInTooltip": true, ~/~/ Отображать в подсказке
1773 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1774 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1775 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1776 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1777 + "expr": "string", ~/~/ Формула
1778 + "children": [ ~/~/ массив дочерних датчиков
1779 + "string"
1780 + ],
1781 + "customParams": { ~/~/ прочие произвольные параметры
1782 + "additionalProp1": "string",
1783 + "additionalProp2": "string",
1784 + "additionalProp3": "string"
1785 + },
1786 +
1787 +~/~/ Характерные для произвольного:
1788 +
1789 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1790 +
1791 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1792 +
1793 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1794 +
1795 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1796 +
1797 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1798 +
1799 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1800 +
1801 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1802 +
1803 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1804 +
1805 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1806 +
1807 +~/~/ "ValueOn": "Вкл.",
1808 +
1809 +~/~/ "ValueOff": "Выкл."
1810 + "summaryMaxValue": 0 ~/~/ Макс. значение
1811 + }
1812 + ],
1813 + "customFields": [ ~/~/ Произвольные поля
1814 + {
1815 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1816 + "name": "string",
1817 + "value": "string",
1818 + "forClient": true,
1819 + "forTooltip": true,
1820 + "forReport": true
1821 + }
1822 + ]
1823 +}
1824 +
852 852  (% style="color:#000000" %)Ответ:
853 853  
854 854  (% lang="en-US" style="text-align:left" %)
... ... @@ -899,18 +899,19 @@
899 899  (% lang="en-US" style="text-align:left" %)
900 900  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
901 901  
902 -**валидация:**
1875 +**Валидация:**
903 903  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
904 904  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
905 905  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
906 906  
1880 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
907 907  
908 908  (% class="box errormessage" %)
909 909  (((
910 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1884 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
911 911  )))
912 912  
913 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1887 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
914 914  
915 915  (% style="color:#000000" %)Метод запроса: **DELETE**
916 916  
... ... @@ -923,22 +923,20 @@
923 923  (% style="text-align:left" %)
924 924  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
925 925  
1900 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
926 926  
927 -(% class="box" lang="en-US" style="text-align: center;" %)
928 -(((
929 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
930 -)))
1902 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
931 931  
932 932  (% class="box infomessage" %)
933 933  (((
934 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1906 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
935 935  )))
936 936  
937 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1909 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
938 938  
939 939  (% style="color:#000000" %)Метод запроса: **GET**
940 940  
941 -(% 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]]
1913 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
942 942  
943 943  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
944 944  
... ... @@ -952,24 +952,22 @@
952 952  (% style="text-align:left" %)
953 953  (% style="color:#000000" %)}
954 954  
1927 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
955 955  
956 -(% class="box" style="text-align: center;" %)
957 -(((
958 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
959 -)))
1929 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
960 960  
961 961  (% class="box infomessage" %)
962 962  (((
963 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1933 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
964 964  )))
965 965  
966 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1936 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
967 967  
968 968  (% style="color:#000000" %)Метод запроса: **GET**
969 969  
970 970  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
971 971  
972 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1942 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
973 973  
974 974  (% style="color:#000000" %)Ответ:
975 975  
... ... @@ -982,7 +982,2892 @@
982 982  (% style="text-align:left" %)
983 983  (% style="color:#000000" %)}
984 984  
1955 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
985 985  
1957 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1958 +
1959 +(% class="box infomessage" style="text-align: left;" %)
1960 +(((
1961 +**POST /api/v3/terminalMessages/count**
1962 +)))
1963 +
1964 +(% style="text-align: left;" %)
1965 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1966 +
1967 +(% style="text-align: left;" %)
1968 +Метод запроса **POST**
1969 +
1970 +(% style="text-align: left;" %)
1971 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1972 +
1973 +(% style="text-align: left;" %)
1974 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1975 +
1976 +(% style="text-align: left;" %)
1977 +{
1978 + "vehicleIds": [
1979 + id ~/~/ здесь передается список идентификаторов объектов
1980 + ],
1981 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1982 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1983 +}
1984 +
1985 +(% style="text-align: left;" %)
1986 +Ответ:
1987 +
1988 +(% style="text-align: left;" %)
1989 +[
1990 + {
1991 + "vehicleId": 0, ~/~/ идентификатор объекта
1992 + "count": 0 ~/~/ количество сообщений за период
1993 + }
1994 +]
1995 +
1996 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1997 +
1998 +(% class="box infomessage" style="text-align: left;" %)
1999 +(((
2000 +**POST /api/v3/terminalMessages/mapping**
2001 +)))
2002 +
2003 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2004 +
2005 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2006 +
2007 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2008 +
2009 +{
2010 + "protocolType": 0,
2011 + "params": ["string"]
2012 +}
2013 +
2014 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2015 +|protocolType|ID типа протокола
2016 +|params|(((
2017 +Массив наименований параметров в сообщении
2018 +)))
2019 +
2020 +Ответ:
2021 +
2022 +{
2023 + "protocolType": 0,
2024 + "mapping": {
2025 + "additionalProp1": {
2026 + "inputType": 0,
2027 + "inputNumber": 0
2028 + },
2029 + "additionalProp2": {
2030 + "inputType": 0,
2031 + "inputNumber": 0
2032 + }
2033 + }
2034 +}
2035 +
2036 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2037 +|protocolType|Тип протокола
2038 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2039 +|inputNumber|(((
2040 +Номер входа
2041 +)))
2042 +
2043 +(% class="wikigeneratedid" %)
2044 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2045 +
2046 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2047 +
2048 +(% class="box infomessage" %)
2049 +(((
2050 +**POST /api/v3/terminalMessages**
2051 +)))
2052 +
2053 +Метод возвращает список сообщений терминала объекта за выбранный период.
2054 +
2055 +(% style="text-align: left;" %)
2056 +Метод запроса **POST**
2057 +
2058 +(% style="text-align: left;" %)
2059 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2060 +
2061 +(% style="text-align: left;" %)
2062 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2063 +
2064 +{
2065 + "vehicleId": 0, ~/~/ id объекта
2066 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2067 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2068 +}
2069 +
2070 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2071 +|vehicleId|ID объекта
2072 +|from|Дата и время начала периода запроса
2073 +|to|Дата и время окончания периода запроса
2074 +
2075 +Ответ:
2076 +
2077 +[
2078 + {
2079 + "messages": [
2080 + {
2081 + "deviceTime": "2023-11-29T07:40:44.052Z",
2082 + "serverTime": "2023-11-29T07:40:44.052Z",
2083 + "speed": 0,
2084 + "altitude": 0,
2085 + "latitude": 0,
2086 + "longitude": 0,
2087 + "satellites": 0,
2088 + "course": 0,
2089 + "voltage": 0,
2090 + "parameters": {
2091 + "additionalProp1": "string",
2092 + "additionalProp2": "string",
2093 + "additionalProp3": "string"
2094 + },
2095 + "photoCount": 0,
2096 + "lbsCorrectedCoords": true,
2097 + "protocolType": 0
2098 + }
2099 + ]
2100 + }
2101 +]
2102 +
2103 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2104 +|deviceTime|Время сообщения терминала
2105 +|serverTime|Время когда сообщение поступило на сервер
2106 +|speed|Скорость
2107 +|altitude|Высота над уровнем моря
2108 +|latitude|Широта
2109 +|longitude|Долгота
2110 +|satellites|Кол-во спутников
2111 +|course|Курс
2112 +|voltage|Бортовое напряжение
2113 +|parameters|Список параметров и их значений
2114 +|photoCount|Количество фото
2115 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2116 +|protocolType|ID типа протокола
2117 +
2118 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2119 +
2120 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2121 +
2122 +(% class="box infomessage" %)
2123 +(((
2124 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2125 +)))
2126 +
2127 +(% style="color:#000000" %)Метод запроса: **POST**
2128 +
2129 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2130 +
2131 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2132 +
2133 +(% style="text-align:left" %)
2134 +Тело запроса:
2135 +
2136 +{
2137 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2138 + "vehicleIds": [0], ~/~/ Список ID объектов
2139 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2140 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2141 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2142 +}
2143 +
2144 +Ответ:
2145 +
2146 +[
2147 + {
2148 + "vehicleId": 0, ~/~/ ID объекта
2149 + "name": "string", ~/~/ Имя ТС
2150 + "periods": [ ~/~/ Периоды
2151 + {
2152 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2153 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2154 + "mileageBegin": 0, ~/~/ Пробег на начало периода
2155 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
2156 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2157 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2158 + }
2159 + ]
2160 + }
2161 +]
2162 +
2163 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2164 +
2165 +(% class="box infomessage" %)
2166 +(((
2167 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2168 +)))
2169 +
2170 +(% style="color:#000000" %)Метод запроса: **POST**
2171 +
2172 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2173 +
2174 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2175 +
2176 +(% style="text-align:left" %)
2177 +Тело запроса:
2178 +
2179 +{
2180 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2181 + "vehicleIds": [0], ~/~/ Список ID объектов
2182 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2183 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2184 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2185 +}
2186 +
2187 +Ответ:
2188 +
2189 +[
2190 + {
2191 + "vehicleId": 0, ~/~/ ID объекта
2192 + "name": "string", ~/~/ Имя ТС
2193 + "periods": [ ~/~/ Периоды
2194 + {
2195 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2196 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2197 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2198 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2199 + "fuelConsumption": 0, ~/~/ Расход топлива
2200 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2201 + }
2202 + ]
2203 + }
2204 +]
2205 +
2206 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2207 +
2208 +(% class="box infomessage" %)
2209 +(((
2210 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2211 +)))
2212 +
2213 +(% style="color:#000000" %)Метод запроса: **POST**
2214 +
2215 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2216 +
2217 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2218 +
2219 +(% style="text-align:left" %)
2220 +Тело запроса:
2221 +
2222 +{
2223 + "vehicleIds": [0], ~/~/ Список ID объектов
2224 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2225 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2226 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2227 +}
2228 +
2229 +Ответ:
2230 +
2231 +[
2232 + {
2233 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2234 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2235 + "vehicleId": 0, ~/~/ ID объекта
2236 + "name": "string", ~/~/ Имя объекта
2237 + "model": "string", ~/~/ Модель объекта
2238 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2239 + {
2240 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2241 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2242 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2243 + "valueFuel": 0, ~/~/ Количество
2244 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2245 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2246 + }
2247 + ]
2248 + }
2249 +]
2250 +
2251 +
2252 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2253 +
2254 +(% class="box infomessage" %)
2255 +(((
2256 +**POST /api/v3/vehicles/moveStop**
2257 +)))
2258 +
2259 +Метод запроса: **POST**
2260 +
2261 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2262 +
2263 +В заголовках запроса: X-Auth: Токен авторизации
2264 +
2265 +
2266 +Тело запроса:
2267 +
2268 +{
2269 +
2270 + "vehicleIds": [ ], ~/~/ Список ID объектов
2271 +
2272 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2273 +
2274 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2275 +
2276 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2277 +
2278 +}
2279 +
2280 +Ответ:
2281 +
2282 +[
2283 +
2284 + {
2285 +
2286 + "vehicleId": 0, ~/~/ ID объекта
2287 +
2288 + "vehicleName": "string", ~/~/ Имя объекта
2289 +
2290 + "moves": [ ~/~/ Событие движения
2291 +
2292 + {
2293 +
2294 + "mileage": 0, ~/~/ Пробег, км
2295 +
2296 + "eventId": 0, ~/~/ Идентификатор события
2297 +
2298 + "eventName": "string", ~/~/ Название события
2299 +
2300 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2301 +
2302 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2303 +
2304 + "duration": 0 ~/~/ Продолжительность события, секунд
2305 +
2306 + }
2307 +
2308 + ],
2309 +
2310 + "stops": [ ~/~/ События стоянок
2311 +
2312 + {
2313 +
2314 + "address": "string", ~/~/ Адрес события
2315 +
2316 + "eventId": 0, ~/~/ Идентификатор события
2317 +
2318 + "eventName": "string", ~/~/ Название события
2319 +
2320 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2321 +
2322 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2323 +
2324 + "duration": 0 ~/~/ Продолжительность события, секунд
2325 +
2326 +
2327 + }
2328 +
2329 + ]
2330 +
2331 + }
2332 +
2333 +]
2334 +
2335 +
2336 +
2337 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2338 +
2339 +(% class="box infomessage" %)
2340 +(((
2341 +**POST /api/v3/vehicles/getlastdata**
2342 +)))
2343 +
2344 +Метод запроса: **POST**
2345 +
2346 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2347 +
2348 +В заголовках запроса: X-Auth: Токен авторизации
2349 +
2350 +
2351 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2352 +
2353 +Ответ:
2354 + {
2355 + "vehicleId": 0, ~/~/Идентификатор объекта.
2356 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2357 + "vehicleNumber": "string",~/~/Номер объекта.
2358 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2359 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2360 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2361 + "speed": 0,~/~/Скорость объекта.
2362 + "course": 0,~/~/Курс движения [0;360]
2363 + "latitude": 0,~/~/Широта [-90°;90°].
2364 + "longitude": 0,~/~/Долгота [-180°;180°].
2365 + "address": "string",~/~/Адрес.
2366 + "geozones": [ ~/~/Сведения по геозонам.
2367 + {
2368 + "id": 0,
2369 + "name": "string"
2370 + }
2371 +
2372 +
2373 +
2374 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2375 +
2376 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2377 +
2378 +(% class="box infomessage" %)
2379 +(((
2380 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2381 +)))
2382 +
2383 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2384 +
2385 +(% style="color:#000000" %)Метод запроса: **POST**
2386 +
2387 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2388 +
2389 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2390 +
2391 +(% style="text-align:left" %)
2392 +Тело запроса:
2393 +
2394 +(% style="text-align:left" %)
2395 +{
2396 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2397 +}
2398 +
2399 +(% style="text-align:left" %)
2400 +Ответ:
2401 +
2402 +[
2403 + {
2404 + "id": 0, ~/~/ Идентификатор объекта геозоны
2405 + "name": "string", ~/~/ Название объекта геозоны
2406 + "type": 0, ~/~/ Тип объекта геозоны
2407 + "fname": "string", ~/~/ Имя файла
2408 + "parentId": "string", ~/~/ Идентификатор клиента
2409 + "radius": 0, ~/~/ Радиус геообъекта
2410 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2411 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2412 + "description": "string", ~/~/ Описание
2413 + "area": 0, ~/~/ Площадь, м^^2^^
2414 + "perimetr": 0, ~/~/ Периметр, м
2415 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2416 + }
2417 +]
2418 +
2419 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2420 +
2421 +(% class="box infomessage" %)
2422 +(((
2423 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2424 +)))
2425 +
2426 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2427 +
2428 +(% style="color:#000000" %)Метод запроса: **POST**
2429 +
2430 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2431 +
2432 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2433 +
2434 +(% style="text-align:left" %)
2435 +Тело запроса:
2436 +
2437 +{
2438 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2439 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2440 + "ids": [ ], ~/~/ Массив id объектов
2441 + "byTime": 0, ~/~/ Объединение событий по времени 
2442 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2443 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2444 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2445 +}
2446 +
2447 +Ответ:
2448 +[
2449 + {
2450 + "geozoneId": 0, ~/~/ ID геообъекта
2451 + "geozoneName": "string", ~/~/ Название геообъекта
2452 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2453 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2454 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2455 + "vehicleId": 0, ~/~/ ID объекта
2456 + "vehicleName": "string" ~/~/ Имя объекта
2457 + }
2458 +]
2459 +
2460 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2461 +
2462 +(% class="box infomessage" %)
2463 +(((
2464 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2465 +)))
2466 +
2467 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2468 +
2469 +(% style="color:#000000" %)Метод запроса: **POST**
2470 +
2471 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2472 +
2473 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2474 +
2475 +(% style="text-align:left" %)
2476 +Тело запроса:
2477 +
2478 +{
2479 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2480 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2481 + "ids": [ ], ~/~/ Массив id геообъектов
2482 + "byTime": 0, ~/~/ Объединение событий по времени 
2483 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2484 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2485 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2486 +}
2487 +
2488 +Ответ:
2489 +
2490 +[
2491 + {
2492 + "geozoneId": 0, ~/~/ ID геообъекта
2493 + "geozoneName": "string", ~/~/ Название геообъекта
2494 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2495 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2496 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2497 + "vehicleId": 0, ~/~/ ID объекта
2498 + "vehicleName": "string" ~/~/ Имя объекта
2499 + }
2500 +]
2501 +
2502 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2503 +
2504 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2505 +
2506 +(% class="box infomessage" %)
2507 +(((
2508 +**POST /api/v3/notifications/find**
2509 +)))
2510 +
2511 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2512 +
2513 +(% style="text-align: left;" %)
2514 +Метод запроса **POST**
2515 +
2516 +(% style="text-align: left;" %)
2517 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2518 +
2519 +(% style="text-align: left;" %)
2520 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2521 +
2522 +{
2523 + "parentId": "" ~/~/ id клиента
2524 +}
2525 +
2526 +Ответ:
2527 +
2528 +[
2529 + {
2530 + "id": 0, ~/~/ ID уведомления
2531 + "name": "string", ~/~/ Название уведомления
2532 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2533 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2534 + "userId": "", ~/~/ Пользователь, создавший уведомление
2535 + "parentId": "", ~/~/ Идентификатор клиента
2536 + "parentName": "string" ~/~/ Имя клиента
2537 + }
2538 +]
2539 +
2540 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2541 +
2542 +(% class="box infomessage" %)
2543 +(((
2544 +**GET /api/v3/notifications/{id}**
2545 +)))
2546 +
2547 +Метод возвращает данные правил формирования выбранного уведомления.
2548 +
2549 +(% style="text-align: left;" %)
2550 +Метод запроса **GET**
2551 +
2552 +(% style="text-align: left;" %)
2553 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2554 +
2555 +(% style="text-align: left;" %)
2556 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2557 +
2558 +(% style="text-align: left;" %)
2559 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2560 +
2561 +(% style="text-align: left;" %)
2562 +(% style="color:#000000" %)Ответ:
2563 +
2564 +(% style="text-align: left;" %)
2565 +(% style="color:#000000" %){
2566 + "id": 0, ~/~/ (%%)id уведомления
2567 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2568 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2569 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2570 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2571 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2572 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2573 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2574 +(% style="color:#000000" %) 0
2575 + ],
2576 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2577 +(% style="color:#000000" %) 0
2578 + ],
2579 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
2580 +(% style="color:#000000" %) 0
2581 + ],
2582 + "settings": { ~/~/ Список параметров уведомления
2583 + "additionalProp1": "string",
2584 + "additionalProp2": "string",
2585 + "additionalProp3": "string"
2586 + },
2587 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2588 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2589 +(% style="color:#000000" %) ""
2590 + ],
2591 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2592 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2593 +(% style="color:#000000" %) "string"
2594 + ],
2595 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2596 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2597 +(% style="color:#000000" %) {
2598 + "id": 0, ~/~/ (%%)Идентификатор участника чата
2599 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2600 +(% style="color:#000000" %) }
2601 + ],
2602 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2603 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2604 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2605 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2606 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2607 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2608 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2609 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2610 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2611 +(% style="color:#000000" %)}
2612 +
2613 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2614 +
2615 +(% class="box warningmessage" %)
2616 +(((
2617 +**PUT /api/v3/notifications/**
2618 +)))
2619 +
2620 +Метод позволяет отредактировать уведомление.
2621 +
2622 +Метод запроса **PUT**
2623 +
2624 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2625 +
2626 +В заголовках запроса: X-Auth: Токен авторизации
2627 +
2628 +Тело запроса:
2629 +{
2630 + "id": 0, ~/~/ id уведомления
2631 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2632 + "userId": "", ~/~/ Пользователь, создавший уведомление
2633 + "parentId": "", ~/~/ Идентификатор клиента
2634 + "parentName": "string", ~/~/ Имя клиента
2635 + "name": "string", ~/~/ Название уведомления
2636 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2637 + "vehicleIds": [ ~/~/ Список id объектов для анализа
2638 + 0
2639 + ],
2640 + "geoids": [ ~/~/ Список id геообъектов для анализа
2641 + 0
2642 + ],
2643 + "fieldids": [ ~/~/ Список id полей для анализа
2644 + 0
2645 + ],
2646 + "settings": { ~/~/ Список параметров уведомления
2647 + "additionalProp1": "string",
2648 + "additionalProp2": "string",
2649 + "additionalProp3": "string"
2650 + },
2651 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2652 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2653 + ""
2654 + ],
2655 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2656 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2657 + "string"
2658 + ],
2659 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2660 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2661 + {
2662 + "id": 0, ~/~/ Идентификатор участника чата
2663 + "info": "string" ~/~/ Дополнительные сведения
2664 + }
2665 + ],
2666 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2667 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2668 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2669 + "kind": 0, ~/~/ Определяет вид уведомления
2670 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2671 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2672 + "timezone": 0, ~/~/ Сдвиг часового пояса
2673 + "validity": 0, ~/~/ Срок действия в днях (1-90)
2674 + "autoProlongation": true ~/~/ Автопродление срока действия
2675 +}
2676 +
2677 +Ответ:
2678 +
2679 +Success
2680 +
2681 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2682 +
2683 +(% class="box errormessage" %)
2684 +(((
2685 +**DELETE /api/v3/notifications/{id}**
2686 +)))
2687 +
2688 +Метод позволяет удалить выбранное уведомление.
2689 +
2690 +Метод запроса **DELETE**
2691 +
2692 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2693 +
2694 +Передаваемый параметр: {id} - id уведомления
2695 +
2696 +В заголовках запроса: X-Auth: Токен авторизации
2697 +
2698 +Ответ:
2699 +
2700 +Success
2701 +
2702 +
2703 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2704 +
2705 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2706 +
2707 +(% class="box infomessage" %)
2708 +(((
2709 +**POST /api/v3/Drivers/find**
2710 +)))
2711 +
2712 +Передается параметр: parentId - ID клиента-родителя
2713 +
2714 +Ответ:
2715 +
2716 +[
2717 + {
2718 + "name": "string", ~/~/ Определяет наименование
2719 + "description": "string", ~/~/ Определяет описание
2720 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2721 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2722 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2723 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2724 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2725 + "deleted": true ~/~/ Признак удаления
2726 + }
2727 +]
2728 +
2729 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2730 +
2731 +(% class="box infomessage" %)
2732 +(((
2733 +**GET /api/v3/Drivers/{driverGuid}**
2734 +)))
2735 +
2736 +Передается параметр: ID водителя
2737 +
2738 +Ответ:
2739 +
2740 +{
2741 + "name": "string", ~/~/ Определяет наименование
2742 + "description": "string", ~/~/ Определяет описание
2743 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2744 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2745 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2746 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2747 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2748 + "deleted": true ~/~/ Признак удаления
2749 +}
2750 +
2751 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2752 +
2753 +(% class="box successmessage" %)
2754 +(((
2755 +**POST /api/v3/Drivers**
2756 +)))
2757 +
2758 +Запрос:
2759 +
2760 +{
2761 + "name": "string",
2762 + "description": "string",
2763 + "hiredate": "2023-06-30T12:50:54.020Z",
2764 + "chopdate": "2023-06-30T12:50:54.020Z",
2765 + "exclusive": true,
2766 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2767 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2768 + "deleted": true
2769 +}
2770 +
2771 +Ответ:
2772 +
2773 +{
2774 + "name": "string",
2775 + "description": "string",
2776 + "hiredate": "2023-06-30T12:50:54.051Z",
2777 + "chopdate": "2023-06-30T12:50:54.051Z",
2778 + "exclusive": true,
2779 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2780 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2781 + "deleted": true
2782 +}
2783 +
2784 +
2785 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2786 +
2787 +(% class="box warningmessage" %)
2788 +(((
2789 +**PUT /api/v3/Drivers**
2790 +)))
2791 +
2792 +Запрос:
2793 +
2794 +{
2795 + "name": "string",
2796 + "description": "string",
2797 + "hiredate": "2023-06-30T12:50:27.910Z",
2798 + "chopdate": "2023-06-30T12:50:27.910Z",
2799 + "exclusive": true,
2800 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2801 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2802 + "deleted": true
2803 +}
2804 +
2805 +Ответ:
2806 +
2807 +{
2808 + "name": "string",
2809 + "description": "string",
2810 + "hiredate": "2023-06-30T12:50:27.929Z",
2811 + "chopdate": "2023-06-30T12:50:27.929Z",
2812 + "exclusive": true,
2813 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2814 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2815 + "deleted": true
2816 +}
2817 +
2818 +
2819 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2820 +
2821 +(% class="box errormessage" %)
2822 +(((
2823 +**DELETE /api/v3/Drivers/{driverGuid}**
2824 +)))
2825 +
2826 +Передается параметр: ID водителя
2827 +
2828 +Ответ:
2829 +
2830 +Success
2831 +
2832 +
2833 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2834 +
2835 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2836 +
2837 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2838 +
2839 +(% class="box infomessage" %)
2840 +(((
2841 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2842 +)))
2843 +
2844 +Запрос:
2845 +
2846 +{
2847 + "Ids": [
2848 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2849 + ],
2850 + "BeginTime": "2023-06-30T12:49:04.365Z",
2851 + "EndTime": "2023-06-30T12:49:04.365Z"
2852 +}
2853 +
2854 +Ответ:
2855 +
2856 +[
2857 + {
2858 + "VehicleId": 0,
2859 + "CreateTime": "2023-06-30T09:52:31.240Z",
2860 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2861 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2862 + "BeginTime": "2023-06-30T09:52:31.240Z",
2863 + "EndTime": "2023-06-30T09:52:31.240Z"
2864 + }
2865 +]
2866 +
2867 +
2868 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2869 +
2870 +(% class="box infomessage" %)
2871 +(((
2872 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2873 +)))
2874 +
2875 +Запрос:
2876 +
2877 +{
2878 + "Ids": [
2879 + 0
2880 + ],
2881 + "BeginTime": "2023-06-30T12:48:39.419Z",
2882 + "EndTime": "2023-06-30T12:48:39.419Z"
2883 +}
2884 +
2885 +Ответ:
2886 +
2887 +[
2888 + {
2889 + "VehicleId": 0,
2890 + "CreateTime": "2023-06-30T09:54:01.631Z",
2891 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2892 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2893 + "BeginTime": "2023-06-30T09:54:01.631Z",
2894 + "EndTime": "2023-06-30T09:54:01.631Z"
2895 + }
2896 +]
2897 +
2898 +
2899 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2900 +
2901 +(% class="box successmessage" %)
2902 +(((
2903 +**POST /api/v3/DriversVehiclesAssignments**
2904 +)))
2905 +
2906 +Передается массив назначений
2907 +
2908 +Запрос:
2909 +
2910 +[
2911 + {
2912 + "VehicleId": 0, ~/~/ Идентификатор объекта
2913 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2914 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2915 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2916 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2917 + }
2918 +]
2919 +
2920 +Ответ:
2921 +
2922 +[
2923 + {
2924 + "VehicleId": 0,
2925 + "CreateTime": "2023-06-30T11:04:46.903Z",
2926 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2927 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2928 + "BeginTime": "2023-06-30T11:04:46.903Z",
2929 + "EndTime": "2023-06-30T11:04:46.903Z"
2930 + }
2931 +]
2932 +
2933 +
2934 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2935 +
2936 +(% class="box warningmessage" %)
2937 +(((
2938 +**PUT /api/v3/DriversVehiclesAssignments**
2939 +)))
2940 +
2941 +Запрос:
2942 +
2943 +[
2944 + {
2945 + "VehicleId": 0,
2946 + "CreateTime": "2023-06-30T11:14:08.117Z",
2947 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2948 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2949 + "BeginTime": "2023-06-30T11:14:08.117Z",
2950 + "EndTime": "2023-06-30T11:14:08.117Z"
2951 + }
2952 +]
2953 +
2954 +Ответ:
2955 +
2956 +[
2957 + {
2958 + "VehicleId": 0,
2959 + "CreateTime": "2023-06-30T11:14:53.349Z",
2960 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2961 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2962 + "BeginTime": "2023-06-30T11:14:53.349Z",
2963 + "EndTime": "2023-06-30T11:14:53.349Z"
2964 + }
2965 +]
2966 +
2967 +
2968 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2969 +
2970 +(% class="box errormessage" %)
2971 +(((
2972 +**DELETE /api/v3/DriversVehiclesAssignments**
2973 +)))
2974 +
2975 +Запрос:
2976 +
2977 +[
2978 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2979 +]
2980 +
2981 +Ответ:
2982 +
2983 +Success
2984 +
2985 +
2986 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2987 +
2988 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2989 +
2990 +(% class="box infomessage" %)
2991 +(((
2992 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2993 +)))
2994 +
2995 +Запрос:
2996 +
2997 +{
2998 + "Ids": [
2999 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3000 + ],
3001 + "BeginTime": "2023-06-30T12:47:12.162Z",
3002 + "EndTime": "2023-06-30T12:47:12.162Z"
3003 +}
3004 +
3005 +Ответ:
3006 +
3007 +[
3008 + {
3009 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3010 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3011 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3012 + "BeginTime": "2023-06-30T11:19:40.703Z",
3013 + "EndTime": "2023-06-30T11:19:40.703Z"
3014 + }
3015 +]
3016 +
3017 +
3018 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3019 +
3020 +(% class="box infomessage" %)
3021 +(((
3022 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3023 +)))
3024 +
3025 +Запрос:
3026 +
3027 +{
3028 + "Ids": [
3029 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3030 + ],
3031 + "BeginTime": "2023-06-30T12:47:12.162Z",
3032 + "EndTime": "2023-06-30T12:47:12.162Z"
3033 +}
3034 +
3035 +Ответ:
3036 +
3037 +[
3038 + {
3039 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3040 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3041 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3042 + "BeginTime": "2023-06-30T11:19:40.703Z",
3043 + "EndTime": "2023-06-30T11:19:40.703Z"
3044 + }
3045 +]
3046 +
3047 +
3048 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3049 +
3050 +(% class="box successmessage" %)
3051 +(((
3052 +**POST /api/v3/DriversRfidsAssignments**
3053 +)))
3054 +
3055 +Запрос:
3056 +
3057 +[
3058 + {
3059 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3060 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3061 + "BeginTime": "2023-06-30T11:27:08.635Z",
3062 + "EndTime": "2023-06-30T11:27:08.635Z"
3063 + }
3064 +]
3065 +
3066 +Ответ:
3067 +
3068 +[
3069 + {
3070 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3071 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3072 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3073 + "BeginTime": "2023-06-30T11:27:08.677Z",
3074 + "EndTime": "2023-06-30T11:27:08.677Z"
3075 + }
3076 +]
3077 +
3078 +
3079 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3080 +
3081 +(% class="box warningmessage" %)
3082 +(((
3083 +**PUT /api/v3/DriversRfidsAssignments**
3084 +)))
3085 +
3086 +Запрос:
3087 +
3088 +[
3089 + {
3090 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3091 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3092 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3093 + "BeginTime": "2023-06-30T11:28:43.330Z",
3094 + "EndTime": "2023-06-30T11:28:43.330Z"
3095 + }
3096 +]
3097 +
3098 +Ответ:
3099 +
3100 +[
3101 + {
3102 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3103 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3104 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3105 + "BeginTime": "2023-06-30T11:28:43.331Z",
3106 + "EndTime": "2023-06-30T11:28:43.331Z"
3107 + }
3108 +]
3109 +
3110 +
3111 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3112 +
3113 +(% class="box errormessage" %)
3114 +(((
3115 +**DELETE /api/v3/DriversRfidsAssignments**
3116 +)))
3117 +
3118 +Запрос:
3119 +
3120 +[
3121 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3122 +]
3123 +
3124 +Ответ:
3125 +
3126 +Success
3127 +
3128 +
3129 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3130 +
3131 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3132 +
3133 +(% class="box infomessage" %)
3134 +(((
3135 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3136 +)))
3137 +
3138 +Запрос:
3139 +
3140 +{
3141 + "Ids": [
3142 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3143 + ],
3144 + "BeginTime": "2023-06-30T12:45:10.852Z",
3145 + "EndTime": "2023-06-30T12:45:10.852Z"
3146 +}
3147 +
3148 +Ответ:
3149 +
3150 +[
3151 + {
3152 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3153 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3154 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3155 + "BeginTime": "2023-06-30T11:58:04.695Z",
3156 + "EndTime": "2023-06-30T11:58:04.695Z"
3157 + }
3158 +]
3159 +
3160 +
3161 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3162 +
3163 +(% class="box infomessage" %)
3164 +(((
3165 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3166 +)))
3167 +
3168 +Запрос:
3169 +
3170 +{
3171 + "Ids": [
3172 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3173 + ],
3174 + "BeginTime": "2023-06-30T12:45:10.852Z",
3175 + "EndTime": "2023-06-30T12:45:10.852Z"
3176 +}
3177 +
3178 +Ответ:
3179 +
3180 +[
3181 + {
3182 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3183 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3184 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3185 + "BeginTime": "2023-06-30T11:58:04.695Z",
3186 + "EndTime": "2023-06-30T11:58:04.695Z"
3187 + }
3188 +]
3189 +
3190 +
3191 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3192 +
3193 +(% class="box successmessage" %)
3194 +(((
3195 +**POST /api/v3/DriversFuelCardsAssignments**
3196 +)))
3197 +
3198 +Запрос:
3199 +
3200 +[
3201 + {
3202 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3203 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3204 + "BeginTime": "2023-06-30T12:09:53.175Z",
3205 + "EndTime": "2023-06-30T12:09:53.175Z"
3206 + }
3207 +]
3208 +
3209 +Ответ:
3210 +
3211 +[
3212 + {
3213 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3214 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3215 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3216 + "BeginTime": "2023-06-30T12:09:53.201Z",
3217 + "EndTime": "2023-06-30T12:09:53.201Z"
3218 + }
3219 +]
3220 +
3221 +
3222 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3223 +
3224 +(% class="box warningmessage" %)
3225 +(((
3226 +**PUT /api/v3/DriversFuelCardsAssignments**
3227 +)))
3228 +
3229 +Запрос:
3230 +
3231 +[
3232 + {
3233 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3234 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3235 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3236 + "BeginTime": "2023-06-30T12:09:53.201Z",
3237 + "EndTime": "2023-06-30T12:09:53.201Z"
3238 + }
3239 +]
3240 +
3241 +Ответ:
3242 +
3243 +[
3244 + {
3245 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3248 + "BeginTime": "2023-06-30T12:09:53.201Z",
3249 + "EndTime": "2023-06-30T12:09:53.201Z"
3250 + }
3251 +]
3252 +
3253 +
3254 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3255 +
3256 +(% class="box errormessage" %)
3257 +(((
3258 +**DELETE /api/v3/DriversFuelCardsAssignments**
3259 +)))
3260 +
3261 +Запрос:
3262 +
3263 +[
3264 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3265 +]
3266 +
3267 +Ответ:
3268 +
3269 +Success
3270 +
3271 +
3272 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3273 +
3274 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3275 +
3276 +(% class="box infomessage" %)
3277 +(((
3278 +**POST /api/v3/Trailers**
3279 +)))
3280 +
3281 +Пример запроса:
3282 +
3283 +{
3284 + "startDate": "2023-11-14T10:48:03.671Z",
3285 + "endDate": "2023-11-14T10:48:03.671Z",
3286 + "ids": [ 0 ],
3287 + "timezone": 0
3288 +}
3289 +
3290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3291 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3292 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3293 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3294 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3295 +
3296 +Пример ответа:
3297 +
3298 +[
3299 + {
3300 + "SD": "2023-11-14T10:48:03.717Z",
3301 + "ED": "2023-11-14T10:48:03.717Z", 
3302 + "id": 0,
3303 + "SLat": 0,
3304 + "SLon": 0,
3305 + "ELat": 0,
3306 + "ELon": 0,
3307 + "mileage": 0
3308 + "Duration": 0
3309 + "Address": "string",
3310 + "Address2": "string",
3311 + "name": "string",
3312 + "rid": "string",
3313 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3314 + "trailer": {
3315 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3316 + "Number": "string",
3317 + "Description": "string",
3318 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3319 + "ExternalID": "string",
3320 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3321 + "CreateTime": "2023-11-14T10:48:03.717Z",
3322 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3323 + "IsDeleted": true
3324 + },
3325 + "filesCount": 0,
3326 + }
3327 +]
3328 +
3329 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3330 +|SD|Дата и время начала события
3331 +|ED|Дата и время окончания события
3332 +|id|ID объекта
3333 +|SLat|Широта начальной координаты
3334 +|SLon|Долгота начальной координаты
3335 +|ELat|Широта конечной координаты
3336 +|ELon|Долгота конечной координаты
3337 +|mileage|Пробег
3338 +|Duration|Продолжительность
3339 +|Address|Адрес начального местоположения
3340 +|Address2|Адрес конечного местоположения
3341 +|name|Имя радиометки
3342 +|rid|Номер радиометки
3343 +|rguid|ID радиометки
3344 +|trailer|Информация об агрегате
3345 +|ModelGuid|ID агрегата
3346 +|Number|Название/номер агрегата
3347 +|Description|Текст примечания агрегата
3348 +
3349 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3350 +
3351 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3352 +
3353 +(% class="box infomessage" %)
3354 +(((
3355 +**POST /api/v3/Rfids/find**
3356 +)))
3357 +
3358 +Запрос:
3359 +
3360 +{
3361 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3362 +}
3363 +
3364 +Ответ:
3365 +
3366 +[
3367 + {
3368 + "name": "string",
3369 + "number": 0,
3370 + "period": 0,
3371 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3372 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3373 + }
3374 +]
3375 +
3376 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3377 +|parentId|ID клиента
3378 +|name|Название карты-метки
3379 +|number|Номер
3380 +|period|Период запросов в секундах (работает только для агрегатов)
3381 +|id|ID карты-метки
3382 +
3383 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3384 +
3385 +(% class="box infomessage" %)
3386 +(((
3387 +**GET /api/v3/Rfids/{rfidGuid}**
3388 +)))
3389 +
3390 +Передаем параметр rfidGuid - идентификатор карты-метки
3391 +
3392 +Ответ:
3393 +
3394 +[
3395 + {
3396 + "name": "string",
3397 + "number": 0,
3398 + "period": 0,
3399 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3400 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3401 + }
3402 +]
3403 +
3404 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3405 +|name|Название карты-метки
3406 +|number|Номер
3407 +|period|Период запросов в секундах (работает только для агрегатов)
3408 +|id|ID карты-метки
3409 +|parentId|ID клиента
3410 +
3411 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3412 +
3413 +(% class="box successmessage" %)
3414 +(((
3415 +**POST /api/v3/Rfids**
3416 +)))
3417 +
3418 +Запрос:
3419 +
3420 +{
3421 + "name": "string",
3422 + "number": 0,
3423 + "period": 0,
3424 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3425 +}
3426 +
3427 +Ответ:
3428 +
3429 +{
3430 + "name": "string",
3431 + "number": 0,
3432 + "period": 0,
3433 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3434 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3435 +}
3436 +
3437 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3438 +|name|Название карты-метки
3439 +|number|Номер
3440 +|period|Период запросов в секундах (работает только для агрегатов)
3441 +|id|ID карты-метки
3442 +|parentId|ID клиента
3443 +
3444 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3445 +
3446 +(% class="box warningmessage" %)
3447 +(((
3448 +**PUT /api/v3/Rfids**
3449 +)))
3450 +
3451 +Запрос:
3452 +
3453 +{
3454 + "name": "string",
3455 + "number": 0,
3456 + "period": 0,
3457 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3458 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3459 +}
3460 +
3461 +Ответ:
3462 +
3463 +{
3464 + "name": "string",
3465 + "number": 0,
3466 + "period": 0,
3467 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3469 +}
3470 +
3471 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3472 +|name|Название карты-метки
3473 +|number|Номер
3474 +|period|Период запросов в секундах (работает только для агрегатов)
3475 +|id|ID карты-метки
3476 +|parentId|ID клиента
3477 +
3478 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3479 +
3480 +(% class="box errormessage" %)
3481 +(((
3482 +**DELETE /api/v3/Rfids/{rfidGuid}**
3483 +)))
3484 +
3485 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3486 +
3487 +Ответ:
3488 +
3489 +Success
3490 +
3491 +
3492 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3493 +
3494 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3495 +
3496 +(% class="box infomessage" %)
3497 +(((
3498 +**GET /api/v3/Billing/client/balance/{clientId}**
3499 +)))
3500 +
3501 +Параметр запроса: **clientId **- идентификатор клиента.
3502 +
3503 +Ответ:
3504 +
3505 +{
3506 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3507 + "Balance": 0
3508 +}
3509 +
3510 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3511 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3512 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3513 +
3514 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3515 +
3516 +(% class="box infomessage" %)
3517 +(((
3518 +**GET /api/v3/Billing/client/constraint/{clientId}**
3519 +)))
3520 +
3521 +Параметр запроса: **clientId **- идентификатор клиента.
3522 +
3523 +Ответ:
3524 +
3525 +{
3526 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3527 + "CalculationType": 0,
3528 + "PermissibleBalance": 0,
3529 + "DefermentDays": 0,
3530 + "SendUiNotifications": true,
3531 + "SendEmailNotifications": true,
3532 + "IsPrivate": true,
3533 +}
3534 +
3535 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3536 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3537 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3538 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3539 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3540 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3541 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3542 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3543 +
3544 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3545 +
3546 +(% class="box infomessage" %)
3547 +(((
3548 +**GET /api/v3/Billing/client/plan/{clientId}**
3549 +)))
3550 +
3551 +Параметры запроса:
3552 +
3553 +**clientId **- идентификатор клиента.
3554 +
3555 +**planId **- идентификатор тарифного плана.
3556 +
3557 +Ответ:
3558 +
3559 +{
3560 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3561 + "Plan": { **~/~/ Описание тарифного плана**
3562 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3563 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3564 + "Name": "string",
3565 + "IsArchived": true,
3566 + "Constraint": {
3567 + "CalculationType": 0,
3568 + "PermissibleBalance": 0,
3569 + "DefermentDays": 0
3570 + },
3571 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3572 + {
3573 + "Feature": "string",
3574 + "IsFactual": true,
3575 + "Limit": 0,
3576 + "Price": 0,
3577 + "PeriodValue": 0,
3578 + "PeriodType": 0
3579 + }
3580 + ]
3581 + },
3582 + "DebitDate": "2023-10-18T12:46:24.213Z",
3583 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3584 + {
3585 + "Feature": "string",
3586 + "IsEnabled": true,
3587 + "IsPrivate": true,
3588 + "IsFactual": true,
3589 + "Limit": 0,
3590 + "Price": 0,
3591 + "DebitDate": "2023-10-18T12:46:24.213Z",
3592 + "PeriodValue": 0,
3593 + "PeriodType": 0
3594 + }
3595 + ]
3596 +}
3597 +
3598 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3599 +|ClientId|Идентификатор клиента
3600 +|Id|Идентификатор тарифного плана
3601 +|OwnerId|Идентификатор клиента-владельца
3602 +|Name|Наименование тарифного плана
3603 +|IsArchived|Признак, определяющий архивный тарифный план
3604 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3605 +|PermissibleBalance|Допустимый баланс
3606 +|DefermentDays|Отсрочка, количество дней
3607 +|Feature|Код услуги
3608 +|IsEnabled|Признак, определяющий активирована ли услуга
3609 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3610 +|IsFactual|Признак, определяющий расчёт по факту
3611 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3612 +|Price|Цена за единицу.
3613 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3614 +|PeriodValue|Значение периода.
3615 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3616 +
3617 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3618 +
3619 +(% class="box infomessage" %)
3620 +(((
3621 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3622 +)))
3623 +
3624 +Параметр запроса: **clientId **- идентификатор клиента.
3625 +
3626 +Ответ:
3627 +
3628 +[
3629 + {
3630 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3631 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 + "Name": "string",
3633 + "IsArchived": true,
3634 + "Constraint": {
3635 + "CalculationType": 0,
3636 + "PermissibleBalance": 0,
3637 + "DefermentDays": 0
3638 + },
3639 + "Features": [
3640 + {
3641 + "Feature": "string",
3642 + "IsFactual": true,
3643 + "Limit": 0,
3644 + "Price": 0,
3645 + "PeriodValue": 0,
3646 + "PeriodType": 0
3647 + }
3648 + ]
3649 + }
3650 +]
3651 +
3652 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3653 +|ClientId|Идентификатор клиента
3654 +|Id|Идентификатор тарифного плана
3655 +|OwnerId|Идентификатор клиента-владельца
3656 +|Name|Наименование тарифного плана
3657 +|IsArchived|Признак, определяющий архивный тарифный план
3658 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3659 +|PermissibleBalance|Допустимый баланс
3660 +|DefermentDays|Отсрочка, количество дней
3661 +|Feature|Код услуги
3662 +|IsFactual|Признак, определяющий расчёт по факту
3663 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3664 +|Price|Цена за единицу.
3665 +|PeriodValue|Значение периода.
3666 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3667 +
3668 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3669 +
3670 +(% class="box infomessage" %)
3671 +(((
3672 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3673 +)))
3674 +
3675 +Параметр запроса: **clientId **- идентификатор клиента.
3676 +
3677 +Ответ:
3678 +
3679 +[
3680 + {
3681 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3682 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3683 + "Name": "string",
3684 + "IsArchived": true,
3685 + "Constraint": {
3686 + "CalculationType": 0,
3687 + "PermissibleBalance": 0,
3688 + "DefermentDays": 0
3689 + },
3690 + "Features": [
3691 + {
3692 + "Feature": "string",
3693 + "IsFactual": true,
3694 + "Limit": 0,
3695 + "Price": 0,
3696 + "PeriodValue": 0,
3697 + "PeriodType": 0
3698 + }
3699 + ]
3700 + }
3701 +]
3702 +
3703 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3704 +|ClientId|Идентификатор клиента
3705 +|Id|Идентификатор тарифного плана
3706 +|OwnerId|Идентификатор клиента-владельца
3707 +|Name|Наименование тарифного плана
3708 +|IsArchived|Признак, определяющий архивный тарифный план
3709 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3710 +|PermissibleBalance|Допустимый баланс
3711 +|DefermentDays|Отсрочка, количество дней
3712 +|Feature|Код услуги
3713 +|IsFactual|Признак, определяющий расчёт по факту
3714 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3715 +|Price|Цена за единицу.
3716 +|PeriodValue|Значение периода.
3717 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3718 +
3719 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3720 +
3721 +(% class="box warningmessage" %)
3722 +(((
3723 +**PUT /api/v3/Billing/client/balance**
3724 +)))
3725 +
3726 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3727 +
3728 +Тело запроса:
3729 +
3730 +{
3731 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3732 + "Balance": 0
3733 +}
3734 +
3735 +Ответ: Success
3736 +
3737 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3738 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3739 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3740 +
3741 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3742 +
3743 +(% class="box warningmessage" %)
3744 +(((
3745 +**PUT /api/v3/billing/client/balance/deposit**
3746 +)))
3747 +
3748 +Создает операцию **Пополнение **с указанной суммой
3749 +
3750 +Тело запроса:
3751 +
3752 +{
3753 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3754 + "Balance": 0
3755 +}
3756 +
3757 +Ответ: Success
3758 +
3759 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3760 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3761 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3762 +
3763 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3764 +
3765 +Создает операцию **Списание **с указанной суммой
3766 +
3767 +(% class="box warningmessage" %)
3768 +(((
3769 +**PUT /api/v3/billing/client/balance/withdraw**
3770 +)))
3771 +
3772 +Тело запроса:
3773 +
3774 +{
3775 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3776 + "Balance": 0
3777 +}
3778 +
3779 +Ответ: Success
3780 +
3781 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3783 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3784 +
3785 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3786 +
3787 +(% class="box warningmessage" %)
3788 +(((
3789 +**PUT /api/v3/Billing/client/constraint**
3790 +)))
3791 +
3792 +Тело запроса:
3793 +
3794 +{
3795 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3796 + "CalculationType": 0,
3797 + "PermissibleBalance": 0,
3798 + "DefermentDays": 0,
3799 + "SendUiNotifications": true,
3800 + "SendEmailNotifications": true,
3801 + "IsPrivate": true,
3802 +}
3803 +
3804 +Ответ: Success
3805 +
3806 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3807 +|ClientId|Идентификатор клиента
3808 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3809 +|PermissibleBalance|Допустимый баланс
3810 +|DefermentDays|(((
3811 +Отсрочка, количество дней
3812 +)))
3813 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3814 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3815 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3816 +
3817 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3818 +
3819 +(% class="box warningmessage" %)
3820 +(((
3821 +**PUT /api/v3/Billing/client/plan**
3822 +)))
3823 +
3824 +Тело запроса:
3825 +
3826 +{
3827 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3828 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3829 + "Features": [
3830 + {
3831 + "Feature": "string",
3832 + "IsEnabled": true,
3833 + "IsFactual": true,
3834 + "Limit": 0,
3835 + "Price": 0,
3836 + "DebitDate": "2023-10-18T13:26:58.987Z",
3837 + "PeriodValue": 0,
3838 + "PeriodType": 0
3839 + }
3840 + ]
3841 +}
3842 +
3843 +Ответ: Success
3844 +
3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3846 +|ClientId|Идентификатор клиента
3847 +|PlanId|Идентификатор тарифного плана
3848 +|Feature|Код услуги
3849 +|IsEnabled|Признак, определяющий активирована ли услуга
3850 +|IsFactual|Признак, определяющий расчёт по факту
3851 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3852 +|Price|Цена за единицу.
3853 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3854 +|PeriodValue|Значение периода.
3855 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3856 +
3857 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3858 +
3859 +(% class="box warningmessage" %)
3860 +(((
3861 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3862 +)))
3863 +
3864 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3865 +
3866 +(% class="box infomessage" %)
3867 +(((
3868 +**POST /api/v3/vehicles/import/{agentId}**
3869 +)))
3870 +
3871 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3872 +
3873 +В пути указывается **agentId** - id клиента.
3874 +
3875 +**Заголовок**
3876 +
3877 +**X-Auth: [токен авторизации]**
3878 +
3879 +**Параметры**
3880 +
3881 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3882 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3883 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3884 +
3885 +В теле использовать тип **form-data,** тип значения** file**
3886 +
3887 +**Ключи**
3888 +
3889 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3890 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3891 +|csv|В значении передаем файл датчиков, формат **csv**
3892 +
3893 +Ответ:
3894 +
3895 +{
3896 + "vehicleId": 0,
3897 + "name": "string",
3898 + "errors": ["string"]
3899 +}
3900 +
3901 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3902 +|vehicleId|ID созданного объекта
3903 +|name|Имя созданного объекта
3904 +|errors|Ошибки и их описание
3905 +
3906 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3907 +
3908 +(% class="box infomessage" %)
3909 +(((
3910 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3911 +)))
3912 +
3913 +(% class="wikigeneratedid" %)
3914 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3915 +
3916 +(% class="wikigeneratedid" %)
3917 +В пути указывается **vehicleId **- id объекта.
3918 +
3919 +**Заголовок**
3920 +
3921 +**X-Auth: [токен авторизации]**
3922 +
3923 +В теле использовать тип **form-data.**
3924 +
3925 +Ключи:
3926 +
3927 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3928 +|**history**|В значении передавать файл с историей
3929 +
3930 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3931 +
3932 +Ответ:
3933 +
3934 +{
3935 + "results": [
3936 + {
3937 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3938 + "vehicleId": 0,
3939 + "errors": [
3940 + "string"
3941 + ],
3942 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3943 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3944 + "producedCount": 0,
3945 + "msgCount": 0
3946 + }
3947 + ]
3948 +}
3949 +
3950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3951 +|results|Результаты импорта в разрезе ТС
3952 +|vehicleGuid|Guid ТС
3953 +|vehicleId|ID ТС
3954 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3955 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3956 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3957 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3958 +|msgCount|Кол-во обработанных сообщений всего
3959 +
3960 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3961 +
3962 +(% class="box infomessage" %)
3963 +(((
3964 +**GET /api/v3/vehicles/import/history/status**
3965 +)))
3966 +
3967 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3968 +
3969 +Ответ:
3970 +
3971 +{
3972 + "activity": true,
3973 + "progress": 0,
3974 + "message": "string"
3975 +}
3976 +
3977 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3978 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3979 +|progress|Guid ТС
3980 +
3981 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3982 +
3983 +(% class="box infomessage" %)
3984 +(((
3985 +**POST /api/v3/vehicles/export**
3986 +)))
3987 +
3988 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3989 +
3990 +Тело запроса:
3991 +
3992 +[
3993 + id
3994 +]
3995 +
3996 +Ответ: Success 200, получаете файлы с настройками.
3997 +
3998 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3999 +
4000 +(% class="box infomessage" %)
4001 +(((
4002 +**POST /api/v3/vehicles/export/history**
4003 +)))
4004 +
4005 +Метод возвращает список сообщений терминала объекта за выбранный период.
4006 +
4007 +Тело запроса:
4008 +
4009 +{
4010 + "vehicleId": 0,
4011 + "asArchive": true,
4012 + "from": "2023-09-27T12:17:45.973Z",
4013 + "to": "2023-09-27T12:17:45.973Z"
4014 +}
4015 +
4016 +Ответ:
4017 +
4018 +Получаете файл. Сообщение: Code 200/Success
4019 +
4020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4021 +|vehicleId|ID объекта
4022 +|asArchive|true - Архивировать файл, False - не архивировать
4023 +|from|Дата и время начала запроса
4024 +|to|Дата и время окончания запроса
4025 +
4026 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4027 +
4028 +(% class="box infomessage" %)
4029 +(((
4030 +**GET /api/v3/vehicles/export/history/status**
4031 +)))
4032 +
4033 +Метод возвращает список сообщений терминала объекта за выбранный период.
4034 +
4035 +Ответ:
4036 +
4037 +{
4038 + "activity": true,
4039 + "progress": 0,
4040 + "message": "string"
4041 +}
4042 +
4043 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4044 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4045 +|progress|Прогресс экспорта, от 0 до 100%
4046 +|message|Текст описывающий статус
4047 +
4048 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4049 +
4050 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4051 +
4052 +(% class="box infomessage" %)
4053 +(((
4054 +**POST /api/v3/EcoDriving/rating**
4055 +)))
4056 +
4057 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4058 +
4059 +Тело запроса:
4060 +
4061 +{
4062 + "vehicleIds": [vehicleId],
4063 + "from": "2023-11-22T09:29:48.051Z",
4064 + "to": "2023-11-22T09:29:48.051Z"
4065 +}
4066 +
4067 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4068 +|vehicleIds|Массив ID объектов
4069 +|from|Дата начала запроса
4070 +|to|Дата окончания запроса
4071 +
4072 +Ответ:
4073 +
4074 +{
4075 + "items": [
4076 + {
4077 + "from": "2023-11-22T09:29:48.052Z",
4078 + "to": "2023-11-22T09:29:48.052Z",
4079 + "vehicleId": 0,
4080 + "vehicleName": "string",
4081 + "vehicleModel": "string",
4082 + "penalty": 0,
4083 + "score": 0,
4084 + "totalViolations": 0,
4085 + "violationsByType": {
4086 + "overspeedingViolations": 0,
4087 + "accelerationViolations": 0,
4088 + "brakingViolations": 0,
4089 + "turningViolations": 0,
4090 + "dangerousDrivingViolations": 0,
4091 + "sensorViolations": 0
4092 + },
4093 + "moveTime": 0,
4094 + "mileage": 0,
4095 + "tripsCount": 0,
4096 + "trips": [
4097 + {
4098 + "penalty": 0,
4099 + "score": 0,
4100 + "violationsCount": 0,
4101 + "violationsByType": {
4102 + "overspeedingViolations": 0,
4103 + "accelerationViolations": 0,
4104 + "brakingViolations": 0,
4105 + "turningViolations": 0,
4106 + "dangerousDrivingViolations": 0,
4107 + "sensorViolations": 0
4108 + },
4109 + "moveTime": 0,
4110 + "mileage": 0,
4111 + "motohours": 0,
4112 + "maxSpeed": 0,
4113 + "startAddress": "string",
4114 + "endAddress": "string",
4115 + "drivers": [
4116 + {
4117 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4118 + "driverName": "string",
4119 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4120 + }
4121 + ]
4122 + }
4123 + ]
4124 + }
4125 + ]
4126 +}
4127 +
4128 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4129 +|from|Дата начала запроса
4130 +|to|Дата  окончания
4131 +|vehicleId|ID объекта
4132 +|vehicleName|Имя объекта
4133 +|vehicleModel|Модель объекта
4134 +|penalty|Сумма штрафных баллов
4135 +|score|Оценка
4136 +|totalViolations|Суммарное количество нарушений
4137 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4138 +|overspeedingViolations|Превышение скорости
4139 +|accelerationViolations|Ускорение
4140 +|brakingViolations|Торможение
4141 +|turningViolations|Резкий поворот
4142 +|dangerousDrivingViolations|Резкое вождение
4143 +|sensorViolations|Нарушение по датчику
4144 +|moveTime|Время в движении
4145 +|mileage|Пробег
4146 +|tripsCount|Количество рейсов
4147 +|motohours|Моточасы
4148 +|maxSpeed|Максимальная скорость
4149 +|startAddress|Адрес начала рейса
4150 +|endAddress|Адрес окончания рейса
4151 +|drivers|Список водителей, которые были на объекте в течениии рейса
4152 +|driverGuid|Guid водителя
4153 +|driverName|Имя водителя
4154 +|driverRfid|Номер Карты-метки
4155 +
4156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4157 +
4158 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4159 +
4160 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4161 +
4162 +(% class="box infomessage" %)
4163 +(((
4164 +POST /api/v3/fuelcards/transactions
4165 +)))
4166 +
4167 +Метод запроса: POST
4168 +
4169 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4170 +\\В заголовках запроса: X-Auth: Токен авторизации
4171 +
4172 +Параметры в теле запроса (JSON):
4173 +
4174 +{
4175 +
4176 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4177 +
4178 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4179 +
4180 + "ids": [
4181 +
4182 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4183 +
4184 + ],
4185 +
4186 + "timezone": 0 ~/~/Таймзона
4187 +
4188 +}
4189 +
4190 +Ответ:
4191 +
4192 + {
4193 +
4194 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4195 +
4196 + "driver": "string", ~/~/Водители, привязанные к ТК
4197 +
4198 + "object": "string", ~/~/Наименование ТС
4199 +
4200 + "amount": 0, ~/~/Количество топлива
4201 +
4202 + "amountDut": 0, ~/~/Количество по ДУТ
4203 +
4204 + "amountDiff": 0, ~/~/Разница, л
4205 +
4206 + "amountDiffPerc": 0, ~/~/Разница, %
4207 +
4208 + "summa": 0, ~/~/Стоимость, руб
4209 +
4210 + "serviceName": "string", ~/~/Тип топлива
4211 +
4212 + "price": 0, ~/~/Цена за литр, руб
4213 +
4214 + "cardName": "string", ~/~/Наименование ТК
4215 +
4216 + "cardNum": "string", ~/~/Номер ТК
4217 +
4218 + "operator": "string", ~/~/Оператор ТК
4219 +
4220 + "address": "string" ~/~/Адрес АЗС
4221 +
4222 + }
4223 +
4224 +
4225 +==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ====
4226 +
4227 +
4228 +==== **Получение полных данных о ретрансляторе** ====
4229 +
4230 +(% class="box infomessage" %)
4231 +(((
4232 +**GET ** **/api/v3/retranslations/{id}**
4233 +)))
4234 +
4235 +Идентификатор запроса: ID
4236 +
4237 +
4238 +Пример ответа:
4239 +
4240 +{
4241 +
4242 +"description": "", ~/~/ Определяет описание
4243 +
4244 +"subscriberId": "", ~/~/ Подписчик
4245 +
4246 +"protocolType": 0, ~/~/ Тип протокола
4247 +
4248 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4249 +
4250 +"address": "string", ~/~/ Адрес события
4251 +
4252 +"objects": [ ~/~/Объекты для ретрансляции
4253 +
4254 +{
4255 +
4256 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4257 +
4258 +"name": "", ~/~/ Наименование объекта ретрансляции
4259 +
4260 +"imei": "", ~/~/ IMEI объекта
4261 +
4262 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4263 +
4264 +}
4265 +
4266 + ],
4267 +
4268 +"id": "", ~/~/ идентификатор пользователя  
4269 +
4270 +"parentId": "", ~/~/Guid родителя
4271 +
4272 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4273 +
4274 +}
4275 +
4276 +
4277 +==== **Удаление данных ретранслятора** ====
4278 +
4279 +(% class="box infomessage" %)
4280 +(((
4281 +**DELETE** **/api/v3/retranslations/{id}**
4282 +)))
4283 +
4284 +Параметр запроса: ID
4285 +
4286 +
4287 +==== **Создание ретранслятора** ====
4288 +
4289 +(% class="box infomessage" %)
4290 +(((
4291 +**POST ** **/api/v3/retranslations/{id}**
4292 +)))
4293 +
4294 +Запрос:
4295 +
4296 +
4297 +{
4298 +
4299 +"description": "", ~/~/ Описание
4300 +
4301 +"subscriberId": "", ~/~/ Подписчик
4302 +
4303 +"protocolType": 0, ~/~/ Тип протокола
4304 +
4305 +"address": "", ~/~/ Адрес ретрансляции
4306 +
4307 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4308 +
4309 +"objects": [ ~/~/Объекты для ретрансляции
4310 +
4311 +{
4312 +
4313 +"id": "", ~/~/ идентификатор пользователя    
4314 +
4315 +"imei": "", ~/~/IMEI объекта
4316 +
4317 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен
4318 +
4319 +}
4320 +
4321 + ]
4322 +
4323 +}
4324 +
4325 +
4326 +
4327 +Ответ
4328 +
4329 +{
4330 +
4331 +"description": "string", ~/~/ Определяет описание
4332 +
4333 +"subscriberId": "", ~/~/ идентификатор запроса
4334 +
4335 +"protocolType": 0, ~/~/ Тип протокола
4336 +
4337 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4338 +
4339 +"address": "", ~/~/ Адрес события
4340 +
4341 +"objects": [ ~/~/Объекты для ретрансляции
4342 +
4343 +{
4344 +
4345 +"id": "", ~/~/ идентификатор пользователя   
4346 +
4347 +"name": "string", ~/~/ Название уведомления
4348 +
4349 +"imei": "string", ~/~/IMEI объекта
4350 +
4351 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4352 +
4353 +}
4354 +
4355 + ],
4356 +
4357 +"id": "", ~/~/ идентификатор пользователя 
4358 +
4359 +"parentId": "", ~/~/ Guid идентификатор родителя
4360 +
4361 +"deleted": true ~/~/ Признак удаления
4362 +
4363 +}
4364 +
4365 +
4366 +==== **Редактирование ретранслятора** ====
4367 +
4368 +(% class="box infomessage" %)
4369 +(((
4370 +**PUT** **/api/v3/retranslations**
4371 +)))
4372 +
4373 +Пример запроса:
4374 +
4375 +{
4376 +
4377 +"id": "", ~/~/ идентификатор пользователя  
4378 +
4379 +"description": "string", ~/~/ Определяет описание
4380 +
4381 +"subscriberId": "", ~/~/ идентификатор запроса
4382 +
4383 +"protocolType": 0, ~/~/ Тип протокола
4384 +
4385 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4386 +
4387 +"address": "string", ~/~/ Адрес события
4388 +
4389 +"objects": ~/~/Объекты для ретрансляции
4390 +
4391 +[
4392 +
4393 +{
4394 +
4395 +"id": "",  ~/~/ идентификатор пользователя        
4396 +
4397 +"imei": "", ~/~/IMEI объекта
4398 +
4399 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4400 +
4401 +}
4402 +
4403 + ]
4404 +
4405 +}
4406 +
4407 +
4408 +Пример ответа:
4409 +
4410 +{
4411 +
4412 +"description": "", ~/~/ Определяет описание
4413 +
4414 +"subscriberId": "", ~/~/ идентификатор запроса
4415 +
4416 +"protocolType": 0, ~/~/ Тип протокола
4417 +
4418 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4419 +
4420 +"address": "string", ~/~/ Адрес события
4421 +
4422 +"objects": [ ~/~/Объекты для ретрансляции
4423 +
4424 +{
4425 +
4426 +"id": "", ~/~/ идентификатор пользователя    
4427 +
4428 +"name": "string", ~/~/ Название уведомления   
4429 +
4430 +"imei": "", ~/~/IMEI объекта
4431 +
4432 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4433 +
4434 +}
4435 +
4436 + ],
4437 +
4438 +"id": "", ~/~/ идентификатор пользователя  
4439 +
4440 +"parentId": "", ~/~/ Guid идентификатор родителя
4441 +
4442 +"deleted": true ~/~/ Признак удаления
4443 +
4444 +}
4445 +
4446 +
4447 +
4448 +==== **Получение списка ретранслятора клиента** ====
4449 +
4450 +(% class="box infomessage" %)
4451 +(((
4452 +**POST /api/v3/retranslations/find**
4453 +)))
4454 +
4455 +Пример запроса:
4456 +
4457 +
4458 +{
4459 +
4460 +"id": "", ~/~/ идентификатор пользователя  
4461 +
4462 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4463 +
4464 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4465 +
4466 +}
4467 +
4468 +
4469 +
4470 +Ответ
4471 +
4472 +
4473 +[
4474 +
4475 +{
4476 +
4477 +"description": "", ~/~/ Определяет описание
4478 +
4479 +"subscriberId": "", ~/~/ идентификатор запроса
4480 +
4481 +"protocolType": 0, ~/~/ Тип протокола
4482 +
4483 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4484 +
4485 +"address": "string", ~/~/ Адрес события
4486 +
4487 +"id": "", ~/~/ идентификатор пользователя  
4488 +
4489 +"parentId": "", ~/~/ Guid идентификатор родителя
4490 +
4491 +"deleted": true ~/~/ Признак удаления
4492 +
4493 +}
4494 +
4495 +]
4496 +
4497 +
4498 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
4499 +
4500 +
4501 +==== **API для отчета по выгрузке комбайнов** ====
4502 +
4503 +
4504 +(% class="box infomessage" %)
4505 +(((
4506 +POST **/api/v3/Reports/harvesterUnloading**
4507 +)))
4508 +
4509 +Пример запроса:
4510 +
4511 +
4512 +{
4513 +
4514 + "byTime": 0, ~/~/ Объединение событий по времени
4515 +
4516 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4517 +
4518 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4519 +
4520 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4521 +
4522 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4523 +
4524 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4525 +
4526 + 0
4527 +
4528 + ],
4529 +
4530 + "from": "", ~/~/ Дата и время начало запроса
4531 +
4532 + "to": "", ~/~/ Дата и время окончания запроса
4533 +
4534 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4535 +
4536 +}
4537 +
4538 +
4539 +
4540 +Пример ответа:
4541 +
4542 +
4543 +[
4544 +
4545 + {
4546 +
4547 + "harvesterName": "", ~/~/Комбайн, номер
4548 +
4549 + "harvesterId": 0, ~/~/Комбайн, id
4550 +
4551 +"harvesterModel": "", ~/~/ Модель комбайна
4552 +
4553 + "hopperCapacity": 0, ~/~/ Объем бункера м3
4554 +
4555 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4556 +
4557 + "events": [ ~/~/Список событий в разрезе комбайна
4558 +
4559 + {
4560 +
4561 + "driverId": "", ~/~/Идентификатор водителя
4562 +
4563 + "driverName": "", ~/~/Водитель комбайна, ФИО
4564 +
4565 + "RFID": "", ~/~/ идентификатор карты-метки
4566 +
4567 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4568 +
4569 + "vehicleId": 0, ~/~/идентификатор объекта
4570 +
4571 + "vehicleName": "string", ~/~/ Имя объекта
4572 +
4573 + "modelName": "string", ~/~/ Имя модели объекта
4574 +
4575 + "nearestVehicles": [ ~/~/Объекты рядом
4576 +
4577 + {
4578 +
4579 + "vehicleId": 0, ~/~/идентификатор объекта
4580 +
4581 + "vehicleName": "string" ~/~/ Имя объекта
4582 +
4583 + }
4584 +
4585 + ],
4586 +
4587 + "fields": [ ~/~/Поля, где происходила выгрузка
4588 +
4589 + {
4590 +
4591 + "id": 0, ~/~/ идентификатор пользователя
4592 +
4593 + "name": "string" ~/~/ имя пользователя
4594 +
4595 + }
4596 +
4597 + ],
4598 +
4599 + "event": "string", ~/~/Событие
4600 +
4601 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4602 +
4603 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4604 +
4605 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4606 +
4607 + "cultureName": "string", ~/~/ название культуры
4608 +
4609 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4610 +
4611 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4612 +
4613 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4614 +
4615 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4616 +
4617 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4618 +
4619 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4620 +
4621 + "issued": 0, ~/~/Выдано, бункеров
4622 +
4623 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4624 +
4625 + "latitude": 0, ~/~/Широта
4626 +
4627 + "longitude": 0, ~/~/ Долгота
4628 +
4629 + "litresAway": 0, ~/~/Отдано, л
4630 +
4631 + "m3Away": 0 ~/~/Отдано, м3
4632 +
4633 + }
4634 +
4635 + ]
4636 +
4637 + }
4638 +
4639 +]
4640 +
4641 +
4642 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4643 +
4644 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4645 +
4646 +
4647 +(% class="box infomessage" %)
4648 +(((
4649 +GET api/v3/Vehicles/recyclebin/all
4650 +)))
4651 +
4652 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4653 +
4654 +Параметр запроса: {parentId} - идентификатор агента
4655 +
4656 +В заголовках запроса: X-Auth: Токен авторизации
4657 +
4658 +Ответ:
4659 +
4660 +[
4661 +
4662 + {
4663 +
4664 + "recordTime": "", ~/~/Время записи
4665 +
4666 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4667 +
4668 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4669 +
4670 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4671 +
4672 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4673 +
4674 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4675 +
4676 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4677 +
4678 + "items": [ ~/~/ [
4679 +
4680 +nullable: true ~/~/Детали
4681 +
4682 + {
4683 +
4684 + "name": "string", ~/~/наименование столбца
4685 +
4686 + "value": "string" ~/~/содержание столбца
4687 +
4688 + }
4689 +
4690 + ]
4691 +
4692 + },
4693 +
4694 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4695 +
4696 + "string"
4697 +
4698 + ]
4699 +
4700 + }
4701 +
4702 +]
4703 +
4704 +
4705 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4706 +
4707 +(% class="box infomessage" %)
4708 +(((
4709 +POST/api/v3/Vehicles/recyclebin/erase
4710 +)))
4711 +
4712 +В заголовках запроса: X-Auth: Токен авторизации
4713 +
4714 +Пример запроса:
4715 +
4716 +
4717 +[
4718 +
4719 + 0
4720 +
4721 +]
4722 +
4723 +
4724 +Пример ответа:
4725 +
4726 +[
4727 +
4728 + {
4729 +
4730 + "recordTime": "", ~/~/Время записи
4731 +
4732 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4733 +
4734 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4735 +
4736 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4737 +
4738 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4739 +
4740 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4741 +
4742 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4743 +
4744 + "items": [ ~/~/Детали
4745 +
4746 + {
4747 +
4748 + "name": "", ~/~/Имя свойства
4749 +
4750 + "value": "" ~/~/Значение свойства
4751 +
4752 + }
4753 +
4754 + ]
4755 +
4756 + },
4757 +
4758 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4759 +
4760 + ""
4761 +
4762 + ]
4763 +
4764 + }
4765 +
4766 +]
4767 +
4768 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4769 +
4770 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4771 +
4772 +(% class="box infomessage" %)
4773 +(((
4774 +POST/api/v3/Vehicles/recyclebin/restore
4775 +)))
4776 +
4777 +В заголовках запроса: X-Auth: Токен авторизации
4778 +
4779 +Параметры в теле запроса (JSON):
4780 +
4781 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4782 +
4783 +В заголовках запроса: X-Auth: Токен авторизации
4784 +
4785 +
4786 +Пример запроса:
4787 +
4788 +[
4789 +
4790 + 0
4791 +
4792 +]
4793 +
4794 +
4795 +Пример ответа:
4796 +
4797 +[
4798 +
4799 + {
4800 +
4801 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4802 +
4803 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4804 +
4805 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4806 +
4807 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4808 +
4809 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4810 +
4811 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4812 +
4813 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4814 +
4815 + "items": [ ~/~/Детали
4816 +
4817 + {
4818 +
4819 + "name": "string", ~/~/Имя свойства
4820 +
4821 + "value": "string" ~/~/Значение свойства
4822 +
4823 + }
4824 +
4825 + ]
4826 +
4827 + },
4828 +
4829 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4830 +
4831 + "string"
4832 +
4833 + ]
4834 +
4835 + }
4836 +
4837 +]
4838 +
4839 +
4840 +
986 986  (% class="box" lang="en-US" style="text-align: center;" %)
987 987  (((
988 988  (% 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 г.