Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 22.5 >
edited by Артем Шемяков
on 2022/09/02 10:06
To version < 16.2 >
edited by Артем Шемяков
on 2022/09/01 16:25
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -31,21 +31,11 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ:**
37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
38 38  
39 -(% lang="en-US" %)
40 -(% style="color:#000000" %){
41 -
42 -(% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
45 -
46 -(% lang="en-US" %)
47 -}
48 -
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
51 51  
... ... @@ -82,144 +82,108 @@
82 82  
83 83  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
75 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86 86  
87 87  (% style="color:#000000" %)Метод запроса: **GET**
88 88  
89 89  (% 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>
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92 92  
93 93  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
95 -(% style="color:#000000" %)Ответ:
85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
96 96  
97 -(% style="color:#000000" %){
98 - "agentId": "", ~/~/ идентификатор клиента
99 - "parentId": "", ~/~/ идентификатор клиента-родителя
100 - "name": "", ~/~/ наименование клиента
101 - "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 - "status": "", ~/~/ статус клиента
104 -}
87 +(% 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" %)]
105 105  
106 106  
107 -(% class="box" style="text-align: center;" %)
90 +(% class="box" lang="en-US" style="text-align: center;" %)
108 108  (((
109 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
92 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
110 110  )))
111 111  
112 -(% class="box successmessage" %)
95 +(% class="box infomessage" %)
113 113  (((
114 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
97 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
115 115  )))
116 116  
117 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
100 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
118 118  
119 -(% style="color:#000000" %)Метод запроса: **POST**
102 +(% style="color:#000000" %)Метод запроса: **GET**
120 120  
121 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
104 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
122 122  
123 123  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
124 124  
125 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
108 +(% style="color:#000000" %)Ответ: [
126 126  
127 -(% style="color:#000000" %){ 
128 - "lastName": "", ~/~/ фамилия
129 - "firstName": "", ~/~/ имя
130 - "position": "", ~/~/ должность
131 - "phone": "", ~/~/ телефон
132 - "organization": "", ~/~/ организация
133 - "login": "", ~/~/ логин
134 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 - "email": "", ~/~/ email
136 - "description": "", ~/~/ описание
137 - "isEnabled": "", ~/~/ признак включения
138 - "parentId": "", ~/~/ Guid родительского агента
139 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
140 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
141 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 - "groups": "" , ~/~/ группы пользователя, названия групп
145 -}
110 +(% class="western" %)
111 +{{{ {
112 + "deviceTypeId" : "", // ID типа устройства
113 + "deviceTypeName" : "" // Название типа устройства
114 + },}}}
146 146  
147 147  (% style="text-align:left" %)
148 -(% style="color:#000000; font-weight:normal" %)Ответ:
117 +(% style="color:#000000" %)…** **]
149 149  
150 -(% style="text-align:left" %)
151 -(% style="color:#000000; font-weight:normal" %){    
152 152  
153 -(% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
155 - "lastName": "" , ~/~/ Фамилия ,
156 - "firstName": "" , ~/~/ Имя
157 - "position": "" , ~/~/ Должность
158 - "phone": "" , ~/~/ Телефон
159 - "organization": "" , ~/~/ Организация
160 - "login": "" , ~/~/ Логин
161 - "password": "" , ~/~/ Пароль
162 - "email": "" , ~/~/ Email
163 - "description": "" , ~/~/ Описание
164 - "isEnabled": "" , ~/~/ Признак включения
165 - "parentId": "" , ~/~/ Guid родительского агента
166 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
167 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 - "kind": "" , ~/~/ тип аутентификации
169 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
120 +(% class="box" style="text-align: center;" %)
121 +(((
122 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
123 +)))
171 171  
172 -(% style="text-align:left" %)
173 -(% style="color:#000000; font-weight:normal" %)}
174 -
175 -
176 -(% class="box successmessage" %)
125 +(% class="box infomessage" %)
177 177  (((
178 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
127 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
179 179  )))
180 180  
181 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
130 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
182 182  
183 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
132 +(% style="color:#000000" %)Метод запроса: **GET**
184 184  
185 -(% style="color:#000000" %)Метод запроса: **POST**
134 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
186 186  
187 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
136 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
188 188  
189 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
138 +(% style="color:#000000" %)Ответ: [
190 190  
191 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
140 +(% class="western" style="margin-bottom:19px" %)
141 +{{{ {}}}
192 192  
193 -(% style="color:#000000" %){
143 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
194 194  
195 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
196 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
197 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
198 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
145 +(% class="western" %)
146 +{{{ "description": "" // Описание
147 + },}}}
199 199  
200 -(% style="color:#000000" %)}
149 +(% style="text-align:left" %)
150 +(% style="color:#000000" %)… ]
201 201  
202 -(% style="color:#000000" %)Ответ:
203 203  
204 -(% style="color:#000000" %){         (%%)
153 +(% class="box" style="text-align: center;" %)
154 +(((
155 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
156 +)))
205 205  
206 - "id": "" , ~/~/ идентификатор пользователя
207 - "lastName": "" , ~/~/ фамилия
208 - "firstName": "" , ~/~/ имя
209 - "position": "" , ~/~/ должность
210 - "phone": "" , ~/~/ телефон
211 - "parentId": "" , ~/~/ идентификатор клиента-родителя
212 - "parentName": "" , ~/~/ наименование клиента-родителя
213 - "organization": "" , ~/~/ организация
214 - "login": "" , ~/~/ логин
215 - "email": "" , ~/~/ E-mail
216 - "sessionDuration":"", ~/~/ длительность сессии в минутах
217 - "status": "1",  ~/~/ статус пользователя
218 - "astLogged": "", ~/~/ дата/время последней авторизации
158 +(% class="box successmessage" %)
159 +(((
160 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
161 +)))
219 219  
220 -(% style="color:#000000" %)}
163 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
221 221  
165 +(% style="color:#000000" %)Метод запроса: **POST**
222 222  
167 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
168 +
169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
170 +
171 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
172 +
173 +(% style="text-align:left" %)
174 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
175 +
176 +
223 223  (% class="box warningmessage" %)
224 224  (((
225 225  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -234,90 +234,62 @@
234 234  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235 235  
236 236  (% lang="en-US" style="text-align:left" %)
237 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
191 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
238 238  
239 -(% lang="en-US" style="text-align:left" %)
240 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
241 241  
242 -(% lang="en-US" style="text-align:left" %)
243 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
244 - "lastName": "" , ~/~/ фамилия
245 - "firstName": "" , ~/~/ имя
246 - "position": "" , ~/~/ должность
247 - "phone": "" , ~/~/ телефон
248 - "organization": "" , ~/~/ организация
249 - "login": "" , ~/~/ логин
250 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 - "email": "" , ~/~/ email
252 - "description": "" , ~/~/ описание
253 - "isEnabled": "" , ~/~/ признак включения
254 - "parentId": "" , ~/~/ Guid родительского агента
255 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
256 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
257 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
258 - "kind": "" , ~/~/ тип аутентификации
259 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
260 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
194 +(% class="box warningmessage" %)
195 +(((
196 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
197 +)))
261 261  
262 -(% lang="en-US" style="text-align:left" %)
263 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
199 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
264 264  
265 -(% lang="en-US" style="text-align:left" %)
266 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
201 +(% style="color:#000000" %)Метод запроса: **PUT**
267 267  
268 -(% lang="en-US" style="text-align:left" %)
269 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
203 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:
270 270  
271 -(% lang="en-US" style="text-align:left" %)
272 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
273 - "lastName": "" , ~/~/ фамилия
274 - "firstName": "" , ~/~/ имя
275 - "position": "" , ~/~/ должность
276 - "phone": "" , ~/~/ телефон
277 - "organization": "" , ~/~/ организация
278 - "login": "" , ~/~/ логин
279 - "password": "" , ~/~/ пароль 
280 - "email": "" , ~/~/ email
281 - "description": "" , ~/~/ описание
282 - "isEnabled": "" , ~/~/ признак включения
283 - "parentId": "" , ~/~/ Guid родительского агента
284 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
285 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
286 - "kind": "" , ~/~/ тип аутентификации
287 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
288 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
205 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
289 289  
290 -(% lang="en-US" style="text-align:left" %)
291 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
207 +(% class="western" %)
208 +{{{ "description": "", // описание
209 + "data": "" // данные, связанные со сменой статуса}}}
292 292  
211 +(% style="color:#000000" %)}
293 293  
294 -(% class="box warningmessage" %)
213 +(% style="text-align:left" %)
214 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
215 +
216 +
217 +(% class="box successmessage" %)
295 295  (((
296 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
219 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
297 297  )))
298 298  
299 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
222 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
300 300  
301 -(% style="color:#000000" %)Метод запроса: **PUT**
224 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
302 302  
303 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
226 +(% style="color:#000000" %)Метод запроса: **POST**
304 304  
305 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
228 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
306 306  
307 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
230 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
308 308  
309 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
232 +(% class="western" %)
233 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
234 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
235 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
236 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
310 310  
311 -(% style="color:#000000" %){
238 +(% style="color:#000000" %)}
312 312  
313 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
314 - "description": "" , ~/~/ описание
315 - "data": "" , ~/~/ данные, связанные со сменой статуса
240 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
316 316  
317 -(% style="color:#000000" %)}
242 +(% class="western" style="margin-bottom:19px" %)
243 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
318 318  
319 -(% style="text-align:left" %)
320 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
245 +(% lang="en-US" style="text-align:left" %)
246 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
321 321  
322 322  
323 323  (% class="box errormessage" %)
... ... @@ -331,10 +331,8 @@
331 331  
332 332  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
333 333  
334 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
260 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
335 335  
336 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337 -
338 338  (% style="text-align:left" %)
339 339  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
340 340  
... ... @@ -344,6 +344,25 @@
344 344  (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
345 345  )))
346 346  
271 +(% class="box errormessage" %)
272 +(((
273 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
274 +)))
275 +
276 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
277 +
278 +(% style="color:#000000" %)Метод запроса: **DELETE**
279 +
280 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
281 +
282 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
283 +
284 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
285 +
286 +(% style="text-align:left" %)
287 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
288 +
289 +
347 347  (% class="box infomessage" %)
348 348  (((
349 349  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -355,13 +355,13 @@
355 355  
356 356  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
357 357  
358 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
301 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
359 359  
360 360  (% style="color:#000000" %)Метод запроса: **GET**
361 361  
362 362  (% 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>
363 363  
364 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
307 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
365 365  
366 366  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
367 367  
... ... @@ -369,20 +369,24 @@
369 369  
370 370  (% style="color:#000000" %){
371 371  
372 - "vehicleId": "" , ~/~/ идентификатор объекта
373 - "name": "" , ~/~/ имя объекта
374 - "imei": "" , ~/~/ IMEI объекта
375 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
376 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
377 - "parentId": "" , ~/~/ идентификатор клиента-родителя
378 - "parentName": "" , ~/~/ наименование клиента-родителя,
379 - "modelId": "" , ~/~/ идентификатор модели объекта
380 - "modelName": "" , ~/~/ наименование модели объекта,
381 - "unitId": "" , ~/~/ идентификатор подразделения
382 - "unitName": "" , ~/~/ наименование подразделения
383 - "status": "" , ~/~/ статус объекта
315 +(% class="western" %)
316 +{{{ "vehicleId": “”, // идентификатор объекта
317 + "name": "", // имя объекта
318 + "imei": "", // IMEI объекта
319 + "deviceTypeId": “”, // идентификатор устройства объекта
320 + "deviceTypeName": "" // наименование устройства объекта
321 + "parentId": "", // идентификатор клиента-родителя
322 + "parentName": "" // наименование клиента-родителя,
323 + "modelId": "", // идентификатор модели объекта
324 + "modelName": "" // наименование модели объекта,
325 + "unitId": "", // идентификатор подразделения
326 + "unitName": "", // наименование подразделения
327 + "status": “”, // статус объекта
328 + ...
329 + },
330 + ...}}}
384 384  
385 -}
332 +(% style="color:#000000" %)}
386 386  
387 387  (% style="text-align:left" %)
388 388  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -404,397 +404,235 @@
404 404  
405 405  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
406 406  
407 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
354 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
408 408  
409 -(% style="color:#000000" %){
410 -
411 - "parentId": "" , ~/~/ ID клиента
412 - "name": "" , ~/~/ имя ТС
413 - "imei": "" , ~/~/ IMEI
414 - "deviceTypeId": "" , ~/~/ ID типа устройства
415 - "modelId": "" , ~/~/ ID модели
416 - "unitId": "" , ~/~/ ID подразделения
417 - "sim1": "" , ~/~/ Номер SIM 1
418 - "sim2": "" , ~/~/ Номер SIM2
419 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 - "counters": {
423 - "mileage": "" , ~/~/ пробег
424 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 - "motohours": "" , ~/~/ моточасы
426 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
356 +(% class="western" %)
357 +{{{ "parentId": "", // ID клиента
358 + "name": "", // имя ТС
359 + "imei": "", // IMEI
360 + "deviceTypeId": "",// ID типа устройства
361 + "modelId": "",
362 + "unitId": "", // ID подразделения
363 + "sim1": "", // Номер SIM 1
364 + "sim2": "", // Номер SIM2
365 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
366 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
367 + "consumptionIdle": "",// Расход топлива на холостом ходу
368 + "counters": {
369 + "mileage": "", // пробег
370 + "mileageEnabled": true, // флаг активности счётчика "пробег"
371 + "motohours":"", // моточасы
372 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
373 + },
374 + "cmsv6Parameters": { // параметры CMSv6
375 + "enabled": true, // флаг включения
376 + //"id": "", // идентификатор
377 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
378 + "login": "", // имя учетной записи
379 + "password": "" // пароль учетной записи
427 427   },
428 - "cmsv6Parameters": { ~/~/ параметры CMSv6
429 - "enabled": true, ~/~/ флаг включения
430 - "id": "" , ~/~/ идентификатор
431 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 - "login": "" , ~/~/ имя учетной записи
433 - "password": "" ~/~/ пароль учетной записи
434 - },
435 - "inspectionTasks": ~/~/ задания на ТО
381 + "inspectionTasks": [ // задания на ТО
436 436   {
437 - "enabled": "" , ~/~/ Признак включения
438 - "name": "" , ~/~/ Имя задания
439 - "description": "" , ~/~/ Описание задания
440 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
441 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
442 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
443 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
444 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
445 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
446 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
447 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
448 - }
383 + "enabled": "", // Признак включения
384 + "name": "", // Имя задания
385 + "description": "", // Описание задания
386 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
387 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
388 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
389 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
390 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
391 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
392 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
393 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
394 + },
395 + ]}}}
449 449  
450 -(% style="color:#000000" %) }
397 +(% style="color:#000000" %)… }
451 451  
452 452  (% style="color:#000000" %)Ответ:
453 453  
454 454  (% style="color:#000000" %){
455 455  
456 - "vehicleId": "", ~/~/ID ТС 
457 - "parentId": "", ~/~/Guid владельца ТС
458 - "name": "", ~/~/Имя объекта
459 - "imei": "", ~/~/IMEI
460 - "deviceTypeId": "", ~/~/ID типа устройства
461 - "modelId": "", ~/~/ID модели
462 - "unitId": "", ~/~/ID подразделения
463 - "sim1": "", ~/~/SIM1
464 - "sim2": "", ~/~/SIM2
465 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
466 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
467 - "counters": { ~/~/Счётчики
468 - "mileageEnabled": true,
469 - "motohoursEnabled": true,
470 - "mileage": "",
471 - "motohours": 345.0
472 - },
473 - "cmsv6Parameters": { ~/~/Параметры CmsV6
474 - "id": null,
475 - "enabled": true, ~/~/флаг включения
476 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
477 - "login": "", ~/~/ имя учетной записи
478 - "password": "" ~/~/ пароль учетной записи
479 - },
480 - "inspectionTasks": { ~/~/ задания на ТО
481 - "id": "", ~/~/ ID задачи
482 - "enabled": false, ~/~/ Признак включения
483 - "name": "", ~/~/ Имя задания
484 - "description": "", ~/~/ Описание задания
485 - "mileageCondition": "", ~/~/ Условие по пробегу
486 - "lastMileage": "", ~/~/ Пробег (в метрах)
487 - "motohoursCondition": "", ~/~/ Условие по моточасам
488 - "lastMotohours": "", ~/~/ Моточасы
489 - "periodicCondition": "", ~/~/ Условие периодичности по времени
490 - "kind": "", ~/~/ Вид периодичности по времени 
491 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
492 - }
403 +(% class="western" %)
404 +{{{ "vehicleId": "", //ID ТС
405 + "parentId": "", //Guid владельца ТС
406 + "name": "", //Имя объекта
407 + "imei": "", //IMEI
408 + "deviceTypeId": "", //ID типа устройства
409 + "modelId": "", //ID модели
410 + "unitId": "", //ID подразделения
411 + "sim1": "", //SIM1
412 + "sim2": "", //SIM2
413 + "consumptionPer100Km": "", //Расход топлива на 100 км
414 + "consumptionIdle": "", //Расход топлива на холостом ходу
415 + "counters": { //Счётчики
416 + "mileageEnabled": true,
417 + "motohoursEnabled": true,
418 + "mileage": "",
419 + "motohours": 345.0
420 + },
421 + "cmsv6Parameters": { //Параметры CmsV6
422 + "id": null,
423 + "enabled": true, //флаг включения
424 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
425 + "login": "", // имя учетной записи
426 + "password": "" // пароль учетной записи
427 + },
428 + "inspectionTasks": [ // задания на ТО
429 + {
430 + "id": "", // ID задачи
431 + "enabled": false, // Признак включения
432 + "name": "", // Имя задания
433 + "description": "", // Описание задания
434 + "mileageCondition": "", // Условие по пробегу
435 + "lastMileage": "", // Пробег (в метрах)
436 + "motohoursCondition": "", // Условие по моточасам
437 + "lastMotohours": "", // Моточасы
438 + "periodicCondition": "", // Условие периодичности по времени
439 + "kind": "", // Вид периодичности по времени
440 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
441 + }
442 + ]}}}
493 493  
494 494  (% style="text-align:left" %)
495 495  (% style="color:#000000" %)}
496 496  
497 497  
498 -(% class="box successmessage" %)
448 +(% class="box warningmessage" %)
499 499  (((
500 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
450 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
501 501  )))
502 502  
503 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
453 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
504 504  
505 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
455 +(% style="color:#000000" %)Метод запроса: **PUT**
506 506  
507 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
457 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
508 508  
509 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
459 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
510 510  
511 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
461 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
512 512  
513 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
463 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
514 514  
515 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
516 -
517 -(% style="color:#000000" %)Метод запроса: **POST**
518 -
519 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
520 -
521 -(% style="color:#000000" %)В заголовках запроса:
522 -
523 -(% style="color:#000000" %)− Content-Type: application/json
524 -
525 -(% style="color:#000000" %)− X-Auth: Токен авторизации
526 -
527 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
528 -
529 -(% class="western" style="color:#000000" %)##{##
530 -
531 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
532 - "name": null, ~/~/ Имя ТС (string, опционально) 
533 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
534 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
535 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
536 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
537 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
538 -(% style="color:#000000" %)}
539 -
540 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
541 -
542 542  (% style="color:#000000" %)Ответ:
543 543  
544 -(% style="color:#000000" %){
467 +(% lang="en-US" style="text-align:left" %)
468 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
545 545  
546 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
547 - "name": "" ~/~/ наименование объекта
548 - "imei": "" ~/~/ IMEI объекта
549 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
550 - "deviceTypeName": "" ~/~/ наименование типа устройства
551 - "sim1": "" ~/~/ первый номер телефона
552 - "sim2": "" ~/~/ второй номер телефона
553 - "parentId": "" ~/~/ идентификатор клиента-родителя
554 - "parentName": "" ~/~/ наименование клиента-родителя
555 - "modelId": "" ~/~/ идентификатор модели объекта
556 - "modelName": "" ~/~/ наименование модели объекта
557 - "unitId": "" ~/~/ идентификатор подразделения
558 - "unitName": "" ~/~/ наименование подразделения
559 - "status": "" ~/~/ статус объекта         
560 - "createdAt": "" ~/~/ дата создания объектов  (%%)
561 -(% style="color:#000000" %)}
562 562  
563 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
564 -
565 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
566 -
567 -
568 568  (% class="box successmessage" %)
569 569  (((
570 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
473 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
571 571  )))
572 572  
573 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
476 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
574 574  
575 -(% style="color:#000000" %)Метод запроса: **POST**
478 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
576 576  
577 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
480 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
578 578  
579 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
482 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
580 580  
581 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
484 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
582 582  
583 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
486 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
584 584  
585 -(% style="color:#000000" %){
488 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
586 586  
587 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
588 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
589 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
590 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
591 - "description": "", ~/~/ Описание
592 - "data": "", ~/~/ Данные
593 - "overwrite": false, ~/~/ Флаг перезаписи
594 - "stage": "", ~/~/ Состояние, может быть null
490 +(% style="color:#000000" %)Метод запроса: **POST**
595 595  
596 -(% style="color:#000000" %)}
492 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
597 597  
598 -(% style="color:#000000" %)Ответ:
494 +(% style="color:#000000" %)В заголовках запроса:
599 599  
600 -(% style="color:#000000" %){
496 +(% style="color:#000000" %)− Content-Type: application/json
601 601  
602 - "status": "", ~/~/ значение статуса
603 - "date": "", ~/~/ Дата смены статуса 
604 - "description": "", ~/~/ Описание
605 - "data": "", ~/~/ Данные
606 - "overwrite": false, ~/~/ Флаг перезаписи
607 - "stage": "", ~/~/ Состояние
498 +(% style="color:#000000" %)− X-Auth: Токен авторизации
608 608  
609 -(% style="text-align:left" %)
610 -(% style="color:#000000" %) }
500 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
611 611  
502 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
612 612  
613 -(% class="box warningmessage" %)
614 -(((
615 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
616 -)))
504 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
617 617  
618 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
506 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
619 619  
620 -(% style="color:#000000" %)Метод запроса: **PUT**
508 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
621 621  
622 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
510 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
623 623  
624 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
512 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
625 625  
626 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
514 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
627 627  
628 -(% style="color:#000000" %){    
516 +(% style="color:#000000" %)0 - «Блокировка»
629 629  
630 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
631 - "parentId": "", ~/~/ ID клиента
632 - "name": "", ~/~/ имя ТС
633 - "imei": "", ~/~/ IMEI
634 - "deviceTypeId": "", ~/~/ ID типа устройства
635 - "modelId": "", ~/~/ , ID модели    
636 - "unitId": "", ~/~/ подразделения
637 - "sim1": "", ~/~/ SIM 1
638 - "sim2": "", ~/~/ SIM2
639 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
640 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
641 - "counters": 
642 - {
643 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
644 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
645 - "mileage": «», пробег
646 - "motohours": «» моточасы
647 - }
648 - "cmsv6Parameters": ~/~/ параметры CMSv6
649 - {       
650 - "id": "", ~/~/ идентификатор
651 - "enabled": true, ~/~/ флаг включения
652 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
653 - "login": "", ~/~/ имя учетной записи
654 - "password": "", ~/~/ пароль учетной записи
655 - }
656 - "inspectionTasks": ~/~/ задания на ТО
657 - {
658 - "id": "", ~/~/ ID задания
659 - "enabled": false, ~/~/ Признак включения
660 - "name": "", ~/~/ Имя задания
661 - "description": "", ~/~/ Описание задания
662 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
663 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
664 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
665 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
666 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
667 - "kind": "", ~/~/ Вид периодичности по времени
668 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
669 - } 
518 +(% style="color:#000000" %)1 - «Активен»,
670 670  
671 -(% style="color:#000000" %)}
520 +(% style="color:#000000" %)2 - «Отменен»
672 672  
673 -(% style="color:#000000" %)Ответ:
522 +(% style="color:#000000" %)3 - «Оборудован»
674 674  
675 -(% lang="en-US" style="text-align:left" %)
676 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
524 +(% style="color:#000000" %)4 - «Диагностика»
677 677  
678 -(% lang="en-US" style="text-align:left" %)
679 - "vehicleId": "", ~/~/ ID ТС
680 - "parentId": "", ~/~/ ID клиента
681 - "name": "", ~/~/ имя ТС
682 - "imei": "", ~/~/ IMEI
683 - "deviceTypeId": "", ~/~/ типа устройства
684 - "modelId": "", ~/~/ ID модели
685 - "unitId": "", ~/~/ ID подразделения
686 - "sim1": "", ~/~/ SIM 1
687 - "sim2": "", ~/~/ SIM2
688 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
689 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
690 - "counters": 
691 - {
692 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
693 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
694 - "mileage": "", ~/~/ пробег
695 - "motohours": "", ~/~/ моточасы
696 - }
697 - "cmsv6Parameters": ~/~/ параметры CMSv6
698 - {
699 - "id": ~/~/ идентификатор
700 - "enabled": true, ~/~/ флаг включения
701 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
702 - "login": "", ~/~/ имя учетной записи
703 - "password": "", ~/~/ пароль учетной записи
704 - }
705 - "inspectionTasks": ~/~/ задания на ТО
706 - {
707 - "id": "", ~/~/ ID задания
708 - "enabled": false, ~/~/ Признак включения
709 - "name": "", ~/~/ Имя задания
710 - "description": "", ~/~/ Описание задания
711 - "mileageCondition": "", ~/~/ Условие по пробегу
712 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
713 - "motohoursCondition": "", ~/~/ Условие по моточасам
714 - "lastMotohours": "", ~/~/ Моточасы
715 - "periodicCondition": "", ~/~/ Условие периодичности по времени
716 - "kind": "", ~/~/ Вид периодичности по времени
717 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
718 - }
526 +(% style="color:#000000" %)5 - «Сервис»
719 719  
720 -(% lang="en-US" style="text-align:left" %)
721 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
528 +(% style="color:#000000" %)6 - «Демонтаж»
722 722  
530 +(% style="color:#000000" %)7 - «Монтаж»
723 723  
724 -(% class="box errormessage" %)
725 -(((
726 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
727 -)))
532 +(% style="color:#000000" %)8 - «Дозаказ»
728 728  
729 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
534 +(% style="color:#000000" %)9 - «Обслужен»
730 730  
731 -(% style="color:#000000" %)Метод запроса: **DELETE**
536 +(% style="color:#000000" %)10 - «Списан»
732 732  
733 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
538 +(% style="color:#000000" %)11 - «Неисправен»
734 734  
735 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
540 +(% style="color:#000000" %)12 - «Проверен»
736 736  
737 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
738 -
739 739  (% style="text-align:left" %)
740 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
543 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
741 741  
742 742  
743 -(% class="box" lang="en-US" style="text-align: center;" %)
546 +(% class="box successmessage" %)
744 744  (((
745 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
548 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
746 746  )))
747 747  
748 -(% class="box infomessage" %)
749 -(((
750 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
751 -)))
551 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
752 752  
753 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
553 +(% style="color:#000000" %)Метод запроса: **POST**
754 754  
755 -(% style="color:#000000" %)Метод запроса: **GET**
555 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
756 756  
757 -(% 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]]
557 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
758 758  
759 759  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
760 760  
761 -(% style="color:#000000" %)Ответ:
561 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
762 762  
763 -(% style="color:#000000" %){
563 +(% class="western" %)
564 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
565 + "date": "", // Дата смены статуса (null если сменить немедленно)
566 + "description": "", // Описание
567 + "data": "", // Данные
568 + "overwrite": false, // Флаг перезаписи
569 + "stage": "", // Состояние, может быть null}}}
764 764  
765 - "deviceTypeId" : "", ~/~/ ID типа устройства
766 - "deviceTypeName" : "" ~/~/ Название типа устройства
767 -
768 -(% style="text-align:left" %)
769 769  (% style="color:#000000" %)}
770 770  
573 +(% style="color:#000000" %)Ответ: {
771 771  
772 -(% class="box" style="text-align: center;" %)
773 -(((
774 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
775 -)))
575 +(% class="western" %)
576 +{{{ "status": "", // значение статуса
577 + "date": "", // Дата смены статуса
578 + "description": "", // Описание
579 + "data": "", // Данные
580 + "overwrite": false, // Флаг перезаписи
581 + "stage": "", // Состояние}}}
776 776  
777 -(% class="box infomessage" %)
778 -(((
779 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
780 -)))
781 -
782 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
783 -
784 -(% style="color:#000000" %)Метод запроса: **GET**
785 -
786 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
787 -
788 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
789 -
790 -(% style="color:#000000" %)Ответ:
791 -
792 -(% style="color:#000000" %){
793 -
794 - "id": "", ~/~/ ID типа датчика 
795 - "name": "", ~/~/ Название
796 - "description": "", ~/~/ Описание
797 -
798 798  (% style="text-align:left" %)
799 799  (% style="color:#000000" %)}
800 800  

Меню

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