<
From version < 40.1 >
edited by Илья Крайнов
on 2022/11/17 14:54
To version < 184.1 >
edited by Андрей Калиновский
on 2024/11/22 13:26
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -1,37 +1,44 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**\
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
7 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 +
9 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
10 +
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
15 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
16 +
17 +
18 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
19 +
20 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
21 +
22 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
23 +
24 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
19 19  (((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
26 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
27 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
21 21  )))
22 22  
23 23  (% class="box successmessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
32 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
35 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
41 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -38,30 +38,35 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
48 +}
43 43  
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
47 47  (% style="color:#000000" %){
48 -
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
54 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
55 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
60 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
61 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
62 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
63 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
64 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
58 58  
66 +(% class="wikigeneratedid" %)
67 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
68 +
69 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
70 +
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
73 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
76 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,56 +72,306 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
87 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
89 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
90 +
91 +(% class="box infomessage" %)
77 77  (((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
93 +**GET api/v3/agents/{id}**
79 79  )))
80 80  
96 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
97 +
98 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
99 +
100 +(% style="color:#000000" %)Метод запроса: **GET**
101 +
102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
103 +
104 +Запрос должен содержать данные параметра "**agentId**"
105 +
106 +(% style="color:#000000" %)Ответ:
107 +{
108 + "agentId": "",  (%%)
109 + "parentId": "",
110 + "parentName": "string",
111 + "name": "string",
112 + "fullName": "string",
113 + "agentInfoType": 0,
114 + "isForeign": true/false,
115 + "district": "string", 
116 + "region": "string",
117 + "city": "string",
118 + "inn": "string",
119 + "kpp": "string",
120 + "address": "string",
121 + "addressFact": "string",
122 + "email": "string",
123 + "director": "string",
124 + "bankName": "string",
125 + "bankBIK": "string",
126 + "bankRS": "string",
127 + "bankKS": "string"
128 + }
129 +
130 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
131 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
132 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
133 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
134 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
135 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
136 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
137 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
138 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
139 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
140 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
141 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
142 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
143 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
144 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
145 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
146 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
147 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
148 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
149 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
150 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
151 +
152 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
153 +
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
156 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
159 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
90 90  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91 91  
92 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
165 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
167 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
169 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
171 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
173 +(% style="color:#000000" %){
174 + "parentId": "string"
175 +}
101 101  
102 102  (% style="color:#000000" %)Ответ:
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
179 +{
180 + "agentId": "",(% style="color:#000000" %)   (%%)
181 + "parentId": "",
182 + "name": "string",
183 + "fullName": "string",
184 + "agentInfoType": 0,
185 +(% style="color:#000000" %) "status": "",
111 111  }
112 112  
113 113  
114 -(% class="box" style="text-align: center;" %)
189 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
190 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
191 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
192 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
193 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
194 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
195 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
196 +
197 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
198 +
199 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
201 +**POST /api/v3/agents **
117 117  )))
118 118  
204 +Метод позволяет добавить клиента, указанного в запросе.
205 +
206 +Метод запроса: **POST**
207 +
208 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
209 +
210 +В заголовках запроса: X-Auth: Токен авторизации
211 +
212 +Параметры в теле запроса (JSON):
213 +
214 +{
215 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
216 + "name": "string", ~/~/ имя
217 + "fullName": "string", ~/~/ полное наименование
218 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
219 + "isForeign": true, ~/~/ иностранный контрагент
220 + "district": "string", ~/~/ округ
221 + "region": "string", ~/~/ регион
222 + "city": "string", ~/~/ город
223 + "inn": "string", ~/~/ ИНН
224 + "kpp": "string", ~/~/ КПП
225 + "address": "string", ~/~/ юридический адрес
226 + "addressFact": "string", ~/~/ фактический адрес
227 + "email": "string", ~/~/ email
228 + "director": "string", ~/~/ ФИО руководителя
229 + "bankName": "string", ~/~/ банк
230 + "bankBIK": "string", ~/~/ БИК
231 + "bankRS": "string", ~/~/ номер счёта
232 + "bankKS": "string" ~/~/ корр. счёт
233 +}
234 +
235 +Ответ:
236 +
237 +{
238 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
239 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
240 + "name": "string", ~/~/ имя
241 + "fullName": "string", ~/~/ полное наименование
242 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
243 + "isForeign": true, ~/~/ иностранный контрагент
244 + "district": "string", ~/~/ округ
245 + "region": "string", ~/~/ регион
246 + "city": "string", ~/~/ город
247 + "inn": "string", ~/~/ ИНН
248 + "kpp": "string", ~/~/ КПП
249 + "address": "string", ~/~/ юридический адрес
250 + "addressFact": "string", ~/~/ фактический адрес
251 + "email": "string", ~/~/ email
252 + "director": "string", ~/~/ ФИО руководителя
253 + "bankName": "string", ~/~/ банк
254 + "bankBIK": "string", ~/~/ БИК
255 + "bankRS": "string", ~/~/ номер счёта
256 + "bankKS": "string" ~/~/ корр. счёт
257 +}
258 +
259 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
260 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
261 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
262 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
263 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
264 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
265 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
266 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
267 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
268 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
269 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
270 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
271 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
272 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
273 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
274 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
275 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
276 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
277 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
278 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
279 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
280 +
281 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
282 +
283 +(% class="box warningmessage" %)
284 +(((
285 +**PUT /api/v3/agents**
286 +)))
287 +
288 +Метод позволяет отредактировать клиента, указанного в запросе.
289 +
290 +Метод запроса: **PUT**
291 +
292 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
293 +
294 +В заголовках запроса: X-Auth: Токен авторизации
295 +
296 +Параметры в теле запроса (JSON):
297 +
298 +{
299 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
300 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
301 + "name": "string", ~/~/ имя
302 + "fullName": "string", ~/~/ полное наименование
303 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
304 + "isForeign": true, ~/~/ иностранный контрагент
305 + "district": "string", ~/~/ округ
306 + "region": "string", ~/~/ регион
307 + "city": "string", ~/~/ город
308 + "inn": "string", ~/~/ ИНН
309 + "kpp": "string", ~/~/ КПП
310 + "address": "string", ~/~/ юридический адрес
311 + "addressFact": "string", ~/~/ фактический адрес
312 + "email": "string", ~/~/ email
313 + "director": "string", ~/~/ ФИО руководителя
314 + "bankName": "string", ~/~/ банк
315 + "bankBIK": "string", ~/~/ БИК
316 + "bankRS": "string", ~/~/ номер счёта
317 + "bankKS": "string" ~/~/ корр. счёт
318 +}
319 +
320 +Ответ:
321 +
322 +{
323 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
324 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
325 + "name": "string", ~/~/ имя
326 + "fullName": "string", ~/~/ полное наименование
327 + "isForeign": true, ~/~/ иностранный контрагент
328 + "district": "string", ~/~/ округ
329 + "region": "string", ~/~/ регион
330 + "city": "string", ~/~/ город
331 + "inn": "string", ~/~/ ИНН
332 + "kpp": "string", ~/~/ КПП
333 + "address": "string", ~/~/ юридический адрес
334 + "addressFact": "string", ~/~/ фактический адрес
335 + "email": "string", ~/~/ email
336 + "director": "string", ~/~/ ФИО руководителя
337 + "bankName": "string", ~/~/ банк
338 + "bankBIK": "string", ~/~/ БИК
339 + "bankRS": "string", ~/~/ номер счёта
340 + "bankKS": "string" ~/~/ корр. счёт
341 +}
342 +
343 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
344 +
345 +(% class="box errormessage" %)
346 +(((
347 +**DELETE /api/v3/agents/{clientId}**
348 +)))
349 +
350 +Метод позволяет удалить клиента, указанного в строке запроса.
351 +
352 +Метод запроса: **DELETE**
353 +
354 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
355 +
356 +Параметр запроса: **{clientId}** - Guid пользователя
357 +
358 +В заголовках запроса: X-Auth: Токен авторизации
359 +
360 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
361 +
362 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
363 +
364 +(% class="box warningmessage" %)
365 +(((
366 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
367 +)))
368 +
369 +Метод позволяет изменить статус клиента, указанного в запросе.
370 +
371 +В пути указывается GUID клиента и статус клиента.
372 +
373 +**status **- значение 0 - заблокирован, 1 - активен.
374 +
375 +Ответ: Code 204
376 +
377 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
378 +
379 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
380 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
383 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
386 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -131,7 +131,8 @@
131 131  
132 132  (% style="color:#000000" %)Параметры в теле запроса (JSON):
133 133  
134 -(% style="color:#000000" %){ 
396 +(% style="color:#000000" %)
397 +{ 
135 135   "lastName": "", ~/~/ фамилия
136 136   "firstName": "", ~/~/ имя
137 137   "position": "", ~/~/ должность
... ... @@ -140,25 +140,43 @@
140 140   "login": "", ~/~/ логин (обязателен)
141 141   "password": "", ~/~/ пароль (обязателен)
142 142   "email": "", ~/~/ email (обязателен)
143 - "description": "", ~/~/ описание
144 - "isEnabled": "", ~/~/ признак включения
406 + "description": "string", ~/~/ Описание
407 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
408 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
409 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
145 145   "parentId": "", ~/~/ Guid родительского агента
146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
411 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
412 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
413 + "doubleAuth":
414 + {
415 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
416 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
417 + },
418 + "groups":
419 + [
420 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
421 + ],
422 + "customGroups":
423 + [
424 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
425 + ],
426 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
152 152  }
428 +{
429 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
430 + "lastName": "string",
431 + "firstName": "string",
432 + "position": "string",
433 + "phone": "string",
434 + "organization": "string",
435 + "login": "string",
436 + "password": "string",
437 + "email": "string",
153 153  
154 154  (% style="text-align:left" %)
155 155  (% style="color:#000000; font-weight:normal" %)Ответ:
156 -
157 -(% style="text-align:left" %)
158 -(% style="color:#000000; font-weight:normal" %){    
159 -
160 -(% style="text-align:left" %)
161 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
441 +{     
442 + "id": "" , ~/~/ ID пользователя
162 162   "lastName": "" , ~/~/ Фамилия ,
163 163   "firstName": "" , ~/~/ Имя
164 164   "position": "" , ~/~/ Должность
... ... @@ -175,17 +175,17 @@
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 177   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
459 +}
178 178  
179 -(% style="text-align:left" %)
180 -(% style="color:#000000; font-weight:normal" %)}
181 181  
462 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 -(% class="box successmessage" %)
464 +(% class="box infomessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
466 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
469 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -197,19 +197,16 @@
197 197  
198 198  (% style="color:#000000" %)Параметры в теле запроса (JSON):
199 199  
200 -(% style="color:#000000" %){
201 -
481 +(% style="color:#000000" %){(%%)
202 202   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 203   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 204   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 205   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
206 -
207 207  (% style="color:#000000" %)}
208 208  
209 209  (% style="color:#000000" %)Ответ:
210 210  
211 211  (% style="color:#000000" %){         (%%)
212 -
213 213   "id": "" , ~/~/ идентификатор пользователя
214 214   "lastName": "" , ~/~/ фамилия
215 215   "firstName": "" , ~/~/ имя
... ... @@ -222,17 +222,69 @@
222 222   "email": "" , ~/~/ E-mail
223 223   "sessionDuration":"", ~/~/ длительность сессии в минутах
224 224   "status": "1",  ~/~/ статус пользователя
225 - "astLogged": "", ~/~/ дата/время последней авторизации
226 -
503 + "lastLogged": "", ~/~/ дата/время последней авторизации
227 227  (% style="color:#000000" %)}
228 228  
506 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
508 +(% class="box infomessage" %)
509 +(((
510 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
511 +)))
512 +
513 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
514 +
515 +(% style="color:#000000" %)Метод запроса: **GET**
516 +
517 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
518 +
519 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
520 +
521 +(% style="color:#000000" %)Ответ:
522 +
523 +(((
524 +(((
525 +{
526 + "id": "", ~/~/ GUID пользователя
527 + "lastName": "", ~/~/ Фамилия 
528 + "firstName": "", ~/~/ Имя
529 + "position": "", ~/~/ Должность
530 + "phone": "", ~/~/ Номер телефона
531 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
532 + "parentName": "", Наименование клиента, которому принадлежит пользователь
533 + "organization": "", ~/~/ Организация
534 + "login": "", ~/~/ Логин пользователя
535 + "email": "", ~/~/ Адрес электронной почты
536 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
537 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
538 + "description": "", ~/~/ Описание
539 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
540 + "doubleAuth":
541 + {
542 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
543 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
544 + },
545 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
546 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
547 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
548 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
549 + "groups": [], ~/~/ Список ролей пользователя
550 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
551 + "authDevices": [ ], ~/~/ Список авторизованных устройств
552 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
553 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
554 +}
555 +)))
556 +)))
557 +
558 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
559 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
562 +(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
565 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -244,29 +244,30 @@
244 244  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
245 245  
246 246  (% lang="en-US" style="text-align:left" %)
247 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
248 -
249 -(% lang="en-US" style="text-align:left" %)
250 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
577 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
578 + "id": "" , ~/~/ ID пользователя 
251 251   "lastName": "" , ~/~/ фамилия
252 252   "firstName": "" , ~/~/ имя
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%)
257 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
258 - "email": "" , ~/~/ email  (% style="color:#000000" %)(Если null - менять не надо)(%%)
584 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
585 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
586 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
587 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
588 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
259 259  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 263   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 - "kind": "" , ~/~/ тип аутентификации
266 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
267 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
268 -
269 -(% lang="en-US" style="text-align:left" %)
594 + "doubleAuth":
595 + {
596 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
597 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
598 + },
599 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
600 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
270 270  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
271 271  
272 272  (% lang="en-US" style="text-align:left" %)
... ... @@ -273,10 +273,8 @@
273 273  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
274 274  
275 275  (% lang="en-US" style="text-align:left" %)
276 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
277 -
278 -(% lang="en-US" style="text-align:left" %)
279 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
607 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
608 + "id": "" , ~/~/ идентификатор пользователя
280 280   "lastName": "" , ~/~/ фамилия
281 281   "firstName": "" , ~/~/ имя
282 282   "position": "" , ~/~/ должность
... ... @@ -289,21 +289,24 @@
289 289   "isEnabled": "" , ~/~/ признак включения
290 290   "parentId": "" , ~/~/ Guid родительского агента
291 291   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 - "kind": "" , ~/~/ тип аутентификации
621 + "doubleAuth":
622 + {
623 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
624 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
625 + },
626 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
294 294   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 295   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
629 +}
296 296  
297 -(% lang="en-US" style="text-align:left" %)
298 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
631 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
299 299  
300 -
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
635 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
638 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -315,24 +315,23 @@
315 315  
316 316  (% style="color:#000000" %)Параметры в теле запроса (JSON):
317 317  
318 -(% style="color:#000000" %){
319 -
650 +(% style="color:#000000" %){(%%)
320 320   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 321   "description": "" , ~/~/ описание
322 322   "data": "" , ~/~/ данные, связанные со сменой статуса
323 -
324 324  (% style="color:#000000" %)}
325 325  
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
659 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
329 329  
330 330  (% class="box warningmessage" %)
331 331  (((
332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
663 +**POST /api/v3/users/disable**
333 333  )))
334 334  
335 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
666 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
336 336  
337 337  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
338 338  
... ... @@ -341,19 +341,20 @@
341 341  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
342 342  
343 343   [ 
344 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
675 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
345 345   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
346 346   ]
347 347  
348 348  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
349 349  
681 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
350 350  
351 351  (% class="box warningmessage" %)
352 352  (((
353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
685 +**POST /api/v3/users/enable**
354 354  )))
355 355  
356 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
688 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
357 357  
358 358  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
359 359  
... ... @@ -369,6 +369,7 @@
369 369  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 370  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 371  
704 +(((
372 372  В теле ответа:
373 373  {
374 374   "errorMessages": [
... ... @@ -380,14 +380,16 @@
380 380  }
381 381  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 382  "users" - массив id пользователей, которых не удалось включить или отключить.
383 -
716 +)))
384 384  
718 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
719 +
385 385  (% class="box errormessage" %)
386 386  (((
387 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
722 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
388 388  )))
389 389  
390 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
725 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
391 391  
392 392  (% style="color:#000000" %)Метод запроса: **DELETE**
393 393  
... ... @@ -400,20 +400,261 @@
400 400  (% style="text-align:left" %)
401 401  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
402 402  
738 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
403 403  
404 -(% class="box" style="text-align: center;" %)
740 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
741 +
742 +(% class="box infomessage" %)
405 405  (((
406 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
744 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
407 407  )))
408 408  
747 +Метод возвращает полную информацию о модели объекта.
748 +
749 +(% style="color:#000000" %)Метод запроса: **GET**
750 +
751 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
752 +
753 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
754 +
755 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
756 +
757 +(% style="color:#000000" %)Ответ:
758 +
759 +(% style="color:#000000" %){
760 + "parentName": "string",
761 + "name": "string",
762 + "picture": "string",
763 + "minspeed": 0,
764 + "maxspeed": 0,
765 + "width": 0,
766 + "imbeddedtrailer": true,
767 + "hoppercapacity": 0,
768 + "hopperdischargespeed": 0,
769 + "modelType": 0,
770 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
771 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
772 + "deleted": true
773 +}
774 +
775 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
776 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
777 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
778 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
779 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
780 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
781 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
782 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
783 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
784 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
785 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
786 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
787 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
788 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
789 +
790 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
791 +
792 +(% class="box successmessage" %)
793 +(((
794 +(% lang="en-US" %)**POST /api/v3/models/find**
795 +)))
796 +
797 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
798 +
799 +(% style="color:#000000" %)Метод запроса: **POST**
800 +
801 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
802 +
803 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
804 +
805 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
806 +
807 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
808 +}
809 +
810 +(% style="color:#000000" %)Ответ:
811 +
812 +(% style="color:#000000" %)[
813 + {
814 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
815 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
816 + "parentName": "string",
817 + "name": "string",
818 + "modelType": 0
819 + }
820 +]
821 +
822 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
823 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
824 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
825 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
826 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
827 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
828 +
829 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
830 +
831 +(% class="box successmessage" %)
832 +(((
833 +(% lang="en-US" %)**POST /api/v3/models**
834 +)))
835 +
836 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
837 +
838 +(% style="color:#000000" %)Метод запроса: **POST**
839 +
840 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
841 +
842 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
843 +
844 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
845 +
846 +{
847 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
848 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
849 + "deleted": true,
850 + "extId": "string",
851 + "name": "string",
852 + "picture": "string",
853 + "minspeed": 0,
854 + "maxspeed": 0,
855 + "width": 0,
856 + "imbeddedtrailer": true,
857 + "fueloutlay": 0,
858 + "hoppercapacity": 0,
859 + "hopperdischargespeed": 0,
860 + "modelType": 0
861 +}
862 +
863 +Ответ:
864 +
865 +{
866 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
868 + "deleted": true,
869 + "extId": "string",
870 + "name": "string",
871 + "picture": "string",
872 + "minspeed": 0,
873 + "maxspeed": 0,
874 + "width": 0,
875 + "imbeddedtrailer": true,
876 + "hoppercapacity": 0,
877 + "hopperdischargespeed": 0,
878 + "modelType": 0
879 +}
880 +
881 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
882 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
883 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
884 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
885 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
886 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
887 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
888 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
889 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
890 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
891 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
892 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
893 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
894 +
895 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
896 +
897 +(% class="box warningmessage" %)
898 +(((
899 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
900 +)))
901 +
902 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
903 +
904 +(% style="color:#000000" %)Метод запроса: **PUT**
905 +
906 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
907 +
908 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
909 +
910 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
911 +
912 +{
913 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
914 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
915 + "deleted": true,
916 + "extId": "string",
917 + "name": "string",
918 + "picture": "string",
919 + "minspeed": 0,
920 + "maxspeed": 0,
921 + "width": 0,
922 + "imbeddedtrailer": true,
923 + "fueloutlay": 0,
924 + "hoppercapacity": 0,
925 + "hopperdischargespeed": 0,
926 + "modelType": 0
927 +}
928 +
929 +Ответ:
930 +
931 +{
932 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
933 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
934 + "deleted": true,
935 + "extId": "string",
936 + "name": "string",
937 + "picture": "string",
938 + "minspeed": 0,
939 + "maxspeed": 0,
940 + "width": 0,
941 + "imbeddedtrailer": true,
942 + "fueloutlay": 0,
943 + "hoppercapacity": 0,
944 + "hopperdischargespeed": 0,
945 + "modelType": 0
946 +}
947 +
948 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
949 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
950 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
951 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
952 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
953 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
954 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
955 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
956 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
957 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
958 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
959 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
960 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
961 +
962 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
963 +
964 +(% class="box errormessage" %)
965 +(((
966 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
967 +)))
968 +
969 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
970 +
971 +(% style="color:#000000" %)Метод запроса: **DELETE**
972 +
973 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
974 +
975 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
976 +
977 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
978 +
979 +Ответ: В случае успеха **Success 200**
980 +
981 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
982 +
983 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
984 +
409 409  (% class="box infomessage" %)
410 410  (((
411 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
987 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
412 412  )))
413 413  
414 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
990 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
415 415  
416 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
992 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
417 417  
418 418  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
419 419  
... ... @@ -421,99 +421,324 @@
421 421  
422 422  (% style="color:#000000" %)Метод запроса: **GET**
423 423  
424 -(% 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>
1000 +(% 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}
425 425  
426 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
1002 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
427 427  
428 428  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
1008 +(((
432 432  {
433 -
434 434   "vehicleId": "", ~/~/ ID объекта
435 -
436 436   "name": "", ~/~/ Имя объекта
437 -
438 438   "imei": "", ~/~/ IMEI объекта
439 -
440 440   "deviceTypeId": , ~/~/ ID типа устройства
441 -
442 442   "deviceTypeName": "", ~/~/ Название типа устройства
443 -
444 444   "sim1": "", ~/~/ Номер SIM1
1016 + "sim2": "", ~/~/ Номер SIM2
1017 + "parentId": "", ~/~/ ID клиента-родителя
1018 + "parentName": "", ~/~/ Наименование клиента-родителя
1019 + "modelId": "", ~/~/ ID модели объекта
1020 + "modelName": "", ~/~/ Имя модели объекта
1021 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1022 + "unitName": "string", ~/~/ Наименование подразделения
1023 + "status": 0, ~/~/ Статус объекта
1024 + "createdAt": "", ~/~/ Дата создания объекта
1025 + },
1026 +"customFields": [ ~/~/ Произвольные поля
1027 + {
1028 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1029 + "name": "string", ~/~/ Имя поля
1030 + "value": "string", ~/~/ Значение поля
1031 + "forClient": true, ~/~/ Не используемая функция
1032 + "forTooltip": true, ~/~/ Отображать в подсказке
1033 + "forReport": true ~/~/ Отображать в отчете
1034 + }
445 445  
446 - "parentId": "", Номер SIM2
1036 +], ~/~/ Данные с вкладки нормы
1037 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1038 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1039 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1040 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1041 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1042 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1043 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1044 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1045 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1046 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1047 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1048 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1049 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1050 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1051 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1052 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1053 + "counters": { ~/~/ Счетчики
1054 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1055 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1056 + "mileage": 0, ~/~/ Текущий пробег
1057 + "motohours": 0, ~/~/ Текущие моточасы
1058 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1059 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1060 + },
447 447  
448 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
1062 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1063 + "id": "string", ~/~/ ID объекта
1064 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1065 + "host": "string", ~/~/ CMSV6 Web Host
1066 + "login": "string", ~/~/ CMSV6 Account
1067 + "password": "string" ~/~/ CMSV6 Password
1068 + },
449 449  
450 - "modelId": "", ID модели объекта
1070 +"commandTemplates": [ ~/~/ Шаблоны команд
1071 + {
1072 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1073 + "name": "string", ~/~/ Наименование команды
1074 + "command": "string", ~/~/ Текст команды
1075 + "retries": 0 ~/~/ Количество попыток
1076 + }
1077 + ],
1078 + "sensors": [ ~/~/ Датчики
1079 + {
1080 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1081 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1082 + "type": 0, ~/~/ Тип датчика
1083 + "name": "string", ~/~/ Имя датчика
1084 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1085 + "inputNumber": 0, ~/~/ Номер входа
1086 + "pseudonym": "string", ~/~/ Псевдоним
1087 + "medianDegree": 0, ~/~/ Медианная фильтрация
1088 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1089 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1090 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1091 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1092 + {
1093 + "grades": [ ~/~/ Таблица тарировки 1
1094 + {
1095 + "input": 0, ~/~/ Входящее значение
1096 + "output": 0 ~/~/ Выходящее значение
1097 + }
1098 + ],
1099 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1100 + }
1101 + ],
1102 + "showInTooltip": true, ~/~/ Отображать в подсказке
1103 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1104 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1105 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1106 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1107 + "expr": "string", ~/~/ Формула
1108 + "children": [ ~/~/ массив дочерних датчиков
1109 + "string"
1110 + ],
1111 + "customParams": { ~/~/ прочие произвольные параметры
1112 + "additionalProp1": "string",
1113 + "additionalProp2": "string",
1114 + "additionalProp3": "string"
1115 + },
451 451  
452 - "modelName": "", Имя модели объекта
1117 +~/~/ Характерные для произвольного:
1118 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1119 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1120 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1121 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1122 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1123 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1124 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1125 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1126 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1127 +~/~/ "ValueOn": "Вкл.",
1128 +~/~/ "ValueOff": "Выкл."
1129 + "summaryMaxValue": 0 ~/~/ Макс. значение
1130 + }
1131 + "drivers": [ ~/~/ Водители
1132 + {
1133 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1134 + "name": "string", ~/~/ Наименование
1135 + "description": "string",
1136 + "isDefault": true ~/~/ По умолчанию
1137 + }
1138 + ],
1139 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1140 + {
1141 + "id": "", ~/~/ ID  задания
1142 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1143 + "name": "", ~/~/ Наименование задания
1144 + "description": "", ~/~/ Описание задания
1145 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1146 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1147 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1148 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1149 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1150 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1151 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1152 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1153 + }
1154 + ],
1155 +"statusHistory": [ ~/~/ История статусов
1156 + {
1157 + "status": 0,
1158 + "date": "2023-05-22T09:57:39.562Z",
1159 + "description": "string",
1160 + "additionalInfo": "string"
1161 + }
1162 + ]
1163 +}
1164 +)))
453 453  
454 - "createdAt": "", Дата создания объекта
1166 +(% style="text-align:left" %)
1167 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
455 455  
456 - "mileageCalcMethod": "", Выбранный метод расчета пробега
1169 +(% style="text-align:left" %)
1170 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
457 457  
458 - "counters": { ~/~/ Нормы
459 459  
460 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
1173 +== **Импортировать историю ТС (Асинхронный запрос)** ==
461 461  
462 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
1175 +(% class="box successmessage" %)
1176 +(((
1177 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1178 +)))
463 463  
464 - "mileage": "", ~/~/ Пробег по нормам в метрах
1180 +(% style="color:#000000" %)Метод запроса: **POST**
465 465  
466 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
1182 +(% style="color:#000000" %)URL запроса: (%%)**https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
467 467  
468 - },
1184 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства
469 469  
470 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 471  
472 - {
1187 +Ответ:
473 473  
474 - "id": "", ~/~/ ID  задания
1189 +{
475 475  
476 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1191 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
477 477  
478 - "name": "", ~/~/ Наименование задания
1193 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
479 479  
480 - "description": "", ~/~/ Описание задания
1195 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
481 481  
482 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1197 + "Message": "string", ~/~/ Информация о выполнении запроса
483 483  
484 - "lastMileage": "", ~/~/ Пробег метрах) на момент последнего ТО (null - неважно)
1199 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
485 485  
486 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1201 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
487 487  
488 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1203 + "Data": "string" ~/~/ Данные
489 489  
490 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1205 +}
491 491  
492 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 493  
494 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1208 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
495 495  
496 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1210 +(% class="box infomessage" %)
1211 +(((
1212 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1213 +)))
497 497  
498 - }
1215 +(% style="color:#000000" %)Метод запроса: **GET**
499 499  
500 - ]
1217 +(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
501 501  
1219 +(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса
1220 +
1221 +
1222 +Ответ:
1223 +
1224 +{
1225 +
1226 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1227 +
1228 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1229 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1230 +
1231 + "Message": "string", ~/~/ Информация о выполнении запроса
1232 +
1233 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1234 +
1235 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1236 +
1237 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1238 +
1239 + "Data": "string" ~/~/ Данные
1240 +
502 502  }
503 503  
504 -(% style="text-align:left" %)
505 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
506 506  
507 -(% style="text-align:left" %)
508 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1244 +== **Отправить команду на терминал** ==
509 509  
1246 +(% class="box successmessage" %)
1247 +(((
1248 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1249 +)))
510 510  
1251 +Команда для отправки на тс.
1252 +
1253 +{  
1254 +"id": "", ~/~/идентификатор произвольного поля
1255 +"command": "", ~/~/ Текст команды
1256 +"retries": "", ~/~/ Количество попыток
1257 +"idTemplate": "" ~/~/ ID шаблона команды
1258 +}
1259 +
1260 +
1261 +== **Получить ответ на отправленную на ТС команду** ==
1262 +
1263 +(% class="box infomessage" %)
1264 +(((
1265 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1266 +)))
1267 +
1268 +Идентификатор команды: cmdid
1269 +
1270 +Запрос от терминала на ответ команды
1271 +
1272 +Пример ответ от терминала:
1273 +
1274 +ID= "" ~/~/ идентификатор произвольного поля
1275 +Soft="" ~/~/ версия софта
1276 +GPS=4 ~/~/ тип трекера
1277 +Time=11:05:43 28.06.24 ~/~/ время запроса
1278 +Lat=45.056221 ~/~/ широта
1279 +Lon=39.035938 ~/~/ долгота
1280 +Speed=0.0 ~/~/ скорость
1281 +Course=181.4 ~/~/направление
1282 +
1283 +(((
1284 +== **Список отправленных объекту команд с ответами** ==
1285 +
1286 +(% class="box infomessage" %)
1287 +(((
1288 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1289 +)))
1290 +
1291 +Идентификатор ТС: vehicleId
1292 +
1293 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1294 +
1295 +Пример ответа терминала
1296 +
1297 +[ 
1298 +{    
1299 +"id": "", ~/~/ идентификатор пользователя
1300 +"commandText": "", ~/~/Текст команды.
1301 +"templateId": "", ~/~/Идентификатор шаблона
1302 +"updated": "", ~/~/ Время отправки  
1303 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1304 +"answer": "", ~/~/ Ответ терминала.
1305 +"status": "" ~/~/ Статус отправки
1306 +}
1307 +]
1308 +)))
1309 +
1310 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1311 +
511 511  (% class="box successmessage" %)
512 512  (((
513 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
1314 +(% lang="en-US" %)**POST /api/v3/vehicles**
514 514  )))
515 515  
516 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1317 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
517 517  
518 518  (% style="color:#000000" %)Метод запроса: **POST**
519 519  
... ... @@ -523,8 +523,7 @@
523 523  
524 524  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
525 525  
526 -(% style="color:#000000" %){
527 -
1327 +(% style="color:#000000" %){(%%)
528 528   "parentId": "" , ~/~/ ID клиента
529 529   "name": "" , ~/~/ имя ТС
530 530   "imei": "" , ~/~/ IMEI
... ... @@ -545,6 +545,10 @@
545 545   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
546 546   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
547 547   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1348 + "mileageCalcMethod": 0,
1349 + "mileageCoeff": 0,
1350 + "locationByCellId": true,
1351 + "dottedLineTrackWhenNoCoords": true,
548 548   "counters": ~/~/ счетчики
549 549   {
550 550   "mileage": "" , ~/~/ пробег
... ... @@ -573,68 +573,265 @@
573 573   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
574 574   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
575 575   }
1380 +"drivers": [ ~/~/ Водители
1381 + {
1382 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1383 + "isDefault": true
1384 + }
1385 + ],
1386 + "commandTemplates": [ ~/~/ Шаблон команды
1387 + {
1388 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1389 + "name": "string",
1390 + "command": "string",
1391 + "retries": 0
1392 + }
1393 + ],
1394 +"sensors": [ ~/~/ Датчики
1395 + {
1396 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1397 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1398 + "type": 0, ~/~/ Тип датчика
1399 + "name": "string", ~/~/ Имя датчика
1400 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1401 + "inputNumber": 0, ~/~/ Номер входа
1402 + "pseudonym": "string", ~/~/ Псевдоним
1403 + "medianDegree": 0, ~/~/ Медианная фильтрация
1404 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1405 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1406 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1407 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1408 + {
1409 + "grades": [ ~/~/ Таблица тарировки 1
1410 + {
1411 + "input": 0, ~/~/ Входящее значение
1412 + "output": 0 ~/~/ Выходящее значение
1413 + }
1414 + ],
1415 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1416 + }
1417 + ],
1418 + "showInTooltip": true, ~/~/ Отображать в подсказке
1419 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1420 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1421 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1422 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1423 + "expr": "string", ~/~/ Формула
1424 + "children": [ ~/~/ массив дочерних датчиков
1425 + "string"
1426 + ],
1427 + "customParams": { ~/~/ прочие произвольные параметры
1428 + "additionalProp1": "string",
1429 + "additionalProp2": "string",
1430 + "additionalProp3": "string"
1431 + },
1432 +~/~/ Характерные для произвольного:
1433 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1434 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1435 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1436 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1437 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1438 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1439 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1440 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1441 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1442 +~/~/ "ValueOn": "Вкл.",
1443 +~/~/ "ValueOff": "Выкл."
1444 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
576 576  
577 -(% style="color:#000000" %) }
1446 +(((
1447 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1448 + {
1449 + "from": 0, ~/~/ С какого значения
1450 + "color": "string", ~/~/ Каким цветом
1451 + "text": "string" ~/~/ Текст подписи к этому интервалу
1452 + }
1453 + ]
1454 + }
1455 + ],
1456 +)))
578 578  
1458 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1459 +
1460 +
1461 + "customFields": [ ~/~/ Произвольные поля
1462 + {
1463 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1464 + "name": "string", ~/~/ Наименование произвольного поля
1465 + "value": "string", ~/~/ Значение произвольного поля
1466 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1467 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1468 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1469 + }
1470 + ]
1471 +}
1472 +
579 579  (% style="color:#000000" %)Ответ:
580 580  
581 -(% style="color:#000000" %){
582 582  
583 - "vehicleId": "", ~/~/ID ТС 
584 - "parentId": "", ~/~/Guid владельца ТС
585 - "name": "", ~/~/Имя объекта
586 - "imei": "", ~/~/IMEI
587 - "deviceTypeId": "", ~/~/ID типа устройства
588 - "modelId": "", ~/~/ID модели
589 - "unitId": "", ~/~/ID подразделения
590 - "sim1": "", ~/~/SIM1
591 - "sim2": "", ~/~/SIM2
592 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
593 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
594 - "counters": { ~/~/Счётчики
595 - "mileageEnabled": true,
596 - "motohoursEnabled": true,
597 - "mileage": "",
598 - "motohours": 345.0
599 - },
600 - "cmsv6Parameters": { ~/~/Параметры CmsV6
601 - "id": null,
602 - "enabled": true, ~/~/флаг включения
603 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
604 - "login": "", ~/~/ имя учетной записи
605 - "password": "" ~/~/ пароль учетной записи
606 - },
607 - "inspectionTasks": { ~/~/ задания на ТО
608 - "id": "", ~/~/ ID задачи
609 - "enabled": false, ~/~/ Признак включения
610 - "name": "", ~/~/ Имя задания
611 - "description": "", ~/~/ Описание задания
612 - "mileageCondition": "", ~/~/ Условие по пробегу
613 - "lastMileage": "", ~/~/ Пробег (в метрах)
614 - "motohoursCondition": "", ~/~/ Условие по моточасам
615 - "lastMotohours": "", ~/~/ Моточасы
616 - "periodicCondition": "", ~/~/ Условие периодичности по времени
617 - "kind": "", ~/~/ Вид периодичности по времени 
618 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1476 +(((
1477 +(((
1478 +(((
1479 +{
1480 + "vehicleId": 0,  ~/~/ ID ТС
1481 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1482 + "name": "string", ~/~/ Имя объекта
1483 + "imei": "string", ~/~/ IMEI
1484 + "deviceTypeId": 0, ~/~/ ID типа устройства
1485 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1486 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1487 + "sim1": "string", ~/~/ SIM1
1488 + "sim2": "string", ~/~/ SIM2
1489 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1490 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1491 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1492 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1493 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1494 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1495 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1496 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1497 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1498 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1499 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1500 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1501 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1502 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1503 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1504 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1505 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1506 + "counters": {  ~/~/ Dto для состояний счётчиков
1507 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1508 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1509 + "mileage": 0, ~/~/ Пробег
1510 + "motohours": 0 ~/~/ Моточасы
1511 + },
1512 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1513 + "id": "string", ~/~/ CMSV6 Идентификатор
1514 + "enabled": true, ~/~/ Признак включения
1515 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1516 + "login": "string", ~/~/ CMSV6 имя учетной записи
1517 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1518 + },
1519 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1520 + {
1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1522 + "enabled": true, ~/~/ Признак включения
1523 + "name": "string", ~/~/ Имя задания
1524 + "description": "string", ~/~/ Описание задания
1525 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1526 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1527 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1528 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1529 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1530 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1531 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1532 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
619 619   }
1534 + ],
1535 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1536 + {
1537 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1538 + "inputNumber": 0, ~/~/ № входа.
1539 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1540 + "comment": "string", ~/~/ Комментарий
1541 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1542 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1543 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1544 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1545 + }
1546 + ],
1547 + "commandTemplates": [  ~/~/ Список шаблонов команд
1548 + {
1549 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1550 + "name": "string", ~/~/ Название шаблона команд
1551 + "command": "string", ~/~/ Команда на выполнение
1552 + "retries": 0 ~/~/ Лимит попыток отправки
1553 + }
1554 + ],
1555 + "sensors": [ ~/~/ Список датчиков
1556 + {
1557 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1558 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1559 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1560 + "name": "string",  ~/~/ Имя датчика
1561 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1562 + "inputNumber": 0, ~/~/ Номер входа
1563 + "pseudonym": "string", ~/~/ Псевдоним
1564 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1565 + "isInverted": true, ~/~/  Признак инверсии
1566 + "disabled": true, ~/~/ Датчик не участвует в обработке
1567 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1568 + "gradesTables": [ ~/~/ Тарировка
1569 + {
1570 + "grades": [ ~/~/ Таблицы тарировки
1571 + {
1572 + "input": 0, ~/~/ Вход
1573 + "output": 0 ~/~/ Выход
1574 + }
1575 + ],
1576 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1577 + }
1578 + ],
1579 + "showInTooltip": true, ~/~/ Отображение в подсказке
1580 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1581 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1582 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1583 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1584 + "expr": "string", ~/~/ Выражение
1585 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1586 + "string"
1587 + ],
1588 + "customParams": {
1589 + "additionalProp1": "string",
1590 + "additionalProp2": "string",
1591 + "additionalProp3": "string"
1592 + },
1593 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1594 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1595 + {
1596 + "from": 0, ~/~/ С какого значения
1597 + "color": "string", ~/~/ Каким цветом
1598 +)))
620 620  
621 -(% style="text-align:left" %)
622 -(% style="color:#000000" %)}
1600 +(((
1601 + "text": "string" ~/~/ Текст подписи к этому интервалу
1602 + }
1603 + ]
1604 + }
1605 + ],
1606 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1607 + "customFields": [ ~/~/ Список произвольных полей
1608 + {
1609 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1610 + "name": "string", ~/~/ Наименование произвольного поля
1611 + "value": "string", ~/~/ Значение произвольного поля
1612 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1613 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1614 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1615 + }
1616 + ],
1617 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
1618 +}
1619 +)))
1620 +)))
1621 +)))
623 623  
1623 +
624 624  **Валидация:**
625 625  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
626 626  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
627 627  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
628 628  
1629 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
629 629  
630 -(% class="box successmessage" %)
1631 +(% class="box infomessage" %)
631 631  (((
632 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1633 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
633 633  )))
634 634  
635 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1636 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
636 636  
637 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1638 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
638 638  
639 639  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
640 640  
... ... @@ -660,23 +660,32 @@
660 660  
661 661  (% style="color:#000000" %)Параметры в теле запроса (JSON):
662 662  
663 -(% class="western" style="color:#000000" %)##{##
1664 +{
1665 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1666 + "name": null, ~/~/ Имя ТС (string, опционально)
1667 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1668 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1669 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1670 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1671 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1672 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1673 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1674 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1675 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1676 +}
664 664  
665 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
666 - "name": null, ~/~/ Имя ТС (string, опционально) 
667 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
671 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
672 -(% style="color:#000000" %)}
1678 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
673 673  
674 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
675 -
676 676  (% style="color:#000000" %)Ответ:
677 677  
678 -(% style="color:#000000" %){
1682 +(% style="color:#000000" %)[
1683 +{
679 679  
1685 +(((
1686 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1687 +)))
1688 +
1689 +(((
680 680  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
681 681   "name": "" ~/~/ наименование объекта
682 682   "imei": "" ~/~/ IMEI объекта
... ... @@ -693,18 +693,40 @@
693 693   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
694 694   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
695 695   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
696 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
697 -(% style="color:#000000" %)}
1706 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1707 + "customFields": [ 
1708 + {
1709 + "id": "", ~/~/ идентификатор произвольного поля
1710 + "name": "", ~/~/ имя произвольного поля
1711 + "value": "", ~/~/ значение произвольного поля
1712 + "forClient": true, ~/~/ право на отображение у клиента
1713 + "forTooltip": false, ~/~/ право на отображение в подсказке
1714 + "forReport": false ~/~/ право на отображение в отчетах
1715 +)))
698 698  
1717 +(((
1718 + }
1719 + ],
1720 + "vehicleGroups": [  ~/~/ Группы ТС
1721 + {
1722 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1723 + "name": "string" ~/~/ Наименование группы ТС
1724 + }
1725 + ]
1726 + }
1727 +]
1728 +)))
1729 +
699 699  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
700 700  
1732 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
701 701  
702 702  (% class="box successmessage" %)
703 703  (((
704 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1736 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
705 705  )))
706 706  
707 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1739 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
708 708  
709 709  (% style="color:#000000" %)Метод запроса: **POST**
710 710  
... ... @@ -726,13 +726,11 @@
726 726   "data": "", ~/~/ Данные
727 727   "overwrite": false, ~/~/ Флаг перезаписи
728 728   "stage": "", ~/~/ Состояние, может быть null
729 -
730 730  (% style="color:#000000" %)}
731 731  
732 732  (% style="color:#000000" %)Ответ:
733 733  
734 -(% style="color:#000000" %){
735 -
1765 +(% style="color:#000000" %){(%%)
736 736   "status": "", ~/~/ значение статуса
737 737   "date": "", ~/~/ Дата смены статуса 
738 738   "description": "", ~/~/ Описание
... ... @@ -739,17 +739,18 @@
739 739   "data": "", ~/~/ Данные
740 740   "overwrite": false, ~/~/ Флаг перезаписи
741 741   "stage": "", ~/~/ Состояние
742 -
743 -(% style="text-align:left" %)
744 744  (% style="color:#000000" %) }
745 745  
1774 +== ==
746 746  
1776 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1777 +
747 747  (% class="box warningmessage" %)
748 748  (((
749 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1780 +(% lang="en-US" %)**PUT /api/v3/vehicles**
750 750  )))
751 751  
752 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1783 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
753 753  
754 754  (% style="color:#000000" %)Метод запроса: **PUT**
755 755  
... ... @@ -759,18 +759,16 @@
759 759  
760 760  (% style="color:#000000" %)Параметры в теле запроса (JSON):
761 761  
762 -(% style="color:#000000" %){    
763 -
764 -(((
765 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
766 - "parentId": "", ~/~/ ID клиента
767 - "name": "", ~/~/ имя ТС
768 - "imei": "", ~/~/ IMEI
769 - "deviceTypeId": "", ~/~/ ID типа устройства
770 - "modelId": "", ~/~/ , ID модели    
771 - "unitId": "", ~/~/ подразделения
772 - "sim1": "", ~/~/ SIM 1
773 - "sim2": "", ~/~/ SIM2     (%%)
1793 +(% style="color:#000000" %){
1794 + "vehicleId": , ~/~/ ID объекта
1795 + "parentId": "" , ~/~/ ID клиента
1796 + "name": "" , ~/~/ имя ТС
1797 + "imei": "" , ~/~/ IMEI
1798 + "deviceTypeId": "" , ~/~/ ID типа устройства
1799 + "modelId": "" , ~/~/ ID модели
1800 + "unitId": "" , ~/~/ ID подразделения
1801 + "sim1": "" , ~/~/ Номер SIM 1
1802 + "sim2": "" , ~/~/ Номер SIM2
774 774   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
775 775   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
776 776   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -783,101 +783,314 @@
783 783   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
784 784   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
785 785   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
786 -(% style="color:#000000" %) "counters": 
787 - {
788 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
789 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
790 - "mileage": "", ~/~/ пробег, в метрах 
791 - "motohours": "" ~/~/ моточасы, в секундах
792 - }
793 - "cmsv6Parameters": ~/~/ параметры CMSv6
794 - {       
795 - "id": "", ~/~/ идентификатор
796 - "enabled": true, ~/~/ флаг включения
797 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
798 - "login": "", ~/~/ имя учетной записи
799 - "password": "", ~/~/ пароль учетной записи
800 - }
801 - "inspectionTasks": ~/~/ задания на ТО
802 - {
803 - "id": "", ~/~/ ID задания
804 - "enabled": false, ~/~/ Признак включения
805 - "name": "", ~/~/ Имя задания
806 - "description": "", ~/~/ Описание задания
807 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
808 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
809 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
810 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
811 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
812 - "kind": "", ~/~/ Вид периодичности по времени
813 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
814 - } 
815 -)))
816 816  
817 -(% style="color:#000000" %)}
1816 + "mileageCalcMethod": 0,
1817 + "mileageCoeff": 0,
1818 + "locationByCellId": true,
1819 + "dottedLineTrackWhenNoCoords": true,
1820 + "counters": ~/~/ счетчики
1821 + {
1822 + "mileage": "" , ~/~/ пробег
1823 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1824 + "motohours": "" , ~/~/ моточасы
1825 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1826 + },
1827 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1828 + "enabled": true, ~/~/ флаг включения
1829 + "id": "" , ~/~/ идентификатор
1830 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1831 + "login": "" , ~/~/ имя учетной записи
1832 + "password": "" ~/~/ пароль учетной записи
1833 + },
1834 + "inspectionTasks": ~/~/ задания на ТО
1835 + {
1836 + "enabled": "" , ~/~/ Признак включения
1837 + "name": "" , ~/~/ Имя задания
1838 + "description": "" , ~/~/ Описание задания
1839 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1840 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1841 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1842 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1843 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1844 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1845 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1846 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1847 + }
818 818  
1849 +"drivers": [ ~/~/ Водители
1850 + {
1851 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1852 + "isDefault": true
1853 + }
1854 + ],
1855 + "commandTemplates": [ ~/~/ Шаблон команды
1856 + {
1857 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1858 + "name": "string",
1859 + "command": "string",
1860 + "retries": 0
1861 + }
1862 + ],
1863 +"sensors": [ ~/~/ Датчики
1864 + {
1865 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1866 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1867 + "type": 0, ~/~/ Тип датчика
1868 + "name": "string", ~/~/ Имя датчика
1869 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1870 + "inputNumber": 0, ~/~/ Номер входа
1871 + "pseudonym": "string", ~/~/ Псевдоним
1872 + "medianDegree": 0, ~/~/ Медианная фильтрация
1873 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1874 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1875 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1876 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1877 + {
1878 + "grades": [ ~/~/ Таблица тарировки 1
1879 + {
1880 + "input": 0, ~/~/ Входящее значение
1881 + "output": 0 ~/~/ Выходящее значение
1882 + }
1883 + ],
1884 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1885 + }
1886 + ],
1887 + "showInTooltip": true, ~/~/ Отображать в подсказке
1888 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1889 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1890 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1891 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1892 + "expr": "string", ~/~/ Формула
1893 + "children": [ ~/~/ массив дочерних датчиков
1894 + "string"
1895 + ],
1896 + "customParams": { ~/~/ прочие произвольные параметры
1897 + "additionalProp1": "string",
1898 + "additionalProp2": "string",
1899 + "additionalProp3": "string"
1900 + },
1901 +~/~/ Характерные для произвольного:
1902 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1903 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1904 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1905 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1906 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1907 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1908 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1909 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1910 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1911 +~/~/ "ValueOn": "Вкл.",
1912 +~/~/ "ValueOff": "Выкл."
1913 + "summaryMaxValue": 0 ~/~/ Макс. значение
1914 +
1915 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1916 + {
1917 + "from": 0, ~/~/ С какого значения
1918 + "color": "string", ~/~/ Каким цветом
1919 + "text": "string" ~/~/ Текст подписи к этому интервалу
1920 + }
1921 + ]
1922 + }
1923 + ],
1924 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1925 +
1926 + "customFields": [ ~/~/ Произвольные поля
1927 + {     
1928 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1929 + "name": "string", ~/~/ Наименование произвольного поля
1930 + "value": "string", ~/~/ Значение произвольного поля
1931 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1932 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1933 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1934 + }
1935 + ]
1936 +}
1937 +
1938 +
819 819  (% style="color:#000000" %)Ответ:
820 820  
821 -(% lang="en-US" style="text-align:left" %)
822 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1941 +(((
1942 +{
1943 + "vehicleId": 0, ~/~/ ID ТС
1944 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1945 + "name": "string", ~/~/ Имя объекта
1946 + "imei": "string", ~/~/ IMEI
1947 + "deviceTypeId": 0, ~/~/ ID типа устройства
1948 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1949 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1950 + "sim1": "string", ~/~/ SIM1
1951 + "sim2": "string", ~/~/ SIM2
1952 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1953 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1954 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1955 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1956 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1957 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1958 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1959 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1960 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1961 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1962 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1963 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1964 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1965 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1966 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1967 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1968 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1969 + "counters": { ~/~/ состояний счётчиков
1970 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1971 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1972 + "mileage": 0, ~/~/ Пробег
1973 + "motohours": 0 ~/~/ Моточасы 
1974 + },
1975 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1976 + "id": "string", ~/~/ CMSV6 Идентификатор
1977 + "enabled": true, ~/~/ Признак включения
1978 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1979 +)))
823 823  
824 -(% lang="en-US" style="text-align:left" %)
825 - "vehicleId": "", ~/~/ ID ТС
826 - "parentId": "", ~/~/ ID клиента
827 - "name": "", ~/~/ имя ТС
828 - "imei": "", ~/~/ IMEI
829 - "deviceTypeId": "", ~/~/ типа устройства
830 - "modelId": "", ~/~/ ID модели
831 - "unitId": "", ~/~/ ID подразделения
832 - "sim1": "", ~/~/ SIM 1
833 - "sim2": "", ~/~/ SIM2
834 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
835 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
836 - "counters": 
837 - {
838 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
839 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
840 - "mileage": "", ~/~/ пробег
841 - "motohours": "", ~/~/ моточасы
842 - }
843 - "cmsv6Parameters": ~/~/ параметры CMSv6
1981 +
1982 +(((
1983 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1984 + "login": "string", ~/~/ CMSV6 имя учетной записи
1985 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1986 + },
1987 + "inspectionTasks": [ ~/~/ Задания на ТО
1988 + {
1989 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1990 + "enabled": true, ~/~/ Признак включения
1991 + "name": "string", ~/~/ Имя задания
1992 + "description": "string", ~/~/ Описание задания
1993 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1994 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1995 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1996 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1997 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1998 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
1999 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2000 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2001 + }
2002 + ],
2003 + "drivers": [  ~/~/ Список водителей
2004 + {
2005 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2006 + "inputNumber": 0, ~/~/ № входа.
2007 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2008 + "comment": "string", ~/~/ Комментарий.
2009 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2010 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2011 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2012 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2013 + }
2014 + ],
2015 + "commandTemplates": [ ~/~/ Список шаблонов команд
2016 + {
2017 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2018 + "name": "string", ~/~/ Название шаблона команд
2019 + "command": "string", ~/~/ Команда на выполнение
2020 + "retries": 0 ~/~/ Лимит попыток отправки
2021 + }
2022 + ],
2023 + "sensors": [  ~/~/ Список датчиков 
2024 + {
2025 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2026 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2027 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2028 +)))
2029 +
2030 +(((
2031 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2032 +)))
2033 +
2034 +(((
2035 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2036 +)))
2037 +
2038 +(((
2039 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2040 +)))
2041 +
2042 +(((
2043 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2044 +)))
2045 +
2046 +(((
2047 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2048 + "name": "string", ~/~/ Имя датчика
2049 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2050 +)))
2051 +
2052 +(((
2053 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2054 + "inputNumber": 0, ~/~/ Номер входа
2055 + "pseudonym": "string", ~/~/ Псевдоним
2056 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2057 + "isInverted": true, ~/~/ Признак инверсии
2058 + "disabled": true, ~/~/ Датчик не участвует в обработке
2059 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2060 + "gradesTables": [ ~/~/ Тарировка
844 844   {
845 - "id": ~/~/ идентификатор
846 - "enabled": true, ~/~/ флаг включения
847 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
848 - "login": "", ~/~/ имя учетной записи
849 - "password": "", ~/~/ пароль учетной записи
850 - }
851 - "inspectionTasks": ~/~/ задания на ТО
2062 + "grades": [ ~/~/ Таблицы тарировки
2063 + {
2064 + "input": 0, ~/~/ Вход
2065 + "output": 0 ~/~/ Выход
2066 + }
2067 + ],
2068 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2069 + }
2070 + ],
2071 + "showInTooltip": true, ~/~/ Отображение в подсказке
2072 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
2073 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2074 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2075 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2076 + "expr": "string", ~/~/ Выражение
2077 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2078 + "string" 
2079 + ],
2080 + "customParams": { ~/~/ Дополнительные настройки
2081 + "additionalProp1": "string",
2082 + "additionalProp2": "string",
2083 + "additionalProp3": "string"
2084 + },
2085 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2086 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
852 852   {
853 - "id": "", ~/~/ ID задания
854 - "enabled": false, ~/~/ Признак включения
855 - "name": "", ~/~/ Имя задания
856 - "description": "", ~/~/ Описание задания
857 - "mileageCondition": "", ~/~/ Условие по пробегу
858 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
859 - "motohoursCondition": "", ~/~/ Условие по моточасам
860 - "lastMotohours": "", ~/~/ Моточасы
861 - "periodicCondition": "", ~/~/ Условие периодичности по времени
862 - "kind": "", ~/~/ Вид периодичности по времени
863 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2088 + "from": 0, ~/~/ С какого значения
2089 + "color": "string", ~/~/ Каким цветом
2090 + "text": "string" ~/~/ Текст подписи к этому интервалу
864 864   }
2092 + ]
2093 + }
2094 + ],
2095 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2096 + "customFields": [ ~/~/ Список произвольных полей
2097 + {
2098 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2099 + "name": "string", ~/~/ Наименование произвольного поля
2100 + "value": "string", ~/~/ Значение произвольного поля
2101 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2102 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2103 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2104 + }
2105 + ],
2106 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2107 +}
2108 +)))
865 865  
866 -(% lang="en-US" style="text-align:left" %)
867 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
868 -
869 -**валидация:**
2110 +**Валидация:**
870 870  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
871 871  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
872 872  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
873 873  
2115 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
874 874  
875 875  (% class="box errormessage" %)
876 876  (((
877 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2119 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
878 878  )))
879 879  
880 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2122 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
881 881  
882 882  (% style="color:#000000" %)Метод запроса: **DELETE**
883 883  
... ... @@ -890,66 +890,2670 @@
890 890  (% style="text-align:left" %)
891 891  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
892 892  
2135 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
893 893  
894 -(% class="box" lang="en-US" style="text-align: center;" %)
895 -(((
896 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
897 -)))
2137 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
898 898  
899 899  (% class="box infomessage" %)
900 900  (((
901 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
2141 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
902 902  )))
903 903  
904 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2144 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
905 905  
906 906  (% style="color:#000000" %)Метод запроса: **GET**
907 907  
908 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
2148 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
909 909  
910 910  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911 911  
912 912  (% style="color:#000000" %)Ответ:
913 913  
914 -(% style="color:#000000" %){
915 -
2154 +(% style="color:#000000" %){(%%)
916 916   "deviceTypeId" : "", ~/~/ ID типа устройства
917 917   "deviceTypeName" : "" ~/~/ Название типа устройства
918 -
919 -(% style="text-align:left" %)
920 920  (% style="color:#000000" %)}
921 921  
2159 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
922 922  
923 -(% class="box" style="text-align: center;" %)
924 -(((
925 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
926 -)))
2161 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
927 927  
928 928  (% class="box infomessage" %)
929 929  (((
930 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
2165 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
931 931  )))
932 932  
933 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2168 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
934 934  
935 935  (% style="color:#000000" %)Метод запроса: **GET**
936 936  
937 937  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
938 938  
939 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
2174 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940 940  
941 941  (% style="color:#000000" %)Ответ:
942 942  
943 -(% style="color:#000000" %){
944 -
2178 +(% style="color:#000000" %){(%%)
945 945   "id": "", ~/~/ ID типа датчика 
946 946   "name": "", ~/~/ Название
947 947   "description": "", ~/~/ Описание
2182 +(% style="color:#000000" %)}
948 948  
2184 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2185 +
2186 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2187 +
2188 +(% class="box infomessage" style="text-align: left;" %)
2189 +(((
2190 +**POST /api/v3/terminalMessages/count**
2191 +)))
2192 +
2193 +(% style="text-align: left;" %)
2194 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2195 +
2196 +(% style="text-align: left;" %)
2197 +Метод запроса **POST**
2198 +
2199 +(% style="text-align: left;" %)
2200 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2201 +
2202 +(% style="text-align: left;" %)
2203 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2204 +
2205 +(% style="text-align: left;" %)
2206 +{
2207 + "vehicleIds": [
2208 + id ~/~/ здесь передается список идентификаторов объектов
2209 + ],
2210 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2211 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2212 +}
2213 +
2214 +(% style="text-align: left;" %)
2215 +Ответ:
2216 +
2217 +(% style="text-align: left;" %)
2218 +[
2219 + {
2220 + "vehicleId": 0, ~/~/ идентификатор объекта
2221 + "count": 0 ~/~/ количество сообщений за период
2222 + }
2223 +]
2224 +
2225 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2226 +
2227 +(% class="box infomessage" style="text-align: left;" %)
2228 +(((
2229 +**POST /api/v3/terminalMessages/mapping**
2230 +)))
2231 +
2232 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2233 +
2234 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2235 +
2236 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2237 +
2238 +{
2239 + "protocolType": 0,
2240 + "params": ["string"]
2241 +}
2242 +
2243 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2244 +|protocolType|ID типа протокола
2245 +|params|(((
2246 +Массив наименований параметров в сообщении
2247 +)))
2248 +
2249 +Ответ:
2250 +
2251 +{
2252 + "protocolType": 0,
2253 + "mapping": {
2254 + "additionalProp1": {
2255 + "inputType": 0,
2256 + "inputNumber": 0
2257 + },
2258 + "additionalProp2": {
2259 + "inputType": 0,
2260 + "inputNumber": 0
2261 + }
2262 + }
2263 +}
2264 +
2265 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2266 +|protocolType|Тип протокола
2267 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2268 +|inputNumber|(((
2269 +Номер входа
2270 +)))
2271 +
2272 +(% class="wikigeneratedid" %)
2273 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2274 +
2275 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2276 +
2277 +(% class="box infomessage" %)
2278 +(((
2279 +**POST /api/v3/terminalMessages**
2280 +)))
2281 +
2282 +Метод возвращает список сообщений терминала объекта за выбранный период.
2283 +
2284 +(% style="text-align: left;" %)
2285 +Метод запроса **POST**
2286 +
2287 +(% style="text-align: left;" %)
2288 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2289 +
2290 +(% style="text-align: left;" %)
2291 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2292 +
2293 +{
2294 + "vehicleId": 0, ~/~/ id объекта
2295 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2296 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2297 +}
2298 +
2299 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2300 +|vehicleId|ID объекта
2301 +|from|Дата и время начала периода запроса
2302 +|to|Дата и время окончания периода запроса
2303 +
2304 +Ответ:
2305 +
2306 +[
2307 + {
2308 + "messages": [
2309 + {
2310 + "deviceTime": "2023-11-29T07:40:44.052Z",
2311 + "serverTime": "2023-11-29T07:40:44.052Z",
2312 + "speed": 0,
2313 + "altitude": 0,
2314 + "latitude": 0,
2315 + "longitude": 0,
2316 + "satellites": 0,
2317 + "course": 0,
2318 + "voltage": 0,
2319 + "parameters": {
2320 + "additionalProp1": "string",
2321 + "additionalProp2": "string",
2322 + "additionalProp3": "string"
2323 + },
2324 + "photoCount": 0,
2325 + "lbsCorrectedCoords": true,
2326 + "protocolType": 0
2327 + }
2328 + ]
2329 + }
2330 +]
2331 +
2332 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2333 +|deviceTime|Время сообщения терминала
2334 +|serverTime|Время когда сообщение поступило на сервер
2335 +|speed|Скорость
2336 +|altitude|Высота над уровнем моря
2337 +|latitude|Широта
2338 +|longitude|Долгота
2339 +|satellites|Кол-во спутников
2340 +|course|Курс
2341 +|voltage|Бортовое напряжение
2342 +|parameters|Список параметров и их значений
2343 +|photoCount|Количество фото
2344 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2345 +|protocolType|ID типа протокола
2346 +
2347 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2348 +
2349 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2350 +
2351 +(% class="box infomessage" %)
2352 +(((
2353 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2354 +)))
2355 +
2356 +(% style="color:#000000" %)Метод запроса: **POST**
2357 +
2358 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2359 +
2360 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2361 +
949 949  (% style="text-align:left" %)
2363 +Тело запроса:
2364 +
2365 +{
2366 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2367 + "vehicleIds": [0], ~/~/ Список ID объектов
2368 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2369 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2370 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2371 +}
2372 +
2373 +Ответ:
2374 +
2375 +[
2376 + {
2377 + "vehicleId": 0, ~/~/ ID объекта
2378 + "name": "string", ~/~/ Имя ТС
2379 + "periods": [ ~/~/ Периоды
2380 + {
2381 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2382 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2383 + "mileage": 0, ~/~/ Пробег за период, километры
2384 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2385 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2386 + "motohours": 0, ~/~/ Моточасы за период, секунды
2387 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2388 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2389 + }
2390 + ]
2391 + }
2392 +]
2393 +
2394 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2395 +
2396 +(% class="box infomessage" %)
2397 +(((
2398 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2399 +)))
2400 +
2401 +(% style="color:#000000" %)Метод запроса: **POST**
2402 +
2403 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2404 +
2405 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2406 +
2407 +(% style="text-align:left" %)
2408 +Тело запроса:
2409 +
2410 +{
2411 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2412 + "vehicleIds": [0], ~/~/ Список ID объектов
2413 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2414 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2415 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2416 +}
2417 +
2418 +Ответ:
2419 +
2420 +[
2421 + {
2422 + "vehicleId": 0, ~/~/ ID объекта
2423 + "name": "string", ~/~/ Имя ТС
2424 + "periods": [ ~/~/ Периоды
2425 + {
2426 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2427 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2428 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2429 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2430 + "fuelConsumption": 0, ~/~/ Расход топлива
2431 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2432 + }
2433 + ]
2434 + }
2435 +]
2436 +
2437 +(% class="box warningmessage" %)
2438 +(((
2439 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2440 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2441 +)))
2442 +
2443 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2444 +
2445 +(% class="box infomessage" %)
2446 +(((
2447 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2448 +)))
2449 +
2450 +(% style="color:#000000" %)Метод запроса: **POST**
2451 +
2452 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2453 +
2454 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2455 +
2456 +(% style="text-align:left" %)
2457 +Тело запроса:
2458 +
2459 +{
2460 + "vehicleIds": [0], ~/~/ Список ID объектов
2461 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2462 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2463 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2464 +}
2465 +
2466 +Ответ:
2467 +
2468 +[
2469 + {
2470 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2471 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2472 + "vehicleId": 0, ~/~/ ID объекта
2473 + "name": "string", ~/~/ Имя объекта
2474 + "model": "string", ~/~/ Модель объекта
2475 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2476 + {
2477 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2478 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2479 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2480 + "valueFuel": 0, ~/~/ Количество
2481 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2482 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2483 + }
2484 + ]
2485 + }
2486 +]
2487 +
2488 +
2489 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2490 +
2491 +(% class="box infomessage" %)
2492 +(((
2493 +**POST /api/v3/vehicles/moveStop**
2494 +)))
2495 +
2496 +Метод запроса: **POST**
2497 +
2498 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2499 +
2500 +В заголовках запроса: X-Auth: Токен авторизации
2501 +
2502 +
2503 +Тело запроса:
2504 +
2505 +{
2506 + "vehicleIds": [ ], ~/~/ Список ID объектов
2507 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2508 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2509 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2510 +}
2511 +
2512 +Ответ:
2513 +
2514 +[ 
2515 + {
2516 + "vehicleId": 0, ~/~/ ID объекта
2517 + "vehicleName": "string", ~/~/ Имя объекта
2518 + "moves": [ ~/~/ Событие движения
2519 + {
2520 + "mileage": 0, ~/~/ Пробег, км
2521 + "eventId": 0, ~/~/ Идентификатор события
2522 + "eventName": "string", ~/~/ Название события
2523 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2524 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2525 + "duration": 0 ~/~/ Продолжительность события, секунд
2526 + }
2527 + ],
2528 + "stops": [ ~/~/ События стоянок
2529 + {
2530 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2531 + "eventId": 0, ~/~/ Идентификатор события
2532 + "eventName": "string", ~/~/ Название события
2533 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2534 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2535 + "duration": 0 ~/~/ Продолжительность события, секунд
2536 + }
2537 + ]
2538 + }
2539 +]
2540 +
2541 +
2542 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2543 +
2544 +(% class="box infomessage" %)
2545 +(((
2546 +**POST /api/v3/vehicles/getlastdata**
2547 +)))
2548 +
2549 +Метод запроса: **POST**
2550 +
2551 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2552 +
2553 +В заголовках запроса: X-Auth: Токен авторизации
2554 +
2555 +
2556 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2557 +
2558 +Ответ:
2559 + {
2560 + "vehicleId": 0, ~/~/Идентификатор объекта.
2561 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2562 + "vehicleNumber": "string",~/~/Номер объекта.
2563 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2564 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2565 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2566 + "speed": 0,~/~/Скорость объекта.
2567 + "course": 0,~/~/Курс движения [0;360]
2568 + "latitude": 0,~/~/Широта [-90°;90°].
2569 + "longitude": 0,~/~/Долгота [-180°;180°].
2570 + "address": "string",~/~/Адрес.
2571 + "geozones": [ ~/~/Сведения по геозонам.
2572 + {
2573 + "id": 0,
2574 + "name": "string"
2575 + }
2576 +
2577 +
2578 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2579 +
2580 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2581 +
2582 +(% class="box infomessage" %)
2583 +(((
2584 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2585 +)))
2586 +
2587 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2588 +
2589 +(% style="color:#000000" %)Метод запроса: **POST**
2590 +
2591 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2592 +
2593 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2594 +
2595 +(% style="text-align:left" %)
2596 +Тело запроса:
2597 +
2598 +(% style="text-align:left" %)
2599 +{
2600 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2601 +}
2602 +
2603 +(% style="text-align:left" %)
2604 +Ответ:
2605 +
2606 +[
2607 + {
2608 + "id": 0, ~/~/ Идентификатор объекта геозоны
2609 + "name": "string", ~/~/ Название объекта геозоны
2610 + "type": 0, ~/~/ Тип объекта геозоны
2611 + "fname": "string", ~/~/ Имя файла
2612 + "parentId": "string", ~/~/ Идентификатор клиента
2613 + "radius": 0, ~/~/ Радиус геообъекта
2614 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2615 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2616 + "description": "string", ~/~/ Описание
2617 + "area": 0, ~/~/ Площадь, м^^2^^
2618 + "perimetr": 0, ~/~/ Периметр, м
2619 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2620 + }
2621 +]
2622 +
2623 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2624 +
2625 +(% class="box infomessage" %)
2626 +(((
2627 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2628 +)))
2629 +
2630 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2631 +
2632 +(% style="color:#000000" %)Метод запроса: **POST**
2633 +
2634 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2635 +
2636 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2637 +
2638 +(% style="text-align:left" %)
2639 +Тело запроса:
2640 +
2641 +{
2642 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2643 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2644 + "ids": [ ], ~/~/ Массив id объектов
2645 + "byTime": 0, ~/~/ Объединение событий по времени 
2646 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2647 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2648 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2649 +}
2650 +
2651 +Ответ:
2652 +[
2653 + {
2654 + "geozoneId": 0, ~/~/ ID геообъекта
2655 + "geozoneName": "string", ~/~/ Название геообъекта
2656 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2657 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2658 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2659 + "vehicleId": 0, ~/~/ ID объекта
2660 + "vehicleName": "string" ~/~/ Имя объекта
2661 + }
2662 +]
2663 +
2664 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2665 +
2666 +(% class="box infomessage" %)
2667 +(((
2668 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2669 +)))
2670 +
2671 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2672 +
2673 +(% style="color:#000000" %)Метод запроса: **POST**
2674 +
2675 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2676 +
2677 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2678 +
2679 +(% style="text-align:left" %)
2680 +Тело запроса:
2681 +
2682 +{
2683 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2684 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2685 + "ids": [ ], ~/~/ Массив id геообъектов
2686 + "byTime": 0, ~/~/ Объединение событий по времени 
2687 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2688 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2689 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2690 +}
2691 +
2692 +Ответ:
2693 +
2694 +[
2695 + {
2696 + "geozoneId": 0, ~/~/ ID геообъекта
2697 + "geozoneName": "string", ~/~/ Название геообъекта
2698 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2699 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2700 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2701 + "vehicleId": 0, ~/~/ ID объекта
2702 + "vehicleName": "string" ~/~/ Имя объекта
2703 + }
2704 +]
2705 +
2706 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2707 +
2708 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2709 +
2710 +(% class="box infomessage" %)
2711 +(((
2712 +**POST /api/v3/notifications/find**
2713 +)))
2714 +
2715 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2716 +
2717 +(% style="text-align: left;" %)
2718 +Метод запроса **POST**
2719 +
2720 +(% style="text-align: left;" %)
2721 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2722 +
2723 +(% style="text-align: left;" %)
2724 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2725 +
2726 +{
2727 + "parentId": "" ~/~/ id клиента
2728 +}
2729 +
2730 +Ответ:
2731 +
2732 +[
2733 + {
2734 + "id": 0, ~/~/ ID уведомления
2735 + "name": "string", ~/~/ Название уведомления
2736 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2737 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2738 + "userId": "", ~/~/ Пользователь, создавший уведомление
2739 + "parentId": "", ~/~/ Идентификатор клиента
2740 + "parentName": "string" ~/~/ Имя клиента
2741 + }
2742 +]
2743 +
2744 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2745 +
2746 +(% class="box infomessage" %)
2747 +(((
2748 +**GET /api/v3/notifications/{id}**
2749 +)))
2750 +
2751 +Метод возвращает данные правил формирования выбранного уведомления.
2752 +
2753 +(% style="text-align: left;" %)
2754 +Метод запроса **GET**
2755 +
2756 +(% style="text-align: left;" %)
2757 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2758 +
2759 +(% style="text-align: left;" %)
2760 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2761 +
2762 +(% style="text-align: left;" %)
2763 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2764 +
2765 +(% style="text-align: left;" %)
2766 +(% style="color:#000000" %)Ответ:
2767 +
2768 +(% style="text-align: left;" %)
2769 +(% style="color:#000000" %){
2770 + "id": 0, ~/~/ (%%)id уведомления
2771 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2772 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2773 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2774 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2775 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2776 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2777 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2778 +(% style="color:#000000" %) 0
2779 + ],
2780 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2781 +(% style="color:#000000" %) 0
2782 + ],
2783 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
2784 +(% style="color:#000000" %) 0
2785 + ],
2786 + "settings": { ~/~/ Список параметров уведомления
2787 + "additionalProp1": "string",
2788 + "additionalProp2": "string",
2789 + "additionalProp3": "string"
2790 + },
2791 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2792 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2793 +(% style="color:#000000" %) ""
2794 + ],
2795 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2796 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2797 +(% style="color:#000000" %) "string"
2798 + ],
2799 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2800 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2801 +(% style="color:#000000" %) {
2802 + "id": 0, ~/~/ (%%)Идентификатор участника чата
2803 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2804 +(% style="color:#000000" %) }
2805 + ],
2806 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2807 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2808 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2809 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2810 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2811 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2812 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2813 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2814 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
950 950  (% style="color:#000000" %)}
951 951  
2817 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
952 952  
2819 +(% class="box warningmessage" %)
2820 +(((
2821 +**PUT /api/v3/notifications/**
2822 +)))
2823 +
2824 +Метод позволяет отредактировать уведомление.
2825 +
2826 +Метод запроса **PUT**
2827 +
2828 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2829 +
2830 +В заголовках запроса: X-Auth: Токен авторизации
2831 +
2832 +Тело запроса:
2833 +{
2834 + "id": 0, ~/~/ id уведомления
2835 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2836 + "userId": "", ~/~/ Пользователь, создавший уведомление
2837 + "parentId": "", ~/~/ Идентификатор клиента
2838 + "parentName": "string", ~/~/ Имя клиента
2839 + "name": "string", ~/~/ Название уведомления
2840 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2841 + "vehicleIds": [ ~/~/ Список id объектов для анализа
2842 + 0
2843 + ],
2844 + "geoids": [ ~/~/ Список id геообъектов для анализа
2845 + 0
2846 + ],
2847 + "fieldids": [ ~/~/ Список id полей для анализа
2848 + 0
2849 + ],
2850 + "settings": { ~/~/ Список параметров уведомления
2851 + "additionalProp1": "string",
2852 + "additionalProp2": "string",
2853 + "additionalProp3": "string"
2854 + },
2855 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2856 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2857 + ""
2858 + ],
2859 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2860 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2861 + "string"
2862 + ],
2863 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2864 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2865 + {
2866 + "id": 0, ~/~/ Идентификатор участника чата
2867 + "info": "string" ~/~/ Дополнительные сведения
2868 + }
2869 + ],
2870 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2871 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2872 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2873 + "kind": 0, ~/~/ Определяет вид уведомления
2874 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2875 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2876 + "timezone": 0, ~/~/ Сдвиг часового пояса
2877 + "validity": 0, ~/~/ Срок действия в днях (1-90)
2878 + "autoProlongation": true ~/~/ Автопродление срока действия
2879 +}
2880 +
2881 +Ответ:
2882 +
2883 +Success
2884 +
2885 +
2886 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2887 +
2888 +(% class="box warningmessage" %)
2889 +(((
2890 +**PUT** /api/v3/notifications/prolongation
2891 +)))
2892 +
2893 +Метод позволяет продлить уведомления.
2894 +
2895 +Метод запроса **PUT**
2896 +
2897 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2898 +
2899 +В заголовках запроса: X-Auth: Токен авторизации.
2900 +
2901 +Тело запроса:
2902 +
2903 +[
2904 +
2905 +0
2906 +
2907 +]
2908 +
2909 +где 0 идентификатор ids.
2910 +
2911 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2912 +
2913 +(% class="box errormessage" %)
2914 +(((
2915 +**DELETE /api/v3/notifications/{id}**
2916 +)))
2917 +
2918 +Метод позволяет удалить выбранное уведомление.
2919 +
2920 +Метод запроса **DELETE**
2921 +
2922 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2923 +
2924 +Передаваемый параметр: {id} - id уведомления
2925 +
2926 +В заголовках запроса: X-Auth: Токен авторизации
2927 +
2928 +Ответ:
2929 +
2930 +Success
2931 +
2932 +
2933 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2934 +
2935 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2936 +
2937 +(% class="box infomessage" %)
2938 +(((
2939 +**POST /api/v3/Drivers/find**
2940 +)))
2941 +
2942 +Передается параметр: parentId - ID клиента-родителя
2943 +
2944 +Ответ:
2945 +
2946 +[
2947 + {
2948 + "name": "string", ~/~/ Определяет наименование
2949 + "description": "string", ~/~/ Определяет описание
2950 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2951 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2952 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2953 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2954 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2955 + "deleted": true ~/~/ Признак удаления
2956 + }
2957 +]
2958 +
2959 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2960 +
2961 +(% class="box infomessage" %)
2962 +(((
2963 +**GET /api/v3/Drivers/{driverGuid}**
2964 +)))
2965 +
2966 +Передается параметр: ID водителя
2967 +
2968 +Ответ:
2969 +
2970 +{
2971 + "name": "string", ~/~/ Определяет наименование
2972 + "description": "string", ~/~/ Определяет описание
2973 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2974 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2975 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2976 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2977 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2978 + "deleted": true ~/~/ Признак удаления
2979 +}
2980 +
2981 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2982 +
2983 +(% class="box successmessage" %)
2984 +(((
2985 +**POST /api/v3/Drivers**
2986 +)))
2987 +
2988 +Запрос:
2989 +
2990 +{
2991 + "name": "string",
2992 + "description": "string",
2993 + "hiredate": "2023-06-30T12:50:54.020Z",
2994 + "chopdate": "2023-06-30T12:50:54.020Z",
2995 + "exclusive": true,
2996 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2997 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2998 + "deleted": true
2999 +}
3000 +
3001 +Ответ:
3002 +
3003 +{
3004 + "name": "string",
3005 + "description": "string",
3006 + "hiredate": "2023-06-30T12:50:54.051Z",
3007 + "chopdate": "2023-06-30T12:50:54.051Z",
3008 + "exclusive": true,
3009 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3010 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3011 + "deleted": true
3012 +}
3013 +
3014 +
3015 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3016 +
3017 +(% class="box warningmessage" %)
3018 +(((
3019 +**PUT /api/v3/Drivers**
3020 +)))
3021 +
3022 +Запрос:
3023 +
3024 +{
3025 + "name": "string",
3026 + "description": "string",
3027 + "hiredate": "2023-06-30T12:50:27.910Z",
3028 + "chopdate": "2023-06-30T12:50:27.910Z",
3029 + "exclusive": true,
3030 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3031 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3032 + "deleted": true
3033 +}
3034 +
3035 +Ответ:
3036 +
3037 +{
3038 + "name": "string",
3039 + "description": "string",
3040 + "hiredate": "2023-06-30T12:50:27.929Z",
3041 + "chopdate": "2023-06-30T12:50:27.929Z",
3042 + "exclusive": true,
3043 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3045 + "deleted": true
3046 +}
3047 +
3048 +
3049 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3050 +
3051 +(% class="box errormessage" %)
3052 +(((
3053 +**DELETE /api/v3/Drivers/{driverGuid}**
3054 +)))
3055 +
3056 +Передается параметр: ID водителя
3057 +
3058 +Ответ:
3059 +
3060 +Success
3061 +
3062 +
3063 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3064 +
3065 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3066 +
3067 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3068 +
3069 +(% class="box infomessage" %)
3070 +(((
3071 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3072 +)))
3073 +
3074 +Запрос:
3075 +
3076 +{
3077 + "Ids": [
3078 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3079 + ],
3080 + "BeginTime": "2023-06-30T12:49:04.365Z",
3081 + "EndTime": "2023-06-30T12:49:04.365Z"
3082 +}
3083 +
3084 +Ответ:
3085 +
3086 +[
3087 + {
3088 + "VehicleId": 0,
3089 + "CreateTime": "2023-06-30T09:52:31.240Z",
3090 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3091 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3092 + "BeginTime": "2023-06-30T09:52:31.240Z",
3093 + "EndTime": "2023-06-30T09:52:31.240Z"
3094 + }
3095 +]
3096 +
3097 +
3098 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3099 +
3100 +(% class="box infomessage" %)
3101 +(((
3102 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3103 +)))
3104 +
3105 +Запрос:
3106 +
3107 +{
3108 + "Ids": [
3109 + 0
3110 + ],
3111 + "BeginTime": "2023-06-30T12:48:39.419Z",
3112 + "EndTime": "2023-06-30T12:48:39.419Z"
3113 +}
3114 +
3115 +Ответ:
3116 +
3117 +[
3118 + {
3119 + "VehicleId": 0,
3120 + "CreateTime": "2023-06-30T09:54:01.631Z",
3121 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3122 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3123 + "BeginTime": "2023-06-30T09:54:01.631Z",
3124 + "EndTime": "2023-06-30T09:54:01.631Z"
3125 + }
3126 +]
3127 +
3128 +
3129 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3130 +
3131 +(% class="box successmessage" %)
3132 +(((
3133 +**POST /api/v3/DriversVehiclesAssignments**
3134 +)))
3135 +
3136 +Передается массив назначений
3137 +
3138 +Запрос:
3139 +
3140 +[
3141 + {
3142 + "VehicleId": 0, ~/~/ Идентификатор объекта
3143 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3144 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3145 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3146 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3147 + }
3148 +]
3149 +
3150 +Ответ:
3151 +
3152 +[
3153 + {
3154 + "VehicleId": 0,
3155 + "CreateTime": "2023-06-30T11:04:46.903Z",
3156 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3157 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3158 + "BeginTime": "2023-06-30T11:04:46.903Z",
3159 + "EndTime": "2023-06-30T11:04:46.903Z"
3160 + }
3161 +]
3162 +
3163 +
3164 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3165 +
3166 +(% class="box warningmessage" %)
3167 +(((
3168 +**PUT /api/v3/DriversVehiclesAssignments**
3169 +)))
3170 +
3171 +Запрос:
3172 +
3173 +[
3174 + {
3175 + "VehicleId": 0,
3176 + "CreateTime": "2023-06-30T11:14:08.117Z",
3177 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3178 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3179 + "BeginTime": "2023-06-30T11:14:08.117Z",
3180 + "EndTime": "2023-06-30T11:14:08.117Z"
3181 + }
3182 +]
3183 +
3184 +Ответ:
3185 +
3186 +[
3187 + {
3188 + "VehicleId": 0,
3189 + "CreateTime": "2023-06-30T11:14:53.349Z",
3190 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3191 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3192 + "BeginTime": "2023-06-30T11:14:53.349Z",
3193 + "EndTime": "2023-06-30T11:14:53.349Z"
3194 + }
3195 +]
3196 +
3197 +
3198 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3199 +
3200 +(% class="box errormessage" %)
3201 +(((
3202 +**DELETE /api/v3/DriversVehiclesAssignments**
3203 +)))
3204 +
3205 +Запрос:
3206 +
3207 +[
3208 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3209 +]
3210 +
3211 +Ответ:
3212 +
3213 +Success
3214 +
3215 +
3216 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3217 +
3218 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3219 +
3220 +(% class="box infomessage" %)
3221 +(((
3222 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3223 +)))
3224 +
3225 +Запрос:
3226 +
3227 +{
3228 + "Ids": [
3229 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3230 + ],
3231 + "BeginTime": "2023-06-30T12:47:12.162Z",
3232 + "EndTime": "2023-06-30T12:47:12.162Z"
3233 +}
3234 +
3235 +Ответ:
3236 +
3237 +[
3238 + {
3239 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3240 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3241 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3242 + "BeginTime": "2023-06-30T11:19:40.703Z",
3243 + "EndTime": "2023-06-30T11:19:40.703Z"
3244 + }
3245 +]
3246 +
3247 +
3248 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3249 +
3250 +(% class="box infomessage" %)
3251 +(((
3252 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3253 +)))
3254 +
3255 +Запрос:
3256 +
3257 +{
3258 + "Ids": [
3259 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3260 + ],
3261 + "BeginTime": "2023-06-30T12:47:12.162Z",
3262 + "EndTime": "2023-06-30T12:47:12.162Z"
3263 +}
3264 +
3265 +Ответ:
3266 +
3267 +[
3268 + {
3269 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3270 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3271 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3272 + "BeginTime": "2023-06-30T11:19:40.703Z",
3273 + "EndTime": "2023-06-30T11:19:40.703Z"
3274 + }
3275 +]
3276 +
3277 +
3278 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3279 +
3280 +(% class="box successmessage" %)
3281 +(((
3282 +**POST /api/v3/DriversRfidsAssignments**
3283 +)))
3284 +
3285 +Запрос:
3286 +
3287 +[
3288 + {
3289 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3290 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3291 + "BeginTime": "2023-06-30T11:27:08.635Z",
3292 + "EndTime": "2023-06-30T11:27:08.635Z"
3293 + }
3294 +]
3295 +
3296 +Ответ:
3297 +
3298 +[
3299 + {
3300 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3301 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3302 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3303 + "BeginTime": "2023-06-30T11:27:08.677Z",
3304 + "EndTime": "2023-06-30T11:27:08.677Z"
3305 + }
3306 +]
3307 +
3308 +
3309 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3310 +
3311 +(% class="box warningmessage" %)
3312 +(((
3313 +**PUT /api/v3/DriversRfidsAssignments**
3314 +)))
3315 +
3316 +Запрос:
3317 +
3318 +[
3319 + {
3320 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3321 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3322 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3323 + "BeginTime": "2023-06-30T11:28:43.330Z",
3324 + "EndTime": "2023-06-30T11:28:43.330Z"
3325 + }
3326 +]
3327 +
3328 +Ответ:
3329 +
3330 +[
3331 + {
3332 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3333 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3334 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3335 + "BeginTime": "2023-06-30T11:28:43.331Z",
3336 + "EndTime": "2023-06-30T11:28:43.331Z"
3337 + }
3338 +]
3339 +
3340 +
3341 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3342 +
3343 +(% class="box errormessage" %)
3344 +(((
3345 +**DELETE /api/v3/DriversRfidsAssignments**
3346 +)))
3347 +
3348 +Запрос:
3349 +
3350 +[
3351 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3352 +]
3353 +
3354 +Ответ:
3355 +
3356 +Success
3357 +
3358 +
3359 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3360 +
3361 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3362 +
3363 +(% class="box infomessage" %)
3364 +(((
3365 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3366 +)))
3367 +
3368 +Запрос:
3369 +
3370 +{
3371 + "Ids": [
3372 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3373 + ],
3374 + "BeginTime": "2023-06-30T12:45:10.852Z",
3375 + "EndTime": "2023-06-30T12:45:10.852Z"
3376 +}
3377 +
3378 +Ответ:
3379 +
3380 +[
3381 + {
3382 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3383 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3384 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3385 + "BeginTime": "2023-06-30T11:58:04.695Z",
3386 + "EndTime": "2023-06-30T11:58:04.695Z"
3387 + }
3388 +]
3389 +
3390 +
3391 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3392 +
3393 +(% class="box infomessage" %)
3394 +(((
3395 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3396 +)))
3397 +
3398 +Запрос:
3399 +
3400 +{
3401 + "Ids": [
3402 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3403 + ],
3404 + "BeginTime": "2023-06-30T12:45:10.852Z",
3405 + "EndTime": "2023-06-30T12:45:10.852Z"
3406 +}
3407 +
3408 +Ответ:
3409 +
3410 +[
3411 + {
3412 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3414 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3415 + "BeginTime": "2023-06-30T11:58:04.695Z",
3416 + "EndTime": "2023-06-30T11:58:04.695Z"
3417 + }
3418 +]
3419 +
3420 +
3421 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3422 +
3423 +(% class="box successmessage" %)
3424 +(((
3425 +**POST /api/v3/DriversFuelCardsAssignments**
3426 +)))
3427 +
3428 +Запрос:
3429 +
3430 +[
3431 + {
3432 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3433 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3434 + "BeginTime": "2023-06-30T12:09:53.175Z",
3435 + "EndTime": "2023-06-30T12:09:53.175Z"
3436 + }
3437 +]
3438 +
3439 +Ответ:
3440 +
3441 +[
3442 + {
3443 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3444 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3445 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3446 + "BeginTime": "2023-06-30T12:09:53.201Z",
3447 + "EndTime": "2023-06-30T12:09:53.201Z"
3448 + }
3449 +]
3450 +
3451 +
3452 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3453 +
3454 +(% class="box warningmessage" %)
3455 +(((
3456 +**PUT /api/v3/DriversFuelCardsAssignments**
3457 +)))
3458 +
3459 +Запрос:
3460 +
3461 +[
3462 + {
3463 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3464 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3466 + "BeginTime": "2023-06-30T12:09:53.201Z",
3467 + "EndTime": "2023-06-30T12:09:53.201Z"
3468 + }
3469 +]
3470 +
3471 +Ответ:
3472 +
3473 +[
3474 + {
3475 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3476 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3477 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3478 + "BeginTime": "2023-06-30T12:09:53.201Z",
3479 + "EndTime": "2023-06-30T12:09:53.201Z"
3480 + }
3481 +]
3482 +
3483 +
3484 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3485 +
3486 +(% class="box errormessage" %)
3487 +(((
3488 +**DELETE /api/v3/DriversFuelCardsAssignments**
3489 +)))
3490 +
3491 +Запрос:
3492 +
3493 +[
3494 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3495 +]
3496 +
3497 +Ответ:
3498 +
3499 +Success
3500 +
3501 +
3502 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3503 +
3504 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3505 +
3506 +(% class="box infomessage" %)
3507 +(((
3508 +**POST /api/v3/Trailers**
3509 +)))
3510 +
3511 +Пример запроса:
3512 +
3513 +{
3514 + "startDate": "2023-11-14T10:48:03.671Z",
3515 + "endDate": "2023-11-14T10:48:03.671Z",
3516 + "ids": [ 0 ],
3517 + "timezone": 0
3518 +}
3519 +
3520 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3521 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3522 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3523 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3524 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3525 +
3526 +Пример ответа:
3527 +
3528 +[
3529 + {
3530 + "SD": "2023-11-14T10:48:03.717Z",
3531 + "ED": "2023-11-14T10:48:03.717Z", 
3532 + "id": 0,
3533 + "SLat": 0,
3534 + "SLon": 0,
3535 + "ELat": 0,
3536 + "ELon": 0,
3537 + "mileage": 0
3538 + "Duration": 0
3539 + "Address": "string",
3540 + "Address2": "string",
3541 + "name": "string",
3542 + "rid": "string",
3543 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3544 + "trailer": {
3545 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3546 + "Number": "string",
3547 + "Description": "string",
3548 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 + "ExternalID": "string",
3550 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3551 + "CreateTime": "2023-11-14T10:48:03.717Z",
3552 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3553 + "IsDeleted": true
3554 + },
3555 + "filesCount": 0,
3556 + }
3557 +]
3558 +
3559 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3560 +|SD|Дата и время начала события
3561 +|ED|Дата и время окончания события
3562 +|id|ID объекта
3563 +|SLat|Широта начальной координаты
3564 +|SLon|Долгота начальной координаты
3565 +|ELat|Широта конечной координаты
3566 +|ELon|Долгота конечной координаты
3567 +|mileage|Пробег
3568 +|Duration|Продолжительность
3569 +|Address|Адрес начального местоположения
3570 +|Address2|Адрес конечного местоположения
3571 +|name|Имя радиометки
3572 +|rid|Номер радиометки
3573 +|rguid|ID радиометки
3574 +|trailer|Информация об агрегате
3575 +|ModelGuid|ID агрегата
3576 +|Number|Название/номер агрегата
3577 +|Description|Текст примечания агрегата
3578 +
3579 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3580 +
3581 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3582 +
3583 +(% class="box infomessage" %)
3584 +(((
3585 +**POST /api/v3/Rfids/find**
3586 +)))
3587 +
3588 +Запрос:
3589 +
3590 +{
3591 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3592 +}
3593 +
3594 +Ответ:
3595 +
3596 +[
3597 + {
3598 + "name": "string",
3599 + "number": 0,
3600 + "period": 0,
3601 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3602 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3603 + }
3604 +]
3605 +
3606 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3607 +|parentId|ID клиента
3608 +|name|Название карты-метки
3609 +|number|Номер
3610 +|period|Период запросов в секундах (работает только для агрегатов)
3611 +|id|ID карты-метки
3612 +
3613 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3614 +
3615 +(% class="box infomessage" %)
3616 +(((
3617 +**GET /api/v3/Rfids/{rfidGuid}**
3618 +)))
3619 +
3620 +Передаем параметр rfidGuid - идентификатор карты-метки
3621 +
3622 +Ответ:
3623 +
3624 +[
3625 + {
3626 + "name": "string",
3627 + "number": 0,
3628 + "period": 0,
3629 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3630 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3631 + }
3632 +]
3633 +
3634 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3635 +|name|Название карты-метки
3636 +|number|Номер
3637 +|period|Период запросов в секундах (работает только для агрегатов)
3638 +|id|ID карты-метки
3639 +|parentId|ID клиента
3640 +
3641 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3642 +
3643 +(% class="box successmessage" %)
3644 +(((
3645 +**POST /api/v3/Rfids**
3646 +)))
3647 +
3648 +Запрос:
3649 +
3650 +{
3651 + "name": "string",
3652 + "number": 0,
3653 + "period": 0,
3654 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3655 +}
3656 +
3657 +Ответ:
3658 +
3659 +{
3660 + "name": "string",
3661 + "number": 0,
3662 + "period": 0,
3663 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3664 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3665 +}
3666 +
3667 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3668 +|name|Название карты-метки
3669 +|number|Номер
3670 +|period|Период запросов в секундах (работает только для агрегатов)
3671 +|id|ID карты-метки
3672 +|parentId|ID клиента
3673 +
3674 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3675 +
3676 +(% class="box warningmessage" %)
3677 +(((
3678 +**PUT /api/v3/Rfids**
3679 +)))
3680 +
3681 +Запрос:
3682 +
3683 +{
3684 + "name": "string",
3685 + "number": 0,
3686 + "period": 0,
3687 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3688 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3689 +}
3690 +
3691 +Ответ:
3692 +
3693 +{
3694 + "name": "string",
3695 + "number": 0,
3696 + "period": 0,
3697 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3698 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3699 +}
3700 +
3701 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3702 +|name|Название карты-метки
3703 +|number|Номер
3704 +|period|Период запросов в секундах (работает только для агрегатов)
3705 +|id|ID карты-метки
3706 +|parentId|ID клиента
3707 +
3708 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3709 +
3710 +(% class="box errormessage" %)
3711 +(((
3712 +**DELETE /api/v3/Rfids/{rfidGuid}**
3713 +)))
3714 +
3715 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3716 +
3717 +Ответ:
3718 +
3719 +Success
3720 +
3721 +
3722 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3723 +
3724 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3725 +
3726 +(% class="box infomessage" %)
3727 +(((
3728 +**GET /api/v3/Billing/client/balance/{clientId}**
3729 +)))
3730 +
3731 +Параметр запроса: **clientId **- идентификатор клиента.
3732 +
3733 +Ответ:
3734 +
3735 +{
3736 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3737 + "Balance": 0
3738 +}
3739 +
3740 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3741 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3742 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3743 +
3744 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3745 +
3746 +(% class="box infomessage" %)
3747 +(((
3748 +**GET /api/v3/Billing/client/constraint/{clientId}**
3749 +)))
3750 +
3751 +Параметр запроса: **clientId **- идентификатор клиента.
3752 +
3753 +Ответ:
3754 +
3755 +{
3756 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3757 + "CalculationType": 0,
3758 + "PermissibleBalance": 0,
3759 + "DefermentDays": 0,
3760 + "SendUiNotifications": true,
3761 + "SendEmailNotifications": true,
3762 + "IsPrivate": true,
3763 +}
3764 +
3765 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3766 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3767 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3768 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3769 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3770 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3771 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3772 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3773 +
3774 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3775 +
3776 +(% class="box infomessage" %)
3777 +(((
3778 +**GET /api/v3/Billing/client/plan/{clientId}**
3779 +)))
3780 +
3781 +Параметры запроса:
3782 +
3783 +**clientId **- идентификатор клиента.
3784 +
3785 +**planId **- идентификатор тарифного плана.
3786 +
3787 +Ответ:
3788 +
3789 +{
3790 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3791 + "Plan": { **~/~/ Описание тарифного плана**
3792 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3793 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3794 + "Name": "string",
3795 + "IsArchived": true,
3796 + "Constraint": {
3797 + "CalculationType": 0,
3798 + "PermissibleBalance": 0,
3799 + "DefermentDays": 0
3800 + },
3801 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3802 + {
3803 + "Feature": "string",
3804 + "IsFactual": true,
3805 + "Limit": 0,
3806 + "Price": 0,
3807 + "PeriodValue": 0,
3808 + "PeriodType": 0
3809 + }
3810 + ]
3811 + },
3812 + "DebitDate": "2023-10-18T12:46:24.213Z",
3813 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3814 + {
3815 + "Feature": "string",
3816 + "IsEnabled": true,
3817 + "IsPrivate": true,
3818 + "IsFactual": true,
3819 + "Limit": 0,
3820 + "Price": 0,
3821 + "DebitDate": "2023-10-18T12:46:24.213Z",
3822 + "PeriodValue": 0,
3823 + "PeriodType": 0
3824 + }
3825 + ]
3826 +}
3827 +
3828 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3829 +|ClientId|Идентификатор клиента
3830 +|Id|Идентификатор тарифного плана
3831 +|OwnerId|Идентификатор клиента-владельца
3832 +|Name|Наименование тарифного плана
3833 +|IsArchived|Признак, определяющий архивный тарифный план
3834 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3835 +|PermissibleBalance|Допустимый баланс
3836 +|DefermentDays|Отсрочка, количество дней
3837 +|Feature|Код услуги
3838 +|IsEnabled|Признак, определяющий активирована ли услуга
3839 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3840 +|IsFactual|Признак, определяющий расчёт по факту
3841 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3842 +|Price|Цена за единицу.
3843 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3844 +|PeriodValue|Значение периода.
3845 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3846 +
3847 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3848 +
3849 +(% class="box infomessage" %)
3850 +(((
3851 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3852 +)))
3853 +
3854 +Параметр запроса: **clientId **- идентификатор клиента.
3855 +
3856 +Ответ:
3857 +
3858 +[
3859 + {
3860 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3861 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3862 + "Name": "string",
3863 + "IsArchived": true,
3864 + "Constraint": {
3865 + "CalculationType": 0,
3866 + "PermissibleBalance": 0,
3867 + "DefermentDays": 0
3868 + },
3869 + "Features": [
3870 + {
3871 + "Feature": "string",
3872 + "IsFactual": true,
3873 + "Limit": 0,
3874 + "Price": 0,
3875 + "PeriodValue": 0,
3876 + "PeriodType": 0
3877 + }
3878 + ]
3879 + }
3880 +]
3881 +
3882 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3883 +|ClientId|Идентификатор клиента
3884 +|Id|Идентификатор тарифного плана
3885 +|OwnerId|Идентификатор клиента-владельца
3886 +|Name|Наименование тарифного плана
3887 +|IsArchived|Признак, определяющий архивный тарифный план
3888 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3889 +|PermissibleBalance|Допустимый баланс
3890 +|DefermentDays|Отсрочка, количество дней
3891 +|Feature|Код услуги
3892 +|IsFactual|Признак, определяющий расчёт по факту
3893 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3894 +|Price|Цена за единицу.
3895 +|PeriodValue|Значение периода.
3896 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3897 +
3898 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3899 +
3900 +(% class="box infomessage" %)
3901 +(((
3902 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3903 +)))
3904 +
3905 +Параметр запроса: **clientId **- идентификатор клиента.
3906 +
3907 +Ответ:
3908 +
3909 +[
3910 + {
3911 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3912 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3913 + "Name": "string",
3914 + "IsArchived": true,
3915 + "Constraint": {
3916 + "CalculationType": 0,
3917 + "PermissibleBalance": 0,
3918 + "DefermentDays": 0
3919 + },
3920 + "Features": [
3921 + {
3922 + "Feature": "string",
3923 + "IsFactual": true,
3924 + "Limit": 0,
3925 + "Price": 0,
3926 + "PeriodValue": 0,
3927 + "PeriodType": 0
3928 + }
3929 + ]
3930 + }
3931 +]
3932 +
3933 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3934 +|ClientId|Идентификатор клиента
3935 +|Id|Идентификатор тарифного плана
3936 +|OwnerId|Идентификатор клиента-владельца
3937 +|Name|Наименование тарифного плана
3938 +|IsArchived|Признак, определяющий архивный тарифный план
3939 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3940 +|PermissibleBalance|Допустимый баланс
3941 +|DefermentDays|Отсрочка, количество дней
3942 +|Feature|Код услуги
3943 +|IsFactual|Признак, определяющий расчёт по факту
3944 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3945 +|Price|Цена за единицу.
3946 +|PeriodValue|Значение периода.
3947 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3948 +
3949 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3950 +
3951 +(% class="box warningmessage" %)
3952 +(((
3953 +**PUT /api/v3/Billing/client/balance**
3954 +)))
3955 +
3956 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3957 +
3958 +Тело запроса:
3959 +
3960 +{
3961 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3962 + "Balance": 0
3963 +}
3964 +
3965 +Ответ: Success
3966 +
3967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3968 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3969 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3970 +
3971 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3972 +
3973 +(% class="box warningmessage" %)
3974 +(((
3975 +**PUT /api/v3/billing/client/balance/deposit**
3976 +)))
3977 +
3978 +Создает операцию **Пополнение **с указанной суммой
3979 +
3980 +Тело запроса:
3981 +
3982 +{
3983 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3984 + "Balance": 0
3985 +}
3986 +
3987 +Ответ: Success
3988 +
3989 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3990 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3991 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3992 +
3993 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3994 +
3995 +Создает операцию **Списание **с указанной суммой
3996 +
3997 +(% class="box warningmessage" %)
3998 +(((
3999 +**PUT /api/v3/billing/client/balance/withdraw**
4000 +)))
4001 +
4002 +Тело запроса:
4003 +
4004 +{
4005 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4006 + "Balance": 0
4007 +}
4008 +
4009 +Ответ: Success
4010 +
4011 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4012 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4013 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4014 +
4015 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4016 +
4017 +(% class="box warningmessage" %)
4018 +(((
4019 +**PUT /api/v3/Billing/client/constraint**
4020 +)))
4021 +
4022 +Тело запроса:
4023 +
4024 +{
4025 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4026 + "CalculationType": 0,
4027 + "PermissibleBalance": 0,
4028 + "DefermentDays": 0,
4029 + "SendUiNotifications": true,
4030 + "SendEmailNotifications": true,
4031 + "IsPrivate": true,
4032 +}
4033 +
4034 +Ответ: Success
4035 +
4036 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4037 +|ClientId|Идентификатор клиента
4038 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4039 +|PermissibleBalance|Допустимый баланс
4040 +|DefermentDays|(((
4041 +Отсрочка, количество дней
4042 +)))
4043 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4044 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4045 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4046 +
4047 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4048 +
4049 +(% class="box warningmessage" %)
4050 +(((
4051 +**PUT /api/v3/Billing/client/plan**
4052 +)))
4053 +
4054 +Тело запроса:
4055 +
4056 +{
4057 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4058 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4059 + "Features": [
4060 + {
4061 + "Feature": "string",
4062 + "IsEnabled": true,
4063 + "IsFactual": true,
4064 + "Limit": 0,
4065 + "Price": 0,
4066 + "DebitDate": "2023-10-18T13:26:58.987Z",
4067 + "PeriodValue": 0,
4068 + "PeriodType": 0
4069 + }
4070 + ]
4071 +}
4072 +
4073 +Ответ: Success
4074 +
4075 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4076 +|ClientId|Идентификатор клиента
4077 +|PlanId|Идентификатор тарифного плана
4078 +|Feature|Код услуги
4079 +|IsEnabled|Признак, определяющий активирована ли услуга
4080 +|IsFactual|Признак, определяющий расчёт по факту
4081 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4082 +|Price|Цена за единицу.
4083 +|DebitDate|Следующий момент времени списания с баланса за услугу.
4084 +|PeriodValue|Значение периода.
4085 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4086 +
4087 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4088 +
4089 +(% class="box warningmessage" %)
4090 +(((
4091 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4092 +)))
4093 +
4094 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4095 +
4096 +(% class="box infomessage" %)
4097 +(((
4098 +**POST /api/v3/vehicles/import/{agentId}**
4099 +)))
4100 +
4101 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4102 +
4103 +В пути указывается **agentId** - id клиента.
4104 +
4105 +**Заголовок**
4106 +
4107 +**X-Auth: [токен авторизации]**
4108 +
4109 +**Параметры**
4110 +
4111 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4112 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4113 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4114 +
4115 +В теле использовать тип **form-data,** тип значения** file**
4116 +
4117 +**Ключи**
4118 +
4119 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4120 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4121 +|csv|В значении передаем файл датчиков, формат **csv**
4122 +
4123 +Ответ:
4124 +
4125 +{
4126 + "vehicleId": 0,
4127 + "name": "string",
4128 + "errors": ["string"]
4129 +}
4130 +
4131 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4132 +|vehicleId|ID созданного объекта
4133 +|name|Имя созданного объекта
4134 +|errors|Ошибки и их описание
4135 +
4136 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4137 +
4138 +(% class="box infomessage" %)
4139 +(((
4140 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4141 +)))
4142 +
4143 +(% class="wikigeneratedid" %)
4144 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4145 +
4146 +(% class="wikigeneratedid" %)
4147 +В пути указывается **vehicleId **- id объекта.
4148 +
4149 +**Заголовок**
4150 +
4151 +**X-Auth: [токен авторизации]**
4152 +
4153 +В теле использовать тип **form-data.**
4154 +
4155 +Ключи:
4156 +
4157 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4158 +|**history**|В значении передавать файл с историей
4159 +
4160 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4161 +
4162 +Ответ:
4163 +
4164 +{
4165 + "results": [
4166 + {
4167 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4168 + "vehicleId": 0,
4169 + "errors": [
4170 + "string"
4171 + ],
4172 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4173 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4174 + "producedCount": 0,
4175 + "msgCount": 0
4176 + }
4177 + ]
4178 +}
4179 +
4180 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4181 +|results|Результаты импорта в разрезе ТС
4182 +|vehicleGuid|Guid ТС
4183 +|vehicleId|ID ТС
4184 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4185 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4186 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4187 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4188 +|msgCount|Кол-во обработанных сообщений всего
4189 +
4190 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4191 +
4192 +(% class="box infomessage" %)
4193 +(((
4194 +**GET /api/v3/vehicles/import/history/status**
4195 +)))
4196 +
4197 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4198 +
4199 +Ответ:
4200 +
4201 +{
4202 + "activity": true,
4203 + "progress": 0,
4204 + "message": "string"
4205 +}
4206 +
4207 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4208 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4209 +|progress|Guid ТС
4210 +
4211 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4212 +
4213 +(% class="box infomessage" %)
4214 +(((
4215 +**POST /api/v3/vehicles/export**
4216 +)))
4217 +
4218 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4219 +
4220 +Тело запроса:
4221 +
4222 +[
4223 + id
4224 +]
4225 +
4226 +Ответ: Success 200, получаете файлы с настройками.
4227 +
4228 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4229 +
4230 +(% class="box infomessage" %)
4231 +(((
4232 +**POST /api/v3/vehicles/export/history**
4233 +)))
4234 +
4235 +Метод возвращает список сообщений терминала объекта за выбранный период.
4236 +
4237 +Тело запроса:
4238 +
4239 +{
4240 + "vehicleId": 0,
4241 + "asArchive": true,
4242 + "from": "2023-09-27T12:17:45.973Z",
4243 + "to": "2023-09-27T12:17:45.973Z"
4244 +}
4245 +
4246 +Ответ:
4247 +
4248 +Получаете файл. Сообщение: Code 200/Success
4249 +
4250 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4251 +|vehicleId|ID объекта
4252 +|asArchive|true - Архивировать файл, False - не архивировать
4253 +|from|Дата и время начала запроса
4254 +|to|Дата и время окончания запроса
4255 +
4256 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4257 +
4258 +(% class="box infomessage" %)
4259 +(((
4260 +**GET /api/v3/vehicles/export/history/status**
4261 +)))
4262 +
4263 +Метод возвращает список сообщений терминала объекта за выбранный период.
4264 +
4265 +Ответ:
4266 +
4267 +{
4268 + "activity": true,
4269 + "progress": 0,
4270 + "message": "string"
4271 +}
4272 +
4273 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4274 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4275 +|progress|Прогресс экспорта, от 0 до 100%
4276 +|message|Текст описывающий статус
4277 +
4278 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4279 +
4280 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4281 +
4282 +(% class="box infomessage" %)
4283 +(((
4284 +**POST /api/v3/EcoDriving/rating**
4285 +)))
4286 +
4287 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4288 +
4289 +Тело запроса:
4290 +
4291 +{
4292 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4293 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4294 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4295 +}
4296 +
4297 +Ответ:
4298 +
4299 +{
4300 + "items": [  ~/~/ Список в разрезе ТС
4301 + {
4302 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4303 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4304 + "vehicleId": 0, ~/~/ ID ТС
4305 + "vehicleName": "string", ~/~/ Название ТС
4306 + "vehicleModel": "string", ~/~/ Модель ТС
4307 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4308 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4309 + "totalViolations": 0, ~/~/ Нарушений всего
4310 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4311 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4312 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4313 + "brakingViolations": 0, ~/~/ Нарушений торможения
4314 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4315 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4316 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4317 + },
4318 +
4319 +(((
4320 +
4321 +)))
4322 +
4323 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4324 + "mileage": 0, ~/~/ Пробег, м
4325 + "tripsCount": 0, ~/~/ Кол-во рейсов
4326 + "trips": [  ~/~/ Информация по рейсу
4327 + {
4328 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4329 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4330 + "violationsCount": 0, ~/~/ Всего нарушений
4331 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4332 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4333 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4334 + "brakingViolations": 0, ~/~/ Нарушений торможения
4335 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4336 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4337 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4338 + },
4339 +
4340 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4341 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4342 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4343 + "mileage": 0, ~/~/ Пробег, м
4344 + "motohours": 0, ~/~/ Моточасы, секунды
4345 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4346 + "startAddress": "string", ~/~/ Адрес начала рейса
4347 + "endAddress": "string", ~/~/ Адрес конца рейса
4348 + "drivers": [  ~/~/ Список водителей
4349 + {
4350 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4351 + "driverName": "string", ~/~/ФИО водителя
4352 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4353 + }
4354 + ]
4355 + }
4356 + ]
4357 + }
4358 + ]
4359 +}
4360 +
4361 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4362 +
4363 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4364 +
4365 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4366 +
4367 +(% class="box infomessage" %)
4368 +(((
4369 +POST /api/v3/fuelcards/transactions
4370 +)))
4371 +
4372 +Метод запроса: POST
4373 +
4374 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4375 +\\В заголовках запроса: X-Auth: Токен авторизации
4376 +
4377 +Параметры в теле запроса (JSON):
4378 +
4379 +{
4380 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4381 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4382 + "ids": [ 
4383 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4384 + ],
4385 + "timezone": 0 ~/~/Таймзона
4386 +}
4387 +
4388 +
4389 +Ответ:
4390 + {
4391 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4392 + "driver": "string", ~/~/Водители, привязанные к ТК
4393 + "object": "string", ~/~/Наименование ТС
4394 + "amount": 0, ~/~/Количество топлива
4395 + "amountDut": 0, ~/~/Количество по ДУТ
4396 + "amountDiff": 0, ~/~/Разница, л
4397 + "amountDiffPerc": 0, ~/~/Разница, %
4398 + "summa": 0, ~/~/Стоимость, руб
4399 + "serviceName": "string", ~/~/Тип топлива
4400 + "price": 0, ~/~/Цена за литр, руб
4401 + "cardName": "string", ~/~/Наименование ТК
4402 + "cardNum": "string", ~/~/Номер ТК
4403 + "operator": "string", ~/~/Оператор ТК
4404 + "address": "string" ~/~/Адрес АЗС
4405 + }
4406 +
4407 +
4408 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4409 +
4410 +
4411 +== **Получение полных данных о ретрансляторе** ==
4412 +
4413 +(% class="box infomessage" %)
4414 +(((
4415 +**GET ** **/api/v3/retranslations/{id}**
4416 +)))
4417 +
4418 +Идентификатор запроса: ID
4419 +
4420 +
4421 +Пример ответа:
4422 +
4423 +{  
4424 +"description": "", ~/~/ Определяет описание
4425 +"subscriberId": "", ~/~/ Подписчик
4426 +"protocolType": 0, ~/~/ Тип протокола
4427 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4428 +"address": "string", ~/~/ Адрес события
4429 +"objects": [ ~/~/Объекты для ретрансляции
4430 +{      
4431 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4432 +"name": "", ~/~/ Наименование объекта ретрансляции
4433 +"imei": "", ~/~/ IMEI объекта  
4434 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4435 +}
4436 + ],  
4437 +"id": "", ~/~/ идентификатор пользователя   
4438 +"parentId": "", ~/~/Guid родителя
4439 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4440 +}
4441 +
4442 +
4443 +== **Удаление данных ретранслятора** ==
4444 +
4445 +(% class="box infomessage" %)
4446 +(((
4447 +**DELETE** **/api/v3/retranslations/{id}**
4448 +)))
4449 +
4450 +Параметр запроса: ID
4451 +
4452 +
4453 +== **Создание ретранслятора** ==
4454 +
4455 +(% class="box infomessage" %)
4456 +(((
4457 +**POST ** **/api/v3/retranslations/{id}**
4458 +)))
4459 +
4460 +Запрос:
4461 +
4462 +{  
4463 +"description": "", ~/~/ Описание
4464 +"subscriberId": "", ~/~/ Подписчик
4465 +"protocolType": 0, ~/~/ Тип протокола
4466 +"address": "", ~/~/ Адрес ретрансляции
4467 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4468 +"objects": [ ~/~/Объекты для ретрансляции
4469 +{      
4470 +"id": "", ~/~/ идентификатор пользователя     
4471 +"imei": "", ~/~/IMEI объекта
4472 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4473 +}
4474 + ]
4475 +}
4476 +
4477 +
4478 +Ответ:
4479 +
4480 +{  
4481 +"description": "string", ~/~/ Определяет описание
4482 +"subscriberId": "", ~/~/ идентификатор запроса
4483 +"protocolType": 0, ~/~/ Тип протокола
4484 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4485 +"address": "", ~/~/ Адрес события
4486 +"objects": [ ~/~/Объекты для ретрансляции
4487 +{      
4488 +"id": "", ~/~/ идентификатор пользователя    
4489 +"name": "string", ~/~/ Название уведомления
4490 +"imei": "string", ~/~/IMEI объекта  
4491 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4492 +}
4493 + ],  
4494 +"id": "", ~/~/ идентификатор пользователя  
4495 +"parentId": "", ~/~/ Guid идентификатор родителя
4496 +"deleted": true ~/~/ Признак удаления
4497 +}
4498 +
4499 +
4500 +== **Редактирование ретранслятора** ==
4501 +
4502 +(% class="box infomessage" %)
4503 +(((
4504 +**PUT** **/api/v3/retranslations**
4505 +)))
4506 +
4507 +Пример запроса:
4508 +
4509 +{  
4510 +"id": "", ~/~/ идентификатор пользователя   
4511 +"description": "string", ~/~/ Определяет описание
4512 +"subscriberId": "", ~/~/ идентификатор запроса
4513 +"protocolType": 0, ~/~/ Тип протокола
4514 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4515 +"address": "string", ~/~/ Адрес события
4516 +"objects": ~/~/Объекты для ретрансляции
4517 +[    
4518 +{      
4519 +"id": "",  ~/~/ идентификатор пользователя         
4520 +"imei": "", ~/~/IMEI объекта
4521 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4522 +}
4523 + ]
4524 +}
4525 +
4526 +
4527 +Пример ответа:
4528 +
4529 +{  
4530 +"description": "", ~/~/ Определяет описание
4531 +"subscriberId": "", ~/~/ идентификатор запроса
4532 +"protocolType": 0, ~/~/ Тип протокола
4533 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4534 +"address": "string", ~/~/ Адрес события
4535 +"objects": [ ~/~/Объекты для ретрансляции
4536 +{      
4537 +"id": "", ~/~/ идентификатор пользователя     
4538 +"name": "string", ~/~/ Название уведомления    
4539 +"imei": "", ~/~/IMEI объекта
4540 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4541 +}
4542 + ],
4543 +"id": "", ~/~/ идентификатор пользователя   
4544 +"parentId": "", ~/~/ Guid идентификатор родителя
4545 +"deleted": true ~/~/ Признак удаления
4546 +}
4547 +
4548 +
4549 +== **Получение списка ретранслятора клиента** ==
4550 +
4551 +(% class="box infomessage" %)
4552 +(((
4553 +**POST /api/v3/retranslations/find**
4554 +)))
4555 +
4556 +Пример запроса:
4557 +
4558 +{  
4559 +"id": "", ~/~/ идентификатор пользователя   
4560 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4561 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4562 +}
4563 +
4564 +Ответ:
4565 +
4566 +[ 
4567 +{    
4568 +"description": "", ~/~/ Определяет описание
4569 +"subscriberId": "", ~/~/ идентификатор запроса
4570 +"protocolType": 0, ~/~/ Тип протокола
4571 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4572 +"address": "string", ~/~/ Адрес события
4573 +"id": "", ~/~/ идентификатор пользователя   
4574 +"parentId": "", ~/~/ Guid идентификатор родителя
4575 +"deleted": true ~/~/ Признак удаления
4576 +}
4577 +]
4578 +
4579 +
4580 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4581 +
4582 +== **API для отчета по выгрузке комбайнов** ==
4583 +
4584 +(% class="box infomessage" %)
4585 +(((
4586 +POST **/api/v3/Reports/harvesterUnloading**
4587 +)))
4588 +
4589 +Пример запроса:
4590 +
4591 +{
4592 + "byTime": 0, ~/~/ Объединение событий по времени
4593 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4594 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4595 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4596 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4597 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4598 + 0
4599 + ],
4600 + "from": "", ~/~/ Дата и время начало запроса
4601 + "to": "", ~/~/ Дата и время окончания запроса
4602 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4603 +}
4604 +
4605 +Пример ответа:
4606 +
4607 +[ 
4608 + {
4609 + "harvesterName": "", ~/~/Комбайн, номер
4610 + "harvesterId": 0, ~/~/Комбайн, id
4611 +"harvesterModel": "", ~/~/ Модель комбайна
4612 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4613 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4614 + "events": [ ~/~/Список событий в разрезе комбайна
4615 + {
4616 + "driverId": "", ~/~/Идентификатор водителя
4617 + "driverName": "", ~/~/Водитель комбайна, ФИО
4618 + "RFID": "", ~/~/ идентификатор карты-метки
4619 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4620 + "vehicleId": 0, ~/~/идентификатор объекта
4621 + "vehicleName": "string", ~/~/ Имя объекта
4622 + "modelName": "string", ~/~/ Имя модели объекта
4623 + "nearestVehicles": [ ~/~/Объекты рядом
4624 + {
4625 + "vehicleId": 0, ~/~/идентификатор объекта
4626 + "vehicleName": "string" ~/~/ Имя объекта
4627 + }
4628 + ],
4629 + "fields": [ ~/~/Поля, где происходила выгрузка
4630 + {
4631 + "id": 0, ~/~/ идентификатор пользователя 
4632 + "name": "string" ~/~/ имя пользователя 
4633 + }
4634 + ],
4635 + "event": "string", ~/~/Событие
4636 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4637 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4638 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4639 + "cultureName": "string", ~/~/ название культуры
4640 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4641 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4642 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4643 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4644 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4645 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4646 + "issued": 0, ~/~/Выдано, бункеров
4647 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4648 + "latitude": 0, ~/~/Широта
4649 + "longitude": 0, ~/~/ Долгота
4650 + "litresAway": 0, ~/~/Отдано, л
4651 + "m3Away": 0 ~/~/Отдано, м3
4652 + }
4653 + ]
4654 + }
4655 +]
4656 +
4657 +
4658 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4659 +
4660 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4661 +
4662 +
4663 +(% class="box infomessage" %)
4664 +(((
4665 +GET api/v3/Vehicles/recyclebin/all
4666 +)))
4667 +
4668 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4669 +
4670 +Параметр запроса: {parentId} - идентификатор агента
4671 +
4672 +В заголовках запроса: X-Auth: Токен авторизации
4673 +
4674 +Ответ:
4675 +
4676 +[ 
4677 + {
4678 + "recordTime": "", ~/~/Время записи
4679 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4680 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4681 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4682 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4683 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4684 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4685 + "items": [ ~/~/ 
4686 +nullable: true ~/~/Детали
4687 + {
4688 + "name": "string", ~/~/наименование столбца
4689 + "value": "string" ~/~/содержание столбца
4690 + }
4691 + ]
4692 + },
4693 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4694 + "string"
4695 + ]
4696 + }
4697 +]
4698 +
4699 +
4700 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4701 +
4702 +(% class="box infomessage" %)
4703 +(((
4704 +POST/api/v3/Vehicles/recyclebin/erase
4705 +)))
4706 +
4707 +В заголовках запроса: X-Auth: Токен авторизации
4708 +
4709 +Пример запроса:
4710 +
4711 +[
4712 +0
4713 +]
4714 +
4715 +
4716 +Пример ответа:
4717 +
4718 +[ 
4719 +{
4720 + "recordTime": "", ~/~/Время записи
4721 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4722 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4723 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4724 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4725 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4726 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4727 + "items": [ ~/~/Детали
4728 + {
4729 + "name": "", ~/~/Имя свойства
4730 + "value": "" ~/~/Значение свойства
4731 + }
4732 + ]
4733 + },
4734 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4735 + ""
4736 + ]
4737 + }
4738 +]
4739 +
4740 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4741 +
4742 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4743 +
4744 +(% class="box infomessage" %)
4745 +(((
4746 +POST/api/v3/Vehicles/recyclebin/restore
4747 +)))
4748 +
4749 +В заголовках запроса: X-Auth: Токен авторизации
4750 +
4751 +Параметры в теле запроса (JSON):
4752 +
4753 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4754 +
4755 +В заголовках запроса: X-Auth: Токен авторизации
4756 +
4757 +
4758 +Пример запроса:
4759 +
4760 +(((
4761 +[
4762 +)))
4763 +
4764 +(((
4765 + 0
4766 +)))
4767 +
4768 +(((
4769 +]
4770 +)))
4771 +
4772 +
4773 +Пример ответа:
4774 +
4775 +[
4776 +{
4777 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4778 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4779 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4780 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4781 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4782 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4783 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4784 + "items": [ ~/~/Детали
4785 + {
4786 + "name": "string", ~/~/Имя свойства
4787 + "value": "string" ~/~/Значение свойства
4788 + }
4789 + ]
4790 + },
4791 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4792 + "string"
4793 + ]
4794 + }
4795 +]
4796 +
4797 +
4798 +
953 953  (% class="box" lang="en-US" style="text-align: center;" %)
954 954  (((
955 955  (% 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 г.