<
От версии < 70.1 >
отредактировано Илья Крайнов
на 2022/12/05 17:36
К версии < 16.1 >
отредактировано Артем Шемяков
на 2022/09/01 15:36
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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

Меню

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