Last modified by Андрей Калиновский on 2025/04/21 14:13
From version 1.1 >
edited by Андрей Калиновский
on 2022/05/16 11:15
To version < 62.1 >
edited by Илья Крайнов
on 2022/11/24 13:06
>
Change comment: There is no comment for this version

Summary

Details

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

Меню

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