Редактировал(а) Андрей Калиновский 2025/03/12 10:28
<
От версии < 8.1 >
отредактировано Артем Шемяков
на 2022/09/01 14:45
К версии < 7.1 >
отредактировано Андрей Калиновский
на 2022/08/31 14:14
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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

Меню

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