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