<
From version < 66.9 >
edited by Илья Крайнов
on 2022/11/24 13:34
To version < 124.2 >
edited by Илья Крайнов
on 2023/11/28 16:03
>
Change comment: There is no comment for this version

Summary

Details

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