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

Меню

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