Last modified by Андрей Калиновский on 2025/03/28 11:43
<
From version < 20.7 >
edited by Артем Шемяков
on 2022/09/01 17:44
To version < 61.1 >
edited by Илья Крайнов
on 2022/11/24 11:54
>
Change comment: There is no comment for this version

Summary

Details

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

Меню

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