Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 20.2 >
edited by Артем Шемяков
on 2022/09/01 17:08
To version < 25.1 >
edited by Артем Шемяков
on 2022/09/02 16:59
>
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,35 +66,34 @@
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" %)Ответ: [ {
86 - "agentId": "", ~/~/ идентификатор клиента
87 - "parentId": "", ~/~/ идентификатор клиента-родителя
88 - "name": "", ~/~/ наименование клиента
89 - "fullName": "", ~/~/ полное наименование клиента
90 - "agentInfoType": "", ~/~/ тип клиента1
91 - "status": "", ~/~/ статус клиента
92 - }, … ]
95 +(% style="color:#000000" %)Ответ:
93 93  
97 +(% style="color:#000000" %){
98 + "agentId": "", ~/~/ идентификатор клиента
99 + "parentId": "", ~/~/ идентификатор клиента-родителя
100 + "name": "", ~/~/ наименование клиента
101 + "fullName": "", ~/~/ полное наименование клиента
102 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 + "status": "", ~/~/ статус клиента
104 +}
94 94  
95 -(% 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" %)]
96 96  
97 -
98 98  (% class="box" style="text-align: center;" %)
99 99  (((
100 100  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -105,7 +105,7 @@
105 105  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
106 106  )))
107 107  
108 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
109 109  
110 110  (% style="color:#000000" %)Метод запроса: **POST**
111 111  
... ... @@ -113,12 +113,57 @@
113 113  
114 114  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
115 115  
116 -(% 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):
117 117  
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 +
118 118  (% style="text-align:left" %)
119 -(% 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" %)Ответ:
120 120  
150 +(% style="text-align:left" %)
151 +(% style="color:#000000; font-weight:normal" %){    
121 121  
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 +
122 122  (% class="box successmessage" %)
123 123  (((
124 124  (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
... ... @@ -126,37 +126,52 @@
126 126  
127 127  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
128 128  
129 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
130 130  
131 131  (% style="color:#000000" %)Метод запроса: **POST**
132 132  
133 133  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
134 134  
135 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
189 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
136 136  
137 -(% class="western" %)
138 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
139 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
140 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
141 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
191 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
142 142  
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 +
143 143  (% style="color:#000000" %)}
144 144  
145 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
202 +(% style="color:#000000" %)Ответ:
146 146  
147 -(% class="western" style="margin-bottom:19px" %)
148 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
204 +(% style="color:#000000" %){         (%%)
149 149  
150 -(% lang="en-US" style="text-align:left" %)
151 -(% 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": "", ~/~/ дата/время последней авторизации
152 152  
220 +(% style="color:#000000" %)}
153 153  
222 +
154 154  (% class="box warningmessage" %)
155 155  (((
156 156  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
157 157  )))
158 158  
159 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
160 160  
161 161  (% style="color:#000000" %)Метод запроса: **PUT**
162 162  
... ... @@ -165,26 +165,86 @@
165 165  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
166 166  
167 167  (% lang="en-US" style="text-align:left" %)
168 -(% 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):
169 169  
239 +(% lang="en-US" style="text-align:left" %)
240 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
170 170  
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 +
171 171  (% class="box warningmessage" %)
172 172  (((
173 173  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
174 174  )))
175 175  
176 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
177 177  
178 178  (% style="color:#000000" %)Метод запроса: **PUT**
179 179  
180 -(% 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}
181 181  
182 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
305 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
183 183  
184 -(% class="western" %)
185 -{{{ "description": "", // описание
186 - "data": "" // данные, связанные со сменой статуса}}}
307 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
187 187  
309 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
310 +
311 +(% style="color:#000000" %){
312 +
313 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
314 + "description": "" , ~/~/ описание
315 + "data": "" , ~/~/ данные, связанные со сменой статуса
316 +
188 188  (% style="color:#000000" %)}
189 189  
190 190  (% style="text-align:left" %)
... ... @@ -196,14 +196,16 @@
196 196  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
197 197  )))
198 198  
199 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
200 200  
201 201  (% style="color:#000000" %)Метод запроса: **DELETE**
202 202  
203 203  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
204 204  
205 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
334 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
206 206  
336 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337 +
207 207  (% style="text-align:left" %)
208 208  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
209 209  
... ... @@ -220,17 +220,17 @@
220 220  
221 221  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
222 222  
223 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
224 224  
225 225  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
226 226  
227 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
358 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
228 228  
229 229  (% style="color:#000000" %)Метод запроса: **GET**
230 230  
231 231  (% 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>
232 232  
233 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
364 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
234 234  
235 235  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
236 236  
... ... @@ -238,24 +238,20 @@
238 238  
239 239  (% style="color:#000000" %){
240 240  
241 -(% class="western" %)
242 -{{{ "vehicleId": “”, // идентификатор объекта
243 - "name": "", // имя объекта
244 - "imei": "", // IMEI объекта
245 - "deviceTypeId": “”, // идентификатор устройства объекта
246 - "deviceTypeName": "" // наименование устройства объекта
247 - "parentId": "", // идентификатор клиента-родителя
248 - "parentName": "" // наименование клиента-родителя,
249 - "modelId": "", // идентификатор модели объекта
250 - "modelName": "" // наименование модели объекта,
251 - "unitId": "", // идентификатор подразделения
252 - "unitName": "", // наименование подразделения
253 - "status": “”, // статус объекта
254 - ...
255 - },
256 - ...}}}
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": "" , ~/~/ статус объекта
257 257  
258 -(% style="color:#000000" %)}
385 +}
259 259  
260 260  (% style="text-align:left" %)
261 261  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -269,7 +269,7 @@
269 269  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
270 270  )))
271 271  
272 -(% 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**__).
273 273  
274 274  (% style="color:#000000" %)Метод запроса: **POST**
275 275  
... ... @@ -277,95 +277,92 @@
277 277  
278 278  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
279 279  
280 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
407 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
281 281  
282 -(% class="western" %)
283 -{{{ "parentId": "", // ID клиента
284 - "name": "", // имя ТС
285 - "imei": "", // IMEI
286 - "deviceTypeId": "",// ID типа устройства
287 - "modelId": "",
288 - "unitId": "", // ID подразделения
289 - "sim1": "", // Номер SIM 1
290 - "sim2": "", // Номер SIM2
291 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
292 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
293 - "consumptionIdle": "",// Расход топлива на холостом ходу
294 - "counters": {
295 - "mileage": "", // пробег
296 - "mileageEnabled": true, // флаг активности счётчика "пробег"
297 - "motohours":"", // моточасы
298 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
299 - },
300 - "cmsv6Parameters": { // параметры CMSv6
301 - "enabled": true, // флаг включения
302 - //"id": "", // идентификатор
303 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
304 - "login": "", // имя учетной записи
305 - "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 ~/~/ флаг активности счётчика "моточасы"
306 306   },
307 - "inspectionTasks": [ // задания на ТО
308 - {
309 - "enabled": "", // Признак включения
310 - "name": "", // Имя задания
311 - "description": "", // Описание задания
312 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
313 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
314 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
315 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
316 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
317 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
318 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
319 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
428 + "cmsv6Parameters": { ~/~/ параметры CMSv6
429 + "enabled": true, ~/~/ флаг включения
430 + "id": "" , ~/~/ идентификатор
431 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 + "login": "" , ~/~/ имя учетной записи
433 + "password": "" ~/~/ пароль учетной записи
320 320   },
321 - ]}}}
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 + }
322 322  
323 -(% style="color:#000000" %)… }
450 +(% style="color:#000000" %) }
324 324  
325 325  (% style="color:#000000" %)Ответ:
326 326  
327 327  (% style="color:#000000" %){
328 328  
329 -(% class="western" %)
330 -{{{ "vehicleId": "", //ID ТС
331 - "parentId": "", //Guid владельца ТС
332 - "name": "", //Имя объекта
333 - "imei": "", //IMEI
334 - "deviceTypeId": "", //ID типа устройства
335 - "modelId": "", //ID модели
336 - "unitId": "", //ID подразделения
337 - "sim1": "", //SIM1
338 - "sim2": "", //SIM2
339 - "consumptionPer100Km": "", //Расход топлива на 100 км
340 - "consumptionIdle": "", //Расход топлива на холостом ходу
341 - "counters": { //Счётчики
342 - "mileageEnabled": true,
343 - "motohoursEnabled": true,
344 - "mileage": "",
345 - "motohours": 345.0
346 - },
347 - "cmsv6Parameters": { //Параметры CmsV6
348 - "id": null,
349 - "enabled": true, //флаг включения
350 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
351 - "login": "", // имя учетной записи
352 - "password": "" // пароль учетной записи
353 - },
354 - "inspectionTasks": [ // задания на ТО
355 - {
356 - "id": "", // ID задачи
357 - "enabled": false, // Признак включения
358 - "name": "", // Имя задания
359 - "description": "", // Описание задания
360 - "mileageCondition": "", // Условие по пробегу
361 - "lastMileage": "", // Пробег (в метрах)
362 - "motohoursCondition": "", // Условие по моточасам
363 - "lastMotohours": "", // Моточасы
364 - "periodicCondition": "", // Условие периодичности по времени
365 - "kind": "", // Вид периодичности по времени
366 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
367 - }
368 - ]}}}
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 + }
369 369  
370 370  (% style="text-align:left" %)
371 371  (% style="color:#000000" %)}
... ... @@ -378,17 +378,17 @@
378 378  
379 379  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
380 380  
381 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
382 382  
383 383  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
384 384  
385 385  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
386 386  
387 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
511 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
388 388  
389 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
513 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
390 390  
391 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
515 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
392 392  
393 393  (% style="color:#000000" %)Метод запроса: **POST**
394 394  
... ... @@ -396,27 +396,51 @@
396 396  
397 397  (% style="color:#000000" %)В заголовках запроса:
398 398  
399 -(% style="color:#000000" %)− Content-Type: application/json
523 +(% style="color:#000000" %)− Content-Type: __**application/json**__
400 400  
401 401  (% style="color:#000000" %)− X-Auth: Токен авторизации
402 402  
403 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
527 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
404 404  
405 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
529 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
406 406  
407 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
531 +(% class="western" style="color:#000000" %)##{##
408 408  
409 -(% 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" %)}
410 410  
411 -(% 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**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
412 412  
413 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
544 +(% style="color:#000000" %)Ответ:
414 414  
415 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
546 +(% style="color:#000000" %){
416 416  
417 -(% 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": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
562 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
563 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
564 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
565 +(% style="color:#000000" %)}
418 418  
419 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
567 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
420 420  
421 421  
422 422  (% class="box successmessage" %)
... ... @@ -424,42 +424,44 @@
424 424  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
425 425  )))
426 426  
427 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
575 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
428 428  
429 429  (% style="color:#000000" %)Метод запроса: **POST**
430 430  
431 431  (% 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}
432 432  
433 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
581 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
434 434  
435 435  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
436 436  
437 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
585 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
438 438  
439 -(% class="western" %)
440 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
441 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
442 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
443 - "date": "", // Дата смены статуса (null если сменить немедленно)
444 - "description": "", // Описание
445 - "data": "", // Данные
446 - "overwrite": false, // Флаг перезаписи
447 - "stage": "", // Состояние, может быть null}}}
587 +(% style="color:#000000" %){
448 448  
589 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
590 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
591 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
592 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
593 + "description": "", ~/~/ Описание
594 + "data": "", ~/~/ Данные
595 + "overwrite": false, ~/~/ Флаг перезаписи
596 + "stage": "", ~/~/ Состояние, может быть null
597 +
449 449  (% style="color:#000000" %)}
450 450  
451 -(% style="color:#000000" %)Ответ: {
600 +(% style="color:#000000" %)Ответ:
452 452  
453 -(% class="western" %)
454 -{{{ "status": "", // значение статуса
455 - "date": "", // Дата смены статуса
456 - "description": "", // Описание
457 - "data": "", // Данные
458 - "overwrite": false, // Флаг перезаписи
459 - "stage": "", // Состояние}}}
602 +(% style="color:#000000" %){
460 460  
604 + "status": "", ~/~/ значение статуса
605 + "date": "", ~/~/ Дата смены статуса 
606 + "description": "", ~/~/ Описание
607 + "data": "", ~/~/ Данные
608 + "overwrite": false, ~/~/ Флаг перезаписи
609 + "stage": "", ~/~/ Состояние
610 +
461 461  (% style="text-align:left" %)
462 -(% style="color:#000000" %)}
612 +(% style="color:#000000" %) }
463 463  
464 464  
465 465  (% class="box warningmessage" %)
... ... @@ -467,7 +467,7 @@
467 467  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
468 468  )))
469 469  
470 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
620 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
471 471  
472 472  (% style="color:#000000" %)Метод запроса: **PUT**
473 473  
... ... @@ -477,26 +477,114 @@
477 477  
478 478  (% style="color:#000000" %)Параметры в теле запроса (JSON):
479 479  
480 -(% 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»: «» //Сколько раз выполнить задание } ] }
630 +(% style="color:#000000" %){    
481 481  
632 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
633 + "parentId": "", ~/~/ ID клиента
634 + "name": "", ~/~/ имя ТС
635 + "imei": "", ~/~/ IMEI
636 + "deviceTypeId": "", ~/~/ ID типа устройства
637 + "modelId": "", ~/~/ , ID модели    
638 + "unitId": "", ~/~/ подразделения
639 + "sim1": "", ~/~/ SIM 1
640 + "sim2": "", ~/~/ SIM2
641 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
642 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
643 + "counters": 
644 + {
645 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
646 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
647 + "mileage": «», пробег
648 + "motohours": «» моточасы
649 + }
650 + "cmsv6Parameters": ~/~/ параметры CMSv6
651 + {       
652 + "id": "", ~/~/ идентификатор
653 + "enabled": true, ~/~/ флаг включения
654 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
655 + "login": "", ~/~/ имя учетной записи
656 + "password": "", ~/~/ пароль учетной записи
657 + }
658 + "inspectionTasks": ~/~/ задания на ТО
659 + {
660 + "id": "", ~/~/ ID задания
661 + "enabled": false, ~/~/ Признак включения
662 + "name": "", ~/~/ Имя задания
663 + "description": "", ~/~/ Описание задания
664 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
665 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
666 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
667 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
668 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
669 + "kind": "", ~/~/ Вид периодичности по времени
670 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
671 + } 
672 +
673 +(% style="color:#000000" %)}
674 +
482 482  (% style="color:#000000" %)Ответ:
483 483  
484 484  (% lang="en-US" style="text-align:left" %)
485 -(% 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»: «» //Сколько раз выполнить задание } ] }
678 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
486 486  
680 +(% lang="en-US" style="text-align:left" %)
681 + "vehicleId": "", ~/~/ ID ТС
682 + "parentId": "", ~/~/ ID клиента
683 + "name": "", ~/~/ имя ТС
684 + "imei": "", ~/~/ IMEI
685 + "deviceTypeId": "", ~/~/ типа устройства
686 + "modelId": "", ~/~/ ID модели
687 + "unitId": "", ~/~/ ID подразделения
688 + "sim1": "", ~/~/ SIM 1
689 + "sim2": "", ~/~/ SIM2
690 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
691 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
692 + "counters": 
693 + {
694 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
695 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
696 + "mileage": "", ~/~/ пробег
697 + "motohours": "", ~/~/ моточасы
698 + }
699 + "cmsv6Parameters": ~/~/ параметры CMSv6
700 + {
701 + "id": ~/~/ идентификатор
702 + "enabled": true, ~/~/ флаг включения
703 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
704 + "login": "", ~/~/ имя учетной записи
705 + "password": "", ~/~/ пароль учетной записи
706 + }
707 + "inspectionTasks": ~/~/ задания на ТО
708 + {
709 + "id": "", ~/~/ ID задания
710 + "enabled": false, ~/~/ Признак включения
711 + "name": "", ~/~/ Имя задания
712 + "description": "", ~/~/ Описание задания
713 + "mileageCondition": "", ~/~/ Условие по пробегу
714 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
715 + "motohoursCondition": "", ~/~/ Условие по моточасам
716 + "lastMotohours": "", ~/~/ Моточасы
717 + "periodicCondition": "", ~/~/ Условие периодичности по времени
718 + "kind": "", ~/~/ Вид периодичности по времени
719 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
720 + }
487 487  
722 +(% lang="en-US" style="text-align:left" %)
723 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
724 +
725 +
488 488  (% class="box errormessage" %)
489 489  (((
490 490  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
491 491  )))
492 492  
493 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
731 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
494 494  
495 495  (% style="color:#000000" %)Метод запроса: **DELETE**
496 496  
497 497  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
498 498  
499 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
737 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
500 500  
501 501  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
502 502  
... ... @@ -514,7 +514,7 @@
514 514  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
515 515  )))
516 516  
517 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
755 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
518 518  
519 519  (% style="color:#000000" %)Метод запроса: **GET**
520 520  
... ... @@ -522,16 +522,15 @@
522 522  
523 523  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
524 524  
525 -(% style="color:#000000" %)Ответ: [
763 +(% style="color:#000000" %)Ответ:
526 526  
527 -(% class="western" %)
528 -{{{ {
529 - "deviceTypeId" : "", // ID типа устройства
530 - "deviceTypeName" : "" // Название типа устройства
531 - },}}}
765 +(% style="color:#000000" %){
532 532  
767 + "deviceTypeId" : "", ~/~/ ID типа устройства
768 + "deviceTypeName" : "" ~/~/ Название типа устройства
769 +
533 533  (% style="text-align:left" %)
534 -(% style="color:#000000" %)…** **]
771 +(% style="color:#000000" %)}
535 535  
536 536  
537 537  (% class="box" style="text-align: center;" %)
... ... @@ -544,7 +544,7 @@
544 544  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
545 545  )))
546 546  
547 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
784 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
548 548  
549 549  (% style="color:#000000" %)Метод запроса: **GET**
550 550  
... ... @@ -552,19 +552,16 @@
552 552  
553 553  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
554 554  
555 -(% style="color:#000000" %)Ответ: [
792 +(% style="color:#000000" %)Ответ:
556 556  
557 -(% class="western" style="margin-bottom:19px" %)
558 -{{{ {}}}
794 +(% style="color:#000000" %){
559 559  
560 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
796 + "id": "", ~/~/ ID типа датчика 
797 + "name": "", ~/~/ Название
798 + "description": "", ~/~/ Описание
561 561  
562 -(% class="western" %)
563 -{{{ "description": "" // Описание
564 - },}}}
565 -
566 566  (% style="text-align:left" %)
567 -(% style="color:#000000" %)… ]
801 +(% style="color:#000000" %)}
568 568  
569 569  
570 570  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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