<
From version < 77.1 >
edited by Илья Крайнов
on 2023/03/14 14:45
To version < 9.2 >
edited by Артем Шемяков
on 2022/09/01 14:47
>
Change comment: There is no comment for this version

Summary

Details

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

Меню

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