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

Summary

Details

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

Меню

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