<
From version < 66.10 >
edited by Илья Крайнов
on 2022/11/24 13:35
To version < 180.1 >
edited by Андрей Калиновский
on 2024/11/14 16:13
>
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,25 +1,35 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -= Описание ГЛОНАССSoft Public API 3.0 =
2 +(((
3 +**Содержание страницы:**
4 +)))
3 3  
4 -
5 5  {{toc/}}
6 6  
7 7  
8 8  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
9 9  
10 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 11  
12 12  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 13  
14 14  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
15 15  
16 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 17  
19 +
20 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
21 +
22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23 +
18 18  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
19 19  
20 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
26 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
27 +(((
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/]] или другие)
30 +)))
21 21  
22 -(% class="box infomessage" %)
32 +(% class="box successmessage" %)
23 23  (((
24 24  (% lang="en-US" %)**POST /api/v3/auth/login**
25 25  )))
... ... @@ -30,7 +30,7 @@
30 30  
31 31  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 32  
33 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
43 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 34  
35 35  (% style="color:#000000" %)Параметры в теле запроса (JSON):
36 36  
... ... @@ -37,23 +37,27 @@
37 37  (% style="color:#000000" %){
38 38   "login": "testuser",
39 39   "password": "testuser"
40 -}(%%)
50 +}
41 41  
42 -
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
46 46  (% style="color:#000000" %){
47 -
48 -(% lang="en-US" %)
49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 - "User": "testuser" , ~/~/ имя пользователя
51 -
52 -(% lang="en-US" %)
56 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
57 + "User": "testuser" , ~/~/ имя пользователя(%%)
53 53  }
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
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" %)Логин пользователя
67 +
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 +
57 57  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
... ... @@ -61,7 +61,7 @@
61 61  (% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
78 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -74,40 +74,114 @@
74 74  
75 75  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
76 76  
77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
91 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
78 78  
79 79  (% class="box infomessage" %)
80 80  (((
81 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
95 +**GET api/v3/agents/{id}**
82 82  )))
83 83  
84 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
98 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
85 85  
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 +
156 +(% class="box infomessage" %)
157 +(((
158 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
159 +)))
160 +
161 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
162 +
86 86  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
87 87  
88 88  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
89 89  
90 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
167 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
91 91  
92 -(% style="color:#000000" %)Метод запроса: **GET**
169 +(% style="color:#000000" %)Метод запроса: **POST**
93 93  
94 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
171 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
95 95  
96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
173 +(% style="color:#000000" %)Параметр запроса:
97 97  
98 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
175 +(% style="color:#000000" %){
176 + "parentId": "string"
177 +}
99 99  
100 100  (% style="color:#000000" %)Ответ:
101 101  
102 -(% style="color:#000000" %){
103 - "agentId": "", ~/~/ идентификатор клиента
104 - "parentId": "", ~/~/ идентификатор клиента-родителя
105 - "name": "", ~/~/ наименование клиента
106 - "fullName": "", ~/~/ полное наименование клиента
107 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
108 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
181 +{
182 + "agentId": "",(% style="color:#000000" %)   (%%)
183 + "parentId": "",
184 + "name": "string",
185 + "fullName": "string",
186 + "agentInfoType": 0,
187 +(% style="color:#000000" %) "status": "",
109 109  }
110 110  
190 +
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 +
111 111  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
112 112  
113 113  (% class="box successmessage" %)
... ... @@ -115,7 +115,7 @@
115 115  **POST /api/v3/agents **
116 116  )))
117 117  
118 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
206 +Метод позволяет добавить клиента, указанного в запросе.
119 119  
120 120  Метод запроса: **POST**
121 121  
... ... @@ -126,9 +126,10 @@
126 126  Параметры в теле запроса (JSON):
127 127  
128 128  {
129 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
217 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
130 130   "name": "string", ~/~/ имя
131 131   "fullName": "string", ~/~/ полное наименование
220 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
132 132   "isForeign": true, ~/~/ иностранный контрагент
133 133   "district": "string", ~/~/ округ
134 134   "region": "string", ~/~/ регион
... ... @@ -145,7 +145,6 @@
145 145   "bankKS": "string" ~/~/ корр. счёт
146 146  }
147 147  
148 -
149 149  Ответ:
150 150  
151 151  {
... ... @@ -153,6 +153,7 @@
153 153   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
154 154   "name": "string", ~/~/ имя
155 155   "fullName": "string", ~/~/ полное наименование
244 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
156 156   "isForeign": true, ~/~/ иностранный контрагент
157 157   "district": "string", ~/~/ округ
158 158   "region": "string", ~/~/ регион
... ... @@ -169,6 +169,27 @@
169 169   "bankKS": "string" ~/~/ корр. счёт
170 170  }
171 171  
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" %)Корр. счет
172 172  
173 173  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
174 174  
... ... @@ -177,7 +177,7 @@
177 177  **PUT /api/v3/agents**
178 178  )))
179 179  
180 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
290 +Метод позволяет отредактировать клиента, указанного в запросе.
181 181  
182 182  Метод запроса: **PUT**
183 183  
... ... @@ -185,7 +185,6 @@
185 185  
186 186  В заголовках запроса: X-Auth: Токен авторизации
187 187  
188 -
189 189  Параметры в теле запроса (JSON):
190 190  
191 191  {
... ... @@ -193,6 +193,7 @@
193 193   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
194 194   "name": "string", ~/~/ имя
195 195   "fullName": "string", ~/~/ полное наименование
305 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
196 196   "isForeign": true, ~/~/ иностранный контрагент
197 197   "district": "string", ~/~/ округ
198 198   "region": "string", ~/~/ регион
... ... @@ -209,7 +209,6 @@
209 209   "bankKS": "string" ~/~/ корр. счёт
210 210  }
211 211  
212 -
213 213  Ответ:
214 214  
215 215  {
... ... @@ -233,15 +233,14 @@
233 233   "bankKS": "string" ~/~/ корр. счёт
234 234  }
235 235  
345 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
236 236  
237 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
238 -
239 239  (% class="box errormessage" %)
240 240  (((
241 241  **DELETE /api/v3/agents/{clientId}**
242 242  )))
243 243  
244 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
352 +Метод позволяет удалить клиента, указанного в строке запроса.
245 245  
246 246  Метод запроса: **DELETE**
247 247  
... ... @@ -253,18 +253,31 @@
253 253  
254 254  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
255 255  
364 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
256 256  
257 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
366 +(% class="box warningmessage" %)
367 +(((
368 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
369 +)))
258 258  
371 +Метод позволяет изменить статус клиента, указанного в запросе.
259 259  
260 -== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
373 +В пути указывается GUID клиента и статус клиента.
261 261  
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 +
262 262  (% class="box successmessage" %)
263 263  (((
264 264  (% lang="en-US" %)**POST /api/v3/users**
265 265  )))
266 266  
267 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
388 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
268 268  
269 269  (% style="color:#000000" %)Метод запроса: **POST**
270 270  
... ... @@ -274,7 +274,8 @@
274 274  
275 275  (% style="color:#000000" %)Параметры в теле запроса (JSON):
276 276  
277 -(% style="color:#000000" %){ 
398 +(% style="color:#000000" %)
399 +{ 
278 278   "lastName": "", ~/~/ фамилия
279 279   "firstName": "", ~/~/ имя
280 280   "position": "", ~/~/ должность
... ... @@ -283,25 +283,43 @@
283 283   "login": "", ~/~/ логин (обязателен)
284 284   "password": "", ~/~/ пароль (обязателен)
285 285   "email": "", ~/~/ email (обязателен)
286 - "description": "", ~/~/ описание
287 - "isEnabled": "", ~/~/ признак включения
408 + "description": "string", ~/~/ Описание
409 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
410 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
411 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
288 288   "parentId": "", ~/~/ Guid родительского агента
289 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
290 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
291 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
292 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
293 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
294 - "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 - Азербайджанский
295 295  }
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",
296 296  
297 297  (% style="text-align:left" %)
298 298  (% style="color:#000000; font-weight:normal" %)Ответ:
299 -
300 -(% style="text-align:left" %)
301 -(% style="color:#000000; font-weight:normal" %){    
302 -
303 -(% style="text-align:left" %)
304 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
443 +{     
444 + "id": "" , ~/~/ ID пользователя
305 305   "lastName": "" , ~/~/ Фамилия ,
306 306   "firstName": "" , ~/~/ Имя
307 307   "position": "" , ~/~/ Должность
... ... @@ -318,14 +318,12 @@
318 318   "kind": "" , ~/~/ тип аутентификации
319 319   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
320 320   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
461 +}
321 321  
322 -(% style="text-align:left" %)
323 -(% style="color:#000000; font-weight:normal" %)}
324 324  
464 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
325 325  
326 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
327 -
328 -(% class="box successmessage" %)
466 +(% class="box infomessage" %)
329 329  (((
330 330  (% lang="en-US" %)**POST /api/v3/users/find**
331 331  )))
... ... @@ -342,19 +342,16 @@
342 342  
343 343  (% style="color:#000000" %)Параметры в теле запроса (JSON):
344 344  
345 -(% style="color:#000000" %){
346 -
483 +(% style="color:#000000" %){(%%)
347 347   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
348 348   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
349 349   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
350 350   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
351 -
352 352  (% style="color:#000000" %)}
353 353  
354 354  (% style="color:#000000" %)Ответ:
355 355  
356 356  (% style="color:#000000" %){         (%%)
357 -
358 358   "id": "" , ~/~/ идентификатор пользователя
359 359   "lastName": "" , ~/~/ фамилия
360 360   "firstName": "" , ~/~/ имя
... ... @@ -367,14 +367,12 @@
367 367   "email": "" , ~/~/ E-mail
368 368   "sessionDuration":"", ~/~/ длительность сессии в минутах
369 369   "status": "1",  ~/~/ статус пользователя
370 - "astLogged": "", ~/~/ дата/время последней авторизации
371 -
505 + "lastLogged": "", ~/~/ дата/время последней авторизации
372 372  (% style="color:#000000" %)}
373 373  
508 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
374 374  
375 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
376 -
377 -(% class="box successmessage" %)
510 +(% class="box infomessage" %)
378 378  (((
379 379  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
380 380  )))
... ... @@ -406,8 +406,11 @@
406 406   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
407 407   "description": "", ~/~/ Описание
408 408   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
409 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
410 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
542 + "doubleAuth":
543 + {
544 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
545 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
546 + },
411 411   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
412 412   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
413 413   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -421,15 +421,14 @@
421 421  )))
422 422  )))
423 423  
560 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
424 424  
425 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
426 -
427 427  (% class="box warningmessage" %)
428 428  (((
429 429  (% lang="en-US" %)**PUT /api/v3/users**
430 430  )))
431 431  
432 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
567 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
433 433  
434 434  (% style="color:#000000" %)Метод запроса: **PUT**
435 435  
... ... @@ -441,10 +441,8 @@
441 441  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
442 442  
443 443  (% lang="en-US" style="text-align:left" %)
444 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
445 -
446 -(% lang="en-US" style="text-align:left" %)
447 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
580 + "id": "" , ~/~/ ID пользователя 
448 448   "lastName": "" , ~/~/ фамилия
449 449   "firstName": "" , ~/~/ имя
450 450   "position": "" , ~/~/ должность
... ... @@ -451,7 +451,9 @@
451 451   "phone": "" , ~/~/ телефон
452 452   "organization": "" , ~/~/ организация
453 453   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
454 -(% 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 - отключено
455 455   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
456 456  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
457 457   "isEnabled": "" , ~/~/ признак включения
... ... @@ -458,12 +458,13 @@
458 458   "parentId": "" , ~/~/ Guid родительского агента
459 459   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
460 460   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
461 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
462 - "kind": "" , ~/~/ тип аутентификации
463 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
464 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
465 -
466 -(% 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» названия группы пользователя(%%)
467 467  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
468 468  
469 469  (% lang="en-US" style="text-align:left" %)
... ... @@ -470,10 +470,8 @@
470 470  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
471 471  
472 472  (% lang="en-US" style="text-align:left" %)
473 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
474 -
475 -(% lang="en-US" style="text-align:left" %)
476 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
610 + "id": "" , ~/~/ идентификатор пользователя
477 477   "lastName": "" , ~/~/ фамилия
478 478   "firstName": "" , ~/~/ имя
479 479   "position": "" , ~/~/ должность
... ... @@ -486,23 +486,24 @@
486 486   "isEnabled": "" , ~/~/ признак включения
487 487   "parentId": "" , ~/~/ Guid родительского агента
488 488   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
489 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
490 - "kind": "" , ~/~/ тип аутентификации
623 + "doubleAuth":
624 + {
625 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
626 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
627 + },
628 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
491 491   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
492 492   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
631 +}
493 493  
494 -(% lang="en-US" style="text-align:left" %)
495 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
633 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
496 496  
497 -
498 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
499 -
500 500  (% class="box warningmessage" %)
501 501  (((
502 502  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
503 503  )))
504 504  
505 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
640 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
506 506  
507 507  (% style="color:#000000" %)Метод запроса: **PUT**
508 508  
... ... @@ -514,26 +514,23 @@
514 514  
515 515  (% style="color:#000000" %)Параметры в теле запроса (JSON):
516 516  
517 -(% style="color:#000000" %){
518 -
652 +(% style="color:#000000" %){(%%)
519 519   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
520 520   "description": "" , ~/~/ описание
521 521   "data": "" , ~/~/ данные, связанные со сменой статуса
522 -
523 523  (% style="color:#000000" %)}
524 524  
525 525  (% style="text-align:left" %)
526 526  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
527 527  
661 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
528 528  
529 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
530 -
531 531  (% class="box warningmessage" %)
532 532  (((
533 533  **POST /api/v3/users/disable**
534 534  )))
535 535  
536 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
668 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
537 537  
538 538  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
539 539  
... ... @@ -542,21 +542,20 @@
542 542  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
543 543  
544 544   [ 
545 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
677 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
546 546   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
547 547   ]
548 548  
549 549  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
550 550  
683 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
551 551  
552 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
553 -
554 554  (% class="box warningmessage" %)
555 555  (((
556 556  **POST /api/v3/users/enable**
557 557  )))
558 558  
559 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
690 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
560 560  
561 561  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
562 562  
... ... @@ -584,17 +584,16 @@
584 584  }
585 585  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
586 586  "users" - массив id пользователей, которых не удалось включить или отключить.
587 -
588 -
589 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
590 590  )))
591 591  
720 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
721 +
592 592  (% class="box errormessage" %)
593 593  (((
594 594  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
595 595  )))
596 596  
597 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
727 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
598 598  
599 599  (% style="color:#000000" %)Метод запроса: **DELETE**
600 600  
... ... @@ -607,12 +607,253 @@
607 607  (% style="text-align:left" %)
608 608  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
609 609  
740 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
610 610  
611 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
742 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
612 612  
744 +(% class="box infomessage" %)
745 +(((
746 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
747 +)))
613 613  
614 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
749 +Метод возвращает полную информацию о модели объекта.
615 615  
751 +(% style="color:#000000" %)Метод запроса: **GET**
752 +
753 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
754 +
755 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
756 +
757 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
758 +
759 +(% style="color:#000000" %)Ответ:
760 +
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 +}
776 +
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
791 +
792 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
793 +
794 +(% class="box successmessage" %)
795 +(((
796 +(% lang="en-US" %)**POST /api/v3/models/find**
797 +)))
798 +
799 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
800 +
801 +(% style="color:#000000" %)Метод запроса: **POST**
802 +
803 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
804 +
805 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
806 +
807 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
808 +
809 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
810 +}
811 +
812 +(% style="color:#000000" %)Ответ:
813 +
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 +]
823 +
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 клиента, которому принадлежит модель объекта
830 +
831 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
832 +
833 +(% class="box successmessage" %)
834 +(((
835 +(% lang="en-US" %)**POST /api/v3/models**
836 +)))
837 +
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" %)
900 +(((
901 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
902 +)))
903 +
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" %)
967 +(((
968 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
969 +)))
970 +
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 +
616 616  (% class="box infomessage" %)
617 617  (((
618 618  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -620,7 +620,7 @@
620 620  
621 621  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
622 622  
623 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
994 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
624 624  
625 625  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
626 626  
... ... @@ -628,9 +628,9 @@
628 628  
629 629  (% style="color:#000000" %)Метод запроса: **GET**
630 630  
631 -(% 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>
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}
632 632  
633 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
1004 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
634 634  
635 635  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
636 636  
... ... @@ -644,18 +644,129 @@
644 644   "deviceTypeId": , ~/~/ ID типа устройства
645 645   "deviceTypeName": "", ~/~/ Название типа устройства
646 646   "sim1": "", ~/~/ Номер SIM1
647 - "parentId": "", Номер SIM2
648 - "parentName": "", Наименование клиента-родителя
649 - "modelId": "", ID модели объекта
650 - "modelName": "", Имя модели объекта
651 - "createdAt": "", Дата создания объекта
652 - "mileageCalcMethod": "", Выбранный метод расчета пробега
653 - "counters": { ~/~/ Нормы
654 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
655 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
656 - "mileage": "", ~/~/ Пробег по нормам в метрах
657 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
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": "", ~/~/ Дата создания объекта
658 658   },
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 + }
1037 +
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 + },
1063 +
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": [ ~/~/ Массив таблиц тарировки
1094 + {
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 + },
1118 +
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 + ],
659 659   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
660 660   {
661 661   "id": "", ~/~/ ID  задания
... ... @@ -671,7 +671,15 @@
671 671   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
672 672   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
673 673   }
674 - ]
1156 + ],
1157 +"statusHistory": [ ~/~/ История статусов
1158 + {
1159 + "status": 0,
1160 + "date": "2023-05-22T09:57:39.562Z",
1161 + "description": "string",
1162 + "additionalInfo": "string"
1163 + }
1164 + ]
675 675  }
676 676  )))
677 677  
... ... @@ -682,14 +682,80 @@
682 682  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
683 683  
684 684  
685 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
1175 +== **Отправить команду на терминал** ==
686 686  
687 687  (% class="box successmessage" %)
688 688  (((
1179 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1180 +)))
1181 +
1182 +Команда для отправки на тс.
1183 +
1184 +{  
1185 +"id": "", ~/~/идентификатор произвольного поля
1186 +"command": "", ~/~/ Текст команды
1187 +"retries": "", ~/~/ Количество попыток
1188 +"idTemplate": "" ~/~/ ID шаблона команды
1189 +}
1190 +
1191 +
1192 +== **Получить ответ на отправленную на ТС команду** ==
1193 +
1194 +(% class="box infomessage" %)
1195 +(((
1196 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1197 +)))
1198 +
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 +
1214 +(((
1215 +== **Список отправленных объекту команд с ответами** ==
1216 +
1217 +(% class="box infomessage" %)
1218 +(((
1219 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1220 +)))
1221 +
1222 +Идентификатор ТС: vehicleId
1223 +
1224 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1225 +
1226 +Пример ответа терминала
1227 +
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 +
1243 +(% class="box successmessage" %)
1244 +(((
689 689  (% lang="en-US" %)**POST /api/v3/vehicles**
690 690  )))
691 691  
692 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1248 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
693 693  
694 694  (% style="color:#000000" %)Метод запроса: **POST**
695 695  
... ... @@ -699,8 +699,7 @@
699 699  
700 700  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
701 701  
702 -(% style="color:#000000" %){
703 -
1258 +(% style="color:#000000" %){(%%)
704 704   "parentId": "" , ~/~/ ID клиента
705 705   "name": "" , ~/~/ имя ТС
706 706   "imei": "" , ~/~/ IMEI
... ... @@ -721,6 +721,10 @@
721 721   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
722 722   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
723 723   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1279 + "mileageCalcMethod": 0,
1280 + "mileageCoeff": 0,
1281 + "locationByCellId": true,
1282 + "dottedLineTrackWhenNoCoords": true,
724 724   "counters": ~/~/ счетчики
725 725   {
726 726   "mileage": "" , ~/~/ пробег
... ... @@ -749,70 +749,265 @@
749 749   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
750 750   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
751 751   }
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 ~/~/ Определяет максимальное значение датчика в режиме накопления.
752 752  
753 -(% style="color:#000000" %) }
1377 +(((
1378 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1379 + {
1380 + "from": 0, ~/~/ С какого значения
1381 + "color": "string", ~/~/ Каким цветом
1382 + "text": "string" ~/~/ Текст подписи к этому интервалу
1383 + }
1384 + ]
1385 + }
1386 + ],
1387 +)))
754 754  
1389 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1390 +
1391 +
1392 + "customFields": [ ~/~/ Произвольные поля
1393 + {
1394 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1395 + "name": "string", ~/~/ Наименование произвольного поля
1396 + "value": "string", ~/~/ Значение произвольного поля
1397 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1398 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1399 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1400 + }
1401 + ]
1402 +}
1403 +
755 755  (% style="color:#000000" %)Ответ:
756 756  
757 -(% style="color:#000000" %){
758 758  
759 - "vehicleId": "", ~/~/ID ТС 
760 - "parentId": "", ~/~/Guid владельца ТС
761 - "name": "", ~/~/Имя объекта
762 - "imei": "", ~/~/IMEI
763 - "deviceTypeId": "", ~/~/ID типа устройства
764 - "modelId": "", ~/~/ID модели
765 - "unitId": "", ~/~/ID подразделения
766 - "sim1": "", ~/~/SIM1
767 - "sim2": "", ~/~/SIM2
768 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
769 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
770 - "counters": { ~/~/Счётчики
771 - "mileageEnabled": true,
772 - "motohoursEnabled": true,
773 - "mileage": "",
774 - "motohours": 345.0
775 - },
776 - "cmsv6Parameters": { ~/~/Параметры CmsV6
777 - "id": null,
778 - "enabled": true, ~/~/флаг включения
779 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
780 - "login": "", ~/~/ имя учетной записи
781 - "password": "" ~/~/ пароль учетной записи
782 - },
783 - "inspectionTasks": { ~/~/ задания на ТО
784 - "id": "", ~/~/ ID задачи
785 - "enabled": false, ~/~/ Признак включения
786 - "name": "", ~/~/ Имя задания
787 - "description": "", ~/~/ Описание задания
788 - "mileageCondition": "", ~/~/ Условие по пробегу
789 - "lastMileage": "", ~/~/ Пробег (в метрах)
790 - "motohoursCondition": "", ~/~/ Условие по моточасам
791 - "lastMotohours": "", ~/~/ Моточасы
792 - "periodicCondition": "", ~/~/ Условие периодичности по времени
793 - "kind": "", ~/~/ Вид периодичности по времени 
794 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1407 +(((
1408 +(((
1409 +(((
1410 +{
1411 + "vehicleId": 0,  ~/~/ ID ТС
1412 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1413 + "name": "string", ~/~/ Имя объекта
1414 + "imei": "string", ~/~/ IMEI
1415 + "deviceTypeId": 0, ~/~/ ID типа устройства
1416 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1417 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1418 + "sim1": "string", ~/~/ SIM1
1419 + "sim2": "string", ~/~/ SIM2
1420 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1421 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1422 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1423 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1424 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1425 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1426 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1427 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1428 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1429 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1430 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1431 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1432 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1433 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1434 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1435 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1436 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1437 + "counters": {  ~/~/ Dto для состояний счётчиков
1438 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1439 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1440 + "mileage": 0, ~/~/ Пробег
1441 + "motohours": 0 ~/~/ Моточасы
1442 + },
1443 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1444 + "id": "string", ~/~/ CMSV6 Идентификатор
1445 + "enabled": true, ~/~/ Признак включения
1446 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1447 + "login": "string", ~/~/ CMSV6 имя учетной записи
1448 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1449 + },
1450 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1451 + {
1452 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1453 + "enabled": true, ~/~/ Признак включения
1454 + "name": "string", ~/~/ Имя задания
1455 + "description": "string", ~/~/ Описание задания
1456 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1457 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1458 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1459 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1460 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1461 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1462 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1463 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
795 795   }
1465 + ],
1466 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1467 + {
1468 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1469 + "inputNumber": 0, ~/~/ № входа.
1470 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1471 + "comment": "string", ~/~/ Комментарий
1472 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1473 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1474 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1475 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1476 + }
1477 + ],
1478 + "commandTemplates": [  ~/~/ Список шаблонов команд
1479 + {
1480 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1481 + "name": "string", ~/~/ Название шаблона команд
1482 + "command": "string", ~/~/ Команда на выполнение
1483 + "retries": 0 ~/~/ Лимит попыток отправки
1484 + }
1485 + ],
1486 + "sensors": [ ~/~/ Список датчиков
1487 + {
1488 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1489 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1490 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1491 + "name": "string",  ~/~/ Имя датчика
1492 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1493 + "inputNumber": 0, ~/~/ Номер входа
1494 + "pseudonym": "string", ~/~/ Псевдоним
1495 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1496 + "isInverted": true, ~/~/  Признак инверсии
1497 + "disabled": true, ~/~/ Датчик не участвует в обработке
1498 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1499 + "gradesTables": [ ~/~/ Тарировка
1500 + {
1501 + "grades": [ ~/~/ Таблицы тарировки
1502 + {
1503 + "input": 0, ~/~/ Вход
1504 + "output": 0 ~/~/ Выход
1505 + }
1506 + ],
1507 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1508 + }
1509 + ],
1510 + "showInTooltip": true, ~/~/ Отображение в подсказке
1511 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1512 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1513 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1514 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1515 + "expr": "string", ~/~/ Выражение
1516 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1517 + "string"
1518 + ],
1519 + "customParams": {
1520 + "additionalProp1": "string",
1521 + "additionalProp2": "string",
1522 + "additionalProp3": "string"
1523 + },
1524 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1525 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1526 + {
1527 + "from": 0, ~/~/ С какого значения
1528 + "color": "string", ~/~/ Каким цветом
1529 +)))
796 796  
797 -(% style="text-align:left" %)
798 -(% style="color:#000000" %)}
1531 +(((
1532 + "text": "string" ~/~/ Текст подписи к этому интервалу
1533 + }
1534 + ]
1535 + }
1536 + ],
1537 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1538 + "customFields": [ ~/~/ Список произвольных полей
1539 + {
1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1541 + "name": "string", ~/~/ Наименование произвольного поля
1542 + "value": "string", ~/~/ Значение произвольного поля
1543 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1544 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1545 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1546 + }
1547 + ],
1548 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
1549 +}
1550 +)))
1551 +)))
1552 +)))
799 799  
1554 +
800 800  **Валидация:**
801 801  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
802 802  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
803 803  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
804 804  
1560 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
805 805  
806 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
807 -
808 -(% class="box successmessage" %)
1562 +(% class="box infomessage" %)
809 809  (((
810 810  (% lang="en-US" %)**POST /api/v3/vehicles/find**
811 811  )))
812 812  
813 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1567 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
814 814  
815 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1569 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
816 816  
817 817  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
818 818  
... ... @@ -854,8 +854,7 @@
854 854  (% style="color:#000000" %)Ответ:
855 855  
856 856  (% style="color:#000000" %){
857 -
858 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1611 + "vehicleId": "" ~/~/ идентификатор объекта
859 859   "name": "" ~/~/ наименование объекта
860 860   "imei": "" ~/~/ IMEI объекта
861 861   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -885,15 +885,14 @@
885 885  
886 886  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
887 887  
1641 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
888 888  
889 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
890 -
891 891  (% class="box successmessage" %)
892 892  (((
893 893  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
894 894  )))
895 895  
896 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1648 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
897 897  
898 898  (% style="color:#000000" %)Метод запроса: **POST**
899 899  
... ... @@ -915,13 +915,11 @@
915 915   "data": "", ~/~/ Данные
916 916   "overwrite": false, ~/~/ Флаг перезаписи
917 917   "stage": "", ~/~/ Состояние, может быть null
918 -
919 919  (% style="color:#000000" %)}
920 920  
921 921  (% style="color:#000000" %)Ответ:
922 922  
923 -(% style="color:#000000" %){
924 -
1674 +(% style="color:#000000" %){(%%)
925 925   "status": "", ~/~/ значение статуса
926 926   "date": "", ~/~/ Дата смены статуса 
927 927   "description": "", ~/~/ Описание
... ... @@ -928,12 +928,11 @@
928 928   "data": "", ~/~/ Данные
929 929   "overwrite": false, ~/~/ Флаг перезаписи
930 930   "stage": "", ~/~/ Состояние
931 -
932 -(% style="text-align:left" %)
933 933  (% style="color:#000000" %) }
934 934  
1683 +== ==
935 935  
936 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
1685 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
937 937  
938 938  (% class="box warningmessage" %)
939 939  (((
... ... @@ -940,7 +940,7 @@
940 940  (% lang="en-US" %)**PUT /api/v3/vehicles**
941 941  )))
942 942  
943 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1692 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
944 944  
945 945  (% style="color:#000000" %)Метод запроса: **PUT**
946 946  
... ... @@ -950,18 +950,16 @@
950 950  
951 951  (% style="color:#000000" %)Параметры в теле запроса (JSON):
952 952  
953 -(% style="color:#000000" %){    
954 -
955 -(((
956 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
957 - "parentId": "", ~/~/ ID клиента
958 - "name": "", ~/~/ имя ТС
959 - "imei": "", ~/~/ IMEI
960 - "deviceTypeId": "", ~/~/ ID типа устройства
961 - "modelId": "", ~/~/ , ID модели    
962 - "unitId": "", ~/~/ подразделения
963 - "sim1": "", ~/~/ SIM 1
964 - "sim2": "", ~/~/ SIM2     (%%)
1702 +(% style="color:#000000" %){
1703 + "vehicleId": , ~/~/ ID объекта
1704 + "parentId": "" , ~/~/ ID клиента
1705 + "name": "" , ~/~/ имя ТС
1706 + "imei": "" , ~/~/ IMEI
1707 + "deviceTypeId": "" , ~/~/ ID типа устройства
1708 + "modelId": "" , ~/~/ ID модели
1709 + "unitId": "" , ~/~/ ID подразделения
1710 + "sim1": "" , ~/~/ Номер SIM 1
1711 + "sim2": "" , ~/~/ Номер SIM2
965 965   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
966 966   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
967 967   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -974,103 +974,314 @@
974 974   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
975 975   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
976 976   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
977 -(% style="color:#000000" %) "counters": 
978 - {
979 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
980 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
981 - "mileage": "", ~/~/ пробег, в метрах 
982 - "motohours": "" ~/~/ моточасы, в секундах
983 - }
984 - "cmsv6Parameters": ~/~/ параметры CMSv6
985 - {       
986 - "id": "", ~/~/ идентификатор
987 - "enabled": true, ~/~/ флаг включения
988 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
989 - "login": "", ~/~/ имя учетной записи
990 - "password": "", ~/~/ пароль учетной записи
991 - }
992 - "inspectionTasks": ~/~/ задания на ТО
993 - {
994 - "id": "", ~/~/ ID задания
995 - "enabled": false, ~/~/ Признак включения
996 - "name": "", ~/~/ Имя задания
997 - "description": "", ~/~/ Описание задания
998 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
999 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1000 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1001 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1002 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1003 - "kind": "", ~/~/ Вид периодичности по времени
1004 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1005 - } 
1006 -)))
1007 1007  
1008 -(% style="color:#000000" %)}
1725 + "mileageCalcMethod": 0,
1726 + "mileageCoeff": 0,
1727 + "locationByCellId": true,
1728 + "dottedLineTrackWhenNoCoords": true,
1729 + "counters": ~/~/ счетчики
1730 + {
1731 + "mileage": "" , ~/~/ пробег
1732 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1733 + "motohours": "" , ~/~/ моточасы
1734 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1735 + },
1736 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1737 + "enabled": true, ~/~/ флаг включения
1738 + "id": "" , ~/~/ идентификатор
1739 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1740 + "login": "" , ~/~/ имя учетной записи
1741 + "password": "" ~/~/ пароль учетной записи
1742 + },
1743 + "inspectionTasks": ~/~/ задания на ТО
1744 + {
1745 + "enabled": "" , ~/~/ Признак включения
1746 + "name": "" , ~/~/ Имя задания
1747 + "description": "" , ~/~/ Описание задания
1748 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1749 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1750 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1751 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1752 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1753 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1754 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1755 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1756 + }
1009 1009  
1758 +"drivers": [ ~/~/ Водители
1759 + {
1760 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1761 + "isDefault": true
1762 + }
1763 + ],
1764 + "commandTemplates": [ ~/~/ Шаблон команды
1765 + {
1766 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1767 + "name": "string",
1768 + "command": "string",
1769 + "retries": 0
1770 + }
1771 + ],
1772 +"sensors": [ ~/~/ Датчики
1773 + {
1774 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1775 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1776 + "type": 0, ~/~/ Тип датчика
1777 + "name": "string", ~/~/ Имя датчика
1778 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1779 + "inputNumber": 0, ~/~/ Номер входа
1780 + "pseudonym": "string", ~/~/ Псевдоним
1781 + "medianDegree": 0, ~/~/ Медианная фильтрация
1782 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1783 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1784 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1785 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1786 + {
1787 + "grades": [ ~/~/ Таблица тарировки 1
1788 + {
1789 + "input": 0, ~/~/ Входящее значение
1790 + "output": 0 ~/~/ Выходящее значение
1791 + }
1792 + ],
1793 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1794 + }
1795 + ],
1796 + "showInTooltip": true, ~/~/ Отображать в подсказке
1797 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1798 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1799 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1800 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1801 + "expr": "string", ~/~/ Формула
1802 + "children": [ ~/~/ массив дочерних датчиков
1803 + "string"
1804 + ],
1805 + "customParams": { ~/~/ прочие произвольные параметры
1806 + "additionalProp1": "string",
1807 + "additionalProp2": "string",
1808 + "additionalProp3": "string"
1809 + },
1810 +~/~/ Характерные для произвольного:
1811 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1812 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1813 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1814 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1815 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1816 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1817 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1818 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1819 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1820 +~/~/ "ValueOn": "Вкл.",
1821 +~/~/ "ValueOff": "Выкл."
1822 + "summaryMaxValue": 0 ~/~/ Макс. значение
1823 +
1824 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1825 + {
1826 + "from": 0, ~/~/ С какого значения
1827 + "color": "string", ~/~/ Каким цветом
1828 + "text": "string" ~/~/ Текст подписи к этому интервалу
1829 + }
1830 + ]
1831 + }
1832 + ],
1833 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1834 +
1835 + "customFields": [ ~/~/ Произвольные поля
1836 + {     
1837 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1838 + "name": "string", ~/~/ Наименование произвольного поля
1839 + "value": "string", ~/~/ Значение произвольного поля
1840 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1841 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1842 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1843 + }
1844 + ]
1845 +}
1846 +
1847 +
1010 1010  (% style="color:#000000" %)Ответ:
1011 1011  
1012 -(% lang="en-US" style="text-align:left" %)
1013 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1850 +(((
1851 +{
1852 + "vehicleId": 0, ~/~/ ID ТС
1853 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1854 + "name": "string", ~/~/ Имя объекта
1855 + "imei": "string", ~/~/ IMEI
1856 + "deviceTypeId": 0, ~/~/ ID типа устройства
1857 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1858 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1859 + "sim1": "string", ~/~/ SIM1
1860 + "sim2": "string", ~/~/ SIM2
1861 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1862 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1863 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1864 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1865 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1866 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1867 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1868 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1869 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1870 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1871 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1872 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1873 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1874 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1875 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1876 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1877 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1878 + "counters": { ~/~/ состояний счётчиков
1879 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1880 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1881 + "mileage": 0, ~/~/ Пробег
1882 + "motohours": 0 ~/~/ Моточасы 
1883 + },
1884 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1885 + "id": "string", ~/~/ CMSV6 Идентификатор
1886 + "enabled": true, ~/~/ Признак включения
1887 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1888 +)))
1014 1014  
1015 -(% lang="en-US" style="text-align:left" %)
1016 - "vehicleId": "", ~/~/ ID ТС
1017 - "parentId": "", ~/~/ ID клиента
1018 - "name": "", ~/~/ имя ТС
1019 - "imei": "", ~/~/ IMEI
1020 - "deviceTypeId": "", ~/~/ типа устройства
1021 - "modelId": "", ~/~/ ID модели
1022 - "unitId": "", ~/~/ ID подразделения
1023 - "sim1": "", ~/~/ SIM 1
1024 - "sim2": "", ~/~/ SIM2
1025 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1026 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1027 - "counters": 
1028 - {
1029 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1030 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1031 - "mileage": "", ~/~/ пробег
1032 - "motohours": "", ~/~/ моточасы
1033 - }
1034 - "cmsv6Parameters": ~/~/ параметры CMSv6
1890 +
1891 +(((
1892 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1893 + "login": "string", ~/~/ CMSV6 имя учетной записи
1894 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1895 + },
1896 + "inspectionTasks": [ ~/~/ Задания на ТО
1897 + {
1898 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1899 + "enabled": true, ~/~/ Признак включения
1900 + "name": "string", ~/~/ Имя задания
1901 + "description": "string", ~/~/ Описание задания
1902 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1903 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1904 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1905 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1906 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1907 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
1908 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
1909 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
1910 + }
1911 + ],
1912 + "drivers": [  ~/~/ Список водителей
1913 + {
1914 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1915 + "inputNumber": 0, ~/~/ № входа.
1916 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
1917 + "comment": "string", ~/~/ Комментарий.
1918 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1919 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1920 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
1921 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
1922 + }
1923 + ],
1924 + "commandTemplates": [ ~/~/ Список шаблонов команд
1925 + {
1926 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1927 + "name": "string", ~/~/ Название шаблона команд
1928 + "command": "string", ~/~/ Команда на выполнение
1929 + "retries": 0 ~/~/ Лимит попыток отправки
1930 + }
1931 + ],
1932 + "sensors": [  ~/~/ Список датчиков 
1933 + {
1934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1935 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1936 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
1937 +)))
1938 +
1939 +(((
1940 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
1941 +)))
1942 +
1943 +(((
1944 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
1945 +)))
1946 +
1947 +(((
1948 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
1949 +)))
1950 +
1951 +(((
1952 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
1953 +)))
1954 +
1955 +(((
1956 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1957 + "name": "string", ~/~/ Имя датчика
1958 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
1959 +)))
1960 +
1961 +(((
1962 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1963 + "inputNumber": 0, ~/~/ Номер входа
1964 + "pseudonym": "string", ~/~/ Псевдоним
1965 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1966 + "isInverted": true, ~/~/ Признак инверсии
1967 + "disabled": true, ~/~/ Датчик не участвует в обработке
1968 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1969 + "gradesTables": [ ~/~/ Тарировка
1035 1035   {
1036 - "id": ~/~/ идентификатор
1037 - "enabled": true, ~/~/ флаг включения
1038 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1039 - "login": "", ~/~/ имя учетной записи
1040 - "password": "", ~/~/ пароль учетной записи
1041 - }
1042 - "inspectionTasks": ~/~/ задания на ТО
1971 + "grades": [ ~/~/ Таблицы тарировки
1972 + {
1973 + "input": 0, ~/~/ Вход
1974 + "output": 0 ~/~/ Выход
1975 + }
1976 + ],
1977 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
1978 + }
1979 + ],
1980 + "showInTooltip": true, ~/~/ Отображение в подсказке
1981 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1982 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1983 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1984 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
1985 + "expr": "string", ~/~/ Выражение
1986 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1987 + "string" 
1988 + ],
1989 + "customParams": { ~/~/ Дополнительные настройки
1990 + "additionalProp1": "string",
1991 + "additionalProp2": "string",
1992 + "additionalProp3": "string"
1993 + },
1994 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1995 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1043 1043   {
1044 - "id": "", ~/~/ ID задания
1045 - "enabled": false, ~/~/ Признак включения
1046 - "name": "", ~/~/ Имя задания
1047 - "description": "", ~/~/ Описание задания
1048 - "mileageCondition": "", ~/~/ Условие по пробегу
1049 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1050 - "motohoursCondition": "", ~/~/ Условие по моточасам
1051 - "lastMotohours": "", ~/~/ Моточасы
1052 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1053 - "kind": "", ~/~/ Вид периодичности по времени
1054 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1997 + "from": 0, ~/~/ С какого значения
1998 + "color": "string", ~/~/ Каким цветом
1999 + "text": "string" ~/~/ Текст подписи к этому интервалу
1055 1055   }
2001 + ]
2002 + }
2003 + ],
2004 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2005 + "customFields": [ ~/~/ Список произвольных полей
2006 + {
2007 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2008 + "name": "string", ~/~/ Наименование произвольного поля
2009 + "value": "string", ~/~/ Значение произвольного поля
2010 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2011 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2012 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2013 + }
2014 + ],
2015 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2016 +}
2017 +)))
1056 1056  
1057 -(% lang="en-US" style="text-align:left" %)
1058 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1059 -
1060 -**валидация:**
2019 +**Валидация:**
1061 1061  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1062 1062  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1063 1063  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1064 1064  
2024 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1065 1065  
1066 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1067 -
1068 1068  (% class="box errormessage" %)
1069 1069  (((
1070 1070  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1071 1071  )))
1072 1072  
1073 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2031 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1074 1074  
1075 1075  (% style="color:#000000" %)Метод запроса: **DELETE**
1076 1076  
... ... @@ -1083,66 +1083,2695 @@
1083 1083  (% style="text-align:left" %)
1084 1084  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1085 1085  
2044 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1086 1086  
1087 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
2046 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1088 1088  
1089 -
1090 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1091 -
1092 1092  (% class="box infomessage" %)
1093 1093  (((
1094 1094  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1095 1095  )))
1096 1096  
1097 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2053 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1098 1098  
1099 1099  (% style="color:#000000" %)Метод запроса: **GET**
1100 1100  
1101 -(% 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]]
2057 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1102 1102  
1103 1103  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1104 1104  
1105 1105  (% style="color:#000000" %)Ответ:
1106 1106  
1107 -(% style="color:#000000" %){
1108 -
2063 +(% style="color:#000000" %){(%%)
1109 1109   "deviceTypeId" : "", ~/~/ ID типа устройства
1110 1110   "deviceTypeName" : "" ~/~/ Название типа устройства
1111 -
1112 -(% style="text-align:left" %)
1113 1113  (% style="color:#000000" %)}
1114 1114  
2068 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1115 1115  
1116 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
2070 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1117 1117  
1118 -
1119 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1120 -
1121 1121  (% class="box infomessage" %)
1122 1122  (((
1123 1123  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1124 1124  )))
1125 1125  
1126 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2077 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1127 1127  
1128 1128  (% style="color:#000000" %)Метод запроса: **GET**
1129 1129  
1130 1130  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1131 1131  
1132 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
2083 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1133 1133  
1134 1134  (% style="color:#000000" %)Ответ:
1135 1135  
1136 -(% style="color:#000000" %){
1137 -
2087 +(% style="color:#000000" %){(%%)
1138 1138   "id": "", ~/~/ ID типа датчика 
1139 1139   "name": "", ~/~/ Название
1140 1140   "description": "", ~/~/ Описание
2091 +(% style="color:#000000" %)}
1141 1141  
2093 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2094 +
2095 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2096 +
2097 +(% class="box infomessage" style="text-align: left;" %)
2098 +(((
2099 +**POST /api/v3/terminalMessages/count**
2100 +)))
2101 +
2102 +(% style="text-align: left;" %)
2103 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2104 +
2105 +(% style="text-align: left;" %)
2106 +Метод запроса **POST**
2107 +
2108 +(% style="text-align: left;" %)
2109 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2110 +
2111 +(% style="text-align: left;" %)
2112 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2113 +
2114 +(% style="text-align: left;" %)
2115 +{
2116 + "vehicleIds": [
2117 + id ~/~/ здесь передается список идентификаторов объектов
2118 + ],
2119 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2120 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2121 +}
2122 +
2123 +(% style="text-align: left;" %)
2124 +Ответ:
2125 +
2126 +(% style="text-align: left;" %)
2127 +[
2128 + {
2129 + "vehicleId": 0, ~/~/ идентификатор объекта
2130 + "count": 0 ~/~/ количество сообщений за период
2131 + }
2132 +]
2133 +
2134 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2135 +
2136 +(% class="box infomessage" style="text-align: left;" %)
2137 +(((
2138 +**POST /api/v3/terminalMessages/mapping**
2139 +)))
2140 +
2141 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2142 +
2143 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2144 +
2145 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2146 +
2147 +{
2148 + "protocolType": 0,
2149 + "params": ["string"]
2150 +}
2151 +
2152 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2153 +|protocolType|ID типа протокола
2154 +|params|(((
2155 +Массив наименований параметров в сообщении
2156 +)))
2157 +
2158 +Ответ:
2159 +
2160 +{
2161 + "protocolType": 0,
2162 + "mapping": {
2163 + "additionalProp1": {
2164 + "inputType": 0,
2165 + "inputNumber": 0
2166 + },
2167 + "additionalProp2": {
2168 + "inputType": 0,
2169 + "inputNumber": 0
2170 + }
2171 + }
2172 +}
2173 +
2174 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2175 +|protocolType|Тип протокола
2176 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2177 +|inputNumber|(((
2178 +Номер входа
2179 +)))
2180 +
2181 +(% class="wikigeneratedid" %)
2182 +Перечень 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/]]
2183 +
2184 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2185 +
2186 +(% class="box infomessage" %)
2187 +(((
2188 +**POST /api/v3/terminalMessages**
2189 +)))
2190 +
2191 +Метод возвращает список сообщений терминала объекта за выбранный период.
2192 +
2193 +(% style="text-align: left;" %)
2194 +Метод запроса **POST**
2195 +
2196 +(% style="text-align: left;" %)
2197 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2198 +
2199 +(% style="text-align: left;" %)
2200 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2201 +
2202 +{
2203 + "vehicleId": 0, ~/~/ id объекта
2204 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2205 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2206 +}
2207 +
2208 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2209 +|vehicleId|ID объекта
2210 +|from|Дата и время начала периода запроса
2211 +|to|Дата и время окончания периода запроса
2212 +
2213 +Ответ:
2214 +
2215 +[
2216 + {
2217 + "messages": [
2218 + {
2219 + "deviceTime": "2023-11-29T07:40:44.052Z",
2220 + "serverTime": "2023-11-29T07:40:44.052Z",
2221 + "speed": 0,
2222 + "altitude": 0,
2223 + "latitude": 0,
2224 + "longitude": 0,
2225 + "satellites": 0,
2226 + "course": 0,
2227 + "voltage": 0,
2228 + "parameters": {
2229 + "additionalProp1": "string",
2230 + "additionalProp2": "string",
2231 + "additionalProp3": "string"
2232 + },
2233 + "photoCount": 0,
2234 + "lbsCorrectedCoords": true,
2235 + "protocolType": 0
2236 + }
2237 + ]
2238 + }
2239 +]
2240 +
2241 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2242 +|deviceTime|Время сообщения терминала
2243 +|serverTime|Время когда сообщение поступило на сервер
2244 +|speed|Скорость
2245 +|altitude|Высота над уровнем моря
2246 +|latitude|Широта
2247 +|longitude|Долгота
2248 +|satellites|Кол-во спутников
2249 +|course|Курс
2250 +|voltage|Бортовое напряжение
2251 +|parameters|Список параметров и их значений
2252 +|photoCount|Количество фото
2253 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2254 +|protocolType|ID типа протокола
2255 +
2256 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2257 +
2258 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2259 +
2260 +(% class="box infomessage" %)
2261 +(((
2262 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2263 +)))
2264 +
2265 +(% style="color:#000000" %)Метод запроса: **POST**
2266 +
2267 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2268 +
2269 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2270 +
1142 1142  (% style="text-align:left" %)
2272 +Тело запроса:
2273 +
2274 +{
2275 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2276 + "vehicleIds": [0], ~/~/ Список ID объектов
2277 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2278 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2279 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2280 +}
2281 +
2282 +Ответ:
2283 +
2284 +[
2285 + {
2286 + "vehicleId": 0, ~/~/ ID объекта
2287 + "name": "string", ~/~/ Имя ТС
2288 + "periods": [ ~/~/ Периоды
2289 + {
2290 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2291 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2292 + "mileage": 0, ~/~/ Пробег за период, километры
2293 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2294 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2295 + "motohours": 0, ~/~/ Моточасы за период, секунды
2296 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2297 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2298 + }
2299 + ]
2300 + }
2301 +]
2302 +
2303 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2304 +
2305 +(% class="box infomessage" %)
2306 +(((
2307 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2308 +)))
2309 +
2310 +(% style="color:#000000" %)Метод запроса: **POST**
2311 +
2312 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2313 +
2314 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2315 +
2316 +(% style="text-align:left" %)
2317 +Тело запроса:
2318 +
2319 +{
2320 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2321 + "vehicleIds": [0], ~/~/ Список ID объектов
2322 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2323 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2324 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2325 +}
2326 +
2327 +Ответ:
2328 +
2329 +[
2330 + {
2331 + "vehicleId": 0, ~/~/ ID объекта
2332 + "name": "string", ~/~/ Имя ТС
2333 + "periods": [ ~/~/ Периоды
2334 + {
2335 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2336 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2337 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2338 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2339 + "fuelConsumption": 0, ~/~/ Расход топлива
2340 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2341 + }
2342 + ]
2343 + }
2344 +]
2345 +
2346 +(% class="box warningmessage" %)
2347 +(((
2348 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2349 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2350 +)))
2351 +
2352 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2353 +
2354 +(% class="box infomessage" %)
2355 +(((
2356 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2357 +)))
2358 +
2359 +(% style="color:#000000" %)Метод запроса: **POST**
2360 +
2361 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2362 +
2363 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2364 +
2365 +(% style="text-align:left" %)
2366 +Тело запроса:
2367 +
2368 +{
2369 + "vehicleIds": [0], ~/~/ Список ID объектов
2370 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2371 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2372 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2373 +}
2374 +
2375 +Ответ:
2376 +
2377 +[
2378 + {
2379 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2380 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2381 + "vehicleId": 0, ~/~/ ID объекта
2382 + "name": "string", ~/~/ Имя объекта
2383 + "model": "string", ~/~/ Модель объекта
2384 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2385 + {
2386 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2387 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2388 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2389 + "valueFuel": 0, ~/~/ Количество
2390 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2391 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2392 + }
2393 + ]
2394 + }
2395 +]
2396 +
2397 +
2398 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2399 +
2400 +(% class="box infomessage" %)
2401 +(((
2402 +**POST /api/v3/vehicles/moveStop**
2403 +)))
2404 +
2405 +Метод запроса: **POST**
2406 +
2407 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2408 +
2409 +В заголовках запроса: X-Auth: Токен авторизации
2410 +
2411 +
2412 +Тело запроса:
2413 +
2414 +{
2415 + "vehicleIds": [ ], ~/~/ Список ID объектов
2416 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2417 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2418 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2419 +}
2420 +
2421 +Ответ:
2422 +
2423 +[ 
2424 + {
2425 + "vehicleId": 0, ~/~/ ID объекта
2426 + "vehicleName": "string", ~/~/ Имя объекта
2427 + "moves": [ ~/~/ Событие движения
2428 + {
2429 + "mileage": 0, ~/~/ Пробег, км
2430 + "eventId": 0, ~/~/ Идентификатор события
2431 + "eventName": "string", ~/~/ Название события
2432 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2433 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2434 + "duration": 0 ~/~/ Продолжительность события, секунд
2435 + }
2436 + ],
2437 + "stops": [ ~/~/ События стоянок
2438 + {
2439 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2440 + "eventId": 0, ~/~/ Идентификатор события
2441 + "eventName": "string", ~/~/ Название события
2442 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2443 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2444 + "duration": 0 ~/~/ Продолжительность события, секунд
2445 + }
2446 + ]
2447 + }
2448 +]
2449 +
2450 +
2451 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2452 +
2453 +(% class="box infomessage" %)
2454 +(((
2455 +**POST /api/v3/vehicles/getlastdata**
2456 +)))
2457 +
2458 +Метод запроса: **POST**
2459 +
2460 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2461 +
2462 +В заголовках запроса: X-Auth: Токен авторизации
2463 +
2464 +
2465 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2466 +
2467 +Ответ:
2468 + {
2469 + "vehicleId": 0, ~/~/Идентификатор объекта.
2470 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2471 + "vehicleNumber": "string",~/~/Номер объекта.
2472 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2473 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2474 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2475 + "speed": 0,~/~/Скорость объекта.
2476 + "course": 0,~/~/Курс движения [0;360]
2477 + "latitude": 0,~/~/Широта [-90°;90°].
2478 + "longitude": 0,~/~/Долгота [-180°;180°].
2479 + "address": "string",~/~/Адрес.
2480 + "geozones": [ ~/~/Сведения по геозонам.
2481 + {
2482 + "id": 0,
2483 + "name": "string"
2484 + }
2485 +
2486 +
2487 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2488 +
2489 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2490 +
2491 +(% class="box infomessage" %)
2492 +(((
2493 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2494 +)))
2495 +
2496 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2497 +
2498 +(% style="color:#000000" %)Метод запроса: **POST**
2499 +
2500 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2501 +
2502 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2503 +
2504 +(% style="text-align:left" %)
2505 +Тело запроса:
2506 +
2507 +(% style="text-align:left" %)
2508 +{
2509 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2510 +}
2511 +
2512 +(% style="text-align:left" %)
2513 +Ответ:
2514 +
2515 +[
2516 + {
2517 + "id": 0, ~/~/ Идентификатор объекта геозоны
2518 + "name": "string", ~/~/ Название объекта геозоны
2519 + "type": 0, ~/~/ Тип объекта геозоны
2520 + "fname": "string", ~/~/ Имя файла
2521 + "parentId": "string", ~/~/ Идентификатор клиента
2522 + "radius": 0, ~/~/ Радиус геообъекта
2523 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2524 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2525 + "description": "string", ~/~/ Описание
2526 + "area": 0, ~/~/ Площадь, м^^2^^
2527 + "perimetr": 0, ~/~/ Периметр, м
2528 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2529 + }
2530 +]
2531 +
2532 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2533 +
2534 +(% class="box infomessage" %)
2535 +(((
2536 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2537 +)))
2538 +
2539 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2540 +
2541 +(% style="color:#000000" %)Метод запроса: **POST**
2542 +
2543 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2544 +
2545 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2546 +
2547 +(% style="text-align:left" %)
2548 +Тело запроса:
2549 +
2550 +{
2551 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2552 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2553 + "ids": [ ], ~/~/ Массив id объектов
2554 + "byTime": 0, ~/~/ Объединение событий по времени 
2555 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2556 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2557 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2558 +}
2559 +
2560 +Ответ:
2561 +[
2562 + {
2563 + "geozoneId": 0, ~/~/ ID геообъекта
2564 + "geozoneName": "string", ~/~/ Название геообъекта
2565 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2566 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2567 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2568 + "vehicleId": 0, ~/~/ ID объекта
2569 + "vehicleName": "string" ~/~/ Имя объекта
2570 + }
2571 +]
2572 +
2573 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2574 +
2575 +(% class="box infomessage" %)
2576 +(((
2577 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2578 +)))
2579 +
2580 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2581 +
2582 +(% style="color:#000000" %)Метод запроса: **POST**
2583 +
2584 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2585 +
2586 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2587 +
2588 +(% style="text-align:left" %)
2589 +Тело запроса:
2590 +
2591 +{
2592 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2593 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2594 + "ids": [ ], ~/~/ Массив id геообъектов
2595 + "byTime": 0, ~/~/ Объединение событий по времени 
2596 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2597 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2598 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2599 +}
2600 +
2601 +Ответ:
2602 +
2603 +[
2604 + {
2605 + "geozoneId": 0, ~/~/ ID геообъекта
2606 + "geozoneName": "string", ~/~/ Название геообъекта
2607 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2608 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2609 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2610 + "vehicleId": 0, ~/~/ ID объекта
2611 + "vehicleName": "string" ~/~/ Имя объекта
2612 + }
2613 +]
2614 +
2615 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2616 +
2617 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2618 +
2619 +(% class="box infomessage" %)
2620 +(((
2621 +**POST /api/v3/notifications/find**
2622 +)))
2623 +
2624 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2625 +
2626 +(% style="text-align: left;" %)
2627 +Метод запроса **POST**
2628 +
2629 +(% style="text-align: left;" %)
2630 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2631 +
2632 +(% style="text-align: left;" %)
2633 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2634 +
2635 +{
2636 + "parentId": "" ~/~/ id клиента
2637 +}
2638 +
2639 +Ответ:
2640 +
2641 +[
2642 + {
2643 + "id": 0, ~/~/ ID уведомления
2644 + "name": "string", ~/~/ Название уведомления
2645 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2646 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2647 + "userId": "", ~/~/ Пользователь, создавший уведомление
2648 + "parentId": "", ~/~/ Идентификатор клиента
2649 + "parentName": "string" ~/~/ Имя клиента
2650 + }
2651 +]
2652 +
2653 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2654 +
2655 +(% class="box infomessage" %)
2656 +(((
2657 +**GET /api/v3/notifications/{id}**
2658 +)))
2659 +
2660 +Метод возвращает данные правил формирования выбранного уведомления.
2661 +
2662 +(% style="text-align: left;" %)
2663 +Метод запроса **GET**
2664 +
2665 +(% style="text-align: left;" %)
2666 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2667 +
2668 +(% style="text-align: left;" %)
2669 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2670 +
2671 +(% style="text-align: left;" %)
2672 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2673 +
2674 +(% style="text-align: left;" %)
2675 +(% style="color:#000000" %)Ответ:
2676 +
2677 +(% style="text-align: left;" %)
2678 +(% style="color:#000000" %){
2679 + "id": 0, ~/~/ (%%)id уведомления
2680 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2681 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2682 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2683 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2684 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2685 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2686 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2687 +(% style="color:#000000" %) 0
2688 + ],
2689 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2690 +(% style="color:#000000" %) 0
2691 + ],
2692 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
2693 +(% style="color:#000000" %) 0
2694 + ],
2695 + "settings": { ~/~/ Список параметров уведомления
2696 + "additionalProp1": "string",
2697 + "additionalProp2": "string",
2698 + "additionalProp3": "string"
2699 + },
2700 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2701 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2702 +(% style="color:#000000" %) ""
2703 + ],
2704 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2705 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2706 +(% style="color:#000000" %) "string"
2707 + ],
2708 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2709 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2710 +(% style="color:#000000" %) {
2711 + "id": 0, ~/~/ (%%)Идентификатор участника чата
2712 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2713 +(% style="color:#000000" %) }
2714 + ],
2715 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2716 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2717 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2718 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2719 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2720 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2721 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2722 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2723 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1143 1143  (% style="color:#000000" %)}
1144 1144  
2726 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1145 1145  
2728 +(% class="box warningmessage" %)
2729 +(((
2730 +**PUT /api/v3/notifications/**
2731 +)))
2732 +
2733 +Метод позволяет отредактировать уведомление.
2734 +
2735 +Метод запроса **PUT**
2736 +
2737 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2738 +
2739 +В заголовках запроса: X-Auth: Токен авторизации
2740 +
2741 +Тело запроса:
2742 +{
2743 + "id": 0, ~/~/ id уведомления
2744 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2745 + "userId": "", ~/~/ Пользователь, создавший уведомление
2746 + "parentId": "", ~/~/ Идентификатор клиента
2747 + "parentName": "string", ~/~/ Имя клиента
2748 + "name": "string", ~/~/ Название уведомления
2749 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2750 + "vehicleIds": [ ~/~/ Список id объектов для анализа
2751 + 0
2752 + ],
2753 + "geoids": [ ~/~/ Список id геообъектов для анализа
2754 + 0
2755 + ],
2756 + "fieldids": [ ~/~/ Список id полей для анализа
2757 + 0
2758 + ],
2759 + "settings": { ~/~/ Список параметров уведомления
2760 + "additionalProp1": "string",
2761 + "additionalProp2": "string",
2762 + "additionalProp3": "string"
2763 + },
2764 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2765 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2766 + ""
2767 + ],
2768 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2769 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2770 + "string"
2771 + ],
2772 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2773 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2774 + {
2775 + "id": 0, ~/~/ Идентификатор участника чата
2776 + "info": "string" ~/~/ Дополнительные сведения
2777 + }
2778 + ],
2779 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2780 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2781 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2782 + "kind": 0, ~/~/ Определяет вид уведомления
2783 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2784 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2785 + "timezone": 0, ~/~/ Сдвиг часового пояса
2786 + "validity": 0, ~/~/ Срок действия в днях (1-90)
2787 + "autoProlongation": true ~/~/ Автопродление срока действия
2788 +}
2789 +
2790 +Ответ:
2791 +
2792 +Success
2793 +
2794 +
2795 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2796 +
2797 +(% class="box warningmessage" %)
2798 +(((
2799 +**PUT** /api/v3/notifications/prolongation
2800 +)))
2801 +
2802 +Метод позволяет продлить уведомления.
2803 +
2804 +Метод запроса **PUT**
2805 +
2806 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2807 +
2808 +В заголовках запроса: X-Auth: Токен авторизации.
2809 +
2810 +Тело запроса:
2811 +
2812 +[
2813 +
2814 +0
2815 +
2816 +]
2817 +
2818 +где 0 идентификатор ids.
2819 +
2820 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2821 +
2822 +(% class="box errormessage" %)
2823 +(((
2824 +**DELETE /api/v3/notifications/{id}**
2825 +)))
2826 +
2827 +Метод позволяет удалить выбранное уведомление.
2828 +
2829 +Метод запроса **DELETE**
2830 +
2831 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2832 +
2833 +Передаваемый параметр: {id} - id уведомления
2834 +
2835 +В заголовках запроса: X-Auth: Токен авторизации
2836 +
2837 +Ответ:
2838 +
2839 +Success
2840 +
2841 +
2842 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2843 +
2844 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2845 +
2846 +(% class="box infomessage" %)
2847 +(((
2848 +**POST /api/v3/Drivers/find**
2849 +)))
2850 +
2851 +Передается параметр: parentId - ID клиента-родителя
2852 +
2853 +Ответ:
2854 +
2855 +[
2856 + {
2857 + "name": "string", ~/~/ Определяет наименование
2858 + "description": "string", ~/~/ Определяет описание
2859 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2860 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2861 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2862 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2863 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2864 + "deleted": true ~/~/ Признак удаления
2865 + }
2866 +]
2867 +
2868 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2869 +
2870 +(% class="box infomessage" %)
2871 +(((
2872 +**GET /api/v3/Drivers/{driverGuid}**
2873 +)))
2874 +
2875 +Передается параметр: ID водителя
2876 +
2877 +Ответ:
2878 +
2879 +{
2880 + "name": "string", ~/~/ Определяет наименование
2881 + "description": "string", ~/~/ Определяет описание
2882 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2883 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2884 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2885 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2886 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2887 + "deleted": true ~/~/ Признак удаления
2888 +}
2889 +
2890 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2891 +
2892 +(% class="box successmessage" %)
2893 +(((
2894 +**POST /api/v3/Drivers**
2895 +)))
2896 +
2897 +Запрос:
2898 +
2899 +{
2900 + "name": "string",
2901 + "description": "string",
2902 + "hiredate": "2023-06-30T12:50:54.020Z",
2903 + "chopdate": "2023-06-30T12:50:54.020Z",
2904 + "exclusive": true,
2905 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2906 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2907 + "deleted": true
2908 +}
2909 +
2910 +Ответ:
2911 +
2912 +{
2913 + "name": "string",
2914 + "description": "string",
2915 + "hiredate": "2023-06-30T12:50:54.051Z",
2916 + "chopdate": "2023-06-30T12:50:54.051Z",
2917 + "exclusive": true,
2918 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2919 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2920 + "deleted": true
2921 +}
2922 +
2923 +
2924 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2925 +
2926 +(% class="box warningmessage" %)
2927 +(((
2928 +**PUT /api/v3/Drivers**
2929 +)))
2930 +
2931 +Запрос:
2932 +
2933 +{
2934 + "name": "string",
2935 + "description": "string",
2936 + "hiredate": "2023-06-30T12:50:27.910Z",
2937 + "chopdate": "2023-06-30T12:50:27.910Z",
2938 + "exclusive": true,
2939 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2940 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2941 + "deleted": true
2942 +}
2943 +
2944 +Ответ:
2945 +
2946 +{
2947 + "name": "string",
2948 + "description": "string",
2949 + "hiredate": "2023-06-30T12:50:27.929Z",
2950 + "chopdate": "2023-06-30T12:50:27.929Z",
2951 + "exclusive": true,
2952 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2953 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
2955 +}
2956 +
2957 +
2958 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2959 +
2960 +(% class="box errormessage" %)
2961 +(((
2962 +**DELETE /api/v3/Drivers/{driverGuid}**
2963 +)))
2964 +
2965 +Передается параметр: ID водителя
2966 +
2967 +Ответ:
2968 +
2969 +Success
2970 +
2971 +
2972 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2973 +
2974 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2975 +
2976 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2977 +
2978 +(% class="box infomessage" %)
2979 +(((
2980 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2981 +)))
2982 +
2983 +Запрос:
2984 +
2985 +{
2986 + "Ids": [
2987 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2988 + ],
2989 + "BeginTime": "2023-06-30T12:49:04.365Z",
2990 + "EndTime": "2023-06-30T12:49:04.365Z"
2991 +}
2992 +
2993 +Ответ:
2994 +
2995 +[
2996 + {
2997 + "VehicleId": 0,
2998 + "CreateTime": "2023-06-30T09:52:31.240Z",
2999 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3001 + "BeginTime": "2023-06-30T09:52:31.240Z",
3002 + "EndTime": "2023-06-30T09:52:31.240Z"
3003 + }
3004 +]
3005 +
3006 +
3007 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3008 +
3009 +(% class="box infomessage" %)
3010 +(((
3011 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3012 +)))
3013 +
3014 +Запрос:
3015 +
3016 +{
3017 + "Ids": [
3018 + 0
3019 + ],
3020 + "BeginTime": "2023-06-30T12:48:39.419Z",
3021 + "EndTime": "2023-06-30T12:48:39.419Z"
3022 +}
3023 +
3024 +Ответ:
3025 +
3026 +[
3027 + {
3028 + "VehicleId": 0,
3029 + "CreateTime": "2023-06-30T09:54:01.631Z",
3030 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3031 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3032 + "BeginTime": "2023-06-30T09:54:01.631Z",
3033 + "EndTime": "2023-06-30T09:54:01.631Z"
3034 + }
3035 +]
3036 +
3037 +
3038 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3039 +
3040 +(% class="box successmessage" %)
3041 +(((
3042 +**POST /api/v3/DriversVehiclesAssignments**
3043 +)))
3044 +
3045 +Передается массив назначений
3046 +
3047 +Запрос:
3048 +
3049 +[
3050 + {
3051 + "VehicleId": 0, ~/~/ Идентификатор объекта
3052 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3053 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3054 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3055 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3056 + }
3057 +]
3058 +
3059 +Ответ:
3060 +
3061 +[
3062 + {
3063 + "VehicleId": 0,
3064 + "CreateTime": "2023-06-30T11:04:46.903Z",
3065 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3066 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3067 + "BeginTime": "2023-06-30T11:04:46.903Z",
3068 + "EndTime": "2023-06-30T11:04:46.903Z"
3069 + }
3070 +]
3071 +
3072 +
3073 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3074 +
3075 +(% class="box warningmessage" %)
3076 +(((
3077 +**PUT /api/v3/DriversVehiclesAssignments**
3078 +)))
3079 +
3080 +Запрос:
3081 +
3082 +[
3083 + {
3084 + "VehicleId": 0,
3085 + "CreateTime": "2023-06-30T11:14:08.117Z",
3086 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3087 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3088 + "BeginTime": "2023-06-30T11:14:08.117Z",
3089 + "EndTime": "2023-06-30T11:14:08.117Z"
3090 + }
3091 +]
3092 +
3093 +Ответ:
3094 +
3095 +[
3096 + {
3097 + "VehicleId": 0,
3098 + "CreateTime": "2023-06-30T11:14:53.349Z",
3099 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3100 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3101 + "BeginTime": "2023-06-30T11:14:53.349Z",
3102 + "EndTime": "2023-06-30T11:14:53.349Z"
3103 + }
3104 +]
3105 +
3106 +
3107 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3108 +
3109 +(% class="box errormessage" %)
3110 +(((
3111 +**DELETE /api/v3/DriversVehiclesAssignments**
3112 +)))
3113 +
3114 +Запрос:
3115 +
3116 +[
3117 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3118 +]
3119 +
3120 +Ответ:
3121 +
3122 +Success
3123 +
3124 +
3125 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3126 +
3127 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3128 +
3129 +(% class="box infomessage" %)
3130 +(((
3131 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3132 +)))
3133 +
3134 +Запрос:
3135 +
3136 +{
3137 + "Ids": [
3138 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3139 + ],
3140 + "BeginTime": "2023-06-30T12:47:12.162Z",
3141 + "EndTime": "2023-06-30T12:47:12.162Z"
3142 +}
3143 +
3144 +Ответ:
3145 +
3146 +[
3147 + {
3148 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3149 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3150 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3151 + "BeginTime": "2023-06-30T11:19:40.703Z",
3152 + "EndTime": "2023-06-30T11:19:40.703Z"
3153 + }
3154 +]
3155 +
3156 +
3157 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3158 +
3159 +(% class="box infomessage" %)
3160 +(((
3161 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3162 +)))
3163 +
3164 +Запрос:
3165 +
3166 +{
3167 + "Ids": [
3168 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3169 + ],
3170 + "BeginTime": "2023-06-30T12:47:12.162Z",
3171 + "EndTime": "2023-06-30T12:47:12.162Z"
3172 +}
3173 +
3174 +Ответ:
3175 +
3176 +[
3177 + {
3178 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3179 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3180 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3181 + "BeginTime": "2023-06-30T11:19:40.703Z",
3182 + "EndTime": "2023-06-30T11:19:40.703Z"
3183 + }
3184 +]
3185 +
3186 +
3187 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3188 +
3189 +(% class="box successmessage" %)
3190 +(((
3191 +**POST /api/v3/DriversRfidsAssignments**
3192 +)))
3193 +
3194 +Запрос:
3195 +
3196 +[
3197 + {
3198 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3199 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3200 + "BeginTime": "2023-06-30T11:27:08.635Z",
3201 + "EndTime": "2023-06-30T11:27:08.635Z"
3202 + }
3203 +]
3204 +
3205 +Ответ:
3206 +
3207 +[
3208 + {
3209 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3210 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3212 + "BeginTime": "2023-06-30T11:27:08.677Z",
3213 + "EndTime": "2023-06-30T11:27:08.677Z"
3214 + }
3215 +]
3216 +
3217 +
3218 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3219 +
3220 +(% class="box warningmessage" %)
3221 +(((
3222 +**PUT /api/v3/DriversRfidsAssignments**
3223 +)))
3224 +
3225 +Запрос:
3226 +
3227 +[
3228 + {
3229 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3230 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3231 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3232 + "BeginTime": "2023-06-30T11:28:43.330Z",
3233 + "EndTime": "2023-06-30T11:28:43.330Z"
3234 + }
3235 +]
3236 +
3237 +Ответ:
3238 +
3239 +[
3240 + {
3241 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3242 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3243 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3244 + "BeginTime": "2023-06-30T11:28:43.331Z",
3245 + "EndTime": "2023-06-30T11:28:43.331Z"
3246 + }
3247 +]
3248 +
3249 +
3250 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3251 +
3252 +(% class="box errormessage" %)
3253 +(((
3254 +**DELETE /api/v3/DriversRfidsAssignments**
3255 +)))
3256 +
3257 +Запрос:
3258 +
3259 +[
3260 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3261 +]
3262 +
3263 +Ответ:
3264 +
3265 +Success
3266 +
3267 +
3268 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3269 +
3270 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3271 +
3272 +(% class="box infomessage" %)
3273 +(((
3274 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3275 +)))
3276 +
3277 +Запрос:
3278 +
3279 +{
3280 + "Ids": [
3281 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3282 + ],
3283 + "BeginTime": "2023-06-30T12:45:10.852Z",
3284 + "EndTime": "2023-06-30T12:45:10.852Z"
3285 +}
3286 +
3287 +Ответ:
3288 +
3289 +[
3290 + {
3291 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3292 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3293 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3294 + "BeginTime": "2023-06-30T11:58:04.695Z",
3295 + "EndTime": "2023-06-30T11:58:04.695Z"
3296 + }
3297 +]
3298 +
3299 +
3300 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3301 +
3302 +(% class="box infomessage" %)
3303 +(((
3304 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3305 +)))
3306 +
3307 +Запрос:
3308 +
3309 +{
3310 + "Ids": [
3311 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3312 + ],
3313 + "BeginTime": "2023-06-30T12:45:10.852Z",
3314 + "EndTime": "2023-06-30T12:45:10.852Z"
3315 +}
3316 +
3317 +Ответ:
3318 +
3319 +[
3320 + {
3321 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3322 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3323 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3324 + "BeginTime": "2023-06-30T11:58:04.695Z",
3325 + "EndTime": "2023-06-30T11:58:04.695Z"
3326 + }
3327 +]
3328 +
3329 +
3330 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3331 +
3332 +(% class="box successmessage" %)
3333 +(((
3334 +**POST /api/v3/DriversFuelCardsAssignments**
3335 +)))
3336 +
3337 +Запрос:
3338 +
3339 +[
3340 + {
3341 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3342 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3343 + "BeginTime": "2023-06-30T12:09:53.175Z",
3344 + "EndTime": "2023-06-30T12:09:53.175Z"
3345 + }
3346 +]
3347 +
3348 +Ответ:
3349 +
3350 +[
3351 + {
3352 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3353 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3354 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3355 + "BeginTime": "2023-06-30T12:09:53.201Z",
3356 + "EndTime": "2023-06-30T12:09:53.201Z"
3357 + }
3358 +]
3359 +
3360 +
3361 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3362 +
3363 +(% class="box warningmessage" %)
3364 +(((
3365 +**PUT /api/v3/DriversFuelCardsAssignments**
3366 +)))
3367 +
3368 +Запрос:
3369 +
3370 +[
3371 + {
3372 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3373 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3374 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3375 + "BeginTime": "2023-06-30T12:09:53.201Z",
3376 + "EndTime": "2023-06-30T12:09:53.201Z"
3377 + }
3378 +]
3379 +
3380 +Ответ:
3381 +
3382 +[
3383 + {
3384 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3385 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3386 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3387 + "BeginTime": "2023-06-30T12:09:53.201Z",
3388 + "EndTime": "2023-06-30T12:09:53.201Z"
3389 + }
3390 +]
3391 +
3392 +
3393 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3394 +
3395 +(% class="box errormessage" %)
3396 +(((
3397 +**DELETE /api/v3/DriversFuelCardsAssignments**
3398 +)))
3399 +
3400 +Запрос:
3401 +
3402 +[
3403 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3404 +]
3405 +
3406 +Ответ:
3407 +
3408 +Success
3409 +
3410 +
3411 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3412 +
3413 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3414 +
3415 +(% class="box infomessage" %)
3416 +(((
3417 +**POST /api/v3/Trailers**
3418 +)))
3419 +
3420 +Пример запроса:
3421 +
3422 +{
3423 + "startDate": "2023-11-14T10:48:03.671Z",
3424 + "endDate": "2023-11-14T10:48:03.671Z",
3425 + "ids": [ 0 ],
3426 + "timezone": 0
3427 +}
3428 +
3429 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3430 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3431 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3432 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3433 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3434 +
3435 +Пример ответа:
3436 +
3437 +[
3438 + {
3439 + "SD": "2023-11-14T10:48:03.717Z",
3440 + "ED": "2023-11-14T10:48:03.717Z", 
3441 + "id": 0,
3442 + "SLat": 0,
3443 + "SLon": 0,
3444 + "ELat": 0,
3445 + "ELon": 0,
3446 + "mileage": 0
3447 + "Duration": 0
3448 + "Address": "string",
3449 + "Address2": "string",
3450 + "name": "string",
3451 + "rid": "string",
3452 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3453 + "trailer": {
3454 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3455 + "Number": "string",
3456 + "Description": "string",
3457 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3458 + "ExternalID": "string",
3459 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3460 + "CreateTime": "2023-11-14T10:48:03.717Z",
3461 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3462 + "IsDeleted": true
3463 + },
3464 + "filesCount": 0,
3465 + }
3466 +]
3467 +
3468 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3469 +|SD|Дата и время начала события
3470 +|ED|Дата и время окончания события
3471 +|id|ID объекта
3472 +|SLat|Широта начальной координаты
3473 +|SLon|Долгота начальной координаты
3474 +|ELat|Широта конечной координаты
3475 +|ELon|Долгота конечной координаты
3476 +|mileage|Пробег
3477 +|Duration|Продолжительность
3478 +|Address|Адрес начального местоположения
3479 +|Address2|Адрес конечного местоположения
3480 +|name|Имя радиометки
3481 +|rid|Номер радиометки
3482 +|rguid|ID радиометки
3483 +|trailer|Информация об агрегате
3484 +|ModelGuid|ID агрегата
3485 +|Number|Название/номер агрегата
3486 +|Description|Текст примечания агрегата
3487 +
3488 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3489 +
3490 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3491 +
3492 +(% class="box infomessage" %)
3493 +(((
3494 +**POST /api/v3/Rfids/find**
3495 +)))
3496 +
3497 +Запрос:
3498 +
3499 +{
3500 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3501 +}
3502 +
3503 +Ответ:
3504 +
3505 +[
3506 + {
3507 + "name": "string",
3508 + "number": 0,
3509 + "period": 0,
3510 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3511 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3512 + }
3513 +]
3514 +
3515 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3516 +|parentId|ID клиента
3517 +|name|Название карты-метки
3518 +|number|Номер
3519 +|period|Период запросов в секундах (работает только для агрегатов)
3520 +|id|ID карты-метки
3521 +
3522 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3523 +
3524 +(% class="box infomessage" %)
3525 +(((
3526 +**GET /api/v3/Rfids/{rfidGuid}**
3527 +)))
3528 +
3529 +Передаем параметр rfidGuid - идентификатор карты-метки
3530 +
3531 +Ответ:
3532 +
3533 +[
3534 + {
3535 + "name": "string",
3536 + "number": 0,
3537 + "period": 0,
3538 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3539 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3540 + }
3541 +]
3542 +
3543 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3544 +|name|Название карты-метки
3545 +|number|Номер
3546 +|period|Период запросов в секундах (работает только для агрегатов)
3547 +|id|ID карты-метки
3548 +|parentId|ID клиента
3549 +
3550 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3551 +
3552 +(% class="box successmessage" %)
3553 +(((
3554 +**POST /api/v3/Rfids**
3555 +)))
3556 +
3557 +Запрос:
3558 +
3559 +{
3560 + "name": "string",
3561 + "number": 0,
3562 + "period": 0,
3563 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3564 +}
3565 +
3566 +Ответ:
3567 +
3568 +{
3569 + "name": "string",
3570 + "number": 0,
3571 + "period": 0,
3572 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3573 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3574 +}
3575 +
3576 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3577 +|name|Название карты-метки
3578 +|number|Номер
3579 +|period|Период запросов в секундах (работает только для агрегатов)
3580 +|id|ID карты-метки
3581 +|parentId|ID клиента
3582 +
3583 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3584 +
3585 +(% class="box warningmessage" %)
3586 +(((
3587 +**PUT /api/v3/Rfids**
3588 +)))
3589 +
3590 +Запрос:
3591 +
3592 +{
3593 + "name": "string",
3594 + "number": 0,
3595 + "period": 0,
3596 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3597 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3598 +}
3599 +
3600 +Ответ:
3601 +
3602 +{
3603 + "name": "string",
3604 + "number": 0,
3605 + "period": 0,
3606 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3607 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3608 +}
3609 +
3610 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3611 +|name|Название карты-метки
3612 +|number|Номер
3613 +|period|Период запросов в секундах (работает только для агрегатов)
3614 +|id|ID карты-метки
3615 +|parentId|ID клиента
3616 +
3617 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3618 +
3619 +(% class="box errormessage" %)
3620 +(((
3621 +**DELETE /api/v3/Rfids/{rfidGuid}**
3622 +)))
3623 +
3624 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3625 +
3626 +Ответ:
3627 +
3628 +Success
3629 +
3630 +
3631 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3632 +
3633 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3634 +
3635 +(% class="box infomessage" %)
3636 +(((
3637 +**GET /api/v3/Billing/client/balance/{clientId}**
3638 +)))
3639 +
3640 +Параметр запроса: **clientId **- идентификатор клиента.
3641 +
3642 +Ответ:
3643 +
3644 +{
3645 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3646 + "Balance": 0
3647 +}
3648 +
3649 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3650 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3651 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3652 +
3653 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3654 +
3655 +(% class="box infomessage" %)
3656 +(((
3657 +**GET /api/v3/Billing/client/constraint/{clientId}**
3658 +)))
3659 +
3660 +Параметр запроса: **clientId **- идентификатор клиента.
3661 +
3662 +Ответ:
3663 +
3664 +{
3665 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3666 + "CalculationType": 0,
3667 + "PermissibleBalance": 0,
3668 + "DefermentDays": 0,
3669 + "SendUiNotifications": true,
3670 + "SendEmailNotifications": true,
3671 + "IsPrivate": true,
3672 +}
3673 +
3674 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3675 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3676 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3677 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3678 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3679 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3680 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3681 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3682 +
3683 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3684 +
3685 +(% class="box infomessage" %)
3686 +(((
3687 +**GET /api/v3/Billing/client/plan/{clientId}**
3688 +)))
3689 +
3690 +Параметры запроса:
3691 +
3692 +**clientId **- идентификатор клиента.
3693 +
3694 +**planId **- идентификатор тарифного плана.
3695 +
3696 +Ответ:
3697 +
3698 +{
3699 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3700 + "Plan": { **~/~/ Описание тарифного плана**
3701 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3702 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3703 + "Name": "string",
3704 + "IsArchived": true,
3705 + "Constraint": {
3706 + "CalculationType": 0,
3707 + "PermissibleBalance": 0,
3708 + "DefermentDays": 0
3709 + },
3710 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3711 + {
3712 + "Feature": "string",
3713 + "IsFactual": true,
3714 + "Limit": 0,
3715 + "Price": 0,
3716 + "PeriodValue": 0,
3717 + "PeriodType": 0
3718 + }
3719 + ]
3720 + },
3721 + "DebitDate": "2023-10-18T12:46:24.213Z",
3722 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3723 + {
3724 + "Feature": "string",
3725 + "IsEnabled": true,
3726 + "IsPrivate": true,
3727 + "IsFactual": true,
3728 + "Limit": 0,
3729 + "Price": 0,
3730 + "DebitDate": "2023-10-18T12:46:24.213Z",
3731 + "PeriodValue": 0,
3732 + "PeriodType": 0
3733 + }
3734 + ]
3735 +}
3736 +
3737 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3738 +|ClientId|Идентификатор клиента
3739 +|Id|Идентификатор тарифного плана
3740 +|OwnerId|Идентификатор клиента-владельца
3741 +|Name|Наименование тарифного плана
3742 +|IsArchived|Признак, определяющий архивный тарифный план
3743 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3744 +|PermissibleBalance|Допустимый баланс
3745 +|DefermentDays|Отсрочка, количество дней
3746 +|Feature|Код услуги
3747 +|IsEnabled|Признак, определяющий активирована ли услуга
3748 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3749 +|IsFactual|Признак, определяющий расчёт по факту
3750 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3751 +|Price|Цена за единицу.
3752 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3753 +|PeriodValue|Значение периода.
3754 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3755 +
3756 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3757 +
3758 +(% class="box infomessage" %)
3759 +(((
3760 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3761 +)))
3762 +
3763 +Параметр запроса: **clientId **- идентификатор клиента.
3764 +
3765 +Ответ:
3766 +
3767 +[
3768 + {
3769 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3770 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3771 + "Name": "string",
3772 + "IsArchived": true,
3773 + "Constraint": {
3774 + "CalculationType": 0,
3775 + "PermissibleBalance": 0,
3776 + "DefermentDays": 0
3777 + },
3778 + "Features": [
3779 + {
3780 + "Feature": "string",
3781 + "IsFactual": true,
3782 + "Limit": 0,
3783 + "Price": 0,
3784 + "PeriodValue": 0,
3785 + "PeriodType": 0
3786 + }
3787 + ]
3788 + }
3789 +]
3790 +
3791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3792 +|ClientId|Идентификатор клиента
3793 +|Id|Идентификатор тарифного плана
3794 +|OwnerId|Идентификатор клиента-владельца
3795 +|Name|Наименование тарифного плана
3796 +|IsArchived|Признак, определяющий архивный тарифный план
3797 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3798 +|PermissibleBalance|Допустимый баланс
3799 +|DefermentDays|Отсрочка, количество дней
3800 +|Feature|Код услуги
3801 +|IsFactual|Признак, определяющий расчёт по факту
3802 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3803 +|Price|Цена за единицу.
3804 +|PeriodValue|Значение периода.
3805 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3806 +
3807 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3808 +
3809 +(% class="box infomessage" %)
3810 +(((
3811 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3812 +)))
3813 +
3814 +Параметр запроса: **clientId **- идентификатор клиента.
3815 +
3816 +Ответ:
3817 +
3818 +[
3819 + {
3820 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3821 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3822 + "Name": "string",
3823 + "IsArchived": true,
3824 + "Constraint": {
3825 + "CalculationType": 0,
3826 + "PermissibleBalance": 0,
3827 + "DefermentDays": 0
3828 + },
3829 + "Features": [
3830 + {
3831 + "Feature": "string",
3832 + "IsFactual": true,
3833 + "Limit": 0,
3834 + "Price": 0,
3835 + "PeriodValue": 0,
3836 + "PeriodType": 0
3837 + }
3838 + ]
3839 + }
3840 +]
3841 +
3842 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3843 +|ClientId|Идентификатор клиента
3844 +|Id|Идентификатор тарифного плана
3845 +|OwnerId|Идентификатор клиента-владельца
3846 +|Name|Наименование тарифного плана
3847 +|IsArchived|Признак, определяющий архивный тарифный план
3848 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3849 +|PermissibleBalance|Допустимый баланс
3850 +|DefermentDays|Отсрочка, количество дней
3851 +|Feature|Код услуги
3852 +|IsFactual|Признак, определяющий расчёт по факту
3853 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3854 +|Price|Цена за единицу.
3855 +|PeriodValue|Значение периода.
3856 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3857 +
3858 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3859 +
3860 +(% class="box warningmessage" %)
3861 +(((
3862 +**PUT /api/v3/Billing/client/balance**
3863 +)))
3864 +
3865 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3866 +
3867 +Тело запроса:
3868 +
3869 +{
3870 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3871 + "Balance": 0
3872 +}
3873 +
3874 +Ответ: Success
3875 +
3876 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3877 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3878 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3879 +
3880 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3881 +
3882 +(% class="box warningmessage" %)
3883 +(((
3884 +**PUT /api/v3/billing/client/balance/deposit**
3885 +)))
3886 +
3887 +Создает операцию **Пополнение **с указанной суммой
3888 +
3889 +Тело запроса:
3890 +
3891 +{
3892 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3893 + "Balance": 0
3894 +}
3895 +
3896 +Ответ: Success
3897 +
3898 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3899 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3900 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3901 +
3902 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3903 +
3904 +Создает операцию **Списание **с указанной суммой
3905 +
3906 +(% class="box warningmessage" %)
3907 +(((
3908 +**PUT /api/v3/billing/client/balance/withdraw**
3909 +)))
3910 +
3911 +Тело запроса:
3912 +
3913 +{
3914 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3915 + "Balance": 0
3916 +}
3917 +
3918 +Ответ: Success
3919 +
3920 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3921 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3922 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3923 +
3924 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3925 +
3926 +(% class="box warningmessage" %)
3927 +(((
3928 +**PUT /api/v3/Billing/client/constraint**
3929 +)))
3930 +
3931 +Тело запроса:
3932 +
3933 +{
3934 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3935 + "CalculationType": 0,
3936 + "PermissibleBalance": 0,
3937 + "DefermentDays": 0,
3938 + "SendUiNotifications": true,
3939 + "SendEmailNotifications": true,
3940 + "IsPrivate": true,
3941 +}
3942 +
3943 +Ответ: Success
3944 +
3945 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3946 +|ClientId|Идентификатор клиента
3947 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3948 +|PermissibleBalance|Допустимый баланс
3949 +|DefermentDays|(((
3950 +Отсрочка, количество дней
3951 +)))
3952 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3953 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3954 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3955 +
3956 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3957 +
3958 +(% class="box warningmessage" %)
3959 +(((
3960 +**PUT /api/v3/Billing/client/plan**
3961 +)))
3962 +
3963 +Тело запроса:
3964 +
3965 +{
3966 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3967 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3968 + "Features": [
3969 + {
3970 + "Feature": "string",
3971 + "IsEnabled": true,
3972 + "IsFactual": true,
3973 + "Limit": 0,
3974 + "Price": 0,
3975 + "DebitDate": "2023-10-18T13:26:58.987Z",
3976 + "PeriodValue": 0,
3977 + "PeriodType": 0
3978 + }
3979 + ]
3980 +}
3981 +
3982 +Ответ: Success
3983 +
3984 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3985 +|ClientId|Идентификатор клиента
3986 +|PlanId|Идентификатор тарифного плана
3987 +|Feature|Код услуги
3988 +|IsEnabled|Признак, определяющий активирована ли услуга
3989 +|IsFactual|Признак, определяющий расчёт по факту
3990 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3991 +|Price|Цена за единицу.
3992 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3993 +|PeriodValue|Значение периода.
3994 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3995 +
3996 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3997 +
3998 +(% class="box warningmessage" %)
3999 +(((
4000 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4001 +)))
4002 +
4003 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4004 +
4005 +(% class="box infomessage" %)
4006 +(((
4007 +**POST /api/v3/vehicles/import/{agentId}**
4008 +)))
4009 +
4010 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4011 +
4012 +В пути указывается **agentId** - id клиента.
4013 +
4014 +**Заголовок**
4015 +
4016 +**X-Auth: [токен авторизации]**
4017 +
4018 +**Параметры**
4019 +
4020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4021 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4022 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4023 +
4024 +В теле использовать тип **form-data,** тип значения** file**
4025 +
4026 +**Ключи**
4027 +
4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4029 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4030 +|csv|В значении передаем файл датчиков, формат **csv**
4031 +
4032 +Ответ:
4033 +
4034 +{
4035 + "vehicleId": 0,
4036 + "name": "string",
4037 + "errors": ["string"]
4038 +}
4039 +
4040 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4041 +|vehicleId|ID созданного объекта
4042 +|name|Имя созданного объекта
4043 +|errors|Ошибки и их описание
4044 +
4045 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4046 +
4047 +(% class="box infomessage" %)
4048 +(((
4049 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4050 +)))
4051 +
4052 +(% class="wikigeneratedid" %)
4053 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4054 +
4055 +(% class="wikigeneratedid" %)
4056 +В пути указывается **vehicleId **- id объекта.
4057 +
4058 +**Заголовок**
4059 +
4060 +**X-Auth: [токен авторизации]**
4061 +
4062 +В теле использовать тип **form-data.**
4063 +
4064 +Ключи:
4065 +
4066 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4067 +|**history**|В значении передавать файл с историей
4068 +
4069 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4070 +
4071 +Ответ:
4072 +
4073 +{
4074 + "results": [
4075 + {
4076 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4077 + "vehicleId": 0,
4078 + "errors": [
4079 + "string"
4080 + ],
4081 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4082 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4083 + "producedCount": 0,
4084 + "msgCount": 0
4085 + }
4086 + ]
4087 +}
4088 +
4089 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4090 +|results|Результаты импорта в разрезе ТС
4091 +|vehicleGuid|Guid ТС
4092 +|vehicleId|ID ТС
4093 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4094 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4095 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4096 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4097 +|msgCount|Кол-во обработанных сообщений всего
4098 +
4099 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4100 +
4101 +(% class="box infomessage" %)
4102 +(((
4103 +**GET /api/v3/vehicles/import/history/status**
4104 +)))
4105 +
4106 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4107 +
4108 +Ответ:
4109 +
4110 +{
4111 + "activity": true,
4112 + "progress": 0,
4113 + "message": "string"
4114 +}
4115 +
4116 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4117 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4118 +|progress|Guid ТС
4119 +
4120 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4121 +
4122 +(% class="box infomessage" %)
4123 +(((
4124 +**POST /api/v3/vehicles/export**
4125 +)))
4126 +
4127 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4128 +
4129 +Тело запроса:
4130 +
4131 +[
4132 + id
4133 +]
4134 +
4135 +Ответ: Success 200, получаете файлы с настройками.
4136 +
4137 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4138 +
4139 +(% class="box infomessage" %)
4140 +(((
4141 +**POST /api/v3/vehicles/export/history**
4142 +)))
4143 +
4144 +Метод возвращает список сообщений терминала объекта за выбранный период.
4145 +
4146 +Тело запроса:
4147 +
4148 +{
4149 + "vehicleId": 0,
4150 + "asArchive": true,
4151 + "from": "2023-09-27T12:17:45.973Z",
4152 + "to": "2023-09-27T12:17:45.973Z"
4153 +}
4154 +
4155 +Ответ:
4156 +
4157 +Получаете файл. Сообщение: Code 200/Success
4158 +
4159 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4160 +|vehicleId|ID объекта
4161 +|asArchive|true - Архивировать файл, False - не архивировать
4162 +|from|Дата и время начала запроса
4163 +|to|Дата и время окончания запроса
4164 +
4165 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4166 +
4167 +(% class="box infomessage" %)
4168 +(((
4169 +**GET /api/v3/vehicles/export/history/status**
4170 +)))
4171 +
4172 +Метод возвращает список сообщений терминала объекта за выбранный период.
4173 +
4174 +Ответ:
4175 +
4176 +{
4177 + "activity": true,
4178 + "progress": 0,
4179 + "message": "string"
4180 +}
4181 +
4182 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4183 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4184 +|progress|Прогресс экспорта, от 0 до 100%
4185 +|message|Текст описывающий статус
4186 +
4187 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4188 +
4189 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4190 +
4191 +(% class="box infomessage" %)
4192 +(((
4193 +**POST /api/v3/EcoDriving/rating**
4194 +)))
4195 +
4196 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4197 +
4198 +Тело запроса:
4199 +
4200 +{
4201 + "vehicleIds": [vehicleId],
4202 + "from": "2023-11-22T09:29:48.051Z",
4203 + "to": "2023-11-22T09:29:48.051Z"
4204 +}
4205 +
4206 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4207 +|vehicleIds|Массив ID объектов
4208 +|from|Дата начала запроса
4209 +|to|Дата окончания запроса
4210 +
4211 +Ответ:
4212 +
4213 +{
4214 + "items": [
4215 + {
4216 + "from": "2023-11-22T09:29:48.052Z",
4217 + "to": "2023-11-22T09:29:48.052Z",
4218 + "vehicleId": 0,
4219 + "vehicleName": "string",
4220 + "vehicleModel": "string",
4221 + "penalty": 0,
4222 + "score": 0,
4223 + "totalViolations": 0,
4224 + "violationsByType": {
4225 + "overspeedingViolations": 0,
4226 + "accelerationViolations": 0,
4227 + "brakingViolations": 0,
4228 + "turningViolations": 0,
4229 + "dangerousDrivingViolations": 0,
4230 + "sensorViolations": 0
4231 + },
4232 + "moveTime": 0,
4233 + "mileage": 0,
4234 + "tripsCount": 0,
4235 + "trips": [
4236 + {
4237 + "penalty": 0,
4238 + "score": 0,
4239 + "violationsCount": 0,
4240 + "violationsByType": {
4241 + "overspeedingViolations": 0,
4242 + "accelerationViolations": 0,
4243 + "brakingViolations": 0,
4244 + "turningViolations": 0,
4245 + "dangerousDrivingViolations": 0,
4246 + "sensorViolations": 0
4247 + },
4248 + "moveTime": 0,
4249 + "mileage": 0,
4250 + "motohours": 0,
4251 + "maxSpeed": 0,
4252 + "startAddress": "string",
4253 + "endAddress": "string",
4254 + "drivers": [
4255 + {
4256 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4257 + "driverName": "string",
4258 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4259 + }
4260 + ]
4261 + }
4262 + ]
4263 + }
4264 + ]
4265 +}
4266 +
4267 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4268 +|from|Дата начала запроса
4269 +|to|Дата  окончания
4270 +|vehicleId|ID объекта
4271 +|vehicleName|Имя объекта
4272 +|vehicleModel|Модель объекта
4273 +|penalty|Сумма штрафных баллов
4274 +|score|Оценка
4275 +|totalViolations|Суммарное количество нарушений
4276 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4277 +|overspeedingViolations|Превышение скорости
4278 +|accelerationViolations|Ускорение
4279 +|brakingViolations|Торможение
4280 +|turningViolations|Резкий поворот
4281 +|dangerousDrivingViolations|Резкое вождение
4282 +|sensorViolations|Нарушение по датчику
4283 +|moveTime|Время в движении
4284 +|mileage|Пробег (км)
4285 +|tripsCount|Количество рейсов
4286 +|motohours|Моточасы
4287 +|maxSpeed|Максимальная скорость
4288 +|startAddress|Адрес начала рейса
4289 +|endAddress|Адрес окончания рейса
4290 +|drivers|Список водителей, которые были на объекте в течениии рейса
4291 +|driverGuid|Guid водителя
4292 +|driverName|Имя водителя
4293 +|driverRfid|Номер Карты-метки
4294 +
4295 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4296 +
4297 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4298 +
4299 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4300 +
4301 +(% class="box infomessage" %)
4302 +(((
4303 +POST /api/v3/fuelcards/transactions
4304 +)))
4305 +
4306 +Метод запроса: POST
4307 +
4308 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4309 +\\В заголовках запроса: X-Auth: Токен авторизации
4310 +
4311 +Параметры в теле запроса (JSON):
4312 +
4313 +{
4314 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4315 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4316 + "ids": [ 
4317 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4318 + ],
4319 + "timezone": 0 ~/~/Таймзона
4320 +}
4321 +
4322 +
4323 +Ответ:
4324 + {
4325 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4326 + "driver": "string", ~/~/Водители, привязанные к ТК
4327 + "object": "string", ~/~/Наименование ТС
4328 + "amount": 0, ~/~/Количество топлива
4329 + "amountDut": 0, ~/~/Количество по ДУТ
4330 + "amountDiff": 0, ~/~/Разница, л
4331 + "amountDiffPerc": 0, ~/~/Разница, %
4332 + "summa": 0, ~/~/Стоимость, руб
4333 + "serviceName": "string", ~/~/Тип топлива
4334 + "price": 0, ~/~/Цена за литр, руб
4335 + "cardName": "string", ~/~/Наименование ТК
4336 + "cardNum": "string", ~/~/Номер ТК
4337 + "operator": "string", ~/~/Оператор ТК
4338 + "address": "string" ~/~/Адрес АЗС
4339 + }
4340 +
4341 +
4342 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4343 +
4344 +
4345 +== **Получение полных данных о ретрансляторе** ==
4346 +
4347 +(% class="box infomessage" %)
4348 +(((
4349 +**GET ** **/api/v3/retranslations/{id}**
4350 +)))
4351 +
4352 +Идентификатор запроса: ID
4353 +
4354 +
4355 +Пример ответа:
4356 +
4357 +{  
4358 +"description": "", ~/~/ Определяет описание
4359 +"subscriberId": "", ~/~/ Подписчик
4360 +"protocolType": 0, ~/~/ Тип протокола
4361 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4362 +"address": "string", ~/~/ Адрес события
4363 +"objects": [ ~/~/Объекты для ретрансляции
4364 +{      
4365 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4366 +"name": "", ~/~/ Наименование объекта ретрансляции
4367 +"imei": "", ~/~/ IMEI объекта  
4368 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4369 +}
4370 + ],  
4371 +"id": "", ~/~/ идентификатор пользователя   
4372 +"parentId": "", ~/~/Guid родителя
4373 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4374 +}
4375 +
4376 +
4377 +== **Удаление данных ретранслятора** ==
4378 +
4379 +(% class="box infomessage" %)
4380 +(((
4381 +**DELETE** **/api/v3/retranslations/{id}**
4382 +)))
4383 +
4384 +Параметр запроса: ID
4385 +
4386 +
4387 +== **Создание ретранслятора** ==
4388 +
4389 +(% class="box infomessage" %)
4390 +(((
4391 +**POST ** **/api/v3/retranslations/{id}**
4392 +)))
4393 +
4394 +Запрос:
4395 +
4396 +{  
4397 +"description": "", ~/~/ Описание
4398 +"subscriberId": "", ~/~/ Подписчик
4399 +"protocolType": 0, ~/~/ Тип протокола
4400 +"address": "", ~/~/ Адрес ретрансляции
4401 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4402 +"objects": [ ~/~/Объекты для ретрансляции
4403 +{      
4404 +"id": "", ~/~/ идентификатор пользователя     
4405 +"imei": "", ~/~/IMEI объекта
4406 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4407 +}
4408 + ]
4409 +}
4410 +
4411 +
4412 +Ответ:
4413 +
4414 +{  
4415 +"description": "string", ~/~/ Определяет описание
4416 +"subscriberId": "", ~/~/ идентификатор запроса
4417 +"protocolType": 0, ~/~/ Тип протокола
4418 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4419 +"address": "", ~/~/ Адрес события
4420 +"objects": [ ~/~/Объекты для ретрансляции
4421 +{      
4422 +"id": "", ~/~/ идентификатор пользователя    
4423 +"name": "string", ~/~/ Название уведомления
4424 +"imei": "string", ~/~/IMEI объекта  
4425 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4426 +}
4427 + ],  
4428 +"id": "", ~/~/ идентификатор пользователя  
4429 +"parentId": "", ~/~/ Guid идентификатор родителя
4430 +"deleted": true ~/~/ Признак удаления
4431 +}
4432 +
4433 +
4434 +== **Редактирование ретранслятора** ==
4435 +
4436 +(% class="box infomessage" %)
4437 +(((
4438 +**PUT** **/api/v3/retranslations**
4439 +)))
4440 +
4441 +Пример запроса:
4442 +
4443 +{  
4444 +"id": "", ~/~/ идентификатор пользователя   
4445 +"description": "string", ~/~/ Определяет описание
4446 +"subscriberId": "", ~/~/ идентификатор запроса
4447 +"protocolType": 0, ~/~/ Тип протокола
4448 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4449 +"address": "string", ~/~/ Адрес события
4450 +"objects": ~/~/Объекты для ретрансляции
4451 +[    
4452 +{      
4453 +"id": "",  ~/~/ идентификатор пользователя         
4454 +"imei": "", ~/~/IMEI объекта
4455 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4456 +}
4457 + ]
4458 +}
4459 +
4460 +
4461 +Пример ответа:
4462 +
4463 +{  
4464 +"description": "", ~/~/ Определяет описание
4465 +"subscriberId": "", ~/~/ идентификатор запроса
4466 +"protocolType": 0, ~/~/ Тип протокола
4467 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4468 +"address": "string", ~/~/ Адрес события
4469 +"objects": [ ~/~/Объекты для ретрансляции
4470 +{      
4471 +"id": "", ~/~/ идентификатор пользователя     
4472 +"name": "string", ~/~/ Название уведомления    
4473 +"imei": "", ~/~/IMEI объекта
4474 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4475 +}
4476 + ],
4477 +"id": "", ~/~/ идентификатор пользователя   
4478 +"parentId": "", ~/~/ Guid идентификатор родителя
4479 +"deleted": true ~/~/ Признак удаления
4480 +}
4481 +
4482 +
4483 +== **Получение списка ретранслятора клиента** ==
4484 +
4485 +(% class="box infomessage" %)
4486 +(((
4487 +**POST /api/v3/retranslations/find**
4488 +)))
4489 +
4490 +Пример запроса:
4491 +
4492 +{  
4493 +"id": "", ~/~/ идентификатор пользователя   
4494 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4495 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4496 +}
4497 +
4498 +Ответ:
4499 +
4500 +[ 
4501 +{    
4502 +"description": "", ~/~/ Определяет описание
4503 +"subscriberId": "", ~/~/ идентификатор запроса
4504 +"protocolType": 0, ~/~/ Тип протокола
4505 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4506 +"address": "string", ~/~/ Адрес события
4507 +"id": "", ~/~/ идентификатор пользователя   
4508 +"parentId": "", ~/~/ Guid идентификатор родителя
4509 +"deleted": true ~/~/ Признак удаления
4510 +}
4511 +]
4512 +
4513 +
4514 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4515 +
4516 +== **API для отчета по выгрузке комбайнов** ==
4517 +
4518 +(% class="box infomessage" %)
4519 +(((
4520 +POST **/api/v3/Reports/harvesterUnloading**
4521 +)))
4522 +
4523 +Пример запроса:
4524 +
4525 +{
4526 + "byTime": 0, ~/~/ Объединение событий по времени
4527 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4528 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4529 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4530 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4531 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4532 + 0
4533 + ],
4534 + "from": "", ~/~/ Дата и время начало запроса
4535 + "to": "", ~/~/ Дата и время окончания запроса
4536 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4537 +}
4538 +
4539 +Пример ответа:
4540 +
4541 +[ 
4542 + {
4543 + "harvesterName": "", ~/~/Комбайн, номер
4544 + "harvesterId": 0, ~/~/Комбайн, id
4545 +"harvesterModel": "", ~/~/ Модель комбайна
4546 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4547 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4548 + "events": [ ~/~/Список событий в разрезе комбайна
4549 + {
4550 + "driverId": "", ~/~/Идентификатор водителя
4551 + "driverName": "", ~/~/Водитель комбайна, ФИО
4552 + "RFID": "", ~/~/ идентификатор карты-метки
4553 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4554 + "vehicleId": 0, ~/~/идентификатор объекта
4555 + "vehicleName": "string", ~/~/ Имя объекта
4556 + "modelName": "string", ~/~/ Имя модели объекта
4557 + "nearestVehicles": [ ~/~/Объекты рядом
4558 + {
4559 + "vehicleId": 0, ~/~/идентификатор объекта
4560 + "vehicleName": "string" ~/~/ Имя объекта
4561 + }
4562 + ],
4563 + "fields": [ ~/~/Поля, где происходила выгрузка
4564 + {
4565 + "id": 0, ~/~/ идентификатор пользователя 
4566 + "name": "string" ~/~/ имя пользователя 
4567 + }
4568 + ],
4569 + "event": "string", ~/~/Событие
4570 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4571 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4572 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4573 + "cultureName": "string", ~/~/ название культуры
4574 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4575 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4576 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4577 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4578 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4579 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4580 + "issued": 0, ~/~/Выдано, бункеров
4581 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4582 + "latitude": 0, ~/~/Широта
4583 + "longitude": 0, ~/~/ Долгота
4584 + "litresAway": 0, ~/~/Отдано, л
4585 + "m3Away": 0 ~/~/Отдано, м3
4586 + }
4587 + ]
4588 + }
4589 +]
4590 +
4591 +
4592 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4593 +
4594 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4595 +
4596 +
4597 +(% class="box infomessage" %)
4598 +(((
4599 +GET api/v3/Vehicles/recyclebin/all
4600 +)))
4601 +
4602 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4603 +
4604 +Параметр запроса: {parentId} - идентификатор агента
4605 +
4606 +В заголовках запроса: X-Auth: Токен авторизации
4607 +
4608 +Ответ:
4609 +
4610 +[ 
4611 + {
4612 + "recordTime": "", ~/~/Время записи
4613 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4614 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4615 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4616 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4617 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4618 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4619 + "items": [ ~/~/ 
4620 +nullable: true ~/~/Детали
4621 + {
4622 + "name": "string", ~/~/наименование столбца
4623 + "value": "string" ~/~/содержание столбца
4624 + }
4625 + ]
4626 + },
4627 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4628 + "string"
4629 + ]
4630 + }
4631 +]
4632 +
4633 +
4634 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4635 +
4636 +(% class="box infomessage" %)
4637 +(((
4638 +POST/api/v3/Vehicles/recyclebin/erase
4639 +)))
4640 +
4641 +В заголовках запроса: X-Auth: Токен авторизации
4642 +
4643 +Пример запроса:
4644 +
4645 +[
4646 +0
4647 +]
4648 +
4649 +
4650 +Пример ответа:
4651 +
4652 +[ 
4653 +{
4654 + "recordTime": "", ~/~/Время записи
4655 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4656 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4657 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4658 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4659 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4660 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4661 + "items": [ ~/~/Детали
4662 + {
4663 + "name": "", ~/~/Имя свойства
4664 + "value": "" ~/~/Значение свойства
4665 + }
4666 + ]
4667 + },
4668 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4669 + ""
4670 + ]
4671 + }
4672 +]
4673 +
4674 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4675 +
4676 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4677 +
4678 +(% class="box infomessage" %)
4679 +(((
4680 +POST/api/v3/Vehicles/recyclebin/restore
4681 +)))
4682 +
4683 +В заголовках запроса: X-Auth: Токен авторизации
4684 +
4685 +Параметры в теле запроса (JSON):
4686 +
4687 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4688 +
4689 +В заголовках запроса: X-Auth: Токен авторизации
4690 +
4691 +
4692 +Пример запроса:
4693 +
4694 +(((
4695 +[
4696 +)))
4697 +
4698 +(((
4699 + 0
4700 +)))
4701 +
4702 +(((
4703 +]
4704 +)))
4705 +
4706 +
4707 +Пример ответа:
4708 +
4709 +[
4710 +{
4711 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4712 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4713 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4714 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4715 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4716 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4717 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4718 + "items": [ ~/~/Детали
4719 + {
4720 + "name": "string", ~/~/Имя свойства
4721 + "value": "string" ~/~/Значение свойства
4722 + }
4723 + ]
4724 + },
4725 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4726 + "string"
4727 + ]
4728 + }
4729 +]
4730 +
4731 +
4732 +
1146 1146  (% class="box" lang="en-US" style="text-align: center;" %)
1147 1147  (((
1148 1148  (% 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 г.