Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 20.1 >
edited by Артем Шемяков
on 2022/09/01 16:51
To version < 23.2 >
edited by Артем Шемяков
on 2022/09/02 12:30
>
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,11 +31,21 @@
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" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
37 +(% style="color:#000000" %)**Ответ:**
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 +
39 39  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 40  
41 41  
... ... @@ -44,7 +44,7 @@
44 44  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
45 45  )))
46 46  
47 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
48 48  
49 49  (% style="color:#000000" %)Метод запроса: **GET**
50 50  
... ... @@ -66,25 +66,32 @@
66 66  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
67 67  )))
68 68  
69 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
70 70  
71 71  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
72 72  
73 73  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
74 74  
75 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
76 76  
77 77  (% style="color:#000000" %)Метод запроса: **GET**
78 78  
79 79  (% 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>
80 80  
81 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
91 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
82 82  
83 83  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
84 84  
85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
95 +(% style="color:#000000" %)Ответ:
86 86  
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" %)]
97 +(% style="color:#000000" %){
98 + "agentId": "", ~/~/ идентификатор клиента
99 + "parentId": "", ~/~/ идентификатор клиента-родителя
100 + "name": "", ~/~/ наименование клиента
101 + "fullName": "", ~/~/ полное наименование клиента
102 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 + "status": "", ~/~/ статус клиента
104 +}
88 88  
89 89  
90 90  (% class="box" style="text-align: center;" %)
... ... @@ -97,7 +97,7 @@
97 97  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
98 98  )))
99 99  
100 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
101 101  
102 102  (% style="color:#000000" %)Метод запроса: **POST**
103 103  
... ... @@ -105,12 +105,57 @@
105 105  
106 106  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
107 107  
108 -(% 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»: [ // группы пользователя «», //названия групп «», «» ] }
125 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
109 109  
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 +}
146 +
110 110  (% style="text-align:left" %)
111 -(% 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» //названия групп ] }
148 +(% style="color:#000000; font-weight:normal" %)Ответ:
112 112  
150 +(% style="text-align:left" %)
151 +(% style="color:#000000; font-weight:normal" %){    
113 113  
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» названия группы пользователя
171 +
172 +(% style="text-align:left" %)
173 +(% style="color:#000000; font-weight:normal" %)}
174 +
175 +
114 114  (% class="box successmessage" %)
115 115  (((
116 116  (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
... ... @@ -118,37 +118,52 @@
118 118  
119 119  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
120 120  
121 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
122 122  
123 123  (% style="color:#000000" %)Метод запроса: **POST**
124 124  
125 125  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
126 126  
127 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
189 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
128 128  
129 -(% class="western" %)
130 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
131 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
132 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
133 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
191 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
134 134  
193 +(% style="color:#000000" %){
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 - неважно
199 +
135 135  (% style="color:#000000" %)}
136 136  
137 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
202 +(% style="color:#000000" %)Ответ:
138 138  
139 -(% class="western" style="margin-bottom:19px" %)
140 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
204 +(% style="color:#000000" %){         (%%)
141 141  
142 -(% lang="en-US" style="text-align:left" %)
143 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
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": "", ~/~/ дата/время последней авторизации
144 144  
220 +(% style="color:#000000" %)}
145 145  
222 +
146 146  (% class="box warningmessage" %)
147 147  (((
148 148  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
149 149  )))
150 150  
151 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
152 152  
153 153  (% style="color:#000000" %)Метод запроса: **PUT**
154 154  
... ... @@ -157,26 +157,86 @@
157 157  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
158 158  
159 159  (% lang="en-US" style="text-align:left" %)
160 -(% 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» //названия групп ] }  //
237 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
161 161  
239 +(% lang="en-US" style="text-align:left" %)
240 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
162 162  
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» названия группы пользователя
261 +
262 +(% lang="en-US" style="text-align:left" %)
263 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
264 +
265 +(% lang="en-US" style="text-align:left" %)
266 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
267 +
268 +(% lang="en-US" style="text-align:left" %)
269 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
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» названия группы пользователя
289 +
290 +(% lang="en-US" style="text-align:left" %)
291 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
292 +
293 +
163 163  (% class="box warningmessage" %)
164 164  (((
165 165  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
166 166  )))
167 167  
168 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
169 169  
170 170  (% style="color:#000000" %)Метод запроса: **PUT**
171 171  
172 -(% 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} Параметр запроса:
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}
173 173  
174 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
305 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
175 175  
176 -(% class="western" %)
177 -{{{ "description": "", // описание
178 - "data": "" // данные, связанные со сменой статуса}}}
307 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
179 179  
309 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
310 +
311 +(% style="color:#000000" %){
312 +
313 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
314 + "description": "" , ~/~/ описание
315 + "data": "" , ~/~/ данные, связанные со сменой статуса
316 +
180 180  (% style="color:#000000" %)}
181 181  
182 182  (% style="text-align:left" %)
... ... @@ -188,14 +188,16 @@
188 188  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
189 189  )))
190 190  
191 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
192 192  
193 193  (% style="color:#000000" %)Метод запроса: **DELETE**
194 194  
195 195  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
196 196  
197 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
334 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
198 198  
336 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337 +
199 199  (% style="text-align:left" %)
200 200  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
201 201  
... ... @@ -212,17 +212,17 @@
212 212  
213 213  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
214 214  
215 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
216 216  
217 217  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
218 218  
219 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
358 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
220 220  
221 221  (% style="color:#000000" %)Метод запроса: **GET**
222 222  
223 223  (% 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>
224 224  
225 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
364 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
226 226  
227 227  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
228 228  
... ... @@ -230,24 +230,20 @@
230 230  
231 231  (% style="color:#000000" %){
232 232  
233 -(% class="western" %)
234 -{{{ "vehicleId": “”, // идентификатор объекта
235 - "name": "", // имя объекта
236 - "imei": "", // IMEI объекта
237 - "deviceTypeId": “”, // идентификатор устройства объекта
238 - "deviceTypeName": "" // наименование устройства объекта
239 - "parentId": "", // идентификатор клиента-родителя
240 - "parentName": "" // наименование клиента-родителя,
241 - "modelId": "", // идентификатор модели объекта
242 - "modelName": "" // наименование модели объекта,
243 - "unitId": "", // идентификатор подразделения
244 - "unitName": "", // наименование подразделения
245 - "status": “”, // статус объекта
246 - ...
247 - },
248 - ...}}}
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": "" , ~/~/ статус объекта
249 249  
250 -(% style="color:#000000" %)}
385 +}
251 251  
252 252  (% style="text-align:left" %)
253 253  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -261,7 +261,7 @@
261 261  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
262 262  )))
263 263  
264 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
265 265  
266 266  (% style="color:#000000" %)Метод запроса: **POST**
267 267  
... ... @@ -269,95 +269,92 @@
269 269  
270 270  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
271 271  
272 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
407 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
273 273  
274 -(% class="western" %)
275 -{{{ "parentId": "", // ID клиента
276 - "name": "", // имя ТС
277 - "imei": "", // IMEI
278 - "deviceTypeId": "",// ID типа устройства
279 - "modelId": "",
280 - "unitId": "", // ID подразделения
281 - "sim1": "", // Номер SIM 1
282 - "sim2": "", // Номер SIM2
283 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
284 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
285 - "consumptionIdle": "",// Расход топлива на холостом ходу
286 - "counters": {
287 - "mileage": "", // пробег
288 - "mileageEnabled": true, // флаг активности счётчика "пробег"
289 - "motohours":"", // моточасы
290 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
291 - },
292 - "cmsv6Parameters": { // параметры CMSv6
293 - "enabled": true, // флаг включения
294 - //"id": "", // идентификатор
295 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
296 - "login": "", // имя учетной записи
297 - "password": "" // пароль учетной записи
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 ~/~/ флаг активности счётчика "моточасы"
298 298   },
299 - "inspectionTasks": [ // задания на ТО
300 - {
301 - "enabled": "", // Признак включения
302 - "name": "", // Имя задания
303 - "description": "", // Описание задания
304 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
305 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
306 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
307 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
308 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
309 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
310 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
311 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
428 + "cmsv6Parameters": { ~/~/ параметры CMSv6
429 + "enabled": true, ~/~/ флаг включения
430 + "id": "" , ~/~/ идентификатор
431 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 + "login": "" , ~/~/ имя учетной записи
433 + "password": "" ~/~/ пароль учетной записи
312 312   },
313 - ]}}}
435 + "inspectionTasks": ~/~/ задания на ТО
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 + }
314 314  
315 -(% style="color:#000000" %)… }
450 +(% style="color:#000000" %) }
316 316  
317 317  (% style="color:#000000" %)Ответ:
318 318  
319 319  (% style="color:#000000" %){
320 320  
321 -(% class="western" %)
322 -{{{ "vehicleId": "", //ID ТС
323 - "parentId": "", //Guid владельца ТС
324 - "name": "", //Имя объекта
325 - "imei": "", //IMEI
326 - "deviceTypeId": "", //ID типа устройства
327 - "modelId": "", //ID модели
328 - "unitId": "", //ID подразделения
329 - "sim1": "", //SIM1
330 - "sim2": "", //SIM2
331 - "consumptionPer100Km": "", //Расход топлива на 100 км
332 - "consumptionIdle": "", //Расход топлива на холостом ходу
333 - "counters": { //Счётчики
334 - "mileageEnabled": true,
335 - "motohoursEnabled": true,
336 - "mileage": "",
337 - "motohours": 345.0
338 - },
339 - "cmsv6Parameters": { //Параметры CmsV6
340 - "id": null,
341 - "enabled": true, //флаг включения
342 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
343 - "login": "", // имя учетной записи
344 - "password": "" // пароль учетной записи
345 - },
346 - "inspectionTasks": [ // задания на ТО
347 - {
348 - "id": "", // ID задачи
349 - "enabled": false, // Признак включения
350 - "name": "", // Имя задания
351 - "description": "", // Описание задания
352 - "mileageCondition": "", // Условие по пробегу
353 - "lastMileage": "", // Пробег (в метрах)
354 - "motohoursCondition": "", // Условие по моточасам
355 - "lastMotohours": "", // Моточасы
356 - "periodicCondition": "", // Условие периодичности по времени
357 - "kind": "", // Вид периодичности по времени
358 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
359 - }
360 - ]}}}
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 + }
361 361  
362 362  (% style="text-align:left" %)
363 363  (% style="color:#000000" %)}
... ... @@ -370,17 +370,17 @@
370 370  
371 371  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
372 372  
373 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
374 374  
375 375  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
376 376  
377 377  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
378 378  
379 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
511 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
380 380  
381 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
513 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
382 382  
383 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
515 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
384 384  
385 385  (% style="color:#000000" %)Метод запроса: **POST**
386 386  
... ... @@ -388,26 +388,52 @@
388 388  
389 389  (% style="color:#000000" %)В заголовках запроса:
390 390  
391 -(% style="color:#000000" %)− Content-Type: application/json
523 +(% style="color:#000000" %)− Content-Type: __**application/json**__
392 392  
393 393  (% style="color:#000000" %)− X-Auth: Токен авторизации
394 394  
395 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
527 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
396 396  
397 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
529 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
398 398  
399 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
531 +(% class="western" style="color:#000000" %)##{##
400 400  
401 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 + "name": null, ~/~/ Имя ТС (string, опционально) 
535 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
540 +(% style="color:#000000" %)}
402 402  
403 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
542 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
404 404  
405 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
544 +(% style="color:#000000" %)Ответ:
406 406  
407 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
546 +(% style="color:#000000" %){
408 408  
409 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
548 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
549 + "name": "" ~/~/ наименование объекта
550 + "imei": "" ~/~/ IMEI объекта
551 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
552 + "deviceTypeName": "" ~/~/ наименование типа устройства
553 + "sim1": "" ~/~/ первый номер телефона
554 + "sim2": "" ~/~/ второй номер телефона
555 + "parentId": "" ~/~/ идентификатор клиента-родителя
556 + "parentName": "" ~/~/ наименование клиента-родителя
557 + "modelId": "" ~/~/ идентификатор модели объекта
558 + "modelName": "" ~/~/ наименование модели объекта
559 + "unitId": "" ~/~/ идентификатор подразделения
560 + "unitName": "" ~/~/ наименование подразделения
561 + "status": "" ~/~/ статус объекта         
562 + "createdAt": "" ~/~/ дата создания объектов  (%%)
563 +(% style="color:#000000" %)}
410 410  
565 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
566 +
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
568 +
411 411  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
412 412  
413 413  
... ... @@ -416,42 +416,44 @@
416 416  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
417 417  )))
418 418  
419 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
420 420  
421 421  (% style="color:#000000" %)Метод запроса: **POST**
422 422  
423 423  (% 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}
424 424  
425 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
583 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
426 426  
427 427  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
428 428  
429 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
587 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
430 430  
431 -(% class="western" %)
432 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
433 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
434 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
435 - "date": "", // Дата смены статуса (null если сменить немедленно)
436 - "description": "", // Описание
437 - "data": "", // Данные
438 - "overwrite": false, // Флаг перезаписи
439 - "stage": "", // Состояние, может быть null}}}
589 +(% style="color:#000000" %){
440 440  
591 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
592 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
593 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
594 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
595 + "description": "", ~/~/ Описание
596 + "data": "", ~/~/ Данные
597 + "overwrite": false, ~/~/ Флаг перезаписи
598 + "stage": "", ~/~/ Состояние, может быть null
599 +
441 441  (% style="color:#000000" %)}
442 442  
443 -(% style="color:#000000" %)Ответ: {
602 +(% style="color:#000000" %)Ответ:
444 444  
445 -(% class="western" %)
446 -{{{ "status": "", // значение статуса
447 - "date": "", // Дата смены статуса
448 - "description": "", // Описание
449 - "data": "", // Данные
450 - "overwrite": false, // Флаг перезаписи
451 - "stage": "", // Состояние}}}
604 +(% style="color:#000000" %){
452 452  
606 + "status": "", ~/~/ значение статуса
607 + "date": "", ~/~/ Дата смены статуса 
608 + "description": "", ~/~/ Описание
609 + "data": "", ~/~/ Данные
610 + "overwrite": false, ~/~/ Флаг перезаписи
611 + "stage": "", ~/~/ Состояние
612 +
453 453  (% style="text-align:left" %)
454 -(% style="color:#000000" %)}
614 +(% style="color:#000000" %) }
455 455  
456 456  
457 457  (% class="box warningmessage" %)
... ... @@ -459,7 +459,7 @@
459 459  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
460 460  )))
461 461  
462 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
463 463  
464 464  (% style="color:#000000" %)Метод запроса: **PUT**
465 465  
... ... @@ -469,26 +469,114 @@
469 469  
470 470  (% style="color:#000000" %)Параметры в теле запроса (JSON):
471 471  
472 -(% 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»: «» //Сколько раз выполнить задание } ] }
632 +(% style="color:#000000" %){    
473 473  
634 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
635 + "parentId": "", ~/~/ ID клиента
636 + "name": "", ~/~/ имя ТС
637 + "imei": "", ~/~/ IMEI
638 + "deviceTypeId": "", ~/~/ ID типа устройства
639 + "modelId": "", ~/~/ , ID модели    
640 + "unitId": "", ~/~/ подразделения
641 + "sim1": "", ~/~/ SIM 1
642 + "sim2": "", ~/~/ SIM2
643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 + "counters": 
646 + {
647 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
648 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
649 + "mileage": «», пробег
650 + "motohours": «» моточасы
651 + }
652 + "cmsv6Parameters": ~/~/ параметры CMSv6
653 + {       
654 + "id": "", ~/~/ идентификатор
655 + "enabled": true, ~/~/ флаг включения
656 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
657 + "login": "", ~/~/ имя учетной записи
658 + "password": "", ~/~/ пароль учетной записи
659 + }
660 + "inspectionTasks": ~/~/ задания на ТО
661 + {
662 + "id": "", ~/~/ ID задания
663 + "enabled": false, ~/~/ Признак включения
664 + "name": "", ~/~/ Имя задания
665 + "description": "", ~/~/ Описание задания
666 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
667 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
668 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
669 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
671 + "kind": "", ~/~/ Вид периодичности по времени
672 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
673 + } 
674 +
675 +(% style="color:#000000" %)}
676 +
474 474  (% style="color:#000000" %)Ответ:
475 475  
476 476  (% lang="en-US" style="text-align:left" %)
477 -(% 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»: «» //Сколько раз выполнить задание } ] }
680 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
478 478  
682 +(% lang="en-US" style="text-align:left" %)
683 + "vehicleId": "", ~/~/ ID ТС
684 + "parentId": "", ~/~/ ID клиента
685 + "name": "", ~/~/ имя ТС
686 + "imei": "", ~/~/ IMEI
687 + "deviceTypeId": "", ~/~/ типа устройства
688 + "modelId": "", ~/~/ ID модели
689 + "unitId": "", ~/~/ ID подразделения
690 + "sim1": "", ~/~/ SIM 1
691 + "sim2": "", ~/~/ SIM2
692 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
693 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
694 + "counters": 
695 + {
696 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
697 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
698 + "mileage": "", ~/~/ пробег
699 + "motohours": "", ~/~/ моточасы
700 + }
701 + "cmsv6Parameters": ~/~/ параметры CMSv6
702 + {
703 + "id": ~/~/ идентификатор
704 + "enabled": true, ~/~/ флаг включения
705 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
706 + "login": "", ~/~/ имя учетной записи
707 + "password": "", ~/~/ пароль учетной записи
708 + }
709 + "inspectionTasks": ~/~/ задания на ТО
710 + {
711 + "id": "", ~/~/ ID задания
712 + "enabled": false, ~/~/ Признак включения
713 + "name": "", ~/~/ Имя задания
714 + "description": "", ~/~/ Описание задания
715 + "mileageCondition": "", ~/~/ Условие по пробегу
716 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
717 + "motohoursCondition": "", ~/~/ Условие по моточасам
718 + "lastMotohours": "", ~/~/ Моточасы
719 + "periodicCondition": "", ~/~/ Условие периодичности по времени
720 + "kind": "", ~/~/ Вид периодичности по времени
721 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
722 + }
479 479  
724 +(% lang="en-US" style="text-align:left" %)
725 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
726 +
727 +
480 480  (% class="box errormessage" %)
481 481  (((
482 482  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
483 483  )))
484 484  
485 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
486 486  
487 487  (% style="color:#000000" %)Метод запроса: **DELETE**
488 488  
489 489  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
490 490  
491 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
739 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
492 492  
493 493  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
494 494  
... ... @@ -506,7 +506,7 @@
506 506  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
507 507  )))
508 508  
509 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
510 510  
511 511  (% style="color:#000000" %)Метод запроса: **GET**
512 512  
... ... @@ -514,16 +514,15 @@
514 514  
515 515  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
516 516  
517 -(% style="color:#000000" %)Ответ: [
765 +(% style="color:#000000" %)Ответ:
518 518  
519 -(% class="western" %)
520 -{{{ {
521 - "deviceTypeId" : "", // ID типа устройства
522 - "deviceTypeName" : "" // Название типа устройства
523 - },}}}
767 +(% style="color:#000000" %){
524 524  
769 + "deviceTypeId" : "", ~/~/ ID типа устройства
770 + "deviceTypeName" : "" ~/~/ Название типа устройства
771 +
525 525  (% style="text-align:left" %)
526 -(% style="color:#000000" %)…** **]
773 +(% style="color:#000000" %)}
527 527  
528 528  
529 529  (% class="box" style="text-align: center;" %)
... ... @@ -536,7 +536,7 @@
536 536  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
537 537  )))
538 538  
539 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
540 540  
541 541  (% style="color:#000000" %)Метод запроса: **GET**
542 542  
... ... @@ -544,19 +544,16 @@
544 544  
545 545  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
546 546  
547 -(% style="color:#000000" %)Ответ: [
794 +(% style="color:#000000" %)Ответ:
548 548  
549 -(% class="western" style="margin-bottom:19px" %)
550 -{{{ {}}}
796 +(% style="color:#000000" %){
551 551  
552 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
798 + "id": "", ~/~/ ID типа датчика 
799 + "name": "", ~/~/ Название
800 + "description": "", ~/~/ Описание
553 553  
554 -(% class="western" %)
555 -{{{ "description": "" // Описание
556 - },}}}
557 -
558 558  (% style="text-align:left" %)
559 -(% style="color:#000000" %)… ]
803 +(% style="color:#000000" %)}
560 560  
561 561  
562 562  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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