Редактировал(а) Андрей Калиновский 2025/03/28 11:43
<
От версии < 66.13 >
отредактировано Илья Крайнов
на 2022/11/24 13:40
К версии < 20.2 >
отредактировано Артем Шемяков
на 2022/09/01 17:08
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Теги
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Содержимое
... ... @@ -1,67 +1,50 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -= Описание ГЛОНАССSoft Public API 3.0 =
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 +== ==
4 4  
5 -{{toc/}}
6 +(% class="box" style="text-align: center;" %)
7 +(((
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 +)))
6 6  
7 -
8 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
9 -
10 10  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 11  
12 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
13 13  
14 14  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 +
15 15  
16 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
17 17  
18 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
19 -
20 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
21 -
22 22  (% class="box infomessage" %)
23 23  (((
24 -(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 25  )))
26 26  
27 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 28  
29 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
30 30  
31 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
32 32  
33 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 34  
35 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
36 -
37 -(% style="color:#000000" %){
38 - "login": "testuser",
39 - "password": "testuser"
40 -}(%%)
41 -
42 -
43 -(% style="color:#000000" %)**Ответ:**
44 -
45 45  (% lang="en-US" %)
46 -(% style="color:#000000" %){
37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
47 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" %)
53 -}
54 -
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% lang="en-US" %)**GET /api/v3/auth/check**
44 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
47 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,195 +72,57 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
75 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
76 76  
77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
59 +(% class="box" style="text-align: center;" %)
60 +(((
61 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
62 +)))
78 78  
79 79  (% class="box infomessage" %)
80 80  (((
81 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
66 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 82  )))
83 83  
84 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
69 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
85 85  
86 86  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
87 87  
88 88  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
89 89  
90 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
75 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
91 91  
92 92  (% style="color:#000000" %)Метод запроса: **GET**
93 93  
94 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>
95 95  
96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
97 97  
98 98  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
99 99  
100 -(% style="color:#000000" %)Ответ:
85 +(% style="color:#000000" %)Ответ: [ {
86 + "agentId": "", ~/~/ идентификатор клиента
87 + "parentId": "", ~/~/ идентификатор клиента-родителя
88 + "name": "", ~/~/ наименование клиента
89 + "fullName": "", ~/~/ полное наименование клиента
90 + "agentInfoType": "", ~/~/ тип клиента1
91 + "status": "", ~/~/ статус клиента
92 + }, … ]
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 - Отказ)
109 -}
110 110  
111 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
95 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
112 112  
113 -(% class="box successmessage" %)
114 -(((
115 -**POST /api/v3/agents **
116 -)))
117 117  
118 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
119 -
120 -Метод запроса: **POST**
121 -
122 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
123 -
124 -В заголовках запроса: X-Auth: Токен авторизации
125 -
126 -Параметры в теле запроса (JSON):
127 -
128 -{
129 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
130 - "name": "string", ~/~/ имя
131 - "fullName": "string", ~/~/ полное наименование
132 - "isForeign": true, ~/~/ иностранный контрагент
133 - "district": "string", ~/~/ округ
134 - "region": "string", ~/~/ регион
135 - "city": "string", ~/~/ город
136 - "inn": "string", ~/~/ ИНН
137 - "kpp": "string", ~/~/ КПП
138 - "address": "string", ~/~/ юридический адрес
139 - "addressFact": "string", ~/~/ фактический адрес
140 - "email": "string", ~/~/ email
141 - "director": "string", ~/~/ ФИО руководителя
142 - "bankName": "string", ~/~/ банк
143 - "bankBIK": "string", ~/~/ БИК
144 - "bankRS": "string", ~/~/ номер счёта
145 - "bankKS": "string" ~/~/ корр. счёт
146 -}
147 -
148 -
149 -Ответ:
150 -
151 -{
152 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
153 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
154 - "name": "string", ~/~/ имя
155 - "fullName": "string", ~/~/ полное наименование
156 - "isForeign": true, ~/~/ иностранный контрагент
157 - "district": "string", ~/~/ округ
158 - "region": "string", ~/~/ регион
159 - "city": "string", ~/~/ город
160 - "inn": "string", ~/~/ ИНН
161 - "kpp": "string", ~/~/ КПП
162 - "address": "string", ~/~/ юридический адрес
163 - "addressFact": "string", ~/~/ фактический адрес
164 - "email": "string", ~/~/ email
165 - "director": "string", ~/~/ ФИО руководителя
166 - "bankName": "string", ~/~/ банк
167 - "bankBIK": "string", ~/~/ БИК
168 - "bankRS": "string", ~/~/ номер счёта
169 - "bankKS": "string" ~/~/ корр. счёт
170 -}
171 -
172 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
173 -
174 -(% class="box warningmessage" %)
98 +(% class="box" style="text-align: center;" %)
175 175  (((
176 -**PUT /api/v3/agents**
100 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
177 177  )))
178 178  
179 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
180 -
181 -Метод запроса: **PUT**
182 -
183 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
184 -
185 -В заголовках запроса: X-Auth: Токен авторизации
186 -
187 -
188 -Параметры в теле запроса (JSON):
189 -
190 -{
191 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
192 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
193 - "name": "string", ~/~/ имя
194 - "fullName": "string", ~/~/ полное наименование
195 - "isForeign": true, ~/~/ иностранный контрагент
196 - "district": "string", ~/~/ округ
197 - "region": "string", ~/~/ регион
198 - "city": "string", ~/~/ город
199 - "inn": "string", ~/~/ ИНН
200 - "kpp": "string", ~/~/ КПП
201 - "address": "string", ~/~/ юридический адрес
202 - "addressFact": "string", ~/~/ фактический адрес
203 - "email": "string", ~/~/ email
204 - "director": "string", ~/~/ ФИО руководителя
205 - "bankName": "string", ~/~/ банк
206 - "bankBIK": "string", ~/~/ БИК
207 - "bankRS": "string", ~/~/ номер счёта
208 - "bankKS": "string" ~/~/ корр. счёт
209 -}
210 -
211 -
212 -Ответ:
213 -
214 -{
215 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
216 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
217 - "name": "string", ~/~/ имя
218 - "fullName": "string", ~/~/ полное наименование
219 - "isForeign": true, ~/~/ иностранный контрагент
220 - "district": "string", ~/~/ округ
221 - "region": "string", ~/~/ регион
222 - "city": "string", ~/~/ город
223 - "inn": "string", ~/~/ ИНН
224 - "kpp": "string", ~/~/ КПП
225 - "address": "string", ~/~/ юридический адрес
226 - "addressFact": "string", ~/~/ фактический адрес
227 - "email": "string", ~/~/ email
228 - "director": "string", ~/~/ ФИО руководителя
229 - "bankName": "string", ~/~/ банк
230 - "bankBIK": "string", ~/~/ БИК
231 - "bankRS": "string", ~/~/ номер счёта
232 - "bankKS": "string" ~/~/ корр. счёт
233 -}
234 -
235 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
236 -
237 -(% class="box errormessage" %)
238 -(((
239 -**DELETE /api/v3/agents/{clientId}**
240 -)))
241 -
242 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
243 -
244 -Метод запроса: **DELETE**
245 -
246 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
247 -
248 -Параметр запроса: **{clientId}** - Guid пользователя
249 -
250 -В заголовках запроса: X-Auth: Токен авторизации
251 -
252 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
253 -
254 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
255 -
256 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
257 -
258 258  (% class="box successmessage" %)
259 259  (((
260 -(% lang="en-US" %)**POST /api/v3/users**
105 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
261 261  )))
262 262  
263 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
108 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
264 264  
265 265  (% style="color:#000000" %)Метод запроса: **POST**
266 266  
... ... @@ -268,161 +268,50 @@
268 268  
269 269  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
270 270  
271 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
116 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
272 272  
273 -(% style="color:#000000" %){ 
274 - "lastName": "", ~/~/ фамилия
275 - "firstName": "", ~/~/ имя
276 - "position": "", ~/~/ должность
277 - "phone": "", ~/~/ телефон
278 - "organization": "", ~/~/ организация
279 - "login": "", ~/~/ логин (обязателен)
280 - "password": "", ~/~/ пароль (обязателен)
281 - "email": "", ~/~/ email (обязателен)
282 - "description": "", ~/~/ описание
283 - "isEnabled": "", ~/~/ признак включения
284 - "parentId": "", ~/~/ Guid родительского агента
285 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
286 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
287 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
288 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
289 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
290 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
291 -}
292 -
293 293  (% style="text-align:left" %)
294 -(% style="color:#000000; font-weight:normal" %)Ответ:
119 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
295 295  
296 -(% style="text-align:left" %)
297 -(% style="color:#000000; font-weight:normal" %){    
298 298  
299 -(% style="text-align:left" %)
300 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
301 - "lastName": "" , ~/~/ Фамилия ,
302 - "firstName": "" , ~/~/ Имя
303 - "position": "" , ~/~/ Должность
304 - "phone": "" , ~/~/ Телефон
305 - "organization": "" , ~/~/ Организация
306 - "login": "" , ~/~/ Логин
307 - "password": "" , ~/~/ Пароль
308 - "email": "" , ~/~/ Email
309 - "description": "" , ~/~/ Описание
310 - "isEnabled": "" , ~/~/ Признак включения
311 - "parentId": "" , ~/~/ Guid родительского агента
312 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
313 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
314 - "kind": "" , ~/~/ тип аутентификации
315 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
316 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
317 -
318 -(% style="text-align:left" %)
319 -(% style="color:#000000; font-weight:normal" %)}
320 -
321 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
322 -
323 323  (% class="box successmessage" %)
324 324  (((
325 -(% lang="en-US" %)**POST /api/v3/users/find**
124 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
326 326  )))
327 327  
328 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
127 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
329 329  
330 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
129 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
331 331  
332 332  (% style="color:#000000" %)Метод запроса: **POST**
333 333  
334 334  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
335 335  
336 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
135 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
337 337  
338 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
137 +(% class="western" %)
138 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
139 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
140 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
141 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
339 339  
340 -(% style="color:#000000" %){
341 -
342 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
343 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
344 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
345 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
346 -
347 347  (% style="color:#000000" %)}
348 348  
349 -(% style="color:#000000" %)Ответ:
145 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
350 350  
351 -(% style="color:#000000" %){         (%%)
147 +(% class="western" style="margin-bottom:19px" %)
148 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
352 352  
353 - "id": "" , ~/~/ идентификатор пользователя
354 - "lastName": "" , ~/~/ фамилия
355 - "firstName": "" , ~/~/ имя
356 - "position": "" , ~/~/ должность
357 - "phone": "" , ~/~/ телефон
358 - "parentId": "" , ~/~/ идентификатор клиента-родителя
359 - "parentName": "" , ~/~/ наименование клиента-родителя
360 - "organization": "" , ~/~/ организация
361 - "login": "" , ~/~/ логин
362 - "email": "" , ~/~/ E-mail
363 - "sessionDuration":"", ~/~/ длительность сессии в минутах
364 - "status": "1",  ~/~/ статус пользователя
365 - "astLogged": "", ~/~/ дата/время последней авторизации
150 +(% lang="en-US" style="text-align:left" %)
151 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
366 366  
367 -(% style="color:#000000" %)}
368 368  
369 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
370 -
371 -(% class="box successmessage" %)
372 -(((
373 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
374 -)))
375 -
376 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
377 -
378 -(% style="color:#000000" %)Метод запроса: **GET**
379 -
380 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
381 -
382 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
383 -
384 -(% style="color:#000000" %)Ответ:
385 -
386 -(((
387 -(((
388 -{
389 - "id": "", ~/~/ GUID пользователя
390 - "lastName": "", ~/~/ Фамилия 
391 - "firstName": "", ~/~/ Имя
392 - "position": "", ~/~/ Должность
393 - "phone": "", ~/~/ Номер телефона
394 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
395 - "parentName": "", Наименование клиента, которому принадлежит пользователь
396 - "organization": "", ~/~/ Организация
397 - "login": "", ~/~/ Логин пользователя
398 - "email": "", ~/~/ Адрес электронной почты
399 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
400 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
401 - "description": "", ~/~/ Описание
402 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
403 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
404 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
405 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
406 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
407 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
408 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
409 - "groups": [], ~/~/ Список ролей пользователя
410 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
411 - "authDevices": [ ], ~/~/ Список авторизованных устройств
412 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
413 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
414 -}
415 -)))
416 -)))
417 -
418 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
419 -
420 420  (% class="box warningmessage" %)
421 421  (((
422 -(% lang="en-US" %)**PUT /api/v3/users**
156 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
423 423  )))
424 424  
425 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
159 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
426 426  
427 427  (% style="color:#000000" %)Метод запроса: **PUT**
428 428  
... ... @@ -431,239 +431,98 @@
431 431  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
432 432  
433 433  (% lang="en-US" style="text-align:left" %)
434 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
168 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
435 435  
436 -(% lang="en-US" style="text-align:left" %)
437 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
438 438  
439 -(% lang="en-US" style="text-align:left" %)
440 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
441 - "lastName": "" , ~/~/ фамилия
442 - "firstName": "" , ~/~/ имя
443 - "position": "" , ~/~/ должность
444 - "phone": "" , ~/~/ телефон
445 - "organization": "" , ~/~/ организация
446 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
447 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
448 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
449 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
450 - "isEnabled": "" , ~/~/ признак включения
451 - "parentId": "" , ~/~/ Guid родительского агента
452 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
453 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
454 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
455 - "kind": "" , ~/~/ тип аутентификации
456 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
457 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
458 -
459 -(% lang="en-US" style="text-align:left" %)
460 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
461 -
462 -(% lang="en-US" style="text-align:left" %)
463 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
464 -
465 -(% lang="en-US" style="text-align:left" %)
466 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
467 -
468 -(% lang="en-US" style="text-align:left" %)
469 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
470 - "lastName": "" , ~/~/ фамилия
471 - "firstName": "" , ~/~/ имя
472 - "position": "" , ~/~/ должность
473 - "phone": "" , ~/~/ телефон
474 - "organization": "" , ~/~/ организация
475 - "login": "" , ~/~/ логин
476 - "password": "" , ~/~/ пароль 
477 - "email": "" , ~/~/ email
478 - "description": "" , ~/~/ описание
479 - "isEnabled": "" , ~/~/ признак включения
480 - "parentId": "" , ~/~/ Guid родительского агента
481 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
482 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
483 - "kind": "" , ~/~/ тип аутентификации
484 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
485 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
486 -
487 -(% lang="en-US" style="text-align:left" %)
488 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
489 -
490 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
491 -
492 492  (% class="box warningmessage" %)
493 493  (((
494 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
173 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
495 495  )))
496 496  
497 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
176 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
498 498  
499 499  (% style="color:#000000" %)Метод запроса: **PUT**
500 500  
501 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
180 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:
502 502  
503 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
182 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
504 504  
505 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
184 +(% class="western" %)
185 +{{{ "description": "", // описание
186 + "data": "" // данные, связанные со сменой статуса}}}
506 506  
507 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
508 -
509 -(% style="color:#000000" %){
510 -
511 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
512 - "description": "" , ~/~/ описание
513 - "data": "" , ~/~/ данные, связанные со сменой статуса
514 -
515 515  (% style="color:#000000" %)}
516 516  
517 517  (% style="text-align:left" %)
518 518  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
519 519  
520 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
521 521  
522 -(% class="box warningmessage" %)
523 -(((
524 -**POST /api/v3/users/disable**
525 -)))
526 -
527 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
528 -
529 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
530 -
531 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
532 -
533 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
534 -
535 - [ 
536 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
537 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
538 - ]
539 -
540 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
541 -
542 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
543 -
544 -(% class="box warningmessage" %)
545 -(((
546 -**POST /api/v3/users/enable**
547 -)))
548 -
549 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
550 -
551 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
552 -
553 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
554 -
555 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
556 -
557 - [ 
558 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
559 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
560 - ]
561 -
562 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
563 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
564 -
565 -(((
566 -В теле ответа:
567 -{
568 - "errorMessages": [
569 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
570 - ],
571 - "users": [
572 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
573 - ]
574 -}
575 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
576 -"users" - массив id пользователей, которых не удалось включить или отключить.
577 -)))
578 -
579 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
580 -
581 581  (% class="box errormessage" %)
582 582  (((
583 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
196 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
584 584  )))
585 585  
586 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
199 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
587 587  
588 588  (% style="color:#000000" %)Метод запроса: **DELETE**
589 589  
590 590  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
591 591  
592 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
205 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
593 593  
594 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
595 -
596 596  (% style="text-align:left" %)
597 597  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
598 598  
599 599  
600 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
211 +(% class="box" style="text-align: center;" %)
212 +(((
213 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
214 +)))
601 601  
602 -
603 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
604 -
605 605  (% class="box infomessage" %)
606 606  (((
607 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
218 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
608 608  )))
609 609  
610 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
221 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
611 611  
612 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
223 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
613 613  
614 614  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
615 615  
616 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
227 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
617 617  
618 618  (% style="color:#000000" %)Метод запроса: **GET**
619 619  
620 620  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
621 621  
622 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
233 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
623 623  
624 624  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
625 625  
626 626  (% style="color:#000000" %)Ответ:
627 627  
628 -(((
629 -{
630 - "vehicleId": "", ~/~/ ID объекта
631 - "name": "", ~/~/ Имя объекта
632 - "imei": "", ~/~/ IMEI объекта
633 - "deviceTypeId": , ~/~/ ID типа устройства
634 - "deviceTypeName": "", ~/~/ Название типа устройства
635 - "sim1": "", ~/~/ Номер SIM1
636 - "parentId": "", Номер SIM2
637 - "parentName": "", Наименование клиента-родителя
638 - "modelId": "", ID модели объекта
639 - "modelName": "", Имя модели объекта
640 - "createdAt": "", Дата создания объекта
641 - "mileageCalcMethod": "", Выбранный метод расчета пробега
642 - "counters": { ~/~/ Нормы
643 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
644 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
645 - "mileage": "", ~/~/ Пробег по нормам в метрах
646 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
647 - },
648 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
649 - {
650 - "id": "", ~/~/ ID  задания
651 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
652 - "name": "", ~/~/ Наименование задания
653 - "description": "", ~/~/ Описание задания
654 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
655 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
656 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
657 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
658 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
659 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
660 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
661 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
662 - }
663 - ]
664 -}
665 -)))
239 +(% style="color:#000000" %){
666 666  
241 +(% class="western" %)
242 +{{{ "vehicleId": “”, // идентификатор объекта
243 + "name": "", // имя объекта
244 + "imei": "", // IMEI объекта
245 + "deviceTypeId": “”, // идентификатор устройства объекта
246 + "deviceTypeName": "" // наименование устройства объекта
247 + "parentId": "", // идентификатор клиента-родителя
248 + "parentName": "" // наименование клиента-родителя,
249 + "modelId": "", // идентификатор модели объекта
250 + "modelName": "" // наименование модели объекта,
251 + "unitId": "", // идентификатор подразделения
252 + "unitName": "", // наименование подразделения
253 + "status": “”, // статус объекта
254 + ...
255 + },
256 + ...}}}
257 +
258 +(% style="color:#000000" %)}
259 +
667 667  (% style="text-align:left" %)
668 668  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
669 669  
... ... @@ -671,14 +671,12 @@
671 671  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
672 672  
673 673  
674 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
675 -
676 676  (% class="box successmessage" %)
677 677  (((
678 -(% lang="en-US" %)**POST /api/v3/vehicles**
269 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
679 679  )))
680 680  
681 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
272 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
682 682  
683 683  (% style="color:#000000" %)Метод запроса: **POST**
684 684  
... ... @@ -686,132 +686,118 @@
686 686  
687 687  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
688 688  
689 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
280 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
690 690  
691 -(% style="color:#000000" %){
692 -
693 - "parentId": "" , ~/~/ ID клиента
694 - "name": "" , ~/~/ имя ТС
695 - "imei": "" , ~/~/ IMEI
696 - "deviceTypeId": "" , ~/~/ ID типа устройства
697 - "modelId": "" , ~/~/ ID модели
698 - "unitId": "" , ~/~/ ID подразделения
699 - "sim1": "" , ~/~/ Номер SIM 1
700 - "sim2": "" , ~/~/ Номер SIM2
701 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
702 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
703 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
704 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
705 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
706 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
707 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
708 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
709 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
710 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
711 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
712 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
713 - "counters": ~/~/ счетчики
714 - {
715 - "mileage": "" , ~/~/ пробег
716 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
717 - "motohours": "" , ~/~/ моточасы
718 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
282 +(% class="western" %)
283 +{{{ "parentId": "", // ID клиента
284 + "name": "", // имя ТС
285 + "imei": "", // IMEI
286 + "deviceTypeId": "",// ID типа устройства
287 + "modelId": "",
288 + "unitId": "", // ID подразделения
289 + "sim1": "", // Номер SIM 1
290 + "sim2": "", // Номер SIM2
291 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
292 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
293 + "consumptionIdle": "",// Расход топлива на холостом ходу
294 + "counters": {
295 + "mileage": "", // пробег
296 + "mileageEnabled": true, // флаг активности счётчика "пробег"
297 + "motohours":"", // моточасы
298 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
299 + },
300 + "cmsv6Parameters": { // параметры CMSv6
301 + "enabled": true, // флаг включения
302 + //"id": "", // идентификатор
303 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
304 + "login": "", // имя учетной записи
305 + "password": "" // пароль учетной записи
719 719   },
720 - "cmsv6Parameters": { ~/~/ параметры CMSv6
721 - "enabled": true, ~/~/ флаг включения
722 - "id": "" , ~/~/ идентификатор
723 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
724 - "login": "" , ~/~/ имя учетной записи
725 - "password": "" ~/~/ пароль учетной записи
726 - },
727 - "inspectionTasks": ~/~/ задания на ТО
307 + "inspectionTasks": [ // задания на ТО
728 728   {
729 - "enabled": "" , ~/~/ Признак включения
730 - "name": "" , ~/~/ Имя задания
731 - "description": "" , ~/~/ Описание задания
732 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
733 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
734 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
735 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
736 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
737 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
738 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
739 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
740 - }
309 + "enabled": "", // Признак включения
310 + "name": "", // Имя задания
311 + "description": "", // Описание задания
312 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
313 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
314 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
315 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
316 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
317 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
318 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
319 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
320 + },
321 + ]}}}
741 741  
742 -(% style="color:#000000" %) }
323 +(% style="color:#000000" %)… }
743 743  
744 744  (% style="color:#000000" %)Ответ:
745 745  
746 746  (% style="color:#000000" %){
747 747  
748 - "vehicleId": "", ~/~/ID ТС 
749 - "parentId": "", ~/~/Guid владельца ТС
750 - "name": "", ~/~/Имя объекта
751 - "imei": "", ~/~/IMEI
752 - "deviceTypeId": "", ~/~/ID типа устройства
753 - "modelId": "", ~/~/ID модели
754 - "unitId": "", ~/~/ID подразделения
755 - "sim1": "", ~/~/SIM1
756 - "sim2": "", ~/~/SIM2
757 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
758 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
759 - "counters": { ~/~/Счётчики
760 - "mileageEnabled": true,
761 - "motohoursEnabled": true,
762 - "mileage": "",
763 - "motohours": 345.0
764 - },
765 - "cmsv6Parameters": { ~/~/Параметры CmsV6
766 - "id": null,
767 - "enabled": true, ~/~/флаг включения
768 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
769 - "login": "", ~/~/ имя учетной записи
770 - "password": "" ~/~/ пароль учетной записи
771 - },
772 - "inspectionTasks": { ~/~/ задания на ТО
773 - "id": "", ~/~/ ID задачи
774 - "enabled": false, ~/~/ Признак включения
775 - "name": "", ~/~/ Имя задания
776 - "description": "", ~/~/ Описание задания
777 - "mileageCondition": "", ~/~/ Условие по пробегу
778 - "lastMileage": "", ~/~/ Пробег (в метрах)
779 - "motohoursCondition": "", ~/~/ Условие по моточасам
780 - "lastMotohours": "", ~/~/ Моточасы
781 - "periodicCondition": "", ~/~/ Условие периодичности по времени
782 - "kind": "", ~/~/ Вид периодичности по времени 
783 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
784 - }
329 +(% class="western" %)
330 +{{{ "vehicleId": "", //ID ТС
331 + "parentId": "", //Guid владельца ТС
332 + "name": "", //Имя объекта
333 + "imei": "", //IMEI
334 + "deviceTypeId": "", //ID типа устройства
335 + "modelId": "", //ID модели
336 + "unitId": "", //ID подразделения
337 + "sim1": "", //SIM1
338 + "sim2": "", //SIM2
339 + "consumptionPer100Km": "", //Расход топлива на 100 км
340 + "consumptionIdle": "", //Расход топлива на холостом ходу
341 + "counters": { //Счётчики
342 + "mileageEnabled": true,
343 + "motohoursEnabled": true,
344 + "mileage": "",
345 + "motohours": 345.0
346 + },
347 + "cmsv6Parameters": { //Параметры CmsV6
348 + "id": null,
349 + "enabled": true, //флаг включения
350 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
351 + "login": "", // имя учетной записи
352 + "password": "" // пароль учетной записи
353 + },
354 + "inspectionTasks": [ // задания на ТО
355 + {
356 + "id": "", // ID задачи
357 + "enabled": false, // Признак включения
358 + "name": "", // Имя задания
359 + "description": "", // Описание задания
360 + "mileageCondition": "", // Условие по пробегу
361 + "lastMileage": "", // Пробег (в метрах)
362 + "motohoursCondition": "", // Условие по моточасам
363 + "lastMotohours": "", // Моточасы
364 + "periodicCondition": "", // Условие периодичности по времени
365 + "kind": "", // Вид периодичности по времени
366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
367 + }
368 + ]}}}
785 785  
786 786  (% style="text-align:left" %)
787 787  (% style="color:#000000" %)}
788 788  
789 -**Валидация:**
790 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
791 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
792 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
793 793  
794 -
795 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
796 -
797 797  (% class="box successmessage" %)
798 798  (((
799 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
376 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
800 800  )))
801 801  
802 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
379 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
803 803  
804 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
381 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
805 805  
806 806  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
807 807  
808 808  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
809 809  
810 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
387 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
811 811  
812 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
389 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
813 813  
814 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
391 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
815 815  
816 816  (% style="color:#000000" %)Метод запроса: **POST**
817 817  
... ... @@ -819,117 +819,78 @@
819 819  
820 820  (% style="color:#000000" %)В заголовках запроса:
821 821  
822 -(% style="color:#000000" %)− Content-Type: __**application/json**__
399 +(% style="color:#000000" %)− Content-Type: application/json
823 823  
824 824  (% style="color:#000000" %)− X-Auth: Токен авторизации
825 825  
826 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
403 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
827 827  
828 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
405 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
829 829  
830 -{
831 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
832 - "name": null, ~/~/ Имя ТС (string, опционально)
833 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
834 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
835 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
836 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
837 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
838 - "customFields": null ~/~/ значение любого из произвольных полей ТС
839 -}
407 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
840 840  
841 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
409 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
842 842  
843 -(% style="color:#000000" %)Ответ:
411 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
844 844  
845 -(% style="color:#000000" %){
413 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
846 846  
847 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
848 - "name": "" ~/~/ наименование объекта
849 - "imei": "" ~/~/ IMEI объекта
850 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
851 - "deviceTypeName": "" ~/~/ наименование типа устройства
852 - "sim1": "" ~/~/ первый номер телефона
853 - "sim2": "" ~/~/ второй номер телефона
854 - "parentId": "" ~/~/ идентификатор клиента-родителя
855 - "parentName": "" ~/~/ наименование клиента-родителя
856 - "modelId": "" ~/~/ идентификатор модели объекта
857 - "modelName": "" ~/~/ наименование модели объекта
858 - "unitId": "" ~/~/ идентификатор подразделения
859 - "unitName": "" ~/~/ наименование подразделения
860 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
861 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
862 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
863 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
864 - "customFields": [ 
865 - {
866 - "id": "", ~/~/ идентификатор произвольного поля
867 - "name": "", ~/~/ имя произвольного поля
868 - "value": "", ~/~/ значение произвольного поля
869 - "forClient": true, ~/~/ право на отображение у клиента
870 - "forTooltip": false, ~/~/ право на отображение в подсказке
871 - "forReport": false ~/~/ право на отображение в отчетах
872 - }(%%)
873 -(% style="color:#000000" %)}
415 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
874 874  
875 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
417 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
876 876  
419 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
877 877  
878 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
879 879  
880 880  (% class="box successmessage" %)
881 881  (((
882 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
424 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
883 883  )))
884 884  
885 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
427 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
886 886  
887 887  (% style="color:#000000" %)Метод запроса: **POST**
888 888  
889 889  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
890 890  
891 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
433 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
892 892  
893 893  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
894 894  
895 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
437 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
896 896  
897 -(% style="color:#000000" %){
439 +(% class="western" %)
440 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
441 +  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
442 +  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
443 + "date": "", // Дата смены статуса (null если сменить немедленно)
444 + "description": "", // Описание
445 + "data": "", // Данные
446 + "overwrite": false, // Флаг перезаписи
447 + "stage": "", // Состояние, может быть null}}}
898 898  
899 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
900 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
901 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
902 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
903 - "description": "", ~/~/ Описание
904 - "data": "", ~/~/ Данные
905 - "overwrite": false, ~/~/ Флаг перезаписи
906 - "stage": "", ~/~/ Состояние, может быть null
907 -
908 908  (% style="color:#000000" %)}
909 909  
910 -(% style="color:#000000" %)Ответ:
451 +(% style="color:#000000" %)Ответ: {
911 911  
912 -(% style="color:#000000" %){
453 +(% class="western" %)
454 +{{{ "status": "", // значение статуса
455 + "date": "", // Дата смены статуса
456 + "description": "", // Описание
457 + "data": "", // Данные
458 + "overwrite": false, // Флаг перезаписи
459 + "stage": "", // Состояние}}}
913 913  
914 - "status": "", ~/~/ значение статуса
915 - "date": "", ~/~/ Дата смены статуса 
916 - "description": "", ~/~/ Описание
917 - "data": "", ~/~/ Данные
918 - "overwrite": false, ~/~/ Флаг перезаписи
919 - "stage": "", ~/~/ Состояние
920 -
921 921  (% style="text-align:left" %)
922 -(% style="color:#000000" %) }
462 +(% style="color:#000000" %)}
923 923  
924 924  
925 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
926 -
927 927  (% class="box warningmessage" %)
928 928  (((
929 -(% lang="en-US" %)**PUT /api/v3/vehicles**
467 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
930 930  )))
931 931  
932 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
470 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
933 933  
934 934  (% style="color:#000000" %)Метод запроса: **PUT**
935 935  
... ... @@ -939,133 +939,26 @@
939 939  
940 940  (% style="color:#000000" %)Параметры в теле запроса (JSON):
941 941  
942 -(% style="color:#000000" %){    
480 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
943 943  
944 -(((
945 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
946 - "parentId": "", ~/~/ ID клиента
947 - "name": "", ~/~/ имя ТС
948 - "imei": "", ~/~/ IMEI
949 - "deviceTypeId": "", ~/~/ ID типа устройства
950 - "modelId": "", ~/~/ , ID модели    
951 - "unitId": "", ~/~/ подразделения
952 - "sim1": "", ~/~/ SIM 1
953 - "sim2": "", ~/~/ SIM2     (%%)
954 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
955 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
956 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
957 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
958 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
959 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
960 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
961 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
962 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
963 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
964 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
965 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
966 -(% style="color:#000000" %) "counters": 
967 - {
968 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
969 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
970 - "mileage": "", ~/~/ пробег, в метрах 
971 - "motohours": "" ~/~/ моточасы, в секундах
972 - }
973 - "cmsv6Parameters": ~/~/ параметры CMSv6
974 - {       
975 - "id": "", ~/~/ идентификатор
976 - "enabled": true, ~/~/ флаг включения
977 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
978 - "login": "", ~/~/ имя учетной записи
979 - "password": "", ~/~/ пароль учетной записи
980 - }
981 - "inspectionTasks": ~/~/ задания на ТО
982 - {
983 - "id": "", ~/~/ ID задания
984 - "enabled": false, ~/~/ Признак включения
985 - "name": "", ~/~/ Имя задания
986 - "description": "", ~/~/ Описание задания
987 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
988 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
989 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
990 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
991 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
992 - "kind": "", ~/~/ Вид периодичности по времени
993 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
994 - } 
995 -)))
996 -
997 -(% style="color:#000000" %)}
998 -
999 999  (% style="color:#000000" %)Ответ:
1000 1000  
1001 1001  (% lang="en-US" style="text-align:left" %)
1002 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
485 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
1003 1003  
1004 -(% lang="en-US" style="text-align:left" %)
1005 - "vehicleId": "", ~/~/ ID ТС
1006 - "parentId": "", ~/~/ ID клиента
1007 - "name": "", ~/~/ имя ТС
1008 - "imei": "", ~/~/ IMEI
1009 - "deviceTypeId": "", ~/~/ типа устройства
1010 - "modelId": "", ~/~/ ID модели
1011 - "unitId": "", ~/~/ ID подразделения
1012 - "sim1": "", ~/~/ SIM 1
1013 - "sim2": "", ~/~/ SIM2
1014 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1015 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1016 - "counters": 
1017 - {
1018 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1019 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1020 - "mileage": "", ~/~/ пробег
1021 - "motohours": "", ~/~/ моточасы
1022 - }
1023 - "cmsv6Parameters": ~/~/ параметры CMSv6
1024 - {
1025 - "id": ~/~/ идентификатор
1026 - "enabled": true, ~/~/ флаг включения
1027 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1028 - "login": "", ~/~/ имя учетной записи
1029 - "password": "", ~/~/ пароль учетной записи
1030 - }
1031 - "inspectionTasks": ~/~/ задания на ТО
1032 - {
1033 - "id": "", ~/~/ ID задания
1034 - "enabled": false, ~/~/ Признак включения
1035 - "name": "", ~/~/ Имя задания
1036 - "description": "", ~/~/ Описание задания
1037 - "mileageCondition": "", ~/~/ Условие по пробегу
1038 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1039 - "motohoursCondition": "", ~/~/ Условие по моточасам
1040 - "lastMotohours": "", ~/~/ Моточасы
1041 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1042 - "kind": "", ~/~/ Вид периодичности по времени
1043 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1044 - }
1045 1045  
1046 -(% lang="en-US" style="text-align:left" %)
1047 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1048 -
1049 -**валидация:**
1050 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1051 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1052 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1053 -
1054 -
1055 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1056 -
1057 1057  (% class="box errormessage" %)
1058 1058  (((
1059 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
490 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1060 1060  )))
1061 1061  
1062 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
493 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1063 1063  
1064 1064  (% style="color:#000000" %)Метод запроса: **DELETE**
1065 1065  
1066 1066  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1067 1067  
1068 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
499 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1069 1069  
1070 1070  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1071 1071  
... ... @@ -1073,17 +1073,17 @@
1073 1073  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1074 1074  
1075 1075  
1076 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
507 +(% class="box" lang="en-US" style="text-align: center;" %)
508 +(((
509 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
510 +)))
1077 1077  
1078 -
1079 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1080 -
1081 1081  (% class="box infomessage" %)
1082 1082  (((
1083 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
514 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1084 1084  )))
1085 1085  
1086 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
517 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1087 1087  
1088 1088  (% style="color:#000000" %)Метод запроса: **GET**
1089 1089  
... ... @@ -1091,28 +1091,29 @@
1091 1091  
1092 1092  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1093 1093  
1094 -(% style="color:#000000" %)Ответ:
525 +(% style="color:#000000" %)Ответ: [
1095 1095  
1096 -(% style="color:#000000" %){
527 +(% class="western" %)
528 +{{{ {
529 + "deviceTypeId" : "", // ID типа устройства
530 + "deviceTypeName" : "" // Название типа устройства
531 + },}}}
1097 1097  
1098 - "deviceTypeId" : "", ~/~/ ID типа устройства
1099 - "deviceTypeName" : "" ~/~/ Название типа устройства
1100 -
1101 1101  (% style="text-align:left" %)
1102 -(% style="color:#000000" %)}
534 +(% style="color:#000000" %)…** **]
1103 1103  
1104 1104  
1105 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
537 +(% class="box" style="text-align: center;" %)
538 +(((
539 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
540 +)))
1106 1106  
1107 -
1108 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1109 -
1110 1110  (% class="box infomessage" %)
1111 1111  (((
1112 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
544 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1113 1113  )))
1114 1114  
1115 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
547 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1116 1116  
1117 1117  (% style="color:#000000" %)Метод запроса: **GET**
1118 1118  
... ... @@ -1120,16 +1120,19 @@
1120 1120  
1121 1121  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1122 1122  
1123 -(% style="color:#000000" %)Ответ:
555 +(% style="color:#000000" %)Ответ: [
1124 1124  
1125 -(% style="color:#000000" %){
557 +(% class="western" style="margin-bottom:19px" %)
558 +{{{ {}}}
1126 1126  
1127 - "id": "", ~/~/ ID типа датчика 
1128 - "name": "", ~/~/ Название
1129 - "description": "", ~/~/ Описание
560 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1130 1130  
562 +(% class="western" %)
563 +{{{ "description": "" // Описание
564 + },}}}
565 +
1131 1131  (% style="text-align:left" %)
1132 -(% style="color:#000000" %)}
567 +(% style="color:#000000" %)… ]
1133 1133  
1134 1134  
1135 1135  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

ГЛОНАССSoft wiki - 2024 г.