Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 67.1 >
edited by Илья Крайнов
on 2022/11/24 13:52
To version < 129.1 >
edited by Михаил Жучков
on 2023/12/25 17:53
>
Change comment: There is no comment for this version

Summary

Details

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