<
From version < 41.1 >
edited by Илья Крайнов
on 2022/11/18 17:34
To version < 175.1 >
edited by Андрей Калиновский
on 2024/10/23 09:23
>
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,46 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 +{{toc/}}
12 12  
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
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;" %)
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 +
19 +
20 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
21 +
22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23 +
24 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
25 +
26 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
19 19  (((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
28 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
29 +(% 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**
34 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
37 +(% 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**__».
43 +(% 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 -
50 +}
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" %)
56 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
57 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
62 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
63 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
64 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
65 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
66 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
58 58  
68 +(% class="wikigeneratedid" %)
69 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
70 +
71 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
72 +
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**
75 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
78 +(% 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  
89 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
91 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
92 +
93 +(% class="box infomessage" %)
77 77  (((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
95 +**GET api/v3/agents/{id}**
79 79  )))
80 80  
98 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
99 +
100 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
101 +
102 +(% style="color:#000000" %)Метод запроса: **GET**
103 +
104 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
105 +
106 +Запрос должен содержать данные параметра "**agentId**"
107 +
108 +(% style="color:#000000" %)Ответ:
109 +{
110 + "agentId": "",  (%%)
111 + "parentId": "",
112 + "parentName": "string",
113 + "name": "string",
114 + "fullName": "string",
115 + "agentInfoType": 0,
116 + "isForeign": true/false,
117 + "district": "string", 
118 + "region": "string",
119 + "city": "string",
120 + "inn": "string",
121 + "kpp": "string",
122 + "address": "string",
123 + "addressFact": "string",
124 + "email": "string",
125 + "director": "string",
126 + "bankName": "string",
127 + "bankBIK": "string",
128 + "bankRS": "string",
129 + "bankKS": "string"
130 + }
131 +
132 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
133 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
134 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
135 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
136 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
137 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
138 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
139 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
140 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
141 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
142 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
143 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
144 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
145 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
146 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
147 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
148 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
149 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
150 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
151 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
152 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
153 +
154 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
155 +
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
158 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
161 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
90 90  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91 91  
92 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
167 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
169 +(% 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>
171 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
173 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
175 +(% style="color:#000000" %){
176 + "parentId": "string"
177 +}
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 - Отказ)
181 +{
182 + "agentId": "",(% style="color:#000000" %)   (%%)
183 + "parentId": "",
184 + "name": "string",
185 + "fullName": "string",
186 + "agentInfoType": 0,
187 +(% style="color:#000000" %) "status": "",
111 111  }
112 112  
113 113  
114 -(% class="box" style="text-align: center;" %)
191 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
192 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
193 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
194 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
195 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
196 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
197 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
198 +
199 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
200 +
201 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
203 +**POST /api/v3/agents **
117 117  )))
118 118  
206 +Метод позволяет добавить клиента, указанного в запросе.
207 +
208 +Метод запроса: **POST**
209 +
210 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
211 +
212 +В заголовках запроса: X-Auth: Токен авторизации
213 +
214 +Параметры в теле запроса (JSON):
215 +
216 +{
217 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
218 + "name": "string", ~/~/ имя
219 + "fullName": "string", ~/~/ полное наименование
220 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
221 + "isForeign": true, ~/~/ иностранный контрагент
222 + "district": "string", ~/~/ округ
223 + "region": "string", ~/~/ регион
224 + "city": "string", ~/~/ город
225 + "inn": "string", ~/~/ ИНН
226 + "kpp": "string", ~/~/ КПП
227 + "address": "string", ~/~/ юридический адрес
228 + "addressFact": "string", ~/~/ фактический адрес
229 + "email": "string", ~/~/ email
230 + "director": "string", ~/~/ ФИО руководителя
231 + "bankName": "string", ~/~/ банк
232 + "bankBIK": "string", ~/~/ БИК
233 + "bankRS": "string", ~/~/ номер счёта
234 + "bankKS": "string" ~/~/ корр. счёт
235 +}
236 +
237 +Ответ:
238 +
239 +{
240 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
241 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
242 + "name": "string", ~/~/ имя
243 + "fullName": "string", ~/~/ полное наименование
244 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
245 + "isForeign": true, ~/~/ иностранный контрагент
246 + "district": "string", ~/~/ округ
247 + "region": "string", ~/~/ регион
248 + "city": "string", ~/~/ город
249 + "inn": "string", ~/~/ ИНН
250 + "kpp": "string", ~/~/ КПП
251 + "address": "string", ~/~/ юридический адрес
252 + "addressFact": "string", ~/~/ фактический адрес
253 + "email": "string", ~/~/ email
254 + "director": "string", ~/~/ ФИО руководителя
255 + "bankName": "string", ~/~/ банк
256 + "bankBIK": "string", ~/~/ БИК
257 + "bankRS": "string", ~/~/ номер счёта
258 + "bankKS": "string" ~/~/ корр. счёт
259 +}
260 +
261 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
262 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
263 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
264 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
265 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
266 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
267 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
268 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
269 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
270 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
271 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
272 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
273 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
274 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
275 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
276 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
277 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
278 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
279 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
280 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
281 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
282 +
283 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
284 +
285 +(% class="box warningmessage" %)
286 +(((
287 +**PUT /api/v3/agents**
288 +)))
289 +
290 +Метод позволяет отредактировать клиента, указанного в запросе.
291 +
292 +Метод запроса: **PUT**
293 +
294 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
295 +
296 +В заголовках запроса: X-Auth: Токен авторизации
297 +
298 +Параметры в теле запроса (JSON):
299 +
300 +{
301 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
302 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
303 + "name": "string", ~/~/ имя
304 + "fullName": "string", ~/~/ полное наименование
305 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
306 + "isForeign": true, ~/~/ иностранный контрагент
307 + "district": "string", ~/~/ округ
308 + "region": "string", ~/~/ регион
309 + "city": "string", ~/~/ город
310 + "inn": "string", ~/~/ ИНН
311 + "kpp": "string", ~/~/ КПП
312 + "address": "string", ~/~/ юридический адрес
313 + "addressFact": "string", ~/~/ фактический адрес
314 + "email": "string", ~/~/ email
315 + "director": "string", ~/~/ ФИО руководителя
316 + "bankName": "string", ~/~/ банк
317 + "bankBIK": "string", ~/~/ БИК
318 + "bankRS": "string", ~/~/ номер счёта
319 + "bankKS": "string" ~/~/ корр. счёт
320 +}
321 +
322 +Ответ:
323 +
324 +{
325 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
326 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
327 + "name": "string", ~/~/ имя
328 + "fullName": "string", ~/~/ полное наименование
329 + "isForeign": true, ~/~/ иностранный контрагент
330 + "district": "string", ~/~/ округ
331 + "region": "string", ~/~/ регион
332 + "city": "string", ~/~/ город
333 + "inn": "string", ~/~/ ИНН
334 + "kpp": "string", ~/~/ КПП
335 + "address": "string", ~/~/ юридический адрес
336 + "addressFact": "string", ~/~/ фактический адрес
337 + "email": "string", ~/~/ email
338 + "director": "string", ~/~/ ФИО руководителя
339 + "bankName": "string", ~/~/ банк
340 + "bankBIK": "string", ~/~/ БИК
341 + "bankRS": "string", ~/~/ номер счёта
342 + "bankKS": "string" ~/~/ корр. счёт
343 +}
344 +
345 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
346 +
347 +(% class="box errormessage" %)
348 +(((
349 +**DELETE /api/v3/agents/{clientId}**
350 +)))
351 +
352 +Метод позволяет удалить клиента, указанного в строке запроса.
353 +
354 +Метод запроса: **DELETE**
355 +
356 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
357 +
358 +Параметр запроса: **{clientId}** - Guid пользователя
359 +
360 +В заголовках запроса: X-Auth: Токен авторизации
361 +
362 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
363 +
364 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
365 +
366 +(% class="box warningmessage" %)
367 +(((
368 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
369 +)))
370 +
371 +Метод позволяет изменить статус клиента, указанного в запросе.
372 +
373 +В пути указывается GUID клиента и статус клиента.
374 +
375 +**status **- значение 0 - заблокирован, 1 - активен.
376 +
377 +Ответ: Code 204
378 +
379 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
380 +
381 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
382 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
385 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
388 +(% 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" %){ 
398 +(% style="color:#000000" %)
399 +{ 
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": "", ~/~/ признак включения
408 + "description": "string", ~/~/ Описание
409 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
410 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
411 + "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)
413 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
414 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
415 + "doubleAuth":
416 + {
417 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
418 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
419 + },
420 + "groups":
421 + [
422 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
423 + ],
424 + "customGroups":
425 + [
426 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
427 + ],
428 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
152 152  }
430 +{
431 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
432 + "lastName": "string",
433 + "firstName": "string",
434 + "position": "string",
435 + "phone": "string",
436 + "organization": "string",
437 + "login": "string",
438 + "password": "string",
439 + "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 пользователя
443 +{     
444 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя
461 +}
178 178  
179 -(% style="text-align:left" %)
180 -(% style="color:#000000; font-weight:normal" %)}
181 181  
464 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 -(% class="box successmessage" %)
466 +(% class="box infomessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
468 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
471 +(% 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 -
483 +(% 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,139 +222,69 @@
222 222   "email": "" , ~/~/ E-mail
223 223   "sessionDuration":"", ~/~/ длительность сессии в минутах
224 224   "status": "1",  ~/~/ статус пользователя
225 - "astLogged": "", ~/~/ дата/время последней авторизации
226 -
505 + "lastLogged": "", ~/~/ дата/время последней авторизации
227 227  (% style="color:#000000" %)}
228 228  
508 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
230 -(% class="box successmessage" %)
510 +(% class="box infomessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
512 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
515 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **GET**
238 238  
239 239  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240 240  
521 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
522 +
241 241  (% style="color:#000000" %)Ответ:
242 242  
243 243  (((
244 -{
245 -)))
246 -
247 247  (((
527 +{
248 248   "id": "", ~/~/ GUID пользователя
249 -)))
250 -
251 -(((
252 - "lastName": "", ~/~/ Фамилия
253 -)))
254 -
255 -(((
529 + "lastName": "", ~/~/ Фамилия 
256 256   "firstName": "", ~/~/ Имя
257 -)))
258 -
259 -(((
260 260   "position": "", ~/~/ Должность
261 -)))
262 -
263 -(((
264 264   "phone": "", ~/~/ Номер телефона
265 -)))
266 -
267 -(((
268 268   "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
269 -)))
270 -
271 -(((
272 272   "parentName": "", Наименование клиента, которому принадлежит пользователь
273 -)))
274 -
275 -(((
276 276   "organization": "", ~/~/ Организация
277 -)))
278 -
279 -(((
280 280   "login": "", ~/~/ Логин пользователя
281 -)))
282 -
283 -(((
284 284   "email": "", ~/~/ Адрес электронной почты
285 -)))
286 -
287 -(((
288 288   "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
289 -)))
290 -
291 -(((
292 292   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
293 -)))
294 -
295 -(((
296 296   "description": "", ~/~/ Описание
297 -)))
298 -
299 -(((
300 300   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
301 -)))
302 -
303 -(((
304 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
305 -)))
306 -
307 -(((
308 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
309 -)))
310 -
311 -(((
542 + "doubleAuth":
543 + {
544 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
545 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
546 + },
312 312   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
313 -)))
314 -
315 -(((
316 316   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
317 -)))
318 -
319 -(((
320 320   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
321 -)))
322 -
323 -(((
324 324   "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
325 -)))
326 -
327 -(((
328 328   "groups": [], ~/~/ Список ролей пользователя
329 -)))
330 -
331 -(((
332 332   "customGroups": [], ~/~/ Список клиентских ролей пользователя
333 -)))
334 -
335 -(((
336 336   "authDevices": [ ], ~/~/ Список авторизованных устройств
337 -)))
338 -
339 -(((
340 340   "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
341 -)))
342 -
343 -(((
344 344   "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
345 -)))
346 -
347 -(((
348 348  }
349 349  )))
558 +)))
350 350  
560 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
351 351  
352 352  (% class="box warningmessage" %)
353 353  (((
354 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
564 +(% lang="en-US" %)**PUT /api/v3/users**
355 355  )))
356 356  
357 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
567 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
358 358  
359 359  (% style="color:#000000" %)Метод запроса: **PUT**
360 360  
... ... @@ -366,10 +366,8 @@
366 366  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
367 367  
368 368  (% lang="en-US" style="text-align:left" %)
369 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
370 -
371 -(% lang="en-US" style="text-align:left" %)
372 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
580 + "id": "" , ~/~/ ID пользователя 
373 373   "lastName": "" , ~/~/ фамилия
374 374   "firstName": "" , ~/~/ имя
375 375   "position": "" , ~/~/ должность
... ... @@ -376,7 +376,9 @@
376 376   "phone": "" , ~/~/ телефон
377 377   "organization": "" , ~/~/ организация
378 378   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
379 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
587 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
588 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
589 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
380 380   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
381 381  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
382 382   "isEnabled": "" , ~/~/ признак включения
... ... @@ -383,12 +383,13 @@
383 383   "parentId": "" , ~/~/ Guid родительского агента
384 384   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
385 385   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
386 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
387 - "kind": "" , ~/~/ тип аутентификации
388 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
389 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
390 -
391 -(% lang="en-US" style="text-align:left" %)
596 + "doubleAuth":
597 + {
598 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
599 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
600 + },
601 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
602 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
392 392  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
393 393  
394 394  (% lang="en-US" style="text-align:left" %)
... ... @@ -395,10 +395,8 @@
395 395  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
396 396  
397 397  (% lang="en-US" style="text-align:left" %)
398 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
399 -
400 -(% lang="en-US" style="text-align:left" %)
401 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
610 + "id": "" , ~/~/ идентификатор пользователя
402 402   "lastName": "" , ~/~/ фамилия
403 403   "firstName": "" , ~/~/ имя
404 404   "position": "" , ~/~/ должность
... ... @@ -411,21 +411,24 @@
411 411   "isEnabled": "" , ~/~/ признак включения
412 412   "parentId": "" , ~/~/ Guid родительского агента
413 413   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
414 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
415 - "kind": "" , ~/~/ тип аутентификации
623 + "doubleAuth":
624 + {
625 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
626 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
627 + },
628 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
416 416   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
417 417   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
631 +}
418 418  
419 -(% lang="en-US" style="text-align:left" %)
420 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
633 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
421 421  
422 -
423 423  (% class="box warningmessage" %)
424 424  (((
425 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
637 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
426 426  )))
427 427  
428 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
640 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
429 429  
430 430  (% style="color:#000000" %)Метод запроса: **PUT**
431 431  
... ... @@ -437,24 +437,23 @@
437 437  
438 438  (% style="color:#000000" %)Параметры в теле запроса (JSON):
439 439  
440 -(% style="color:#000000" %){
441 -
652 +(% style="color:#000000" %){(%%)
442 442   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
443 443   "description": "" , ~/~/ описание
444 444   "data": "" , ~/~/ данные, связанные со сменой статуса
445 -
446 446  (% style="color:#000000" %)}
447 447  
448 448  (% style="text-align:left" %)
449 449  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
450 450  
661 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
451 451  
452 452  (% class="box warningmessage" %)
453 453  (((
454 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
665 +**POST /api/v3/users/disable**
455 455  )))
456 456  
457 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
668 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
458 458  
459 459  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
460 460  
... ... @@ -463,19 +463,20 @@
463 463  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
464 464  
465 465   [ 
466 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
677 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
467 467   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
468 468   ]
469 469  
470 470  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
471 471  
683 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
472 472  
473 473  (% class="box warningmessage" %)
474 474  (((
475 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
687 +**POST /api/v3/users/enable**
476 476  )))
477 477  
478 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
690 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
479 479  
480 480  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
481 481  
... ... @@ -503,15 +503,16 @@
503 503  }
504 504  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
505 505  "users" - массив id пользователей, которых не удалось включить или отключить.
506 -
507 507  )))
508 508  
720 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
721 +
509 509  (% class="box errormessage" %)
510 510  (((
511 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
724 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
512 512  )))
513 513  
514 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
727 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
515 515  
516 516  (% style="color:#000000" %)Метод запроса: **DELETE**
517 517  
... ... @@ -524,192 +524,515 @@
524 524  (% style="text-align:left" %)
525 525  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
526 526  
740 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
527 527  
528 -(% class="box" style="text-align: center;" %)
529 -(((
530 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
531 -)))
742 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
532 532  
533 533  (% class="box infomessage" %)
534 534  (((
535 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
746 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
536 536  )))
537 537  
538 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
749 +Метод возвращает полную информацию о модели объекта.
539 539  
540 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
541 -
542 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
543 -
544 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
545 -
546 546  (% style="color:#000000" %)Метод запроса: **GET**
547 547  
548 -(% 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>
753 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
549 549  
550 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
755 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
551 551  
552 552  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
553 553  
554 554  (% style="color:#000000" %)Ответ:
555 555  
556 -(((
557 -{
558 -)))
761 +(% style="color:#000000" %){
762 + "parentName": "string",
763 + "name": "string",
764 + "picture": "string",
765 + "minspeed": 0,
766 + "maxspeed": 0,
767 + "width": 0,
768 + "imbeddedtrailer": true,
769 + "hoppercapacity": 0,
770 + "hopperdischargespeed": 0,
771 + "modelType": 0,
772 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
773 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
774 + "deleted": true
775 +}
559 559  
560 -(((
561 - "vehicleId": "", ~/~/ ID объекта
562 -)))
777 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
778 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
779 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
780 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
781 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
782 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
783 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
784 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
785 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
786 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
787 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
788 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
789 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
790 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
563 563  
564 -(((
565 - "name": "", ~/~/ Имя объекта
566 -)))
792 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
567 567  
794 +(% class="box successmessage" %)
568 568  (((
569 - "imei": "", ~/~/ IMEI объекта
796 +(% lang="en-US" %)**POST /api/v3/models/find**
570 570  )))
571 571  
572 -(((
573 - "deviceTypeId": , ~/~/ ID типа устройства
574 -)))
799 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
575 575  
576 -(((
577 - "deviceTypeName": "", ~/~/ Название типа устройства
578 -)))
801 +(% style="color:#000000" %)Метод запроса: **POST**
579 579  
580 -(((
581 - "sim1": "", ~/~/ Номер SIM1
582 -)))
803 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
583 583  
584 -(((
585 - "parentId": "", Номер SIM2
586 -)))
805 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
587 587  
588 -(((
589 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
590 -)))
807 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
591 591  
592 -(((
593 - "modelId": "", ID модели объекта
594 -)))
809 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
810 +}
595 595  
596 -(((
597 - "modelName": "", Имя модели объекта
598 -)))
812 +(% style="color:#000000" %)Ответ:
599 599  
600 -(((
601 - "createdAt": "", Дата создания объекта
602 -)))
814 +(% style="color:#000000" %)[
815 + {
816 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
817 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
818 + "parentName": "string",
819 + "name": "string",
820 + "modelType": 0
821 + }
822 +]
603 603  
604 -(((
605 - "mileageCalcMethod": "", Выбранный метод расчета пробега
606 -)))
824 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
825 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
826 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
827 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
828 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
829 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
607 607  
608 -(((
609 - "counters": { ~/~/ Нормы
610 -)))
831 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
611 611  
833 +(% class="box successmessage" %)
612 612  (((
613 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
835 +(% lang="en-US" %)**POST /api/v3/models**
614 614  )))
615 615  
838 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
839 +
840 +(% style="color:#000000" %)Метод запроса: **POST**
841 +
842 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
843 +
844 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
845 +
846 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
847 +
848 +{
849 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
850 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
851 + "deleted": true,
852 + "extId": "string",
853 + "name": "string",
854 + "picture": "string",
855 + "minspeed": 0,
856 + "maxspeed": 0,
857 + "width": 0,
858 + "imbeddedtrailer": true,
859 + "fueloutlay": 0,
860 + "hoppercapacity": 0,
861 + "hopperdischargespeed": 0,
862 + "modelType": 0
863 +}
864 +
865 +Ответ:
866 +
867 +{
868 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
869 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
870 + "deleted": true,
871 + "extId": "string",
872 + "name": "string",
873 + "picture": "string",
874 + "minspeed": 0,
875 + "maxspeed": 0,
876 + "width": 0,
877 + "imbeddedtrailer": true,
878 + "hoppercapacity": 0,
879 + "hopperdischargespeed": 0,
880 + "modelType": 0
881 +}
882 +
883 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
884 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
885 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
886 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
887 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
888 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
889 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
890 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
891 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
892 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
893 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
894 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
895 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
896 +
897 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
898 +
899 +(% class="box warningmessage" %)
616 616  (((
617 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
901 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
618 618  )))
619 619  
904 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
905 +
906 +(% style="color:#000000" %)Метод запроса: **PUT**
907 +
908 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
909 +
910 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911 +
912 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
913 +
914 +{
915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
916 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
917 + "deleted": true,
918 + "extId": "string",
919 + "name": "string",
920 + "picture": "string",
921 + "minspeed": 0,
922 + "maxspeed": 0,
923 + "width": 0,
924 + "imbeddedtrailer": true,
925 + "fueloutlay": 0,
926 + "hoppercapacity": 0,
927 + "hopperdischargespeed": 0,
928 + "modelType": 0
929 +}
930 +
931 +Ответ:
932 +
933 +{
934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
935 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
936 + "deleted": true,
937 + "extId": "string",
938 + "name": "string",
939 + "picture": "string",
940 + "minspeed": 0,
941 + "maxspeed": 0,
942 + "width": 0,
943 + "imbeddedtrailer": true,
944 + "fueloutlay": 0,
945 + "hoppercapacity": 0,
946 + "hopperdischargespeed": 0,
947 + "modelType": 0
948 +}
949 +
950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
951 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
952 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
953 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
954 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
955 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
956 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
957 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
958 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
959 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
960 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
961 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
962 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
963 +
964 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
965 +
966 +(% class="box errormessage" %)
620 620  (((
621 - "mileage": "", ~/~/ Пробег по нормам в метрах
968 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
622 622  )))
623 623  
971 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
972 +
973 +(% style="color:#000000" %)Метод запроса: **DELETE**
974 +
975 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
976 +
977 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
978 +
979 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
980 +
981 +Ответ: В случае успеха **Success 200**
982 +
983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
984 +
985 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
986 +
987 +(% class="box infomessage" %)
624 624  (((
625 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
989 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
626 626  )))
627 627  
992 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
993 +
994 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
995 +
996 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
997 +
998 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
999 +
1000 +(% style="color:#000000" %)Метод запроса: **GET**
1001 +
1002 +(% 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}
1003 +
1004 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1005 +
1006 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1007 +
1008 +(% style="color:#000000" %)Ответ:
1009 +
628 628  (((
1011 +{
1012 + "vehicleId": "", ~/~/ ID объекта
1013 + "name": "", ~/~/ Имя объекта
1014 + "imei": "", ~/~/ IMEI объекта
1015 + "deviceTypeId": , ~/~/ ID типа устройства
1016 + "deviceTypeName": "", ~/~/ Название типа устройства
1017 + "sim1": "", ~/~/ Номер SIM1
1018 + "sim2": "", ~/~/ Номер SIM2
1019 + "parentId": "", ~/~/ ID клиента-родителя
1020 + "parentName": "", ~/~/ Наименование клиента-родителя
1021 + "modelId": "", ~/~/ ID модели объекта
1022 + "modelName": "", ~/~/ Имя модели объекта
1023 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1024 + "unitName": "string", ~/~/ Наименование подразделения
1025 + "status": 0, ~/~/ Статус объекта
1026 + "createdAt": "", ~/~/ Дата создания объекта
629 629   },
630 -)))
1028 +"customFields": [ ~/~/ Произвольные поля
1029 + {
1030 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1031 + "name": "string", ~/~/ Имя поля
1032 + "value": "string", ~/~/ Значение поля
1033 + "forClient": true, ~/~/ Не используемая функция
1034 + "forTooltip": true, ~/~/ Отображать в подсказке
1035 + "forReport": true ~/~/ Отображать в отчете
1036 + }
631 631  
632 -(((
633 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
634 -)))
1038 +], ~/~/ Данные с вкладки нормы
1039 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1040 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1041 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1042 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1043 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1044 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1045 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1046 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1047 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1048 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1049 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1050 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1051 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1052 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1053 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1054 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1055 + "counters": { ~/~/ Счетчики
1056 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1057 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1058 + "mileage": 0, ~/~/ Текущий пробег
1059 + "motohours": 0, ~/~/ Текущие моточасы
1060 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1061 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1062 + },
635 635  
636 -(((
1064 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1065 + "id": "string", ~/~/ ID объекта
1066 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1067 + "host": "string", ~/~/ CMSV6 Web Host
1068 + "login": "string", ~/~/ CMSV6 Account
1069 + "password": "string" ~/~/ CMSV6 Password
1070 + },
1071 +
1072 +"commandTemplates": [ ~/~/ Шаблоны команд
1073 + {
1074 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1075 + "name": "string", ~/~/ Наименование команды
1076 + "command": "string", ~/~/ Текст команды
1077 + "retries": 0 ~/~/ Количество попыток
1078 + }
1079 + ],
1080 + "sensors": [ ~/~/ Датчики
1081 + {
1082 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1083 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1084 + "type": 0, ~/~/ Тип датчика
1085 + "name": "string", ~/~/ Имя датчика
1086 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1087 + "inputNumber": 0, ~/~/ Номер входа
1088 + "pseudonym": "string", ~/~/ Псевдоним
1089 + "medianDegree": 0, ~/~/ Медианная фильтрация
1090 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1091 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1092 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1093 + "gradesTables": [ ~/~/ Массив таблиц тарировки
637 637   {
638 -)))
1095 + "grades": [ ~/~/ Таблица тарировки 1
1096 + {
1097 + "input": 0, ~/~/ Входящее значение
1098 + "output": 0 ~/~/ Выходящее значение
1099 + }
1100 + ],
1101 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1102 + }
1103 + ],
1104 + "showInTooltip": true, ~/~/ Отображать в подсказке
1105 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1106 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1107 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1108 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1109 + "expr": "string", ~/~/ Формула
1110 + "children": [ ~/~/ массив дочерних датчиков
1111 + "string"
1112 + ],
1113 + "customParams": { ~/~/ прочие произвольные параметры
1114 + "additionalProp1": "string",
1115 + "additionalProp2": "string",
1116 + "additionalProp3": "string"
1117 + },
639 639  
640 -(((
641 - "id": "", ~/~/ ID  задания
642 -)))
643 -
644 -(((
1119 +~/~/ Характерные для произвольного:
1120 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1121 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1122 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1123 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1124 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1125 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1126 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1127 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1128 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1129 +~/~/ "ValueOn": "Вкл.",
1130 +~/~/ "ValueOff": "Выкл."
1131 + "summaryMaxValue": 0 ~/~/ Макс. значение
1132 + }
1133 + "drivers": [ ~/~/ Водители
1134 + {
1135 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1136 + "name": "string", ~/~/ Наименование
1137 + "description": "string",
1138 + "isDefault": true ~/~/ По умолчанию
1139 + }
1140 + ],
1141 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1142 + {
1143 + "id": "", ~/~/ ID  задания
645 645   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
646 -)))
647 -
648 -(((
649 649   "name": "", ~/~/ Наименование задания
650 -)))
651 -
652 -(((
653 653   "description": "", ~/~/ Описание задания
654 -)))
655 -
656 -(((
657 657   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 -)))
659 -
660 -(((
661 661   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 -)))
663 -
664 -(((
665 665   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 -)))
667 -
668 -(((
669 669   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 -)))
671 -
672 -(((
673 673   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
674 -)))
675 -
676 -(((
677 677   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
678 -)))
679 -
680 -(((
681 681   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1154 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1155 + }
1156 + ],
1157 +"statusHistory": [ ~/~/ История статусов
1158 + {
1159 + "status": 0,
1160 + "date": "2023-05-22T09:57:39.562Z",
1161 + "description": "string",
1162 + "additionalInfo": "string"
1163 + }
1164 + ]
1165 +}
682 682  )))
683 683  
1168 +(% style="text-align:left" %)
1169 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1170 +
1171 +(% style="text-align:left" %)
1172 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1173 +
1174 +
1175 +== **Отправить команду на терминал** ==
1176 +
1177 +(% class="box successmessage" %)
684 684  (((
685 - "maxQuantity""" ~/~/ Сколько раз выполнить задание (null - однократно)
1179 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
686 686  )))
687 687  
1182 +Команда для отправки на тс.
1183 +
1184 +{  
1185 +"id": "", ~/~/идентификатор произвольного поля
1186 +"command": "", ~/~/ Текст команды
1187 +"retries": "", ~/~/ Количество попыток
1188 +"idTemplate": "" ~/~/ ID шаблона команды
1189 +}
1190 +
1191 +
1192 +== **Получить ответ на отправленную на ТС команду** ==
1193 +
1194 +(% class="box infomessage" %)
688 688  (((
689 - }
1196 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
690 690  )))
691 691  
1199 +Идентификатор команды: cmdid
1200 +
1201 +Запрос от терминала на ответ команды
1202 +
1203 +Пример ответ от терминала:
1204 +
1205 +ID= "" ~/~/ идентификатор произвольного поля
1206 +Soft="" ~/~/ версия софта
1207 +GPS=4 ~/~/ тип трекера
1208 +Time=11:05:43 28.06.24 ~/~/ время запроса
1209 +Lat=45.056221 ~/~/ широта
1210 +Lon=39.035938 ~/~/ долгота
1211 +Speed=0.0 ~/~/ скорость
1212 +Course=181.4 ~/~/направление
1213 +
692 692  (((
693 - ]
694 -)))
1215 +== **Список отправленных объекту команд с ответами** ==
695 695  
1217 +(% class="box infomessage" %)
696 696  (((
697 -}
1219 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
698 698  )))
699 699  
700 -(% style="text-align:left" %)
701 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1222 +Идентификатор ТС: vehicleId
702 702  
703 -(% style="text-align:left" %)
704 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1224 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
705 705  
1226 +Пример ответа терминала
706 706  
1228 +[ 
1229 +{    
1230 +"id": "", ~/~/ идентификатор пользователя
1231 +"commandText": "", ~/~/Текст команды.
1232 +"templateId": "", ~/~/Идентификатор шаблона
1233 +"updated": "", ~/~/ Время отправки  
1234 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1235 +"answer": "", ~/~/ Ответ терминала.
1236 +"status": "" ~/~/ Статус отправки
1237 +}
1238 +]
1239 +)))
1240 +
1241 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1242 +
707 707  (% class="box successmessage" %)
708 708  (((
709 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
1245 +(% lang="en-US" %)**POST /api/v3/vehicles**
710 710  )))
711 711  
712 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1248 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
713 713  
714 714  (% style="color:#000000" %)Метод запроса: **POST**
715 715  
... ... @@ -719,8 +719,7 @@
719 719  
720 720  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
721 721  
722 -(% style="color:#000000" %){
723 -
1258 +(% style="color:#000000" %){(%%)
724 724   "parentId": "" , ~/~/ ID клиента
725 725   "name": "" , ~/~/ имя ТС
726 726   "imei": "" , ~/~/ IMEI
... ... @@ -741,6 +741,10 @@
741 741   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
742 742   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
743 743   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1279 + "mileageCalcMethod": 0,
1280 + "mileageCoeff": 0,
1281 + "locationByCellId": true,
1282 + "dottedLineTrackWhenNoCoords": true,
744 744   "counters": ~/~/ счетчики
745 745   {
746 746   "mileage": "" , ~/~/ пробег
... ... @@ -769,13 +769,88 @@
769 769   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
770 770   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
771 771   }
1311 +"drivers": [ ~/~/ Водители
1312 + {
1313 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1314 + "isDefault": true
1315 + }
1316 + ],
1317 + "commandTemplates": [ ~/~/ Шаблон команды
1318 + {
1319 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1320 + "name": "string",
1321 + "command": "string",
1322 + "retries": 0
1323 + }
1324 + ],
1325 +"sensors": [ ~/~/ Датчики
1326 + {
1327 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1328 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1329 + "type": 0, ~/~/ Тип датчика
1330 + "name": "string", ~/~/ Имя датчика
1331 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1332 + "inputNumber": 0, ~/~/ Номер входа
1333 + "pseudonym": "string", ~/~/ Псевдоним
1334 + "medianDegree": 0, ~/~/ Медианная фильтрация
1335 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1336 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1337 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1338 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1339 + {
1340 + "grades": [ ~/~/ Таблица тарировки 1
1341 + {
1342 + "input": 0, ~/~/ Входящее значение
1343 + "output": 0 ~/~/ Выходящее значение
1344 + }
1345 + ],
1346 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1347 + }
1348 + ],
1349 + "showInTooltip": true, ~/~/ Отображать в подсказке
1350 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1351 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1352 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1353 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1354 + "expr": "string", ~/~/ Формула
1355 + "children": [ ~/~/ массив дочерних датчиков
1356 + "string"
1357 + ],
1358 + "customParams": { ~/~/ прочие произвольные параметры
1359 + "additionalProp1": "string",
1360 + "additionalProp2": "string",
1361 + "additionalProp3": "string"
1362 + },
1363 +~/~/ Характерные для произвольного:
1364 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1365 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1366 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1367 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1368 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1369 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1370 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1371 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1372 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1373 +~/~/ "ValueOn": "Вкл.",
1374 +~/~/ "ValueOff": "Выкл."
1375 + "summaryMaxValue": 0 ~/~/ Макс. значение
1376 + }
1377 + ],
1378 + "customFields": [ ~/~/ Произвольные поля
1379 + {
1380 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1381 + "name": "string",
1382 + "value": "string",
1383 + "forClient": true,
1384 + "forTooltip": true,
1385 + "forReport": true
1386 + }
1387 + ]
1388 +}
772 772  
773 -(% style="color:#000000" %) }
774 -
775 775  (% style="color:#000000" %)Ответ:
776 776  
777 -(% style="color:#000000" %){
778 -
1392 +(% style="color:#000000" %){(%%)
779 779   "vehicleId": "", ~/~/ID ТС 
780 780   "parentId": "", ~/~/Guid владельца ТС
781 781   "name": "", ~/~/Имя объекта
... ... @@ -813,8 +813,6 @@
813 813   "kind": "", ~/~/ Вид периодичности по времени 
814 814   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
815 815   }
816 -
817 -(% style="text-align:left" %)
818 818  (% style="color:#000000" %)}
819 819  
820 820  **Валидация:**
... ... @@ -822,15 +822,16 @@
822 822  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
823 823  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
824 824  
1437 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
825 825  
826 -(% class="box successmessage" %)
1439 +(% class="box infomessage" %)
827 827  (((
828 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1441 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
829 829  )))
830 830  
831 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1444 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
832 832  
833 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1446 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
834 834  
835 835  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
836 836  
... ... @@ -856,24 +856,23 @@
856 856  
857 857  (% style="color:#000000" %)Параметры в теле запроса (JSON):
858 858  
859 -(% class="western" style="color:#000000" %)##{##
1472 +{
1473 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1474 + "name": null, ~/~/ Имя ТС (string, опционально)
1475 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1476 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1477 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1478 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1479 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1480 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1481 +}
860 860  
861 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
862 - "name": null, ~/~/ Имя ТС (string, опционально) 
863 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
864 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
865 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
866 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
867 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
868 -(% style="color:#000000" %)}
1483 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
869 869  
870 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
871 -
872 872  (% style="color:#000000" %)Ответ:
873 873  
874 874  (% style="color:#000000" %){
875 -
876 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1488 + "vehicleId": "" ~/~/ идентификатор объекта
877 877   "name": "" ~/~/ наименование объекта
878 878   "imei": "" ~/~/ IMEI объекта
879 879   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -889,18 +889,28 @@
889 889   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
890 890   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
891 891   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
892 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
1504 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1505 + "customFields": [ 
1506 + {
1507 + "id": "", ~/~/ идентификатор произвольного поля
1508 + "name": "", ~/~/ имя произвольного поля
1509 + "value": "", ~/~/ значение произвольного поля
1510 + "forClient": true, ~/~/ право на отображение у клиента
1511 + "forTooltip": false, ~/~/ право на отображение в подсказке
1512 + "forReport": false ~/~/ право на отображение в отчетах
1513 + }(%%)
893 893  (% style="color:#000000" %)}
894 894  
895 895  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
896 896  
1518 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
897 897  
898 898  (% class="box successmessage" %)
899 899  (((
900 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1522 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
901 901  )))
902 902  
903 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1525 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
904 904  
905 905  (% style="color:#000000" %)Метод запроса: **POST**
906 906  
... ... @@ -922,13 +922,11 @@
922 922   "data": "", ~/~/ Данные
923 923   "overwrite": false, ~/~/ Флаг перезаписи
924 924   "stage": "", ~/~/ Состояние, может быть null
925 -
926 926  (% style="color:#000000" %)}
927 927  
928 928  (% style="color:#000000" %)Ответ:
929 929  
930 -(% style="color:#000000" %){
931 -
1551 +(% style="color:#000000" %){(%%)
932 932   "status": "", ~/~/ значение статуса
933 933   "date": "", ~/~/ Дата смены статуса 
934 934   "description": "", ~/~/ Описание
... ... @@ -935,17 +935,18 @@
935 935   "data": "", ~/~/ Данные
936 936   "overwrite": false, ~/~/ Флаг перезаписи
937 937   "stage": "", ~/~/ Состояние
938 -
939 -(% style="text-align:left" %)
940 940  (% style="color:#000000" %) }
941 941  
1560 +== ==
942 942  
1562 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1563 +
943 943  (% class="box warningmessage" %)
944 944  (((
945 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1566 +(% lang="en-US" %)**PUT /api/v3/vehicles**
946 946  )))
947 947  
948 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1569 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
949 949  
950 950  (% style="color:#000000" %)Метод запроса: **PUT**
951 951  
... ... @@ -955,18 +955,16 @@
955 955  
956 956  (% style="color:#000000" %)Параметры в теле запроса (JSON):
957 957  
958 -(% style="color:#000000" %){    
959 -
960 -(((
961 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
962 - "parentId": "", ~/~/ ID клиента
963 - "name": "", ~/~/ имя ТС
964 - "imei": "", ~/~/ IMEI
965 - "deviceTypeId": "", ~/~/ ID типа устройства
966 - "modelId": "", ~/~/ , ID модели    
967 - "unitId": "", ~/~/ подразделения
968 - "sim1": "", ~/~/ SIM 1
969 - "sim2": "", ~/~/ SIM2     (%%)
1579 +(% style="color:#000000" %){
1580 + "vehicleId": , ~/~/ ID объекта
1581 + "parentId": "" , ~/~/ ID клиента
1582 + "name": "" , ~/~/ имя ТС
1583 + "imei": "" , ~/~/ IMEI
1584 + "deviceTypeId": "" , ~/~/ ID типа устройства
1585 + "modelId": "" , ~/~/ ID модели
1586 + "unitId": "" , ~/~/ ID подразделения
1587 + "sim1": "" , ~/~/ Номер SIM 1
1588 + "sim2": "" , ~/~/ Номер SIM2
970 970   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
971 971   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
972 972   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -979,45 +979,123 @@
979 979   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
980 980   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
981 981   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
982 -(% style="color:#000000" %) "counters": 
983 - {
984 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
985 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
986 - "mileage": "", ~/~/ пробег, в метрах 
987 - "motohours": "" ~/~/ моточасы, в секундах
988 - }
989 - "cmsv6Parameters": ~/~/ параметры CMSv6
990 - {       
991 - "id": "", ~/~/ идентификатор
992 - "enabled": true, ~/~/ флаг включения
993 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
994 - "login": "", ~/~/ имя учетной записи
995 - "password": "", ~/~/ пароль учетной записи
996 - }
997 - "inspectionTasks": ~/~/ задания на ТО
998 - {
999 - "id": "", ~/~/ ID задания
1000 - "enabled": false, ~/~/ Признак включения
1001 - "name": "", ~/~/ Имя задания
1002 - "description": "", ~/~/ Описание задания
1003 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1004 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1005 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1006 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1007 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1008 - "kind": "", ~/~/ Вид периодичности по времени
1009 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1010 - } 
1011 -)))
1012 1012  
1013 -(% style="color:#000000" %)}
1602 + "mileageCalcMethod": 0,
1603 + "mileageCoeff": 0,
1604 + "locationByCellId": true,
1605 + "dottedLineTrackWhenNoCoords": true,
1606 + "counters": ~/~/ счетчики
1607 + {
1608 + "mileage": "" , ~/~/ пробег
1609 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1610 + "motohours": "" , ~/~/ моточасы
1611 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1612 + },
1613 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1614 + "enabled": true, ~/~/ флаг включения
1615 + "id": "" , ~/~/ идентификатор
1616 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1617 + "login": "" , ~/~/ имя учетной записи
1618 + "password": "" ~/~/ пароль учетной записи
1619 + },
1620 + "inspectionTasks": ~/~/ задания на ТО
1621 + {
1622 + "enabled": "" , ~/~/ Признак включения
1623 + "name": "" , ~/~/ Имя задания
1624 + "description": "" , ~/~/ Описание задания
1625 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1626 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1627 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1628 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1629 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1630 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1631 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1632 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1633 + }
1014 1014  
1635 +"drivers": [ ~/~/ Водители
1636 + {
1637 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1638 + "isDefault": true
1639 + }
1640 + ],
1641 + "commandTemplates": [ ~/~/ Шаблон команды
1642 + {
1643 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1644 + "name": "string",
1645 + "command": "string",
1646 + "retries": 0
1647 + }
1648 + ],
1649 +"sensors": [ ~/~/ Датчики
1650 + {
1651 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1652 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1653 + "type": 0, ~/~/ Тип датчика
1654 + "name": "string", ~/~/ Имя датчика
1655 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1656 + "inputNumber": 0, ~/~/ Номер входа
1657 + "pseudonym": "string", ~/~/ Псевдоним
1658 + "medianDegree": 0, ~/~/ Медианная фильтрация
1659 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1660 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1661 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1662 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1663 + {
1664 + "grades": [ ~/~/ Таблица тарировки 1
1665 + {
1666 + "input": 0, ~/~/ Входящее значение
1667 + "output": 0 ~/~/ Выходящее значение
1668 + }
1669 + ],
1670 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1671 + }
1672 + ],
1673 + "showInTooltip": true, ~/~/ Отображать в подсказке
1674 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1675 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1676 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1677 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1678 + "expr": "string", ~/~/ Формула
1679 + "children": [ ~/~/ массив дочерних датчиков
1680 + "string"
1681 + ],
1682 + "customParams": { ~/~/ прочие произвольные параметры
1683 + "additionalProp1": "string",
1684 + "additionalProp2": "string",
1685 + "additionalProp3": "string"
1686 + },
1687 +~/~/ Характерные для произвольного:
1688 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1689 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1690 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1691 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1692 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1693 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1694 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1695 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1696 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1697 +~/~/ "ValueOn": "Вкл.",
1698 +~/~/ "ValueOff": "Выкл."
1699 + "summaryMaxValue": 0 ~/~/ Макс. значение
1700 + }
1701 + ],
1702 + "customFields": [ ~/~/ Произвольные поля
1703 + {
1704 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1705 + "name": "string",
1706 + "value": "string",
1707 + "forClient": true,
1708 + "forTooltip": true,
1709 + "forReport": true
1710 + }
1711 + ]
1712 +}
1713 +
1015 1015  (% style="color:#000000" %)Ответ:
1016 1016  
1017 1017  (% lang="en-US" style="text-align:left" %)
1018 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1019 -
1020 -(% lang="en-US" style="text-align:left" %)
1717 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1021 1021   "vehicleId": "", ~/~/ ID ТС
1022 1022   "parentId": "", ~/~/ ID клиента
1023 1023   "name": "", ~/~/ имя ТС
... ... @@ -1058,22 +1058,21 @@
1058 1058   "kind": "", ~/~/ Вид периодичности по времени
1059 1059   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1060 1060   }
1061 -
1062 -(% lang="en-US" style="text-align:left" %)
1063 1063  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1064 1064  
1065 -**валидация:**
1760 +**Валидация:**
1066 1066  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1067 1067  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1068 1068  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1069 1069  
1765 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1070 1070  
1071 1071  (% class="box errormessage" %)
1072 1072  (((
1073 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1769 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1074 1074  )))
1075 1075  
1076 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1772 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1077 1077  
1078 1078  (% style="color:#000000" %)Метод запроса: **DELETE**
1079 1079  
... ... @@ -1086,66 +1086,2695 @@
1086 1086  (% style="text-align:left" %)
1087 1087  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1088 1088  
1785 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1089 1089  
1090 -(% class="box" lang="en-US" style="text-align: center;" %)
1091 -(((
1092 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1093 -)))
1787 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1094 1094  
1095 1095  (% class="box infomessage" %)
1096 1096  (((
1097 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1791 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1098 1098  )))
1099 1099  
1100 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1794 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1101 1101  
1102 1102  (% style="color:#000000" %)Метод запроса: **GET**
1103 1103  
1104 -(% 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]]
1798 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1105 1105  
1106 1106  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1107 1107  
1108 1108  (% style="color:#000000" %)Ответ:
1109 1109  
1110 -(% style="color:#000000" %){
1111 -
1804 +(% style="color:#000000" %){(%%)
1112 1112   "deviceTypeId" : "", ~/~/ ID типа устройства
1113 1113   "deviceTypeName" : "" ~/~/ Название типа устройства
1114 -
1115 -(% style="text-align:left" %)
1116 1116  (% style="color:#000000" %)}
1117 1117  
1809 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1118 1118  
1119 -(% class="box" style="text-align: center;" %)
1120 -(((
1121 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1122 -)))
1811 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1123 1123  
1124 1124  (% class="box infomessage" %)
1125 1125  (((
1126 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1815 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1127 1127  )))
1128 1128  
1129 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1818 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1130 1130  
1131 1131  (% style="color:#000000" %)Метод запроса: **GET**
1132 1132  
1133 1133  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1134 1134  
1135 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1824 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1136 1136  
1137 1137  (% style="color:#000000" %)Ответ:
1138 1138  
1139 -(% style="color:#000000" %){
1140 -
1828 +(% style="color:#000000" %){(%%)
1141 1141   "id": "", ~/~/ ID типа датчика 
1142 1142   "name": "", ~/~/ Название
1143 1143   "description": "", ~/~/ Описание
1832 +(% style="color:#000000" %)}
1144 1144  
1834 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1835 +
1836 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1837 +
1838 +(% class="box infomessage" style="text-align: left;" %)
1839 +(((
1840 +**POST /api/v3/terminalMessages/count**
1841 +)))
1842 +
1843 +(% style="text-align: left;" %)
1844 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1845 +
1846 +(% style="text-align: left;" %)
1847 +Метод запроса **POST**
1848 +
1849 +(% style="text-align: left;" %)
1850 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1851 +
1852 +(% style="text-align: left;" %)
1853 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1854 +
1855 +(% style="text-align: left;" %)
1856 +{
1857 + "vehicleIds": [
1858 + id ~/~/ здесь передается список идентификаторов объектов
1859 + ],
1860 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1861 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1862 +}
1863 +
1864 +(% style="text-align: left;" %)
1865 +Ответ:
1866 +
1867 +(% style="text-align: left;" %)
1868 +[
1869 + {
1870 + "vehicleId": 0, ~/~/ идентификатор объекта
1871 + "count": 0 ~/~/ количество сообщений за период
1872 + }
1873 +]
1874 +
1875 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1876 +
1877 +(% class="box infomessage" style="text-align: left;" %)
1878 +(((
1879 +**POST /api/v3/terminalMessages/mapping**
1880 +)))
1881 +
1882 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1883 +
1884 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1885 +
1886 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1887 +
1888 +{
1889 + "protocolType": 0,
1890 + "params": ["string"]
1891 +}
1892 +
1893 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1894 +|protocolType|ID типа протокола
1895 +|params|(((
1896 +Массив наименований параметров в сообщении
1897 +)))
1898 +
1899 +Ответ:
1900 +
1901 +{
1902 + "protocolType": 0,
1903 + "mapping": {
1904 + "additionalProp1": {
1905 + "inputType": 0,
1906 + "inputNumber": 0
1907 + },
1908 + "additionalProp2": {
1909 + "inputType": 0,
1910 + "inputNumber": 0
1911 + }
1912 + }
1913 +}
1914 +
1915 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1916 +|protocolType|Тип протокола
1917 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1918 +|inputNumber|(((
1919 +Номер входа
1920 +)))
1921 +
1922 +(% class="wikigeneratedid" %)
1923 +Перечень 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/]]
1924 +
1925 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1926 +
1927 +(% class="box infomessage" %)
1928 +(((
1929 +**POST /api/v3/terminalMessages**
1930 +)))
1931 +
1932 +Метод возвращает список сообщений терминала объекта за выбранный период.
1933 +
1934 +(% style="text-align: left;" %)
1935 +Метод запроса **POST**
1936 +
1937 +(% style="text-align: left;" %)
1938 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1939 +
1940 +(% style="text-align: left;" %)
1941 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1942 +
1943 +{
1944 + "vehicleId": 0, ~/~/ id объекта
1945 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1946 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1947 +}
1948 +
1949 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1950 +|vehicleId|ID объекта
1951 +|from|Дата и время начала периода запроса
1952 +|to|Дата и время окончания периода запроса
1953 +
1954 +Ответ:
1955 +
1956 +[
1957 + {
1958 + "messages": [
1959 + {
1960 + "deviceTime": "2023-11-29T07:40:44.052Z",
1961 + "serverTime": "2023-11-29T07:40:44.052Z",
1962 + "speed": 0,
1963 + "altitude": 0,
1964 + "latitude": 0,
1965 + "longitude": 0,
1966 + "satellites": 0,
1967 + "course": 0,
1968 + "voltage": 0,
1969 + "parameters": {
1970 + "additionalProp1": "string",
1971 + "additionalProp2": "string",
1972 + "additionalProp3": "string"
1973 + },
1974 + "photoCount": 0,
1975 + "lbsCorrectedCoords": true,
1976 + "protocolType": 0
1977 + }
1978 + ]
1979 + }
1980 +]
1981 +
1982 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1983 +|deviceTime|Время сообщения терминала
1984 +|serverTime|Время когда сообщение поступило на сервер
1985 +|speed|Скорость
1986 +|altitude|Высота над уровнем моря
1987 +|latitude|Широта
1988 +|longitude|Долгота
1989 +|satellites|Кол-во спутников
1990 +|course|Курс
1991 +|voltage|Бортовое напряжение
1992 +|parameters|Список параметров и их значений
1993 +|photoCount|Количество фото
1994 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1995 +|protocolType|ID типа протокола
1996 +
1997 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1998 +
1999 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2000 +
2001 +(% class="box infomessage" %)
2002 +(((
2003 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2004 +)))
2005 +
2006 +(% style="color:#000000" %)Метод запроса: **POST**
2007 +
2008 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2009 +
2010 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2011 +
1145 1145  (% style="text-align:left" %)
2013 +Тело запроса:
2014 +
2015 +{
2016 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2017 + "vehicleIds": [0], ~/~/ Список ID объектов
2018 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2019 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2020 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2021 +}
2022 +
2023 +Ответ:
2024 +
2025 +[
2026 + {
2027 + "vehicleId": 0, ~/~/ ID объекта
2028 + "name": "string", ~/~/ Имя ТС
2029 + "periods": [ ~/~/ Периоды
2030 + {
2031 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2032 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2033 + "mileage": 0, ~/~/ Пробег за период, километры
2034 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2035 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2036 + "motohours": 0, ~/~/ Моточасы за период, секунды
2037 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2038 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2039 + }
2040 + ]
2041 + }
2042 +]
2043 +
2044 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2045 +
2046 +(% class="box infomessage" %)
2047 +(((
2048 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2049 +)))
2050 +
2051 +(% style="color:#000000" %)Метод запроса: **POST**
2052 +
2053 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2054 +
2055 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2056 +
2057 +(% style="text-align:left" %)
2058 +Тело запроса:
2059 +
2060 +{
2061 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2062 + "vehicleIds": [0], ~/~/ Список ID объектов
2063 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2064 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2065 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2066 +}
2067 +
2068 +Ответ:
2069 +
2070 +[
2071 + {
2072 + "vehicleId": 0, ~/~/ ID объекта
2073 + "name": "string", ~/~/ Имя ТС
2074 + "periods": [ ~/~/ Периоды
2075 + {
2076 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2077 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2078 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2079 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2080 + "fuelConsumption": 0, ~/~/ Расход топлива
2081 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2082 + }
2083 + ]
2084 + }
2085 +]
2086 +
2087 +(% class="box warningmessage" %)
2088 +(((
2089 +Максимальное кол-во периодов - 1440 (maxPeriodsCount = 1440)
2090 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2091 +)))
2092 +
2093 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2094 +
2095 +(% class="box infomessage" %)
2096 +(((
2097 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2098 +)))
2099 +
2100 +(% style="color:#000000" %)Метод запроса: **POST**
2101 +
2102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2103 +
2104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2105 +
2106 +(% style="text-align:left" %)
2107 +Тело запроса:
2108 +
2109 +{
2110 + "vehicleIds": [0], ~/~/ Список ID объектов
2111 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2112 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2113 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2114 +}
2115 +
2116 +Ответ:
2117 +
2118 +[
2119 + {
2120 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2121 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2122 + "vehicleId": 0, ~/~/ ID объекта
2123 + "name": "string", ~/~/ Имя объекта
2124 + "model": "string", ~/~/ Модель объекта
2125 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2126 + {
2127 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2128 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2129 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2130 + "valueFuel": 0, ~/~/ Количество
2131 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2132 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2133 + }
2134 + ]
2135 + }
2136 +]
2137 +
2138 +
2139 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2140 +
2141 +(% class="box infomessage" %)
2142 +(((
2143 +**POST /api/v3/vehicles/moveStop**
2144 +)))
2145 +
2146 +Метод запроса: **POST**
2147 +
2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149 +
2150 +В заголовках запроса: X-Auth: Токен авторизации
2151 +
2152 +
2153 +Тело запроса:
2154 +
2155 +{
2156 + "vehicleIds": [ ], ~/~/ Список ID объектов
2157 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2158 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2159 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2160 +}
2161 +
2162 +Ответ:
2163 +
2164 +[ 
2165 + {
2166 + "vehicleId": 0, ~/~/ ID объекта
2167 + "vehicleName": "string", ~/~/ Имя объекта
2168 + "moves": [ ~/~/ Событие движения
2169 + {
2170 + "mileage": 0, ~/~/ Пробег, км
2171 + "eventId": 0, ~/~/ Идентификатор события
2172 + "eventName": "string", ~/~/ Название события
2173 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2174 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2175 + "duration": 0 ~/~/ Продолжительность события, секунд
2176 + }
2177 + ],
2178 + "stops": [ ~/~/ События стоянок
2179 + {
2180 + "address": "string", ~/~/ Адрес события
2181 + "eventId": 0, ~/~/ Идентификатор события
2182 + "eventName": "string", ~/~/ Название события
2183 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2184 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2185 + "duration": 0 ~/~/ Продолжительность события, секунд
2186 + }
2187 + ]
2188 + }
2189 +]
2190 +
2191 +
2192 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2193 +
2194 +(% class="box infomessage" %)
2195 +(((
2196 +**POST /api/v3/vehicles/getlastdata**
2197 +)))
2198 +
2199 +Метод запроса: **POST**
2200 +
2201 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2202 +
2203 +В заголовках запроса: X-Auth: Токен авторизации
2204 +
2205 +
2206 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2207 +
2208 +Ответ:
2209 + {
2210 + "vehicleId": 0, ~/~/Идентификатор объекта.
2211 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2212 + "vehicleNumber": "string",~/~/Номер объекта.
2213 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2214 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2215 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2216 + "speed": 0,~/~/Скорость объекта.
2217 + "course": 0,~/~/Курс движения [0;360]
2218 + "latitude": 0,~/~/Широта [-90°;90°].
2219 + "longitude": 0,~/~/Долгота [-180°;180°].
2220 + "address": "string",~/~/Адрес.
2221 + "geozones": [ ~/~/Сведения по геозонам.
2222 + {
2223 + "id": 0,
2224 + "name": "string"
2225 + }
2226 +
2227 +
2228 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2229 +
2230 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2231 +
2232 +(% class="box infomessage" %)
2233 +(((
2234 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2235 +)))
2236 +
2237 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2238 +
2239 +(% style="color:#000000" %)Метод запроса: **POST**
2240 +
2241 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2242 +
2243 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2244 +
2245 +(% style="text-align:left" %)
2246 +Тело запроса:
2247 +
2248 +(% style="text-align:left" %)
2249 +{
2250 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2251 +}
2252 +
2253 +(% style="text-align:left" %)
2254 +Ответ:
2255 +
2256 +[
2257 + {
2258 + "id": 0, ~/~/ Идентификатор объекта геозоны
2259 + "name": "string", ~/~/ Название объекта геозоны
2260 + "type": 0, ~/~/ Тип объекта геозоны
2261 + "fname": "string", ~/~/ Имя файла
2262 + "parentId": "string", ~/~/ Идентификатор клиента
2263 + "radius": 0, ~/~/ Радиус геообъекта
2264 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2265 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2266 + "description": "string", ~/~/ Описание
2267 + "area": 0, ~/~/ Площадь, м^^2^^
2268 + "perimetr": 0, ~/~/ Периметр, м
2269 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2270 + }
2271 +]
2272 +
2273 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2274 +
2275 +(% class="box infomessage" %)
2276 +(((
2277 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2278 +)))
2279 +
2280 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2281 +
2282 +(% style="color:#000000" %)Метод запроса: **POST**
2283 +
2284 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2285 +
2286 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2287 +
2288 +(% style="text-align:left" %)
2289 +Тело запроса:
2290 +
2291 +{
2292 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2293 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2294 + "ids": [ ], ~/~/ Массив id объектов
2295 + "byTime": 0, ~/~/ Объединение событий по времени 
2296 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2297 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2298 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2299 +}
2300 +
2301 +Ответ:
2302 +[
2303 + {
2304 + "geozoneId": 0, ~/~/ ID геообъекта
2305 + "geozoneName": "string", ~/~/ Название геообъекта
2306 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2307 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2308 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2309 + "vehicleId": 0, ~/~/ ID объекта
2310 + "vehicleName": "string" ~/~/ Имя объекта
2311 + }
2312 +]
2313 +
2314 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2315 +
2316 +(% class="box infomessage" %)
2317 +(((
2318 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2319 +)))
2320 +
2321 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2322 +
2323 +(% style="color:#000000" %)Метод запроса: **POST**
2324 +
2325 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2326 +
2327 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2328 +
2329 +(% style="text-align:left" %)
2330 +Тело запроса:
2331 +
2332 +{
2333 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2334 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2335 + "ids": [ ], ~/~/ Массив id геообъектов
2336 + "byTime": 0, ~/~/ Объединение событий по времени 
2337 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2338 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2339 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2340 +}
2341 +
2342 +Ответ:
2343 +
2344 +[
2345 + {
2346 + "geozoneId": 0, ~/~/ ID геообъекта
2347 + "geozoneName": "string", ~/~/ Название геообъекта
2348 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2349 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2350 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2351 + "vehicleId": 0, ~/~/ ID объекта
2352 + "vehicleName": "string" ~/~/ Имя объекта
2353 + }
2354 +]
2355 +
2356 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2357 +
2358 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2359 +
2360 +(% class="box infomessage" %)
2361 +(((
2362 +**POST /api/v3/notifications/find**
2363 +)))
2364 +
2365 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2366 +
2367 +(% style="text-align: left;" %)
2368 +Метод запроса **POST**
2369 +
2370 +(% style="text-align: left;" %)
2371 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2372 +
2373 +(% style="text-align: left;" %)
2374 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2375 +
2376 +{
2377 + "parentId": "" ~/~/ id клиента
2378 +}
2379 +
2380 +Ответ:
2381 +
2382 +[
2383 + {
2384 + "id": 0, ~/~/ ID уведомления
2385 + "name": "string", ~/~/ Название уведомления
2386 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2387 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2388 + "userId": "", ~/~/ Пользователь, создавший уведомление
2389 + "parentId": "", ~/~/ Идентификатор клиента
2390 + "parentName": "string" ~/~/ Имя клиента
2391 + }
2392 +]
2393 +
2394 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2395 +
2396 +(% class="box infomessage" %)
2397 +(((
2398 +**GET /api/v3/notifications/{id}**
2399 +)))
2400 +
2401 +Метод возвращает данные правил формирования выбранного уведомления.
2402 +
2403 +(% style="text-align: left;" %)
2404 +Метод запроса **GET**
2405 +
2406 +(% style="text-align: left;" %)
2407 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2408 +
2409 +(% style="text-align: left;" %)
2410 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2411 +
2412 +(% style="text-align: left;" %)
2413 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2414 +
2415 +(% style="text-align: left;" %)
2416 +(% style="color:#000000" %)Ответ:
2417 +
2418 +(% style="text-align: left;" %)
2419 +(% style="color:#000000" %){
2420 + "id": 0, ~/~/ (%%)id уведомления
2421 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2422 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2423 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2424 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2425 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2426 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2427 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2428 +(% style="color:#000000" %) 0
2429 + ],
2430 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2431 +(% style="color:#000000" %) 0
2432 + ],
2433 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
2434 +(% style="color:#000000" %) 0
2435 + ],
2436 + "settings": { ~/~/ Список параметров уведомления
2437 + "additionalProp1": "string",
2438 + "additionalProp2": "string",
2439 + "additionalProp3": "string"
2440 + },
2441 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2442 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2443 +(% style="color:#000000" %) ""
2444 + ],
2445 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2446 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2447 +(% style="color:#000000" %) "string"
2448 + ],
2449 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2450 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2451 +(% style="color:#000000" %) {
2452 + "id": 0, ~/~/ (%%)Идентификатор участника чата
2453 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2454 +(% style="color:#000000" %) }
2455 + ],
2456 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2457 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2458 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2459 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2460 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2461 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2462 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2463 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2464 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1146 1146  (% style="color:#000000" %)}
1147 1147  
2467 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1148 1148  
2469 +(% class="box warningmessage" %)
2470 +(((
2471 +**PUT /api/v3/notifications/**
2472 +)))
2473 +
2474 +Метод позволяет отредактировать уведомление.
2475 +
2476 +Метод запроса **PUT**
2477 +
2478 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2479 +
2480 +В заголовках запроса: X-Auth: Токен авторизации
2481 +
2482 +Тело запроса:
2483 +{
2484 + "id": 0, ~/~/ id уведомления
2485 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2486 + "userId": "", ~/~/ Пользователь, создавший уведомление
2487 + "parentId": "", ~/~/ Идентификатор клиента
2488 + "parentName": "string", ~/~/ Имя клиента
2489 + "name": "string", ~/~/ Название уведомления
2490 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2491 + "vehicleIds": [ ~/~/ Список id объектов для анализа
2492 + 0
2493 + ],
2494 + "geoids": [ ~/~/ Список id геообъектов для анализа
2495 + 0
2496 + ],
2497 + "fieldids": [ ~/~/ Список id полей для анализа
2498 + 0
2499 + ],
2500 + "settings": { ~/~/ Список параметров уведомления
2501 + "additionalProp1": "string",
2502 + "additionalProp2": "string",
2503 + "additionalProp3": "string"
2504 + },
2505 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2506 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2507 + ""
2508 + ],
2509 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2510 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2511 + "string"
2512 + ],
2513 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2514 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2515 + {
2516 + "id": 0, ~/~/ Идентификатор участника чата
2517 + "info": "string" ~/~/ Дополнительные сведения
2518 + }
2519 + ],
2520 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2521 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2522 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2523 + "kind": 0, ~/~/ Определяет вид уведомления
2524 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2525 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2526 + "timezone": 0, ~/~/ Сдвиг часового пояса
2527 + "validity": 0, ~/~/ Срок действия в днях (1-90)
2528 + "autoProlongation": true ~/~/ Автопродление срока действия
2529 +}
2530 +
2531 +Ответ:
2532 +
2533 +Success
2534 +
2535 +
2536 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2537 +
2538 +(% class="box warningmessage" %)
2539 +(((
2540 +**PUT** /api/v3/notifications/prolongation
2541 +)))
2542 +
2543 +Метод позволяет продлить уведомления.
2544 +
2545 +Метод запроса **PUT**
2546 +
2547 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2548 +
2549 +В заголовках запроса: X-Auth: Токен авторизации.
2550 +
2551 +Тело запроса:
2552 +
2553 +[
2554 +
2555 +0
2556 +
2557 +]
2558 +
2559 +где 0 идентификатор ids.
2560 +
2561 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2562 +
2563 +(% class="box errormessage" %)
2564 +(((
2565 +**DELETE /api/v3/notifications/{id}**
2566 +)))
2567 +
2568 +Метод позволяет удалить выбранное уведомление.
2569 +
2570 +Метод запроса **DELETE**
2571 +
2572 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2573 +
2574 +Передаваемый параметр: {id} - id уведомления
2575 +
2576 +В заголовках запроса: X-Auth: Токен авторизации
2577 +
2578 +Ответ:
2579 +
2580 +Success
2581 +
2582 +
2583 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2584 +
2585 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2586 +
2587 +(% class="box infomessage" %)
2588 +(((
2589 +**POST /api/v3/Drivers/find**
2590 +)))
2591 +
2592 +Передается параметр: parentId - ID клиента-родителя
2593 +
2594 +Ответ:
2595 +
2596 +[
2597 + {
2598 + "name": "string", ~/~/ Определяет наименование
2599 + "description": "string", ~/~/ Определяет описание
2600 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2601 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2602 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2603 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2604 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2605 + "deleted": true ~/~/ Признак удаления
2606 + }
2607 +]
2608 +
2609 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2610 +
2611 +(% class="box infomessage" %)
2612 +(((
2613 +**GET /api/v3/Drivers/{driverGuid}**
2614 +)))
2615 +
2616 +Передается параметр: ID водителя
2617 +
2618 +Ответ:
2619 +
2620 +{
2621 + "name": "string", ~/~/ Определяет наименование
2622 + "description": "string", ~/~/ Определяет описание
2623 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2624 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2625 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2626 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2627 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2628 + "deleted": true ~/~/ Признак удаления
2629 +}
2630 +
2631 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2632 +
2633 +(% class="box successmessage" %)
2634 +(((
2635 +**POST /api/v3/Drivers**
2636 +)))
2637 +
2638 +Запрос:
2639 +
2640 +{
2641 + "name": "string",
2642 + "description": "string",
2643 + "hiredate": "2023-06-30T12:50:54.020Z",
2644 + "chopdate": "2023-06-30T12:50:54.020Z",
2645 + "exclusive": true,
2646 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2647 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2648 + "deleted": true
2649 +}
2650 +
2651 +Ответ:
2652 +
2653 +{
2654 + "name": "string",
2655 + "description": "string",
2656 + "hiredate": "2023-06-30T12:50:54.051Z",
2657 + "chopdate": "2023-06-30T12:50:54.051Z",
2658 + "exclusive": true,
2659 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2660 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2661 + "deleted": true
2662 +}
2663 +
2664 +
2665 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2666 +
2667 +(% class="box warningmessage" %)
2668 +(((
2669 +**PUT /api/v3/Drivers**
2670 +)))
2671 +
2672 +Запрос:
2673 +
2674 +{
2675 + "name": "string",
2676 + "description": "string",
2677 + "hiredate": "2023-06-30T12:50:27.910Z",
2678 + "chopdate": "2023-06-30T12:50:27.910Z",
2679 + "exclusive": true,
2680 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2681 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2682 + "deleted": true
2683 +}
2684 +
2685 +Ответ:
2686 +
2687 +{
2688 + "name": "string",
2689 + "description": "string",
2690 + "hiredate": "2023-06-30T12:50:27.929Z",
2691 + "chopdate": "2023-06-30T12:50:27.929Z",
2692 + "exclusive": true,
2693 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2694 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2695 + "deleted": true
2696 +}
2697 +
2698 +
2699 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2700 +
2701 +(% class="box errormessage" %)
2702 +(((
2703 +**DELETE /api/v3/Drivers/{driverGuid}**
2704 +)))
2705 +
2706 +Передается параметр: ID водителя
2707 +
2708 +Ответ:
2709 +
2710 +Success
2711 +
2712 +
2713 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2714 +
2715 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2716 +
2717 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2718 +
2719 +(% class="box infomessage" %)
2720 +(((
2721 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2722 +)))
2723 +
2724 +Запрос:
2725 +
2726 +{
2727 + "Ids": [
2728 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2729 + ],
2730 + "BeginTime": "2023-06-30T12:49:04.365Z",
2731 + "EndTime": "2023-06-30T12:49:04.365Z"
2732 +}
2733 +
2734 +Ответ:
2735 +
2736 +[
2737 + {
2738 + "VehicleId": 0,
2739 + "CreateTime": "2023-06-30T09:52:31.240Z",
2740 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2741 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2742 + "BeginTime": "2023-06-30T09:52:31.240Z",
2743 + "EndTime": "2023-06-30T09:52:31.240Z"
2744 + }
2745 +]
2746 +
2747 +
2748 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2749 +
2750 +(% class="box infomessage" %)
2751 +(((
2752 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2753 +)))
2754 +
2755 +Запрос:
2756 +
2757 +{
2758 + "Ids": [
2759 + 0
2760 + ],
2761 + "BeginTime": "2023-06-30T12:48:39.419Z",
2762 + "EndTime": "2023-06-30T12:48:39.419Z"
2763 +}
2764 +
2765 +Ответ:
2766 +
2767 +[
2768 + {
2769 + "VehicleId": 0,
2770 + "CreateTime": "2023-06-30T09:54:01.631Z",
2771 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2772 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2773 + "BeginTime": "2023-06-30T09:54:01.631Z",
2774 + "EndTime": "2023-06-30T09:54:01.631Z"
2775 + }
2776 +]
2777 +
2778 +
2779 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2780 +
2781 +(% class="box successmessage" %)
2782 +(((
2783 +**POST /api/v3/DriversVehiclesAssignments**
2784 +)))
2785 +
2786 +Передается массив назначений
2787 +
2788 +Запрос:
2789 +
2790 +[
2791 + {
2792 + "VehicleId": 0, ~/~/ Идентификатор объекта
2793 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2794 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2795 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2796 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2797 + }
2798 +]
2799 +
2800 +Ответ:
2801 +
2802 +[
2803 + {
2804 + "VehicleId": 0,
2805 + "CreateTime": "2023-06-30T11:04:46.903Z",
2806 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2807 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2808 + "BeginTime": "2023-06-30T11:04:46.903Z",
2809 + "EndTime": "2023-06-30T11:04:46.903Z"
2810 + }
2811 +]
2812 +
2813 +
2814 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2815 +
2816 +(% class="box warningmessage" %)
2817 +(((
2818 +**PUT /api/v3/DriversVehiclesAssignments**
2819 +)))
2820 +
2821 +Запрос:
2822 +
2823 +[
2824 + {
2825 + "VehicleId": 0,
2826 + "CreateTime": "2023-06-30T11:14:08.117Z",
2827 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2828 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2829 + "BeginTime": "2023-06-30T11:14:08.117Z",
2830 + "EndTime": "2023-06-30T11:14:08.117Z"
2831 + }
2832 +]
2833 +
2834 +Ответ:
2835 +
2836 +[
2837 + {
2838 + "VehicleId": 0,
2839 + "CreateTime": "2023-06-30T11:14:53.349Z",
2840 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2841 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2842 + "BeginTime": "2023-06-30T11:14:53.349Z",
2843 + "EndTime": "2023-06-30T11:14:53.349Z"
2844 + }
2845 +]
2846 +
2847 +
2848 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2849 +
2850 +(% class="box errormessage" %)
2851 +(((
2852 +**DELETE /api/v3/DriversVehiclesAssignments**
2853 +)))
2854 +
2855 +Запрос:
2856 +
2857 +[
2858 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2859 +]
2860 +
2861 +Ответ:
2862 +
2863 +Success
2864 +
2865 +
2866 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2867 +
2868 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2869 +
2870 +(% class="box infomessage" %)
2871 +(((
2872 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2873 +)))
2874 +
2875 +Запрос:
2876 +
2877 +{
2878 + "Ids": [
2879 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2880 + ],
2881 + "BeginTime": "2023-06-30T12:47:12.162Z",
2882 + "EndTime": "2023-06-30T12:47:12.162Z"
2883 +}
2884 +
2885 +Ответ:
2886 +
2887 +[
2888 + {
2889 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2890 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2891 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2892 + "BeginTime": "2023-06-30T11:19:40.703Z",
2893 + "EndTime": "2023-06-30T11:19:40.703Z"
2894 + }
2895 +]
2896 +
2897 +
2898 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2899 +
2900 +(% class="box infomessage" %)
2901 +(((
2902 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2903 +)))
2904 +
2905 +Запрос:
2906 +
2907 +{
2908 + "Ids": [
2909 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2910 + ],
2911 + "BeginTime": "2023-06-30T12:47:12.162Z",
2912 + "EndTime": "2023-06-30T12:47:12.162Z"
2913 +}
2914 +
2915 +Ответ:
2916 +
2917 +[
2918 + {
2919 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2920 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2921 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2922 + "BeginTime": "2023-06-30T11:19:40.703Z",
2923 + "EndTime": "2023-06-30T11:19:40.703Z"
2924 + }
2925 +]
2926 +
2927 +
2928 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2929 +
2930 +(% class="box successmessage" %)
2931 +(((
2932 +**POST /api/v3/DriversRfidsAssignments**
2933 +)))
2934 +
2935 +Запрос:
2936 +
2937 +[
2938 + {
2939 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2940 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2941 + "BeginTime": "2023-06-30T11:27:08.635Z",
2942 + "EndTime": "2023-06-30T11:27:08.635Z"
2943 + }
2944 +]
2945 +
2946 +Ответ:
2947 +
2948 +[
2949 + {
2950 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2951 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2952 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2953 + "BeginTime": "2023-06-30T11:27:08.677Z",
2954 + "EndTime": "2023-06-30T11:27:08.677Z"
2955 + }
2956 +]
2957 +
2958 +
2959 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2960 +
2961 +(% class="box warningmessage" %)
2962 +(((
2963 +**PUT /api/v3/DriversRfidsAssignments**
2964 +)))
2965 +
2966 +Запрос:
2967 +
2968 +[
2969 + {
2970 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2971 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2972 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2973 + "BeginTime": "2023-06-30T11:28:43.330Z",
2974 + "EndTime": "2023-06-30T11:28:43.330Z"
2975 + }
2976 +]
2977 +
2978 +Ответ:
2979 +
2980 +[
2981 + {
2982 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2983 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2984 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2985 + "BeginTime": "2023-06-30T11:28:43.331Z",
2986 + "EndTime": "2023-06-30T11:28:43.331Z"
2987 + }
2988 +]
2989 +
2990 +
2991 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2992 +
2993 +(% class="box errormessage" %)
2994 +(((
2995 +**DELETE /api/v3/DriversRfidsAssignments**
2996 +)))
2997 +
2998 +Запрос:
2999 +
3000 +[
3001 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3002 +]
3003 +
3004 +Ответ:
3005 +
3006 +Success
3007 +
3008 +
3009 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3010 +
3011 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3012 +
3013 +(% class="box infomessage" %)
3014 +(((
3015 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3016 +)))
3017 +
3018 +Запрос:
3019 +
3020 +{
3021 + "Ids": [
3022 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3023 + ],
3024 + "BeginTime": "2023-06-30T12:45:10.852Z",
3025 + "EndTime": "2023-06-30T12:45:10.852Z"
3026 +}
3027 +
3028 +Ответ:
3029 +
3030 +[
3031 + {
3032 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3033 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3034 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "BeginTime": "2023-06-30T11:58:04.695Z",
3036 + "EndTime": "2023-06-30T11:58:04.695Z"
3037 + }
3038 +]
3039 +
3040 +
3041 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3042 +
3043 +(% class="box infomessage" %)
3044 +(((
3045 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3046 +)))
3047 +
3048 +Запрос:
3049 +
3050 +{
3051 + "Ids": [
3052 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3053 + ],
3054 + "BeginTime": "2023-06-30T12:45:10.852Z",
3055 + "EndTime": "2023-06-30T12:45:10.852Z"
3056 +}
3057 +
3058 +Ответ:
3059 +
3060 +[
3061 + {
3062 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3063 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3064 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3065 + "BeginTime": "2023-06-30T11:58:04.695Z",
3066 + "EndTime": "2023-06-30T11:58:04.695Z"
3067 + }
3068 +]
3069 +
3070 +
3071 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3072 +
3073 +(% class="box successmessage" %)
3074 +(((
3075 +**POST /api/v3/DriversFuelCardsAssignments**
3076 +)))
3077 +
3078 +Запрос:
3079 +
3080 +[
3081 + {
3082 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 + "BeginTime": "2023-06-30T12:09:53.175Z",
3085 + "EndTime": "2023-06-30T12:09:53.175Z"
3086 + }
3087 +]
3088 +
3089 +Ответ:
3090 +
3091 +[
3092 + {
3093 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3094 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3095 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3096 + "BeginTime": "2023-06-30T12:09:53.201Z",
3097 + "EndTime": "2023-06-30T12:09:53.201Z"
3098 + }
3099 +]
3100 +
3101 +
3102 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3103 +
3104 +(% class="box warningmessage" %)
3105 +(((
3106 +**PUT /api/v3/DriversFuelCardsAssignments**
3107 +)))
3108 +
3109 +Запрос:
3110 +
3111 +[
3112 + {
3113 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3114 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3115 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3116 + "BeginTime": "2023-06-30T12:09:53.201Z",
3117 + "EndTime": "2023-06-30T12:09:53.201Z"
3118 + }
3119 +]
3120 +
3121 +Ответ:
3122 +
3123 +[
3124 + {
3125 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3126 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3127 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3128 + "BeginTime": "2023-06-30T12:09:53.201Z",
3129 + "EndTime": "2023-06-30T12:09:53.201Z"
3130 + }
3131 +]
3132 +
3133 +
3134 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3135 +
3136 +(% class="box errormessage" %)
3137 +(((
3138 +**DELETE /api/v3/DriversFuelCardsAssignments**
3139 +)))
3140 +
3141 +Запрос:
3142 +
3143 +[
3144 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3145 +]
3146 +
3147 +Ответ:
3148 +
3149 +Success
3150 +
3151 +
3152 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3153 +
3154 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3155 +
3156 +(% class="box infomessage" %)
3157 +(((
3158 +**POST /api/v3/Trailers**
3159 +)))
3160 +
3161 +Пример запроса:
3162 +
3163 +{
3164 + "startDate": "2023-11-14T10:48:03.671Z",
3165 + "endDate": "2023-11-14T10:48:03.671Z",
3166 + "ids": [ 0 ],
3167 + "timezone": 0
3168 +}
3169 +
3170 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3171 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3172 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3173 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3174 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3175 +
3176 +Пример ответа:
3177 +
3178 +[
3179 + {
3180 + "SD": "2023-11-14T10:48:03.717Z",
3181 + "ED": "2023-11-14T10:48:03.717Z", 
3182 + "id": 0,
3183 + "SLat": 0,
3184 + "SLon": 0,
3185 + "ELat": 0,
3186 + "ELon": 0,
3187 + "mileage": 0
3188 + "Duration": 0
3189 + "Address": "string",
3190 + "Address2": "string",
3191 + "name": "string",
3192 + "rid": "string",
3193 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3194 + "trailer": {
3195 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3196 + "Number": "string",
3197 + "Description": "string",
3198 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3199 + "ExternalID": "string",
3200 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3201 + "CreateTime": "2023-11-14T10:48:03.717Z",
3202 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3203 + "IsDeleted": true
3204 + },
3205 + "filesCount": 0,
3206 + }
3207 +]
3208 +
3209 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3210 +|SD|Дата и время начала события
3211 +|ED|Дата и время окончания события
3212 +|id|ID объекта
3213 +|SLat|Широта начальной координаты
3214 +|SLon|Долгота начальной координаты
3215 +|ELat|Широта конечной координаты
3216 +|ELon|Долгота конечной координаты
3217 +|mileage|Пробег
3218 +|Duration|Продолжительность
3219 +|Address|Адрес начального местоположения
3220 +|Address2|Адрес конечного местоположения
3221 +|name|Имя радиометки
3222 +|rid|Номер радиометки
3223 +|rguid|ID радиометки
3224 +|trailer|Информация об агрегате
3225 +|ModelGuid|ID агрегата
3226 +|Number|Название/номер агрегата
3227 +|Description|Текст примечания агрегата
3228 +
3229 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3230 +
3231 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3232 +
3233 +(% class="box infomessage" %)
3234 +(((
3235 +**POST /api/v3/Rfids/find**
3236 +)))
3237 +
3238 +Запрос:
3239 +
3240 +{
3241 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3242 +}
3243 +
3244 +Ответ:
3245 +
3246 +[
3247 + {
3248 + "name": "string",
3249 + "number": 0,
3250 + "period": 0,
3251 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3252 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3253 + }
3254 +]
3255 +
3256 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3257 +|parentId|ID клиента
3258 +|name|Название карты-метки
3259 +|number|Номер
3260 +|period|Период запросов в секундах (работает только для агрегатов)
3261 +|id|ID карты-метки
3262 +
3263 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3264 +
3265 +(% class="box infomessage" %)
3266 +(((
3267 +**GET /api/v3/Rfids/{rfidGuid}**
3268 +)))
3269 +
3270 +Передаем параметр rfidGuid - идентификатор карты-метки
3271 +
3272 +Ответ:
3273 +
3274 +[
3275 + {
3276 + "name": "string",
3277 + "number": 0,
3278 + "period": 0,
3279 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3280 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3281 + }
3282 +]
3283 +
3284 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3285 +|name|Название карты-метки
3286 +|number|Номер
3287 +|period|Период запросов в секундах (работает только для агрегатов)
3288 +|id|ID карты-метки
3289 +|parentId|ID клиента
3290 +
3291 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3292 +
3293 +(% class="box successmessage" %)
3294 +(((
3295 +**POST /api/v3/Rfids**
3296 +)))
3297 +
3298 +Запрос:
3299 +
3300 +{
3301 + "name": "string",
3302 + "number": 0,
3303 + "period": 0,
3304 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3305 +}
3306 +
3307 +Ответ:
3308 +
3309 +{
3310 + "name": "string",
3311 + "number": 0,
3312 + "period": 0,
3313 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3314 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 +}
3316 +
3317 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3318 +|name|Название карты-метки
3319 +|number|Номер
3320 +|period|Период запросов в секундах (работает только для агрегатов)
3321 +|id|ID карты-метки
3322 +|parentId|ID клиента
3323 +
3324 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3325 +
3326 +(% class="box warningmessage" %)
3327 +(((
3328 +**PUT /api/v3/Rfids**
3329 +)))
3330 +
3331 +Запрос:
3332 +
3333 +{
3334 + "name": "string",
3335 + "number": 0,
3336 + "period": 0,
3337 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3338 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3339 +}
3340 +
3341 +Ответ:
3342 +
3343 +{
3344 + "name": "string",
3345 + "number": 0,
3346 + "period": 0,
3347 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3348 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3349 +}
3350 +
3351 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3352 +|name|Название карты-метки
3353 +|number|Номер
3354 +|period|Период запросов в секундах (работает только для агрегатов)
3355 +|id|ID карты-метки
3356 +|parentId|ID клиента
3357 +
3358 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3359 +
3360 +(% class="box errormessage" %)
3361 +(((
3362 +**DELETE /api/v3/Rfids/{rfidGuid}**
3363 +)))
3364 +
3365 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3366 +
3367 +Ответ:
3368 +
3369 +Success
3370 +
3371 +
3372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3373 +
3374 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3375 +
3376 +(% class="box infomessage" %)
3377 +(((
3378 +**GET /api/v3/Billing/client/balance/{clientId}**
3379 +)))
3380 +
3381 +Параметр запроса: **clientId **- идентификатор клиента.
3382 +
3383 +Ответ:
3384 +
3385 +{
3386 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3387 + "Balance": 0
3388 +}
3389 +
3390 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3391 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3392 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3393 +
3394 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3395 +
3396 +(% class="box infomessage" %)
3397 +(((
3398 +**GET /api/v3/Billing/client/constraint/{clientId}**
3399 +)))
3400 +
3401 +Параметр запроса: **clientId **- идентификатор клиента.
3402 +
3403 +Ответ:
3404 +
3405 +{
3406 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3407 + "CalculationType": 0,
3408 + "PermissibleBalance": 0,
3409 + "DefermentDays": 0,
3410 + "SendUiNotifications": true,
3411 + "SendEmailNotifications": true,
3412 + "IsPrivate": true,
3413 +}
3414 +
3415 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3416 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3417 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3418 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3419 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3420 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3421 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3422 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3423 +
3424 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3425 +
3426 +(% class="box infomessage" %)
3427 +(((
3428 +**GET /api/v3/Billing/client/plan/{clientId}**
3429 +)))
3430 +
3431 +Параметры запроса:
3432 +
3433 +**clientId **- идентификатор клиента.
3434 +
3435 +**planId **- идентификатор тарифного плана.
3436 +
3437 +Ответ:
3438 +
3439 +{
3440 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3441 + "Plan": { **~/~/ Описание тарифного плана**
3442 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3443 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3444 + "Name": "string",
3445 + "IsArchived": true,
3446 + "Constraint": {
3447 + "CalculationType": 0,
3448 + "PermissibleBalance": 0,
3449 + "DefermentDays": 0
3450 + },
3451 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3452 + {
3453 + "Feature": "string",
3454 + "IsFactual": true,
3455 + "Limit": 0,
3456 + "Price": 0,
3457 + "PeriodValue": 0,
3458 + "PeriodType": 0
3459 + }
3460 + ]
3461 + },
3462 + "DebitDate": "2023-10-18T12:46:24.213Z",
3463 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3464 + {
3465 + "Feature": "string",
3466 + "IsEnabled": true,
3467 + "IsPrivate": true,
3468 + "IsFactual": true,
3469 + "Limit": 0,
3470 + "Price": 0,
3471 + "DebitDate": "2023-10-18T12:46:24.213Z",
3472 + "PeriodValue": 0,
3473 + "PeriodType": 0
3474 + }
3475 + ]
3476 +}
3477 +
3478 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3479 +|ClientId|Идентификатор клиента
3480 +|Id|Идентификатор тарифного плана
3481 +|OwnerId|Идентификатор клиента-владельца
3482 +|Name|Наименование тарифного плана
3483 +|IsArchived|Признак, определяющий архивный тарифный план
3484 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3485 +|PermissibleBalance|Допустимый баланс
3486 +|DefermentDays|Отсрочка, количество дней
3487 +|Feature|Код услуги
3488 +|IsEnabled|Признак, определяющий активирована ли услуга
3489 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3490 +|IsFactual|Признак, определяющий расчёт по факту
3491 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3492 +|Price|Цена за единицу.
3493 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3494 +|PeriodValue|Значение периода.
3495 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3496 +
3497 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3498 +
3499 +(% class="box infomessage" %)
3500 +(((
3501 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3502 +)))
3503 +
3504 +Параметр запроса: **clientId **- идентификатор клиента.
3505 +
3506 +Ответ:
3507 +
3508 +[
3509 + {
3510 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3511 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3512 + "Name": "string",
3513 + "IsArchived": true,
3514 + "Constraint": {
3515 + "CalculationType": 0,
3516 + "PermissibleBalance": 0,
3517 + "DefermentDays": 0
3518 + },
3519 + "Features": [
3520 + {
3521 + "Feature": "string",
3522 + "IsFactual": true,
3523 + "Limit": 0,
3524 + "Price": 0,
3525 + "PeriodValue": 0,
3526 + "PeriodType": 0
3527 + }
3528 + ]
3529 + }
3530 +]
3531 +
3532 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3533 +|ClientId|Идентификатор клиента
3534 +|Id|Идентификатор тарифного плана
3535 +|OwnerId|Идентификатор клиента-владельца
3536 +|Name|Наименование тарифного плана
3537 +|IsArchived|Признак, определяющий архивный тарифный план
3538 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3539 +|PermissibleBalance|Допустимый баланс
3540 +|DefermentDays|Отсрочка, количество дней
3541 +|Feature|Код услуги
3542 +|IsFactual|Признак, определяющий расчёт по факту
3543 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3544 +|Price|Цена за единицу.
3545 +|PeriodValue|Значение периода.
3546 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3547 +
3548 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3549 +
3550 +(% class="box infomessage" %)
3551 +(((
3552 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3553 +)))
3554 +
3555 +Параметр запроса: **clientId **- идентификатор клиента.
3556 +
3557 +Ответ:
3558 +
3559 +[
3560 + {
3561 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3562 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3563 + "Name": "string",
3564 + "IsArchived": true,
3565 + "Constraint": {
3566 + "CalculationType": 0,
3567 + "PermissibleBalance": 0,
3568 + "DefermentDays": 0
3569 + },
3570 + "Features": [
3571 + {
3572 + "Feature": "string",
3573 + "IsFactual": true,
3574 + "Limit": 0,
3575 + "Price": 0,
3576 + "PeriodValue": 0,
3577 + "PeriodType": 0
3578 + }
3579 + ]
3580 + }
3581 +]
3582 +
3583 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3584 +|ClientId|Идентификатор клиента
3585 +|Id|Идентификатор тарифного плана
3586 +|OwnerId|Идентификатор клиента-владельца
3587 +|Name|Наименование тарифного плана
3588 +|IsArchived|Признак, определяющий архивный тарифный план
3589 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3590 +|PermissibleBalance|Допустимый баланс
3591 +|DefermentDays|Отсрочка, количество дней
3592 +|Feature|Код услуги
3593 +|IsFactual|Признак, определяющий расчёт по факту
3594 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3595 +|Price|Цена за единицу.
3596 +|PeriodValue|Значение периода.
3597 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3598 +
3599 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3600 +
3601 +(% class="box warningmessage" %)
3602 +(((
3603 +**PUT /api/v3/Billing/client/balance**
3604 +)))
3605 +
3606 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3607 +
3608 +Тело запроса:
3609 +
3610 +{
3611 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3612 + "Balance": 0
3613 +}
3614 +
3615 +Ответ: Success
3616 +
3617 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3618 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3619 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3620 +
3621 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3622 +
3623 +(% class="box warningmessage" %)
3624 +(((
3625 +**PUT /api/v3/billing/client/balance/deposit**
3626 +)))
3627 +
3628 +Создает операцию **Пополнение **с указанной суммой
3629 +
3630 +Тело запроса:
3631 +
3632 +{
3633 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3634 + "Balance": 0
3635 +}
3636 +
3637 +Ответ: Success
3638 +
3639 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3640 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3641 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3642 +
3643 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3644 +
3645 +Создает операцию **Списание **с указанной суммой
3646 +
3647 +(% class="box warningmessage" %)
3648 +(((
3649 +**PUT /api/v3/billing/client/balance/withdraw**
3650 +)))
3651 +
3652 +Тело запроса:
3653 +
3654 +{
3655 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3656 + "Balance": 0
3657 +}
3658 +
3659 +Ответ: Success
3660 +
3661 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3662 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3663 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3664 +
3665 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3666 +
3667 +(% class="box warningmessage" %)
3668 +(((
3669 +**PUT /api/v3/Billing/client/constraint**
3670 +)))
3671 +
3672 +Тело запроса:
3673 +
3674 +{
3675 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3676 + "CalculationType": 0,
3677 + "PermissibleBalance": 0,
3678 + "DefermentDays": 0,
3679 + "SendUiNotifications": true,
3680 + "SendEmailNotifications": true,
3681 + "IsPrivate": true,
3682 +}
3683 +
3684 +Ответ: Success
3685 +
3686 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3687 +|ClientId|Идентификатор клиента
3688 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3689 +|PermissibleBalance|Допустимый баланс
3690 +|DefermentDays|(((
3691 +Отсрочка, количество дней
3692 +)))
3693 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3694 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3695 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3696 +
3697 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3698 +
3699 +(% class="box warningmessage" %)
3700 +(((
3701 +**PUT /api/v3/Billing/client/plan**
3702 +)))
3703 +
3704 +Тело запроса:
3705 +
3706 +{
3707 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3708 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3709 + "Features": [
3710 + {
3711 + "Feature": "string",
3712 + "IsEnabled": true,
3713 + "IsFactual": true,
3714 + "Limit": 0,
3715 + "Price": 0,
3716 + "DebitDate": "2023-10-18T13:26:58.987Z",
3717 + "PeriodValue": 0,
3718 + "PeriodType": 0
3719 + }
3720 + ]
3721 +}
3722 +
3723 +Ответ: Success
3724 +
3725 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3726 +|ClientId|Идентификатор клиента
3727 +|PlanId|Идентификатор тарифного плана
3728 +|Feature|Код услуги
3729 +|IsEnabled|Признак, определяющий активирована ли услуга
3730 +|IsFactual|Признак, определяющий расчёт по факту
3731 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3732 +|Price|Цена за единицу.
3733 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3734 +|PeriodValue|Значение периода.
3735 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3736 +
3737 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3738 +
3739 +(% class="box warningmessage" %)
3740 +(((
3741 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3742 +)))
3743 +
3744 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3745 +
3746 +(% class="box infomessage" %)
3747 +(((
3748 +**POST /api/v3/vehicles/import/{agentId}**
3749 +)))
3750 +
3751 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3752 +
3753 +В пути указывается **agentId** - id клиента.
3754 +
3755 +**Заголовок**
3756 +
3757 +**X-Auth: [токен авторизации]**
3758 +
3759 +**Параметры**
3760 +
3761 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3762 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3763 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3764 +
3765 +В теле использовать тип **form-data,** тип значения** file**
3766 +
3767 +**Ключи**
3768 +
3769 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3770 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3771 +|csv|В значении передаем файл датчиков, формат **csv**
3772 +
3773 +Ответ:
3774 +
3775 +{
3776 + "vehicleId": 0,
3777 + "name": "string",
3778 + "errors": ["string"]
3779 +}
3780 +
3781 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 +|vehicleId|ID созданного объекта
3783 +|name|Имя созданного объекта
3784 +|errors|Ошибки и их описание
3785 +
3786 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3787 +
3788 +(% class="box infomessage" %)
3789 +(((
3790 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3791 +)))
3792 +
3793 +(% class="wikigeneratedid" %)
3794 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3795 +
3796 +(% class="wikigeneratedid" %)
3797 +В пути указывается **vehicleId **- id объекта.
3798 +
3799 +**Заголовок**
3800 +
3801 +**X-Auth: [токен авторизации]**
3802 +
3803 +В теле использовать тип **form-data.**
3804 +
3805 +Ключи:
3806 +
3807 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3808 +|**history**|В значении передавать файл с историей
3809 +
3810 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3811 +
3812 +Ответ:
3813 +
3814 +{
3815 + "results": [
3816 + {
3817 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 + "vehicleId": 0,
3819 + "errors": [
3820 + "string"
3821 + ],
3822 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3823 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3824 + "producedCount": 0,
3825 + "msgCount": 0
3826 + }
3827 + ]
3828 +}
3829 +
3830 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3831 +|results|Результаты импорта в разрезе ТС
3832 +|vehicleGuid|Guid ТС
3833 +|vehicleId|ID ТС
3834 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3835 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3836 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3837 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3838 +|msgCount|Кол-во обработанных сообщений всего
3839 +
3840 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3841 +
3842 +(% class="box infomessage" %)
3843 +(((
3844 +**GET /api/v3/vehicles/import/history/status**
3845 +)))
3846 +
3847 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3848 +
3849 +Ответ:
3850 +
3851 +{
3852 + "activity": true,
3853 + "progress": 0,
3854 + "message": "string"
3855 +}
3856 +
3857 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3858 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3859 +|progress|Guid ТС
3860 +
3861 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3862 +
3863 +(% class="box infomessage" %)
3864 +(((
3865 +**POST /api/v3/vehicles/export**
3866 +)))
3867 +
3868 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3869 +
3870 +Тело запроса:
3871 +
3872 +[
3873 + id
3874 +]
3875 +
3876 +Ответ: Success 200, получаете файлы с настройками.
3877 +
3878 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3879 +
3880 +(% class="box infomessage" %)
3881 +(((
3882 +**POST /api/v3/vehicles/export/history**
3883 +)))
3884 +
3885 +Метод возвращает список сообщений терминала объекта за выбранный период.
3886 +
3887 +Тело запроса:
3888 +
3889 +{
3890 + "vehicleId": 0,
3891 + "asArchive": true,
3892 + "from": "2023-09-27T12:17:45.973Z",
3893 + "to": "2023-09-27T12:17:45.973Z"
3894 +}
3895 +
3896 +Ответ:
3897 +
3898 +Получаете файл. Сообщение: Code 200/Success
3899 +
3900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3901 +|vehicleId|ID объекта
3902 +|asArchive|true - Архивировать файл, False - не архивировать
3903 +|from|Дата и время начала запроса
3904 +|to|Дата и время окончания запроса
3905 +
3906 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3907 +
3908 +(% class="box infomessage" %)
3909 +(((
3910 +**GET /api/v3/vehicles/export/history/status**
3911 +)))
3912 +
3913 +Метод возвращает список сообщений терминала объекта за выбранный период.
3914 +
3915 +Ответ:
3916 +
3917 +{
3918 + "activity": true,
3919 + "progress": 0,
3920 + "message": "string"
3921 +}
3922 +
3923 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3924 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3925 +|progress|Прогресс экспорта, от 0 до 100%
3926 +|message|Текст описывающий статус
3927 +
3928 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3929 +
3930 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3931 +
3932 +(% class="box infomessage" %)
3933 +(((
3934 +**POST /api/v3/EcoDriving/rating**
3935 +)))
3936 +
3937 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3938 +
3939 +Тело запроса:
3940 +
3941 +{
3942 + "vehicleIds": [vehicleId],
3943 + "from": "2023-11-22T09:29:48.051Z",
3944 + "to": "2023-11-22T09:29:48.051Z"
3945 +}
3946 +
3947 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3948 +|vehicleIds|Массив ID объектов
3949 +|from|Дата начала запроса
3950 +|to|Дата окончания запроса
3951 +
3952 +Ответ:
3953 +
3954 +{
3955 + "items": [
3956 + {
3957 + "from": "2023-11-22T09:29:48.052Z",
3958 + "to": "2023-11-22T09:29:48.052Z",
3959 + "vehicleId": 0,
3960 + "vehicleName": "string",
3961 + "vehicleModel": "string",
3962 + "penalty": 0,
3963 + "score": 0,
3964 + "totalViolations": 0,
3965 + "violationsByType": {
3966 + "overspeedingViolations": 0,
3967 + "accelerationViolations": 0,
3968 + "brakingViolations": 0,
3969 + "turningViolations": 0,
3970 + "dangerousDrivingViolations": 0,
3971 + "sensorViolations": 0
3972 + },
3973 + "moveTime": 0,
3974 + "mileage": 0,
3975 + "tripsCount": 0,
3976 + "trips": [
3977 + {
3978 + "penalty": 0,
3979 + "score": 0,
3980 + "violationsCount": 0,
3981 + "violationsByType": {
3982 + "overspeedingViolations": 0,
3983 + "accelerationViolations": 0,
3984 + "brakingViolations": 0,
3985 + "turningViolations": 0,
3986 + "dangerousDrivingViolations": 0,
3987 + "sensorViolations": 0
3988 + },
3989 + "moveTime": 0,
3990 + "mileage": 0,
3991 + "motohours": 0,
3992 + "maxSpeed": 0,
3993 + "startAddress": "string",
3994 + "endAddress": "string",
3995 + "drivers": [
3996 + {
3997 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3998 + "driverName": "string",
3999 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4000 + }
4001 + ]
4002 + }
4003 + ]
4004 + }
4005 + ]
4006 +}
4007 +
4008 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4009 +|from|Дата начала запроса
4010 +|to|Дата  окончания
4011 +|vehicleId|ID объекта
4012 +|vehicleName|Имя объекта
4013 +|vehicleModel|Модель объекта
4014 +|penalty|Сумма штрафных баллов
4015 +|score|Оценка
4016 +|totalViolations|Суммарное количество нарушений
4017 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4018 +|overspeedingViolations|Превышение скорости
4019 +|accelerationViolations|Ускорение
4020 +|brakingViolations|Торможение
4021 +|turningViolations|Резкий поворот
4022 +|dangerousDrivingViolations|Резкое вождение
4023 +|sensorViolations|Нарушение по датчику
4024 +|moveTime|Время в движении
4025 +|mileage|Пробег (км)
4026 +|tripsCount|Количество рейсов
4027 +|motohours|Моточасы
4028 +|maxSpeed|Максимальная скорость
4029 +|startAddress|Адрес начала рейса
4030 +|endAddress|Адрес окончания рейса
4031 +|drivers|Список водителей, которые были на объекте в течениии рейса
4032 +|driverGuid|Guid водителя
4033 +|driverName|Имя водителя
4034 +|driverRfid|Номер Карты-метки
4035 +
4036 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4037 +
4038 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4039 +
4040 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4041 +
4042 +(% class="box infomessage" %)
4043 +(((
4044 +POST /api/v3/fuelcards/transactions
4045 +)))
4046 +
4047 +Метод запроса: POST
4048 +
4049 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4050 +\\В заголовках запроса: X-Auth: Токен авторизации
4051 +
4052 +Параметры в теле запроса (JSON):
4053 +
4054 +{
4055 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4056 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4057 + "ids": [ 
4058 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4059 + ],
4060 + "timezone": 0 ~/~/Таймзона
4061 +}
4062 +
4063 +
4064 +Ответ:
4065 + {
4066 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4067 + "driver": "string", ~/~/Водители, привязанные к ТК
4068 + "object": "string", ~/~/Наименование ТС
4069 + "amount": 0, ~/~/Количество топлива
4070 + "amountDut": 0, ~/~/Количество по ДУТ
4071 + "amountDiff": 0, ~/~/Разница, л
4072 + "amountDiffPerc": 0, ~/~/Разница, %
4073 + "summa": 0, ~/~/Стоимость, руб
4074 + "serviceName": "string", ~/~/Тип топлива
4075 + "price": 0, ~/~/Цена за литр, руб
4076 + "cardName": "string", ~/~/Наименование ТК
4077 + "cardNum": "string", ~/~/Номер ТК
4078 + "operator": "string", ~/~/Оператор ТК
4079 + "address": "string" ~/~/Адрес АЗС
4080 + }
4081 +
4082 +
4083 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4084 +
4085 +
4086 +== **Получение полных данных о ретрансляторе** ==
4087 +
4088 +(% class="box infomessage" %)
4089 +(((
4090 +**GET ** **/api/v3/retranslations/{id}**
4091 +)))
4092 +
4093 +Идентификатор запроса: ID
4094 +
4095 +
4096 +Пример ответа:
4097 +
4098 +{  
4099 +"description": "", ~/~/ Определяет описание
4100 +"subscriberId": "", ~/~/ Подписчик
4101 +"protocolType": 0, ~/~/ Тип протокола
4102 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4103 +"address": "string", ~/~/ Адрес события
4104 +"objects": [ ~/~/Объекты для ретрансляции
4105 +{      
4106 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4107 +"name": "", ~/~/ Наименование объекта ретрансляции
4108 +"imei": "", ~/~/ IMEI объекта  
4109 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4110 +}
4111 + ],  
4112 +"id": "", ~/~/ идентификатор пользователя   
4113 +"parentId": "", ~/~/Guid родителя
4114 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4115 +}
4116 +
4117 +
4118 +== **Удаление данных ретранслятора** ==
4119 +
4120 +(% class="box infomessage" %)
4121 +(((
4122 +**DELETE** **/api/v3/retranslations/{id}**
4123 +)))
4124 +
4125 +Параметр запроса: ID
4126 +
4127 +
4128 +== **Создание ретранслятора** ==
4129 +
4130 +(% class="box infomessage" %)
4131 +(((
4132 +**POST ** **/api/v3/retranslations/{id}**
4133 +)))
4134 +
4135 +Запрос:
4136 +
4137 +{  
4138 +"description": "", ~/~/ Описание
4139 +"subscriberId": "", ~/~/ Подписчик
4140 +"protocolType": 0, ~/~/ Тип протокола
4141 +"address": "", ~/~/ Адрес ретрансляции
4142 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4143 +"objects": [ ~/~/Объекты для ретрансляции
4144 +{      
4145 +"id": "", ~/~/ идентификатор пользователя     
4146 +"imei": "", ~/~/IMEI объекта
4147 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4148 +}
4149 + ]
4150 +}
4151 +
4152 +
4153 +Ответ:
4154 +
4155 +{  
4156 +"description": "string", ~/~/ Определяет описание
4157 +"subscriberId": "", ~/~/ идентификатор запроса
4158 +"protocolType": 0, ~/~/ Тип протокола
4159 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4160 +"address": "", ~/~/ Адрес события
4161 +"objects": [ ~/~/Объекты для ретрансляции
4162 +{      
4163 +"id": "", ~/~/ идентификатор пользователя    
4164 +"name": "string", ~/~/ Название уведомления
4165 +"imei": "string", ~/~/IMEI объекта  
4166 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4167 +}
4168 + ],  
4169 +"id": "", ~/~/ идентификатор пользователя  
4170 +"parentId": "", ~/~/ Guid идентификатор родителя
4171 +"deleted": true ~/~/ Признак удаления
4172 +}
4173 +
4174 +
4175 +== **Редактирование ретранслятора** ==
4176 +
4177 +(% class="box infomessage" %)
4178 +(((
4179 +**PUT** **/api/v3/retranslations**
4180 +)))
4181 +
4182 +Пример запроса:
4183 +
4184 +{  
4185 +"id": "", ~/~/ идентификатор пользователя   
4186 +"description": "string", ~/~/ Определяет описание
4187 +"subscriberId": "", ~/~/ идентификатор запроса
4188 +"protocolType": 0, ~/~/ Тип протокола
4189 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4190 +"address": "string", ~/~/ Адрес события
4191 +"objects": ~/~/Объекты для ретрансляции
4192 +[    
4193 +{      
4194 +"id": "",  ~/~/ идентификатор пользователя         
4195 +"imei": "", ~/~/IMEI объекта
4196 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4197 +}
4198 + ]
4199 +}
4200 +
4201 +
4202 +Пример ответа:
4203 +
4204 +{  
4205 +"description": "", ~/~/ Определяет описание
4206 +"subscriberId": "", ~/~/ идентификатор запроса
4207 +"protocolType": 0, ~/~/ Тип протокола
4208 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4209 +"address": "string", ~/~/ Адрес события
4210 +"objects": [ ~/~/Объекты для ретрансляции
4211 +{      
4212 +"id": "", ~/~/ идентификатор пользователя     
4213 +"name": "string", ~/~/ Название уведомления    
4214 +"imei": "", ~/~/IMEI объекта
4215 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4216 +}
4217 + ],
4218 +"id": "", ~/~/ идентификатор пользователя   
4219 +"parentId": "", ~/~/ Guid идентификатор родителя
4220 +"deleted": true ~/~/ Признак удаления
4221 +}
4222 +
4223 +
4224 +== **Получение списка ретранслятора клиента** ==
4225 +
4226 +(% class="box infomessage" %)
4227 +(((
4228 +**POST /api/v3/retranslations/find**
4229 +)))
4230 +
4231 +Пример запроса:
4232 +
4233 +{  
4234 +"id": "", ~/~/ идентификатор пользователя   
4235 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4236 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4237 +}
4238 +
4239 +Ответ:
4240 +
4241 +[ 
4242 +{    
4243 +"description": "", ~/~/ Определяет описание
4244 +"subscriberId": "", ~/~/ идентификатор запроса
4245 +"protocolType": 0, ~/~/ Тип протокола
4246 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4247 +"address": "string", ~/~/ Адрес события
4248 +"id": "", ~/~/ идентификатор пользователя   
4249 +"parentId": "", ~/~/ Guid идентификатор родителя
4250 +"deleted": true ~/~/ Признак удаления
4251 +}
4252 +]
4253 +
4254 +
4255 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4256 +
4257 +== **API для отчета по выгрузке комбайнов** ==
4258 +
4259 +(% class="box infomessage" %)
4260 +(((
4261 +POST **/api/v3/Reports/harvesterUnloading**
4262 +)))
4263 +
4264 +Пример запроса:
4265 +
4266 +{
4267 + "byTime": 0, ~/~/ Объединение событий по времени
4268 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4269 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4270 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4271 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4272 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4273 + 0
4274 + ],
4275 + "from": "", ~/~/ Дата и время начало запроса
4276 + "to": "", ~/~/ Дата и время окончания запроса
4277 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4278 +}
4279 +
4280 +Пример ответа:
4281 +
4282 +[ 
4283 + {
4284 + "harvesterName": "", ~/~/Комбайн, номер
4285 + "harvesterId": 0, ~/~/Комбайн, id
4286 +"harvesterModel": "", ~/~/ Модель комбайна
4287 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4288 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4289 + "events": [ ~/~/Список событий в разрезе комбайна
4290 + {
4291 + "driverId": "", ~/~/Идентификатор водителя
4292 + "driverName": "", ~/~/Водитель комбайна, ФИО
4293 + "RFID": "", ~/~/ идентификатор карты-метки
4294 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4295 + "vehicleId": 0, ~/~/идентификатор объекта
4296 + "vehicleName": "string", ~/~/ Имя объекта
4297 + "modelName": "string", ~/~/ Имя модели объекта
4298 + "nearestVehicles": [ ~/~/Объекты рядом
4299 + {
4300 + "vehicleId": 0, ~/~/идентификатор объекта
4301 + "vehicleName": "string" ~/~/ Имя объекта
4302 + }
4303 + ],
4304 + "fields": [ ~/~/Поля, где происходила выгрузка
4305 + {
4306 + "id": 0, ~/~/ идентификатор пользователя 
4307 + "name": "string" ~/~/ имя пользователя 
4308 + }
4309 + ],
4310 + "event": "string", ~/~/Событие
4311 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4312 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4313 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4314 + "cultureName": "string", ~/~/ название культуры
4315 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4316 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4317 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4318 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4319 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4320 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4321 + "issued": 0, ~/~/Выдано, бункеров
4322 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4323 + "latitude": 0, ~/~/Широта
4324 + "longitude": 0, ~/~/ Долгота
4325 + "litresAway": 0, ~/~/Отдано, л
4326 + "m3Away": 0 ~/~/Отдано, м3
4327 + }
4328 + ]
4329 + }
4330 +]
4331 +
4332 +
4333 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4334 +
4335 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4336 +
4337 +
4338 +(% class="box infomessage" %)
4339 +(((
4340 +GET api/v3/Vehicles/recyclebin/all
4341 +)))
4342 +
4343 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4344 +
4345 +Параметр запроса: {parentId} - идентификатор агента
4346 +
4347 +В заголовках запроса: X-Auth: Токен авторизации
4348 +
4349 +Ответ:
4350 +
4351 +[ 
4352 + {
4353 + "recordTime": "", ~/~/Время записи
4354 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4355 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4356 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4357 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4358 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4359 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4360 + "items": [ ~/~/ 
4361 +nullable: true ~/~/Детали
4362 + {
4363 + "name": "string", ~/~/наименование столбца
4364 + "value": "string" ~/~/содержание столбца
4365 + }
4366 + ]
4367 + },
4368 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4369 + "string"
4370 + ]
4371 + }
4372 +]
4373 +
4374 +
4375 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4376 +
4377 +(% class="box infomessage" %)
4378 +(((
4379 +POST/api/v3/Vehicles/recyclebin/erase
4380 +)))
4381 +
4382 +В заголовках запроса: X-Auth: Токен авторизации
4383 +
4384 +Пример запроса:
4385 +
4386 +[
4387 +0
4388 +]
4389 +
4390 +
4391 +Пример ответа:
4392 +
4393 +[ 
4394 +{
4395 + "recordTime": "", ~/~/Время записи
4396 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4397 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4398 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4399 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4400 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4401 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4402 + "items": [ ~/~/Детали
4403 + {
4404 + "name": "", ~/~/Имя свойства
4405 + "value": "" ~/~/Значение свойства
4406 + }
4407 + ]
4408 + },
4409 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4410 + ""
4411 + ]
4412 + }
4413 +]
4414 +
4415 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4416 +
4417 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4418 +
4419 +(% class="box infomessage" %)
4420 +(((
4421 +POST/api/v3/Vehicles/recyclebin/restore
4422 +)))
4423 +
4424 +В заголовках запроса: X-Auth: Токен авторизации
4425 +
4426 +Параметры в теле запроса (JSON):
4427 +
4428 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4429 +
4430 +В заголовках запроса: X-Auth: Токен авторизации
4431 +
4432 +
4433 +Пример запроса:
4434 +
4435 +(((
4436 +[
4437 +)))
4438 +
4439 +(((
4440 + 0
4441 +)))
4442 +
4443 +(((
4444 +]
4445 +)))
4446 +
4447 +
4448 +Пример ответа:
4449 +
4450 +[
4451 +{
4452 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4453 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4454 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4455 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4456 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4457 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4458 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4459 + "items": [ ~/~/Детали
4460 + {
4461 + "name": "string", ~/~/Имя свойства
4462 + "value": "string" ~/~/Значение свойства
4463 + }
4464 + ]
4465 + },
4466 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4467 + "string"
4468 + ]
4469 + }
4470 +]
4471 +
4472 +
4473 +
1149 1149  (% class="box" lang="en-US" style="text-align: center;" %)
1150 1150  (((
1151 1151  (% 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 г.