Last modified by Андрей Калиновский on 2025/04/21 14:13
<
From version < 66.12 >
edited by Илья Крайнов
on 2022/11/24 13:39
To version < 18.1 >
edited by Артем Шемяков
on 2022/09/01 16:46
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -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,49 @@
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" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
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 -}
87 +(% 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" %)]
110 110  
111 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
112 112  
113 -(% class="box successmessage" %)
90 +(% class="box" style="text-align: center;" %)
114 114  (((
115 -**POST /api/v3/agents **
92 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
116 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" %)
175 -(((
176 -**PUT /api/v3/agents**
177 -)))
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**
97 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
261 261  )))
262 262  
263 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
100 +(% 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):
108 +(% 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" %)Ответ:
111 +(% 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**
116 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
326 326  )))
327 327  
328 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
119 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
329 329  
330 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
121 +(% 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" %)Условия фильтрации объектов задаются в теле запроса.
127 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
337 337  
338 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
129 +(% class="western" %)
130 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
131 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
132 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
133 + //"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" %)Ответ:
137 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
350 350  
351 -(% style="color:#000000" %){         (%%)
139 +(% class="western" style="margin-bottom:19px" %)
140 +{{{ "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": "", ~/~/ дата/время последней авторизации
142 +(% lang="en-US" style="text-align:left" %)
143 +(% 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**
148 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
423 423  )))
424 424  
425 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
151 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
426 426  
427 427  (% style="color:#000000" %)Метод запроса: **PUT**
428 428  
... ... @@ -431,240 +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):
160 +(% 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}**
165 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
495 495  )))
496 496  
497 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
168 +(% 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}
172 +(% 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 пользователя
174 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
504 504  
505 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
176 +(% class="western" %)
177 +{{{ "description": "", // описание
178 + "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 -
543 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
544 -
545 -(% class="box warningmessage" %)
546 -(((
547 -**POST /api/v3/users/enable**
548 -)))
549 -
550 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
551 -
552 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
553 -
554 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
555 -
556 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
557 -
558 - [ 
559 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
560 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
561 - ]
562 -
563 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
564 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
565 -
566 -(((
567 -В теле ответа:
568 -{
569 - "errorMessages": [
570 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
571 - ],
572 - "users": [
573 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
574 - ]
575 -}
576 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
577 -"users" - массив id пользователей, которых не удалось включить или отключить.
578 -)))
579 -
580 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
581 -
582 582  (% class="box errormessage" %)
583 583  (((
584 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
188 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
585 585  )))
586 586  
587 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
191 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
588 588  
589 589  (% style="color:#000000" %)Метод запроса: **DELETE**
590 590  
591 591  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
592 592  
593 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
197 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
594 594  
595 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
596 -
597 597  (% style="text-align:left" %)
598 598  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
599 599  
600 600  
601 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
203 +(% class="box" style="text-align: center;" %)
204 +(((
205 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
206 +)))
602 602  
603 -
604 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
605 -
606 606  (% class="box infomessage" %)
607 607  (((
608 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
210 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
609 609  )))
610 610  
611 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
213 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
612 612  
613 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
215 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
614 614  
615 615  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
616 616  
617 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
219 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
618 618  
619 619  (% style="color:#000000" %)Метод запроса: **GET**
620 620  
621 621  (% 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>
622 622  
623 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
225 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
624 624  
625 625  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
626 626  
627 627  (% style="color:#000000" %)Ответ:
628 628  
629 -(((
630 -{
631 - "vehicleId": "", ~/~/ ID объекта
632 - "name": "", ~/~/ Имя объекта
633 - "imei": "", ~/~/ IMEI объекта
634 - "deviceTypeId": , ~/~/ ID типа устройства
635 - "deviceTypeName": "", ~/~/ Название типа устройства
636 - "sim1": "", ~/~/ Номер SIM1
637 - "parentId": "", Номер SIM2
638 - "parentName": "", Наименование клиента-родителя
639 - "modelId": "", ID модели объекта
640 - "modelName": "", Имя модели объекта
641 - "createdAt": "", Дата создания объекта
642 - "mileageCalcMethod": "", Выбранный метод расчета пробега
643 - "counters": { ~/~/ Нормы
644 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
645 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
646 - "mileage": "", ~/~/ Пробег по нормам в метрах
647 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
648 - },
649 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
650 - {
651 - "id": "", ~/~/ ID  задания
652 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
653 - "name": "", ~/~/ Наименование задания
654 - "description": "", ~/~/ Описание задания
655 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
656 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
657 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
658 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
659 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
660 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
661 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
662 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
663 - }
664 - ]
665 -}
666 -)))
231 +(% style="color:#000000" %){
667 667  
233 +(% class="western" %)
234 +{{{ "vehicleId": “”, // идентификатор объекта
235 + "name": "", // имя объекта
236 + "imei": "", // IMEI объекта
237 + "deviceTypeId": “”, // идентификатор устройства объекта
238 + "deviceTypeName": "" // наименование устройства объекта
239 + "parentId": "", // идентификатор клиента-родителя
240 + "parentName": "" // наименование клиента-родителя,
241 + "modelId": "", // идентификатор модели объекта
242 + "modelName": "" // наименование модели объекта,
243 + "unitId": "", // идентификатор подразделения
244 + "unitName": "", // наименование подразделения
245 + "status": “”, // статус объекта
246 + ...
247 + },
248 + ...}}}
249 +
250 +(% style="color:#000000" %)}
251 +
668 668  (% style="text-align:left" %)
669 669  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
670 670  
... ... @@ -672,14 +672,12 @@
672 672  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
673 673  
674 674  
675 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
676 -
677 677  (% class="box successmessage" %)
678 678  (((
679 -(% lang="en-US" %)**POST /api/v3/vehicles**
261 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
680 680  )))
681 681  
682 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
264 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
683 683  
684 684  (% style="color:#000000" %)Метод запроса: **POST**
685 685  
... ... @@ -687,132 +687,118 @@
687 687  
688 688  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
689 689  
690 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
272 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
691 691  
692 -(% style="color:#000000" %){
693 -
694 - "parentId": "" , ~/~/ ID клиента
695 - "name": "" , ~/~/ имя ТС
696 - "imei": "" , ~/~/ IMEI
697 - "deviceTypeId": "" , ~/~/ ID типа устройства
698 - "modelId": "" , ~/~/ ID модели
699 - "unitId": "" , ~/~/ ID подразделения
700 - "sim1": "" , ~/~/ Номер SIM 1
701 - "sim2": "" , ~/~/ Номер SIM2
702 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
703 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
704 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
705 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
706 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
707 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
708 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
709 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
710 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
711 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
712 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
713 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
714 - "counters": ~/~/ счетчики
715 - {
716 - "mileage": "" , ~/~/ пробег
717 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
718 - "motohours": "" , ~/~/ моточасы
719 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
274 +(% class="western" %)
275 +{{{ "parentId": "", // ID клиента
276 + "name": "", // имя ТС
277 + "imei": "", // IMEI
278 + "deviceTypeId": "",// ID типа устройства
279 + "modelId": "",
280 + "unitId": "", // ID подразделения
281 + "sim1": "", // Номер SIM 1
282 + "sim2": "", // Номер SIM2
283 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
284 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
285 + "consumptionIdle": "",// Расход топлива на холостом ходу
286 + "counters": {
287 + "mileage": "", // пробег
288 + "mileageEnabled": true, // флаг активности счётчика "пробег"
289 + "motohours":"", // моточасы
290 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
291 + },
292 + "cmsv6Parameters": { // параметры CMSv6
293 + "enabled": true, // флаг включения
294 + //"id": "", // идентификатор
295 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
296 + "login": "", // имя учетной записи
297 + "password": "" // пароль учетной записи
720 720   },
721 - "cmsv6Parameters": { ~/~/ параметры CMSv6
722 - "enabled": true, ~/~/ флаг включения
723 - "id": "" , ~/~/ идентификатор
724 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
725 - "login": "" , ~/~/ имя учетной записи
726 - "password": "" ~/~/ пароль учетной записи
727 - },
728 - "inspectionTasks": ~/~/ задания на ТО
299 + "inspectionTasks": [ // задания на ТО
729 729   {
730 - "enabled": "" , ~/~/ Признак включения
731 - "name": "" , ~/~/ Имя задания
732 - "description": "" , ~/~/ Описание задания
733 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
734 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
735 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
736 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
737 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
738 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
739 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
740 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
741 - }
301 + "enabled": "", // Признак включения
302 + "name": "", // Имя задания
303 + "description": "", // Описание задания
304 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
305 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
306 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
307 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
308 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
309 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
310 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
311 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
312 + },
313 + ]}}}
742 742  
743 -(% style="color:#000000" %) }
315 +(% style="color:#000000" %)… }
744 744  
745 745  (% style="color:#000000" %)Ответ:
746 746  
747 747  (% style="color:#000000" %){
748 748  
749 - "vehicleId": "", ~/~/ID ТС 
750 - "parentId": "", ~/~/Guid владельца ТС
751 - "name": "", ~/~/Имя объекта
752 - "imei": "", ~/~/IMEI
753 - "deviceTypeId": "", ~/~/ID типа устройства
754 - "modelId": "", ~/~/ID модели
755 - "unitId": "", ~/~/ID подразделения
756 - "sim1": "", ~/~/SIM1
757 - "sim2": "", ~/~/SIM2
758 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
759 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
760 - "counters": { ~/~/Счётчики
761 - "mileageEnabled": true,
762 - "motohoursEnabled": true,
763 - "mileage": "",
764 - "motohours": 345.0
765 - },
766 - "cmsv6Parameters": { ~/~/Параметры CmsV6
767 - "id": null,
768 - "enabled": true, ~/~/флаг включения
769 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
770 - "login": "", ~/~/ имя учетной записи
771 - "password": "" ~/~/ пароль учетной записи
772 - },
773 - "inspectionTasks": { ~/~/ задания на ТО
774 - "id": "", ~/~/ ID задачи
775 - "enabled": false, ~/~/ Признак включения
776 - "name": "", ~/~/ Имя задания
777 - "description": "", ~/~/ Описание задания
778 - "mileageCondition": "", ~/~/ Условие по пробегу
779 - "lastMileage": "", ~/~/ Пробег (в метрах)
780 - "motohoursCondition": "", ~/~/ Условие по моточасам
781 - "lastMotohours": "", ~/~/ Моточасы
782 - "periodicCondition": "", ~/~/ Условие периодичности по времени
783 - "kind": "", ~/~/ Вид периодичности по времени 
784 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
785 - }
321 +(% class="western" %)
322 +{{{ "vehicleId": "", //ID ТС
323 + "parentId": "", //Guid владельца ТС
324 + "name": "", //Имя объекта
325 + "imei": "", //IMEI
326 + "deviceTypeId": "", //ID типа устройства
327 + "modelId": "", //ID модели
328 + "unitId": "", //ID подразделения
329 + "sim1": "", //SIM1
330 + "sim2": "", //SIM2
331 + "consumptionPer100Km": "", //Расход топлива на 100 км
332 + "consumptionIdle": "", //Расход топлива на холостом ходу
333 + "counters": { //Счётчики
334 + "mileageEnabled": true,
335 + "motohoursEnabled": true,
336 + "mileage": "",
337 + "motohours": 345.0
338 + },
339 + "cmsv6Parameters": { //Параметры CmsV6
340 + "id": null,
341 + "enabled": true, //флаг включения
342 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
343 + "login": "", // имя учетной записи
344 + "password": "" // пароль учетной записи
345 + },
346 + "inspectionTasks": [ // задания на ТО
347 + {
348 + "id": "", // ID задачи
349 + "enabled": false, // Признак включения
350 + "name": "", // Имя задания
351 + "description": "", // Описание задания
352 + "mileageCondition": "", // Условие по пробегу
353 + "lastMileage": "", // Пробег (в метрах)
354 + "motohoursCondition": "", // Условие по моточасам
355 + "lastMotohours": "", // Моточасы
356 + "periodicCondition": "", // Условие периодичности по времени
357 + "kind": "", // Вид периодичности по времени
358 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
359 + }
360 + ]}}}
786 786  
787 787  (% style="text-align:left" %)
788 788  (% style="color:#000000" %)}
789 789  
790 -**Валидация:**
791 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
792 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
793 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
794 794  
795 -
796 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
797 -
798 798  (% class="box successmessage" %)
799 799  (((
800 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
368 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
801 801  )))
802 802  
803 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
371 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
804 804  
805 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
373 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
806 806  
807 807  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
808 808  
809 809  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
810 810  
811 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
379 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
812 812  
813 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
381 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
814 814  
815 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
383 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
816 816  
817 817  (% style="color:#000000" %)Метод запроса: **POST**
818 818  
... ... @@ -820,117 +820,103 @@
820 820  
821 821  (% style="color:#000000" %)В заголовках запроса:
822 822  
823 -(% style="color:#000000" %)− Content-Type: __**application/json**__
391 +(% style="color:#000000" %)− Content-Type: application/json
824 824  
825 825  (% style="color:#000000" %)− X-Auth: Токен авторизации
826 826  
827 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
395 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
828 828  
829 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
397 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
830 830  
831 -{
832 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
833 - "name": null, ~/~/ Имя ТС (string, опционально)
834 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
835 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
836 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
837 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
838 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
839 - "customFields": null ~/~/ значение любого из произвольных полей ТС
840 -}
399 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
841 841  
842 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
401 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
843 843  
844 -(% style="color:#000000" %)Ответ:
403 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
845 845  
846 -(% style="color:#000000" %){
405 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
847 847  
848 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
849 - "name": "" ~/~/ наименование объекта
850 - "imei": "" ~/~/ IMEI объекта
851 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
852 - "deviceTypeName": "" ~/~/ наименование типа устройства
853 - "sim1": "" ~/~/ первый номер телефона
854 - "sim2": "" ~/~/ второй номер телефона
855 - "parentId": "" ~/~/ идентификатор клиента-родителя
856 - "parentName": "" ~/~/ наименование клиента-родителя
857 - "modelId": "" ~/~/ идентификатор модели объекта
858 - "modelName": "" ~/~/ наименование модели объекта
859 - "unitId": "" ~/~/ идентификатор подразделения
860 - "unitName": "" ~/~/ наименование подразделения
861 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
862 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
863 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
864 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
865 - "customFields": [ 
866 - {
867 - "id": "", ~/~/ идентификатор произвольного поля
868 - "name": "", ~/~/ имя произвольного поля
869 - "value": "", ~/~/ значение произвольного поля
870 - "forClient": true, ~/~/ право на отображение у клиента
871 - "forTooltip": false, ~/~/ право на отображение в подсказке
872 - "forReport": false ~/~/ право на отображение в отчетах
873 - }(%%)
874 -(% style="color:#000000" %)}
407 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
875 875  
876 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
409 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
877 877  
411 +(% style="color:#000000" %)0 - «Блокировка»;
878 878  
879 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
413 +(% style="color:#000000" %)1 - «Активен»;
880 880  
415 +(% style="color:#000000" %)2 - «Отменен»;
416 +
417 +(% style="color:#000000" %)3 - «Оборудован»;
418 +
419 +(% style="color:#000000" %)4 - «Диагностика»;
420 +
421 +(% style="color:#000000" %)5 - «Сервис»;
422 +
423 +(% style="color:#000000" %)6 - «Демонтаж»;
424 +
425 +(% style="color:#000000" %)7 - «Монтаж»;
426 +
427 +(% style="color:#000000" %)8 - «Дозаказ»;
428 +
429 +(% style="color:#000000" %)9 - «Обслужен»;
430 +
431 +(% style="color:#000000" %)10 - «Списан»;
432 +
433 +(% style="color:#000000" %)11 - «Неисправен»;
434 +
435 +(% style="color:#000000" %)12 - «Проверен»;
436 +
437 +(% style="text-align:left" %)
438 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется».
439 +
440 +
881 881  (% class="box successmessage" %)
882 882  (((
883 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
443 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
884 884  )))
885 885  
886 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
446 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
887 887  
888 888  (% style="color:#000000" %)Метод запроса: **POST**
889 889  
890 890  (% 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}
891 891  
892 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
452 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
893 893  
894 894  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
895 895  
896 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
456 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
897 897  
898 -(% style="color:#000000" %){
458 +(% class="western" %)
459 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
460 + "date": "", // Дата смены статуса (null если сменить немедленно)
461 + "description": "", // Описание
462 + "data": "", // Данные
463 + "overwrite": false, // Флаг перезаписи
464 + "stage": "", // Состояние, может быть null}}}
899 899  
900 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
901 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
902 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
903 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
904 - "description": "", ~/~/ Описание
905 - "data": "", ~/~/ Данные
906 - "overwrite": false, ~/~/ Флаг перезаписи
907 - "stage": "", ~/~/ Состояние, может быть null
908 -
909 909  (% style="color:#000000" %)}
910 910  
911 -(% style="color:#000000" %)Ответ:
468 +(% style="color:#000000" %)Ответ: {
912 912  
913 -(% style="color:#000000" %){
470 +(% class="western" %)
471 +{{{ "status": "", // значение статуса
472 + "date": "", // Дата смены статуса
473 + "description": "", // Описание
474 + "data": "", // Данные
475 + "overwrite": false, // Флаг перезаписи
476 + "stage": "", // Состояние}}}
914 914  
915 - "status": "", ~/~/ значение статуса
916 - "date": "", ~/~/ Дата смены статуса 
917 - "description": "", ~/~/ Описание
918 - "data": "", ~/~/ Данные
919 - "overwrite": false, ~/~/ Флаг перезаписи
920 - "stage": "", ~/~/ Состояние
921 -
922 922  (% style="text-align:left" %)
923 -(% style="color:#000000" %) }
479 +(% style="color:#000000" %)}
924 924  
925 925  
926 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
927 -
928 928  (% class="box warningmessage" %)
929 929  (((
930 -(% lang="en-US" %)**PUT /api/v3/vehicles**
484 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
931 931  )))
932 932  
933 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
487 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
934 934  
935 935  (% style="color:#000000" %)Метод запроса: **PUT**
936 936  
... ... @@ -940,133 +940,26 @@
940 940  
941 941  (% style="color:#000000" %)Параметры в теле запроса (JSON):
942 942  
943 -(% style="color:#000000" %){    
497 +(% 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»: «» //Сколько раз выполнить задание } ] }
944 944  
945 -(((
946 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
947 - "parentId": "", ~/~/ ID клиента
948 - "name": "", ~/~/ имя ТС
949 - "imei": "", ~/~/ IMEI
950 - "deviceTypeId": "", ~/~/ ID типа устройства
951 - "modelId": "", ~/~/ , ID модели    
952 - "unitId": "", ~/~/ подразделения
953 - "sim1": "", ~/~/ SIM 1
954 - "sim2": "", ~/~/ SIM2     (%%)
955 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
956 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
957 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
958 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
959 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
960 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
961 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
962 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
963 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
964 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
965 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
966 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
967 -(% style="color:#000000" %) "counters": 
968 - {
969 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
970 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
971 - "mileage": "", ~/~/ пробег, в метрах 
972 - "motohours": "" ~/~/ моточасы, в секундах
973 - }
974 - "cmsv6Parameters": ~/~/ параметры CMSv6
975 - {       
976 - "id": "", ~/~/ идентификатор
977 - "enabled": true, ~/~/ флаг включения
978 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
979 - "login": "", ~/~/ имя учетной записи
980 - "password": "", ~/~/ пароль учетной записи
981 - }
982 - "inspectionTasks": ~/~/ задания на ТО
983 - {
984 - "id": "", ~/~/ ID задания
985 - "enabled": false, ~/~/ Признак включения
986 - "name": "", ~/~/ Имя задания
987 - "description": "", ~/~/ Описание задания
988 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
989 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
990 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
991 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
992 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
993 - "kind": "", ~/~/ Вид периодичности по времени
994 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
995 - } 
996 -)))
997 -
998 -(% style="color:#000000" %)}
999 -
1000 1000  (% style="color:#000000" %)Ответ:
1001 1001  
1002 1002  (% lang="en-US" style="text-align:left" %)
1003 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
502 +(% 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»: «» //Сколько раз выполнить задание } ] }
1004 1004  
1005 -(% lang="en-US" style="text-align:left" %)
1006 - "vehicleId": "", ~/~/ ID ТС
1007 - "parentId": "", ~/~/ ID клиента
1008 - "name": "", ~/~/ имя ТС
1009 - "imei": "", ~/~/ IMEI
1010 - "deviceTypeId": "", ~/~/ типа устройства
1011 - "modelId": "", ~/~/ ID модели
1012 - "unitId": "", ~/~/ ID подразделения
1013 - "sim1": "", ~/~/ SIM 1
1014 - "sim2": "", ~/~/ SIM2
1015 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1016 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1017 - "counters": 
1018 - {
1019 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1020 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1021 - "mileage": "", ~/~/ пробег
1022 - "motohours": "", ~/~/ моточасы
1023 - }
1024 - "cmsv6Parameters": ~/~/ параметры CMSv6
1025 - {
1026 - "id": ~/~/ идентификатор
1027 - "enabled": true, ~/~/ флаг включения
1028 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1029 - "login": "", ~/~/ имя учетной записи
1030 - "password": "", ~/~/ пароль учетной записи
1031 - }
1032 - "inspectionTasks": ~/~/ задания на ТО
1033 - {
1034 - "id": "", ~/~/ ID задания
1035 - "enabled": false, ~/~/ Признак включения
1036 - "name": "", ~/~/ Имя задания
1037 - "description": "", ~/~/ Описание задания
1038 - "mileageCondition": "", ~/~/ Условие по пробегу
1039 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1040 - "motohoursCondition": "", ~/~/ Условие по моточасам
1041 - "lastMotohours": "", ~/~/ Моточасы
1042 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1043 - "kind": "", ~/~/ Вид периодичности по времени
1044 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1045 - }
1046 1046  
1047 -(% lang="en-US" style="text-align:left" %)
1048 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1049 -
1050 -**валидация:**
1051 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1052 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1053 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1054 -
1055 -
1056 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1057 -
1058 1058  (% class="box errormessage" %)
1059 1059  (((
1060 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
507 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1061 1061  )))
1062 1062  
1063 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
510 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1064 1064  
1065 1065  (% style="color:#000000" %)Метод запроса: **DELETE**
1066 1066  
1067 1067  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1068 1068  
1069 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
516 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1070 1070  
1071 1071  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1072 1072  
... ... @@ -1074,17 +1074,17 @@
1074 1074  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1075 1075  
1076 1076  
1077 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
524 +(% class="box" lang="en-US" style="text-align: center;" %)
525 +(((
526 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
527 +)))
1078 1078  
1079 -
1080 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1081 -
1082 1082  (% class="box infomessage" %)
1083 1083  (((
1084 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
531 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1085 1085  )))
1086 1086  
1087 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
534 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1088 1088  
1089 1089  (% style="color:#000000" %)Метод запроса: **GET**
1090 1090  
... ... @@ -1092,28 +1092,29 @@
1092 1092  
1093 1093  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1094 1094  
1095 -(% style="color:#000000" %)Ответ:
542 +(% style="color:#000000" %)Ответ: [
1096 1096  
1097 -(% style="color:#000000" %){
544 +(% class="western" %)
545 +{{{ {
546 + "deviceTypeId" : "", // ID типа устройства
547 + "deviceTypeName" : "" // Название типа устройства
548 + },}}}
1098 1098  
1099 - "deviceTypeId" : "", ~/~/ ID типа устройства
1100 - "deviceTypeName" : "" ~/~/ Название типа устройства
1101 -
1102 1102  (% style="text-align:left" %)
1103 -(% style="color:#000000" %)}
551 +(% style="color:#000000" %)…** **]
1104 1104  
1105 1105  
1106 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
554 +(% class="box" style="text-align: center;" %)
555 +(((
556 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
557 +)))
1107 1107  
1108 -
1109 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1110 -
1111 1111  (% class="box infomessage" %)
1112 1112  (((
1113 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
561 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1114 1114  )))
1115 1115  
1116 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
564 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1117 1117  
1118 1118  (% style="color:#000000" %)Метод запроса: **GET**
1119 1119  
... ... @@ -1121,16 +1121,19 @@
1121 1121  
1122 1122  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1123 1123  
1124 -(% style="color:#000000" %)Ответ:
572 +(% style="color:#000000" %)Ответ: [
1125 1125  
1126 -(% style="color:#000000" %){
574 +(% class="western" style="margin-bottom:19px" %)
575 +{{{ {}}}
1127 1127  
1128 - "id": "", ~/~/ ID типа датчика 
1129 - "name": "", ~/~/ Название
1130 - "description": "", ~/~/ Описание
577 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1131 1131  
579 +(% class="western" %)
580 +{{{ "description": "" // Описание
581 + },}}}
582 +
1132 1132  (% style="text-align:left" %)
1133 -(% style="color:#000000" %)}
584 +(% style="color:#000000" %)… ]
1134 1134  
1135 1135  
1136 1136  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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