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

Меню

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