Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 20.5 >
edited by Артем Шемяков
on 2022/09/01 17:32
To version < 7.1 >
edited by Андрей Калиновский
on 2022/08/31 14:14
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.Gadmin
Content
... ... @@ -1,314 +1,204 @@
1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
1 +== Описание ГЛОНАССSoft Public API ==
3 3  
4 4  == ==
5 5  
6 -(% class="box" style="text-align: center;" %)
7 -(((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 -)))
5 + **Действующие ограничения**
6 +
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
8 +- Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
13 +\\
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
15 + **Авторизация**
22 22  
23 -(% class="box infomessage" %)
24 -(((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 -)))
17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
19 +Метод запроса: GET
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
21 +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]]
31 31  
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]]
23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
26 +
35 35  
36 -(% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ:**
28 + **Получение списка объектов**
38 38  
39 -(% lang="en-US" %)
40 -(% style="color:#000000" %){
30 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
41 41  
42 -(% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
32 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
45 45  
46 -(% lang="en-US" %)
47 - }
34 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
48 48  
49 -**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
36 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
50 50  
38 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
51 51  
52 -(% class="box infomessage" %)
53 -(((
54 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
55 -)))
40 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
56 56  
57 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
42 +Метод запроса: POST
58 58  
59 -(% style="color:#000000" %)Метод запроса: **GET**
44 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
60 60  
61 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
46 +В заголовках запроса:
62 62  
63 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
48 +−Content-Type: application/json
64 64  
65 -(% lang="en-US" %)
66 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
50 +−X-Auth: Токен авторизации
67 67  
52 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
68 68  
69 -(% class="box" style="text-align: center;" %)
70 -(((
71 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
72 -)))
54 +{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
73 73  
74 -(% class="box infomessage" %)
75 -(((
76 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
77 -)))
56 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
78 78  
79 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
80 80  
81 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
60 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
82 82  
83 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
62 +0 - «Блокировка»
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
64 +1 - «Активен»,
86 86  
87 -(% style="color:#000000" %)Метод запроса: **GET**
66 +2 - «Отменен»
88 88  
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>
68 +3 - «Оборудован»
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
70 +4 - «Диагностика»
92 92  
93 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
72 +5 - «Сервис»
94 94  
95 -(% style="color:#000000" %)Ответ:
74 +6 - «Демонтаж»
96 96  
97 -(% style="color:#000000" %){
98 - "agentId": "", ~/~/ идентификатор клиента
99 - "parentId": "", ~/~/ идентификатор клиента-родителя
100 - "name": "", ~/~/ наименование клиента
101 - "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента1
103 - "status": "", ~/~/ статус клиента
104 - }
76 +7 - «Монтаж»
105 105  
78 +8 - «Дозаказ»
106 106  
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" %)]
80 +9 - «Обслужен»
108 108  
82 +10 - «Списан»
109 109  
110 -(% class="box" style="text-align: center;" %)
111 -(((
112 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
113 -)))
84 +11 - «Неисправен»
114 114  
115 -(% class="box successmessage" %)
116 -(((
117 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
118 -)))
86 +12 - «Проверен»
119 119  
120 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
88 +13 - «Не эксплуатируется»
89 +
121 121  
122 -(% style="color:#000000" %)Метод запроса: **POST**
91 + **Получение списка клиентов.**
123 123  
124 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
93 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
125 125  
126 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
95 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
127 127  
128 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
97 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
129 129  
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 - }
99 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
149 149  
150 -(% style="text-align:left" %)
151 -(% style="color:#000000; font-weight:normal" %)Ответ:
101 +Метод запроса: GET
152 152  
153 -(% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %){
103 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
155 155  
156 -(% style="text-align:left" %)
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» названия группы пользователя
105 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
174 174  
175 -(% style="text-align:left" %)
176 -(% style="color:#000000; font-weight:normal" %) }
107 +В заголовках запроса: X-Auth: Токен авторизации
177 177  
109 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
178 178  
179 -(% class="box successmessage" %)
180 -(((
181 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
182 -)))
111 +Примечание. Возможные значение параметра agentInfoType:
112 +
183 183  
184 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
114 + **Получение списка пользователей.**
185 185  
186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
116 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
187 187  
188 -(% style="color:#000000" %)Метод запроса: **POST**
118 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
189 189  
190 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
120 +Метод запроса: POST
191 191  
192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
193 193  
194 -(% style="color:#000000" %){
124 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
195 195  
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 - неважно
126 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
127 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
128 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
129 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
200 200  
201 -(% style="color:#000000" %) }
131 +}
202 202  
203 -(% style="color:#000000" %)Ответ:
133 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
204 204  
205 -(% style="color:#000000" %){ (%%)
135 +{{{ "sessionDuration": "", // длительность сессии в минутах}}}
206 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": "", ~/~/ дата/время последней авторизации
137 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
138 +
220 220  
221 -(% style="color:#000000" %) }
140 + **Получение списка типов устройств**
222 222  
142 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
223 223  
224 -(% class="box warningmessage" %)
225 -(((
226 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
227 -)))
144 +Метод запроса: GET
228 228  
229 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
146 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
230 230  
231 -(% style="color:#000000" %)Метод запроса: **PUT**
148 +В заголовках запроса:X-Auth: Токен авторизации
232 232  
233 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
150 +Ответ: [
234 234  
235 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
152 +{{{ {
153 + "deviceTypeId" : "", // ID типа устройства
154 + "deviceTypeName" : "" // Название типа устройства
155 + },}}}
236 236  
237 -(% lang="en-US" style="text-align:left" %)
238 -(% 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» //названия групп ] }  //
157 +… ]
158 +
239 239  
160 + **Получение списка типов датчиков**
240 240  
241 -(% class="box warningmessage" %)
242 -(((
243 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
244 -)))
162 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
245 245  
246 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
164 +Метод запроса: GET
247 247  
248 -(% style="color:#000000" %)Метод запроса: **PUT**
166 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
249 249  
250 -(% 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} Параметр запроса:
168 +В заголовках запроса:X-Auth: Токен авторизации
251 251  
252 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
170 +Ответ: [
253 253  
254 -(% class="western" %)
255 -{{{ "description": "", // описание
256 - "data": "" // данные, связанные со сменой статуса}}}
172 +{{{ {}}}
257 257  
258 -(% style="color:#000000" %)}
174 +«id»: «», //ID типа датчика «name»: «», //Название
259 259  
260 -(% style="text-align:left" %)
261 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
176 +{{{ "description": "" // Описание
177 + },}}}
262 262  
179 +… ]
180 +
263 263  
264 -(% class="box errormessage" %)
265 -(((
266 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
267 -)))
182 + **Получение информации об объекте**
268 268  
269 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
184 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
270 270  
271 -(% style="color:#000000" %)Метод запроса: **DELETE**
186 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
272 272  
273 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
188 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
274 274  
275 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
190 +Метод запроса: GET
276 276  
277 -(% style="text-align:left" %)
278 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
192 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
279 279  
194 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
280 280  
281 -(% class="box" style="text-align: center;" %)
282 -(((
283 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
284 -)))
196 +В заголовках запроса: X-Auth: Токен авторизации
285 285  
286 -(% class="box infomessage" %)
287 -(((
288 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
289 -)))
198 +Ответ:
290 290  
291 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
200 +{
292 292  
293 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
294 -
295 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
296 -
297 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
298 -
299 -(% style="color:#000000" %)Метод запроса: **GET**
300 -
301 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
302 -
303 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
304 -
305 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
306 -
307 -(% style="color:#000000" %)Ответ:
308 -
309 -(% style="color:#000000" %){
310 -
311 -(% class="western" %)
312 312  {{{ "vehicleId": “”, // идентификатор объекта
313 313   "name": "", // имя объекта
314 314   "imei": "", // IMEI объекта
... ... @@ -325,31 +325,71 @@
325 325   },
326 326   ...}}}
327 327  
328 -(% style="color:#000000" %)}
218 +}
329 329  
330 -(% style="text-align:left" %)
331 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
332 332  
333 -(% style="text-align:left" %)
334 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
223 + **Добавление пользователя**
335 335  
225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
336 336  
337 -(% class="box successmessage" %)
338 -(((
339 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
340 -)))
227 +Метод запроса: POST
341 341  
342 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
343 343  
344 -(% style="color:#000000" %)Метод запроса: **POST**
231 +В заголовках запроса: X-Auth: Токен авторизации
345 345  
346 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
233 +Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
347 347  
348 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
236 +
349 349  
350 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
238 + **Редактирование пользователя**
351 351  
352 -(% class="western" %)
240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
241 +
242 +Метод запроса: PUT
243 +
244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
245 +
246 +В заголовках запроса: X-Auth: Токен авторизации
247 +
248 +Параметры в теле запроса (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» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
249 +
250 +{{{ "description": "", // описание
251 + "data": "" // данные, связанные со сменой статуса}}}
252 +
253 +}
254 +
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
257 +
258 + **Удаление пользователя**
259 +
260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
261 +
262 +Метод запроса: DELETE
263 +
264 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
265 +
266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
267 +
268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
270 +
271 + **Добавление объекта**
272 +
273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
274 +
275 +Метод запроса: POST
276 +
277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
278 +
279 +В заголовках запроса: X-Auth: Токен авторизации
280 +
281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
282 +
353 353  {{{ "parentId": "", // ID клиента
354 354   "name": "", // имя ТС
355 355   "imei": "", // IMEI
... ... @@ -390,13 +390,12 @@
390 390   },
391 391   ]}}}
392 392  
393 -(% style="color:#000000" %)… }
323 +… }
394 394  
395 -(% style="color:#000000" %)Ответ:
325 +Ответ:
396 396  
397 -(% style="color:#000000" %){
327 +{
398 398  
399 -(% class="western" %)
400 400  {{{ "vehicleId": "", //ID ТС
401 401   "parentId": "", //Guid владельца ТС
402 402   "name": "", //Имя объекта
... ... @@ -431,85 +431,65 @@
431 431   "lastMileage": "", // Пробег (в метрах)
432 432   "motohoursCondition": "", // Условие по моточасам
433 433   "lastMotohours": "", // Моточасы
434 - "periodicCondition": "", // Условие периодичности по времени
435 - "kind": "", // Вид периодичности по времени
363 + "periodicCondition": "", // Условие периодичности по времени}}}
364 +
365 +{{{ "kind": "", // Вид периодичности по времени
436 436   "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
437 437   }
438 438   ]}}}
439 439  
440 -(% style="text-align:left" %)
441 -(% style="color:#000000" %)}
370 +}
371 +
442 442  
373 + **Удаление объекта**
443 443  
444 -(% class="box successmessage" %)
445 -(((
446 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
447 -)))
375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
448 448  
449 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
377 +Метод запроса: DELETE
450 450  
451 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
452 452  
453 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
381 +Параметр запроса: {id} - Guid объекта
454 454  
455 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
383 +В заголовках запроса: X-Auth: Токен авторизации
456 456  
457 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
386 +
458 458  
459 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
388 + **Редактирование объекта**
460 460  
461 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
462 462  
463 -(% style="color:#000000" %)Метод запроса: **POST**
392 +Метод запроса: PUT
464 464  
465 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
466 466  
467 -(% style="color:#000000" %)В заголовках запроса:
396 +В заголовках запроса: X-Auth: Токен авторизации
468 468  
469 -(% style="color:#000000" %)− Content-Type: application/json
398 +Параметры в теле запроса (JSON):
470 470  
471 -(% style="color:#000000" %)− X-Auth: Токен авторизации
400 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
472 472  
473 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
402 +Ответ:
474 474  
475 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
404 +{ «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»: «» //Сколько раз выполнить задание } ] }
405 +
476 476  
477 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
407 + **Изменение статуса объекта**
478 478  
479 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
480 480  
481 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
411 +Метод запроса: POST
482 482  
483 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
484 484  
485 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
415 +Параметр запроса: {vehicleId} - ID ТС
486 486  
487 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
417 +В заголовках запроса: X-Auth: Токен авторизации
488 488  
489 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
419 +Параметры в теле запроса (JSON): {
490 490  
491 -
492 -(% class="box successmessage" %)
493 -(((
494 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
495 -)))
496 -
497 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
498 -
499 -(% style="color:#000000" %)Метод запроса: **POST**
500 -
501 -(% 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}
502 -
503 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
504 -
505 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
506 -
507 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
508 -
509 -(% class="western" %)
510 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
511 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
512 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
421 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
513 513   "date": "", // Дата смены статуса (null если сменить немедленно)
514 514   "description": "", // Описание
515 515   "data": "", // Данные
... ... @@ -516,11 +516,10 @@
516 516   "overwrite": false, // Флаг перезаписи
517 517   "stage": "", // Состояние, может быть null}}}
518 518  
519 -(% style="color:#000000" %)}
428 +}
520 520  
521 -(% style="color:#000000" %)Ответ: {
430 +Ответ: {
522 522  
523 -(% class="western" %)
524 524  {{{ "status": "", // значение статуса
525 525   "date": "", // Дата смены статуса
526 526   "description": "", // Описание
... ... @@ -528,116 +528,19 @@
528 528   "overwrite": false, // Флаг перезаписи
529 529   "stage": "", // Состояние}}}
530 530  
531 -(% style="text-align:left" %)
532 -(% style="color:#000000" %)}
439 +}
440 +
533 533  
442 + **Проверка авторизации**
534 534  
535 -(% class="box warningmessage" %)
536 -(((
537 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
538 -)))
444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
539 539  
540 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
446 +Метод запроса: GET
541 541  
542 -(% style="color:#000000" %)Метод запроса: **PUT**
448 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
543 543  
544 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
450 +В заголовках запроса: X-Auth: Токен авторизации
545 545  
546 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
547 547  
548 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
549 -
550 -(% 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»: «» //Сколько раз выполнить задание } ] }
551 -
552 -(% style="color:#000000" %)Ответ:
553 -
554 -(% lang="en-US" style="text-align:left" %)
555 -(% 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»: «» //Сколько раз выполнить задание } ] }
556 -
557 -
558 -(% class="box errormessage" %)
559 -(((
560 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
561 -)))
562 -
563 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
564 -
565 -(% style="color:#000000" %)Метод запроса: **DELETE**
566 -
567 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
568 -
569 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
570 -
571 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
572 -
573 -(% style="text-align:left" %)
574 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
575 -
576 -
577 -(% class="box" lang="en-US" style="text-align: center;" %)
578 -(((
579 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
580 -)))
581 -
582 -(% class="box infomessage" %)
583 -(((
584 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
585 -)))
586 -
587 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
588 -
589 -(% style="color:#000000" %)Метод запроса: **GET**
590 -
591 -(% 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]]
592 -
593 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
594 -
595 -(% style="color:#000000" %)Ответ: [
596 -
597 -(% class="western" %)
598 -{{{ {
599 - "deviceTypeId" : "", // ID типа устройства
600 - "deviceTypeName" : "" // Название типа устройства
601 - },}}}
602 -
603 -(% style="text-align:left" %)
604 -(% style="color:#000000" %)…** **]
605 -
606 -
607 -(% class="box" style="text-align: center;" %)
608 -(((
609 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
610 -)))
611 -
612 -(% class="box infomessage" %)
613 -(((
614 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
615 -)))
616 -
617 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
618 -
619 -(% style="color:#000000" %)Метод запроса: **GET**
620 -
621 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
622 -
623 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
624 -
625 -(% style="color:#000000" %)Ответ: [
626 -
627 -(% class="western" style="margin-bottom:19px" %)
628 -{{{ {}}}
629 -
630 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
631 -
632 -(% class="western" %)
633 -{{{ "description": "" // Описание
634 - },}}}
635 -
636 -(% style="text-align:left" %)
637 -(% style="color:#000000" %)… ]
638 -
639 -
640 -(% class="box" lang="en-US" style="text-align: center;" %)
641 -(((
642 -(% 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]] **
643 -)))
454 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**

Меню

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