Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 15.2 >
edited by Артем Шемяков
on 2022/09/01 15:29
To version < 21.4 >
edited by Артем Шемяков
on 2022/09/02 09:22
>
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,111 +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 -
89 -(% class="box" lang="en-US" style="text-align: center;" %)
90 -(((
91 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
92 -)))
93 -
94 94  (% class="box infomessage" %)
95 95  (((
96 -(% 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(%%)**
97 97  )))
98 98  
99 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
100 100  
81 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82 +
83 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 +
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86 +
101 101  (% style="color:#000000" %)Метод запроса: **GET**
102 102  
103 -(% 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>
104 104  
91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92 +
105 105  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
106 106  
107 -(% style="color:#000000" %)Ответ: [
95 +(% style="color:#000000" %)Ответ:
108 108  
109 -(% class="western" %)
110 -{{{ {
111 - "deviceTypeId" : "", // ID типа устройства
112 - "deviceTypeName" : "" // Название типа устройства
113 - },}}}
97 +(% style="color:#000000" %){
98 + "agentId": "", ~/~/ идентификатор клиента
99 + "parentId": "", ~/~/ идентификатор клиента-родителя
100 + "name": "", ~/~/ наименование клиента
101 + "fullName": "", ~/~/ полное наименование клиента
102 + "agentInfoType": "", ~/~/ тип клиента1
103 + "status": "", ~/~/ статус клиента
104 + }
114 114  
115 -(% style="text-align:left" %)
116 -(% style="color:#000000" %)…** **]
117 117  
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" %)]
118 118  
109 +
119 119  (% class="box" style="text-align: center;" %)
120 120  (((
121 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
112 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
122 122  )))
123 123  
124 -(% class="box infomessage" %)
115 +(% class="box successmessage" %)
125 125  (((
126 -(% 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**
127 127  )))
128 128  
129 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
120 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
130 130  
131 -(% style="color:#000000" %)Метод запроса: **GET**
122 +(% style="color:#000000" %)Метод запроса: **POST**
132 132  
133 -(% 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]]
134 134  
135 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
126 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
136 136  
137 -(% style="color:#000000" %)Ответ: [
128 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
138 138  
139 -(% class="western" style="margin-bottom:19px" %)
140 -{{{ {}}}
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 + }
141 141  
142 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
150 +(% style="text-align:left" %)
151 +(% style="color:#000000; font-weight:normal" %)Ответ:
143 143  
144 -(% class="western" %)
145 -{{{ "description": "" // Описание
146 - },}}}
153 +(% style="text-align:left" %)
154 +(% style="color:#000000; font-weight:normal" %){    
147 147  
148 148  (% style="text-align:left" %)
149 -(% 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» названия группы пользователя
150 150  
175 +(% style="text-align:left" %)
176 +(% style="color:#000000; font-weight:normal" %) }
151 151  
152 -(% class="box" style="text-align: center;" %)
153 -(((
154 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
155 -)))
156 156  
157 157  (% class="box successmessage" %)
158 158  (((
159 -(% 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**
160 160  )))
161 161  
162 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
184 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
163 163  
186 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
187 +
164 164  (% style="color:#000000" %)Метод запроса: **POST**
165 165  
166 -(% 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]]
167 167  
168 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
169 169  
170 -(% 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" %){
171 171  
172 -(% style="text-align:left" %)
173 -(% 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 - неважно
174 174  
201 +(% style="color:#000000" %) }
175 175  
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 +
176 176  (% class="box warningmessage" %)
177 177  (((
178 178  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -187,62 +187,90 @@
187 187  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
188 188  
189 189  (% lang="en-US" style="text-align:left" %)
190 -(% 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):
191 191  
240 +(% lang="en-US" style="text-align:left" %)
241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
192 192  
193 -(% class="box warningmessage" %)
194 -(((
195 -(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
196 -)))
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» названия группы пользователя
197 197  
198 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
263 +(% lang="en-US" style="text-align:left" %)
264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
199 199  
200 -(% style="color:#000000" %)Метод запроса: **PUT**
266 +(% lang="en-US" style="text-align:left" %)
267 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
201 201  
202 -(% 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" %)//{     //
203 203  
204 -(% 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» названия группы пользователя//
205 205  
206 -(% class="western" %)
207 -{{{ "description": "", // описание
208 - "data": "" // данные, связанные со сменой статуса}}}
291 +(% lang="en-US" style="text-align:left" %)
292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
209 209  
210 -(% style="color:#000000" %)}
211 211  
212 -(% style="text-align:left" %)
213 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
214 -
215 -
216 -(% class="box successmessage" %)
295 +(% class="box warningmessage" %)
217 217  (((
218 -(% 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}**
219 219  )))
220 220  
221 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
300 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
222 222  
223 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
302 +(% style="color:#000000" %)Метод запроса: **PUT**
224 224  
225 -(% 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}
226 226  
227 -(% 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 пользователя
228 228  
229 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
308 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
230 230  
231 -(% class="western" %)
232 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
233 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
234 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
235 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
310 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
236 236  
237 -(% style="color:#000000" %)}
312 +(% style="color:#000000" %){
238 238  
239 -(% 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": "" , ~/~/ данные, связанные со сменой статуса
240 240  
241 -(% class="western" style="margin-bottom:19px" %)
242 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
318 + (% style="color:#000000" %)}
243 243  
244 -(% lang="en-US" style="text-align:left" %)
245 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
320 +(% style="text-align:left" %)
321 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
246 246  
247 247  
248 248  (% class="box errormessage" %)
... ... @@ -256,8 +256,10 @@
256 256  
257 257  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
258 258  
259 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
260 260  
337 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
338 +
261 261  (% style="text-align:left" %)
262 262  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
263 263  
... ... @@ -267,25 +267,6 @@
267 267  (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
268 268  )))
269 269  
270 -(% class="box errormessage" %)
271 -(((
272 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
273 -)))
274 -
275 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
276 -
277 -(% style="color:#000000" %)Метод запроса: **DELETE**
278 -
279 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
280 -
281 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
282 -
283 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
284 -
285 -(% style="text-align:left" %)
286 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
287 -
288 -
289 289  (% class="box infomessage" %)
290 290  (((
291 291  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -311,24 +311,20 @@
311 311  
312 312  (% style="color:#000000" %){
313 313  
314 -(% class="western" %)
315 -{{{ "vehicleId": “”, // идентификатор объекта
316 - "name": "", // имя объекта
317 - "imei": "", // IMEI объекта
318 - "deviceTypeId": “”, // идентификатор устройства объекта
319 - "deviceTypeName": "" // наименование устройства объекта
320 - "parentId": "", // идентификатор клиента-родителя
321 - "parentName": "" // наименование клиента-родителя,
322 - "modelId": "", // идентификатор модели объекта
323 - "modelName": "" // наименование модели объекта,
324 - "unitId": "", // идентификатор подразделения
325 - "unitName": "", // наименование подразделения
326 - "status": “”, // статус объекта
327 - ...
328 - },
329 - ...}}}
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": "" , ~/~/ статус объекта
330 330  
331 -(% style="color:#000000" %)}
386 + }
332 332  
333 333  (% style="text-align:left" %)
334 334  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -350,126 +350,100 @@
350 350  
351 351  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
352 352  
353 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
408 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
354 354  
355 -(% class="western" %)
356 -{{{ "parentId": "", // ID клиента
357 - "name": "", // имя ТС
358 - "imei": "", // IMEI
359 - "deviceTypeId": "",// ID типа устройства
360 - "modelId": "",
361 - "unitId": "", // ID подразделения
362 - "sim1": "", // Номер SIM 1
363 - "sim2": "", // Номер SIM2
364 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
365 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
366 - "consumptionIdle": "",// Расход топлива на холостом ходу
367 - "counters": {
368 - "mileage": "", // пробег
369 - "mileageEnabled": true, // флаг активности счётчика "пробег"
370 - "motohours":"", // моточасы
371 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
372 - },
373 - "cmsv6Parameters": { // параметры CMSv6
374 - "enabled": true, // флаг включения
375 - //"id": "", // идентификатор
376 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
377 - "login": "", // имя учетной записи
378 - "password": "" // пароль учетной записи
379 - },
380 - "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": ~/~/ задания на ТО
381 381   {
382 - "enabled": "", // Признак включения
383 - "name": "", // Имя задания
384 - "description": "", // Описание задания
385 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
386 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
387 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
388 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
389 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
390 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
391 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
392 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
393 - },
394 - ]}}}
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 + }
395 395  
396 -(% style="color:#000000" %)… }
451 +(% style="color:#000000" %) }
397 397  
398 398  (% style="color:#000000" %)Ответ:
399 399  
400 400  (% style="color:#000000" %){
401 401  
402 -(% class="western" %)
403 -{{{ "vehicleId": "", //ID ТС
404 - "parentId": "", //Guid владельца ТС
405 - "name": "", //Имя объекта
406 - "imei": "", //IMEI
407 - "deviceTypeId": "", //ID типа устройства
408 - "modelId": "", //ID модели
409 - "unitId": "", //ID подразделения
410 - "sim1": "", //SIM1
411 - "sim2": "", //SIM2
412 - "consumptionPer100Km": "", //Расход топлива на 100 км
413 - "consumptionIdle": "", //Расход топлива на холостом ходу
414 - "counters": { //Счётчики
415 - "mileageEnabled": true,
416 - "motohoursEnabled": true,
417 - "mileage": "",
418 - "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
419 419   },
420 - "cmsv6Parameters": { //Параметры CmsV6
421 - "id": null,
422 - "enabled": true, //флаг включения
423 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
424 - "login": "", // имя учетной записи
425 - "password": "" // пароль учетной записи
474 + "cmsv6Parameters": { ~/~/Параметры CmsV6
475 + "id": null,
476 + "enabled": true, ~/~/флаг включения
477 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
478 + "login": "", ~/~/ имя учетной записи
479 + "password": "" ~/~/ пароль учетной записи
426 426   },
427 - "inspectionTasks": [ // задания на ТО
428 - {
429 - "id": "", // ID задачи
430 - "enabled": false, // Признак включения
431 - "name": "", // Имя задания
432 - "description": "", // Описание задания
433 - "mileageCondition": "", // Условие по пробегу
434 - "lastMileage": "", // Пробег (в метрах)
435 - "motohoursCondition": "", // Условие по моточасам
436 - "lastMotohours": "", // Моточасы
437 - "periodicCondition": "", // Условие периодичности по времени
438 - "kind": "", // Вид периодичности по времени
439 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
440 - }
441 - ]}}}
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 + }
442 442  
443 443  (% style="text-align:left" %)
444 444  (% style="color:#000000" %)}
445 445  
446 446  
447 -(% class="box warningmessage" %)
448 -(((
449 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
450 -)))
451 -
452 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
453 -
454 -(% style="color:#000000" %)Метод запроса: **PUT**
455 -
456 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
457 -
458 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
459 -
460 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
461 -
462 -(% 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»: «» //Сколько раз выполнить задание } ] }
463 -
464 -(% style="color:#000000" %)Ответ:
465 -
466 -(% lang="en-US" style="text-align:left" %)
467 -(% 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»: «» //Сколько раз выполнить задание } ] }
468 -
469 -
470 470  (% class="box successmessage" %)
471 471  (((
472 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
501 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
473 473  )))
474 474  
475 475  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
... ... @@ -512,36 +512,9 @@
512 512  
513 513  (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
514 514  
515 -(% style="color:#000000" %)0 - «Блокировка»
544 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
516 516  
517 -(% style="color:#000000" %)1 - «Активен»,
518 518  
519 -(% style="color:#000000" %)2 - «Отменен»
520 -
521 -(% style="color:#000000" %)3 - «Оборудован»
522 -
523 -(% style="color:#000000" %)4 - «Диагностика»
524 -
525 -(% style="color:#000000" %)5 - «Сервис»
526 -
527 -(% style="color:#000000" %)6 - «Демонтаж»
528 -
529 -(% style="color:#000000" %)7 - «Монтаж»
530 -
531 -(% style="color:#000000" %)8 - «Дозаказ»
532 -
533 -(% style="color:#000000" %)9 - «Обслужен»
534 -
535 -(% style="color:#000000" %)10 - «Списан»
536 -
537 -(% style="color:#000000" %)11 - «Неисправен»
538 -
539 -(% style="color:#000000" %)12 - «Проверен»
540 -
541 -(% style="text-align:left" %)
542 -(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
543 -
544 -
545 545  (% class="box successmessage" %)
546 546  (((
547 547  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -560,7 +560,9 @@
560 560  (% style="color:#000000" %)Параметры в теле запроса (JSON): {
561 561  
562 562  (% class="western" %)
563 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
565 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
566 +  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
567 +  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
564 564   "date": "", // Дата смены статуса (null если сменить немедленно)
565 565   "description": "", // Описание
566 566   "data": "", // Данные
... ... @@ -583,7 +583,112 @@
583 583  (% style="color:#000000" %)}
584 584  
585 585  
590 +(% class="box warningmessage" %)
591 +(((
592 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
593 +)))
594 +
595 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
596 +
597 +(% style="color:#000000" %)Метод запроса: **PUT**
598 +
599 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
600 +
601 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
602 +
603 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
604 +
605 +(% 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»: «» //Сколько раз выполнить задание } ] }
606 +
607 +(% style="color:#000000" %)Ответ:
608 +
609 +(% lang="en-US" style="text-align:left" %)
610 +(% 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»: «» //Сколько раз выполнить задание } ] }
611 +
612 +
613 +(% class="box errormessage" %)
614 +(((
615 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
616 +)))
617 +
618 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
619 +
620 +(% style="color:#000000" %)Метод запроса: **DELETE**
621 +
622 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
623 +
624 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
625 +
626 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
627 +
628 +(% style="text-align:left" %)
629 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
630 +
631 +
586 586  (% class="box" lang="en-US" style="text-align: center;" %)
587 587  (((
634 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
635 +)))
636 +
637 +(% class="box infomessage" %)
638 +(((
639 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
640 +)))
641 +
642 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
643 +
644 +(% style="color:#000000" %)Метод запроса: **GET**
645 +
646 +(% 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]]
647 +
648 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
649 +
650 +(% style="color:#000000" %)Ответ: [
651 +
652 +(% class="western" %)
653 +{{{ {
654 + "deviceTypeId" : "", // ID типа устройства
655 + "deviceTypeName" : "" // Название типа устройства
656 + },}}}
657 +
658 +(% style="text-align:left" %)
659 +(% style="color:#000000" %)…** **]
660 +
661 +
662 +(% class="box" style="text-align: center;" %)
663 +(((
664 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
665 +)))
666 +
667 +(% class="box infomessage" %)
668 +(((
669 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
670 +)))
671 +
672 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
673 +
674 +(% style="color:#000000" %)Метод запроса: **GET**
675 +
676 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
677 +
678 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
679 +
680 +(% style="color:#000000" %)Ответ: [
681 +
682 +(% class="western" style="margin-bottom:19px" %)
683 +{{{ {}}}
684 +
685 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
686 +
687 +(% class="western" %)
688 +{{{ "description": "" // Описание
689 + },}}}
690 +
691 +(% style="text-align:left" %)
692 +(% style="color:#000000" %)… ]
693 +
694 +
695 +(% class="box" lang="en-US" style="text-align: center;" %)
696 +(((
588 588  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
589 589  )))

Меню

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