From version 1.1 >
edited by Андрей Калиновский
on 2022/05/16 11:15
To version < 44.1 >
edited by Илья Крайнов
on 2022/11/21 10:22
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -API
1 +Методы API для работы с ГЛОНАССSoft
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,441 +1,1216 @@
1 -== Описание ГЛОНАССSoft Public API
2 - ==
1 +(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 - **Действующие ограничения**
4 +== ==
5 5  
6 -Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
6 +(% class="box" style="text-align: center;" %)
7 +(((
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 +)))
7 7  
11 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 +
8 8  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 +
9 9  
10 - **Авторизация**
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
11 11  
12 -Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
23 +(% class="box successmessage" %)
24 +(((
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 +)))
13 13  
14 -Метод запроса: GET
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
15 15  
16 -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]]
30 +(% style="color:#000000" %)Метод запроса: **POST**
17 17  
18 -В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
19 19  
20 -Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
21 21  
22 - **Получение списка объектов**
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
23 23  
24 -Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}(%%)
42 +
25 25  
26 -−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
44 +(% style="color:#000000" %)**Ответ:**
27 27  
28 -−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
46 +(% lang="en-US" %)
47 +(% style="color:#000000" %){
29 29  
30 -−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
49 +(% lang="en-US" %)
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
31 31  
32 -−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
53 +(% lang="en-US" %)
54 +}
33 33  
34 -−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
56 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
35 35  
36 -Метод запроса: POST
37 37  
38 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
59 +(% class="box infomessage" %)
60 +(((
61 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +)))
39 39  
40 -В заголовках запроса:
64 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
41 41  
42 -−Content-Type: application/json
66 +(% style="color:#000000" %)Метод запроса: **GET**
43 43  
44 -−X-Auth: Токен авторизации
68 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
45 45  
46 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
70 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
47 47  
48 -{{{ {"vehicleId": null,//84350, // ID ТС (int, опционально)
49 - "name": null, // Имя ТС (string, опционально)
50 - "imei": null,//"710179307", // IMEI (string, опционально)
51 - "sim": null,//"938112", // Номер телефона (string, опционально)
52 - "deviceTypeId": null,//5 // ID типа устройства (short, опционально)
53 - "parentId": null, // ID клиента (Guid, опционально)
54 - "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
72 +(% lang="en-US" %)
73 +(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
55 55  
56 -Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
57 57  
58 -Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «» // статус объекта }, … ]
76 +(% class="box" style="text-align: center;" %)
77 +(((
78 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 +)))
59 59  
60 -Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
81 +(% class="box infomessage" %)
82 +(((
83 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 +)))
61 61  
62 -0 - «Блокировка»
86 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
63 63  
64 -1 - «Активен»,
88 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
65 65  
66 -2 - «Отменен»
90 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
67 67  
68 -3 - «Оборудован»
92 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
69 69  
70 -4 - «Диагностика»
94 +(% style="color:#000000" %)Метод запроса: **GET**
71 71  
72 -5 - «Сервис»
96 +(% 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>
73 73  
74 -6 - «Демонтаж»
98 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
75 75  
76 -7 - «Монтаж»
100 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
77 77  
78 -8 - «Дозаказ»
102 +(% style="color:#000000" %)Ответ:
79 79  
80 -9 - «Обслужен»
104 +(% style="color:#000000" %){
105 + "agentId": "", ~/~/ идентификатор клиента
106 + "parentId": "", ~/~/ идентификатор клиента-родителя
107 + "name": "", ~/~/ наименование клиента
108 + "fullName": "", ~/~/ полное наименование клиента
109 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 +}
81 81  
82 -10 - «Списан»
83 83  
84 -11 - «Неисправен»
114 +(% class="box" style="text-align: center;" %)
115 +(((
116 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
117 +)))
85 85  
86 -12 - «Проверен»
119 +(% class="box successmessage" %)
120 +(((
121 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 +)))
87 87  
88 -13 - «Не эксплуатируется»
124 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
89 89  
90 - **Получение списка клиентов.**
126 +(% style="color:#000000" %)Метод запроса: **POST**
91 91  
92 -Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
128 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
93 93  
94 -−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
130 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
95 95  
96 -−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
97 97  
98 -−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
134 +(% style="color:#000000" %){ 
135 + "lastName": "", ~/~/ фамилия
136 + "firstName": "", ~/~/ имя
137 + "position": "", ~/~/ должность
138 + "phone": "", ~/~/ телефон
139 + "organization": "", ~/~/ организация
140 + "login": "", ~/~/ логин (обязателен)
141 + "password": "", ~/~/ пароль (обязателен)
142 + "email": "", ~/~/ email (обязателен)
143 + "description": "", ~/~/ описание
144 + "isEnabled": "", ~/~/ признак включения
145 + "parentId": "", ~/~/ Guid родительского агента
146 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 +}
99 99  
100 -Метод запроса: GET
154 +(% style="text-align:left" %)
155 +(% style="color:#000000; font-weight:normal" %)Ответ:
101 101  
102 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
157 +(% style="text-align:left" %)
158 +(% style="color:#000000; font-weight:normal" %){    
103 103  
104 -Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
160 +(% style="text-align:left" %)
161 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 + "lastName": "" , ~/~/ Фамилия ,
163 + "firstName": "" , ~/~/ Имя
164 + "position": "" , ~/~/ Должность
165 + "phone": "" , ~/~/ Телефон
166 + "organization": "" , ~/~/ Организация
167 + "login": "" , ~/~/ Логин
168 + "password": "" , ~/~/ Пароль
169 + "email": "" , ~/~/ Email
170 + "description": "" , ~/~/ Описание
171 + "isEnabled": "" , ~/~/ Признак включения
172 + "parentId": "" , ~/~/ Guid родительского агента
173 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 + "kind": "" , ~/~/ тип аутентификации
176 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
105 105  
106 -В заголовках запроса: X-Auth: Токен авторизации
179 +(% style="text-align:left" %)
180 +(% style="color:#000000; font-weight:normal" %)}
107 107  
108 -Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
109 109  
110 -Примечание. Возможные значение параметра agentInfoType:
183 +(% class="box successmessage" %)
184 +(((
185 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
186 +)))
111 111  
112 - **Получение списка пользователей.**
188 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
113 113  
114 -Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
190 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
115 115  
116 -Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
192 +(% style="color:#000000" %)Метод запроса: **POST**
117 117  
118 -Метод запроса: POST
194 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
119 119  
120 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
196 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
121 121  
122 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
198 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
123 123  
124 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
125 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
126 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
127 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
200 +(% style="color:#000000" %){
128 128  
129 -}
202 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
130 130  
131 -Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
207 +(% style="color:#000000" %)}
132 132  
133 -{{{ "sessionDuration": "", // длительность сессии в минутах}}}
209 +(% style="color:#000000" %)Ответ:
134 134  
135 - «status»: 1, //статус пользователя «lastLogge«» //дата/время последней авторизации }, … ]
211 +(% style="color:#000000" %){         (%%)
136 136  
137 - **Получение списка типов устройств**
213 + "id": "" , ~/~/ идентификатор пользователя
214 + "lastName": "" , ~/~/ фамилия
215 + "firstName": "" , ~/~/ имя
216 + "position": "" , ~/~/ должность
217 + "phone": "" , ~/~/ телефон
218 + "parentId": "" , ~/~/ идентификатор клиента-родителя
219 + "parentName": "" , ~/~/ наименование клиента-родителя
220 + "organization": "" , ~/~/ организация
221 + "login": "" , ~/~/ логин
222 + "email": "" , ~/~/ E-mail
223 + "sessionDuration":"", ~/~/ длительность сессии в минутах
224 + "status": "1",  ~/~/ статус пользователя
225 + "astLogged": "", ~/~/ дата/время последней авторизации
138 138  
139 -Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Aut)
227 +(% style="color:#000000" %)}
140 140  
141 -Метод запроса: GET
142 142  
143 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
230 +(% class="box successmessage" %)
231 +(((
232 +(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 +)))
144 144  
145 -В заголовках запроса:X-Auth: Токен авторизации
235 +(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
146 146  
147 -Ответ: [
237 +(% style="color:#000000" %)Метод запроса: **GET**
148 148  
149 -{{{ {
150 - "deviceTypeId" : "", // ID типа устройства
151 - "deviceTypeName" : "" // Название типа устройства
152 - },}}}
239 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
153 153  
154 - ]
241 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
155 155  
156 - **Получение списка типов датчиков**
243 +(% style="color:#000000" %)Ответ:
157 157  
158 -Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
245 +(((
246 +(((
247 +{
248 +)))
249 +)))
159 159  
160 -Метод запроса: GET
251 +(((
252 +(((
253 + "id": "", ~/~/ GUID пользователя
254 +)))
255 +)))
161 161  
162 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
257 +(((
258 +(((
259 + "lastName": "", ~/~/ Фамилия
260 +)))
261 +)))
163 163  
164 -В заголовках запроса:X-Auth: Токен авторизации
263 +(((
264 +(((
265 + "firstName": "", ~/~/ Имя
266 +)))
267 +)))
165 165  
166 -Ответ: [
269 +(((
270 +(((
271 + "position": "", ~/~/ Должность
272 +)))
273 +)))
167 167  
168 -{{{ {}}}
275 +(((
276 +(((
277 + "phone": "", ~/~/ Номер телефона
278 +)))
279 +)))
169 169  
170 -«id»: «», //ID типа датчика «name»: «», //Название
281 +(((
282 +(((
283 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
284 +)))
285 +)))
171 171  
172 -{{{ "description": "" // Описание
173 - },}}}
287 +(((
288 +(((
289 + "parentName": "", Наименование клиента, которому принадлежит пользователь
290 +)))
291 +)))
174 174  
175 -… ]
293 +(((
294 +(((
295 + "organization": "", ~/~/ Организация
296 +)))
297 +)))
176 176  
177 - **Получение информации об объекте**
299 +(((
300 +(((
301 + "login": "", ~/~/ Логин пользователя
302 +)))
303 +)))
178 178  
179 -Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
305 +(((
306 +(((
307 + "email": "", ~/~/ Адрес электронной почты
308 +)))
309 +)))
180 180  
181 -Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
311 +(((
312 +(((
313 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
314 +)))
315 +)))
182 182  
183 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
317 +(((
318 +(((
319 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
320 +)))
321 +)))
184 184  
185 -Метод запроса: GET
323 +(((
324 +(((
325 + "description": "", ~/~/ Описание
326 +)))
327 +)))
186 186  
187 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
329 +(((
330 +(((
331 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
332 +)))
333 +)))
188 188  
189 -Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
335 +(((
336 +(((
337 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
338 +)))
339 +)))
190 190  
191 -В заголовках запроса: X-Auth: Токен авторизации
341 +(((
342 +(((
343 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
344 +)))
345 +)))
192 192  
193 -Ответ:
347 +(((
348 +(((
349 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
350 +)))
351 +)))
194 194  
195 -{
353 +(((
354 +(((
355 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
356 +)))
357 +)))
196 196  
197 -{{{ "vehicleId": “”, // идентификатор объекта
198 - "name": "", // имя объекта
199 - "imei": "", // IMEI объекта
200 - "deviceTypeId": “”, // идентификатор устройства объекта
201 - "deviceTypeName": "" // наименование устройства объекта
202 - "parentId": "", // идентификатор клиента-родителя
203 - "parentName": "" // наименование клиента-родителя,
204 - "modelId": "", // идентификатор модели объекта
205 - "modelName": "" // наименование модели объекта,
206 - "unitId": "", // идентификатор подразделения
207 - "unitName": "", // наименование подразделения
208 - "status": “”, // статус объекта
209 - ...
210 - },
211 - ...}}}
359 +(((
360 +(((
361 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
362 +)))
363 +)))
212 212  
365 +(((
366 +(((
367 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
368 +)))
369 +)))
370 +
371 +(((
372 +(((
373 + "groups": [], ~/~/ Список ролей пользователя
374 +)))
375 +)))
376 +
377 +(((
378 +(((
379 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
380 +)))
381 +)))
382 +
383 +(((
384 +(((
385 + "authDevices": [ ], ~/~/ Список авторизованных устройств
386 +)))
387 +)))
388 +
389 +(((
390 +(((
391 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
392 +)))
393 +)))
394 +
395 +(((
396 +(((
397 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
398 +)))
399 +)))
400 +
401 +(((
402 +(((
213 213  }
404 +)))
405 +)))
214 214  
215 -Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
216 216  
217 - **Добавление пользователя**
408 +(% class="box warningmessage" %)
409 +(((
410 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
411 +)))
218 218  
219 -Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
413 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
220 220  
221 -Метод запроса: POST
415 +(% style="color:#000000" %)Метод запроса: **PUT**
222 222  
223 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
417 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
224 224  
225 -В заголовках запроса: X-Auth: Токен авторизации
419 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
226 226  
227 араметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
421 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
228 228  
229 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
423 +(% lang="en-US" style="text-align:left" %)
424 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
230 230  
231 - **Редактирование пользователя**
426 +(% lang="en-US" style="text-align:left" %)
427 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
232 232  
233 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
429 +(% lang="en-US" style="text-align:left" %)
430 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
431 + "lastName": "" , ~/~/ фамилия
432 + "firstName": "" , ~/~/ имя
433 + "position": "" , ~/~/ должность
434 + "phone": "" , ~/~/ телефон
435 + "organization": "" , ~/~/ организация
436 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
437 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
438 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
439 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
440 + "isEnabled": "" , ~/~/ признак включения
441 + "parentId": "" , ~/~/ Guid родительского агента
442 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
443 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
444 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
445 + "kind": "" , ~/~/ тип аутентификации
446 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
447 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
234 234  
235 -Метод запроса: PUT
449 +(% lang="en-US" style="text-align:left" %)
450 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
236 236  
237 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
452 +(% lang="en-US" style="text-align:left" %)
453 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
238 238  
239 -В заголовках запроса: X-Auth: Токен авторизации
455 +(% lang="en-US" style="text-align:left" %)
456 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
240 240  
241 -Параметры в теле запроса (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 - блокирован)
458 +(% lang="en-US" style="text-align:left" %)
459 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
460 + "lastName": "" , ~/~/ фамилия
461 + "firstName": "" , ~/~/ имя
462 + "position": "" , ~/~/ должность
463 + "phone": "" , ~/~/ телефон
464 + "organization": "" , ~/~/ организация
465 + "login": "" , ~/~/ логин
466 + "password": "" , ~/~/ пароль 
467 + "email": "" , ~/~/ email
468 + "description": "" , ~/~/ описание
469 + "isEnabled": "" , ~/~/ признак включения
470 + "parentId": "" , ~/~/ Guid родительского агента
471 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
472 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
473 + "kind": "" , ~/~/ тип аутентификации
474 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
475 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
242 242  
243 -{{{ "description": "", // описание
244 - "data": "" // данные, связанные со сменой статуса}}}
477 +(% lang="en-US" style="text-align:left" %)
478 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
245 245  
480 +
481 +(% class="box warningmessage" %)
482 +(((
483 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
484 +)))
485 +
486 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
487 +
488 +(% style="color:#000000" %)Метод запроса: **PUT**
489 +
490 +(% 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}
491 +
492 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
493 +
494 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
495 +
496 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
497 +
498 +(% style="color:#000000" %){
499 +
500 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
501 + "description": "" , ~/~/ описание
502 + "data": "" , ~/~/ данные, связанные со сменой статуса
503 +
504 +(% style="color:#000000" %)}
505 +
506 +(% style="text-align:left" %)
507 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
508 +
509 +
510 +(% class="box warningmessage" %)
511 +(((
512 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
513 +)))
514 +
515 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
516 +
517 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
518 +
519 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
520 +
521 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
522 +
523 + [ 
524 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
525 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
526 + ]
527 +
528 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
529 +
530 +
531 +(% class="box warningmessage" %)
532 +(((
533 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
534 +)))
535 +
536 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
537 +
538 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
539 +
540 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
541 +
542 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
543 +
544 + [ 
545 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
546 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
547 + ]
548 +
549 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
550 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
551 +
552 +(((
553 +В теле ответа:
554 +{
555 + "errorMessages": [
556 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
557 + ],
558 + "users": [
559 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
560 + ]
246 246  }
562 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
563 +"users" - массив id пользователей, которых не удалось включить или отключить.
564 +
565 +)))
247 247  
248 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
567 +(% class="box errormessage" %)
568 +(((
569 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
570 +)))
249 249  
250 - **Удаление пользователя**
572 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
251 251  
252 -Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
574 +(% style="color:#000000" %)Метод запроса: **DELETE**
253 253  
254 -Метод запроса: DELETE
576 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
255 255  
256 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
578 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
257 257  
258 -Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
580 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
259 259  
260 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
582 +(% style="text-align:left" %)
583 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
261 261  
262 - **Добавление объекта**
263 263  
264 -Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
586 +(% class="box" style="text-align: center;" %)
587 +(((
588 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
589 +)))
265 265  
266 -Метод запроса: POST
591 +(% class="box infomessage" %)
592 +(((
593 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
594 +)))
267 267  
268 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
596 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
269 269  
270 -В заголовках запроса: X-Auth: Токен авторизации
598 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
271 271  
272 -Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
600 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
273 273  
274 -{{{ "parentId": "", // ID клиента
275 - "name": "", // имя ТС
276 - "imei": "", // IMEI
277 - "deviceTypeId": "",// ID типа устройства
278 - "modelId": "",
279 - "unitId": "", // ID подразделения
280 - "sim1": "", // Номер SIM 1
281 - "sim2": "", // Номер SIM2
282 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
283 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
284 - "consumptionIdle": "",// Расход топлива на холостом ходу
285 - "counters": {
286 - "mileage": "", // пробег
287 - "mileageEnabled": true, // флаг активности счётчика "пробег"
288 - "motohours":"", // моточасы
289 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
290 - },
291 - "cmsv6Parameters": { // параметры CMSv6
292 - "enabled": true, // флаг включения
293 - //"id": "", // идентификатор
294 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
295 - "login": "", // имя учетной записи
296 - "password": "" // пароль учетной записи
297 - },
298 - "inspectionTasks": [ // задания на ТО
299 - {
300 - "enabled": "", // Признак включения
301 - "name": "", // Имя задания
302 - "description": "", // Описание задания
303 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
304 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
305 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
306 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
307 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
308 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
309 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
310 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
311 - },
312 - ]}}}
602 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
313 313  
314 - }
604 +(% style="color:#000000" %)Метод запроса: **GET**
315 315  
316 -Ответ:
606 +(% 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>
317 317  
608 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
609 +
610 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
611 +
612 +(% style="color:#000000" %)Ответ:
613 +
614 +(((
318 318  {
616 +)))
319 319  
320 -{{{ "vehicleId": "", //ID ТС
321 - "parentId": "", //Guid владельца ТС
322 - "name": "", //Имя объекта
323 - "imei": "", //IMEI
324 - "deviceTypeId": "", //ID типа устройства
325 - "modelId": "", //ID модели
326 - "unitId": "", //ID подразделения
327 - "sim1": "", //SIM1
328 - "sim2": "", //SIM2
329 - "consumptionPer100Km": "", //Расход топлива на 100 км
330 - "consumptionIdle": "", //Расход топлива на холостом ходу
331 - "counters": { //Счётчики
332 - "mileageEnabled": true,
333 - "motohoursEnabled": true,
334 - "mileage": "",
335 - "motohours": 345.0
336 - },
337 - "cmsv6Parameters": { //Параметры CmsV6
338 - "id": null,
339 - "enabled": true, //флаг включения
340 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
341 - "login": "", // имя учетной записи
342 - "password": "" // пароль учетной записи
343 - },
344 - "inspectionTasks": [ // задания на ТО
345 - {
346 - "id": "", // ID задачи
347 - "enabled": false, // Признак включения
348 - "name": "", // Имя задания
349 - "description": "", // Описание задания
350 - "mileageCondition": "", // Условие по пробегу
351 - "lastMileage": "", // Пробег (в метрах)
352 - "motohoursCondition": "", // Условие по моточасам
353 - "lastMotohours": "", // Моточасы
354 - "periodicCondition": "", // Условие периодичности по времени}}}
618 +(((
619 + "vehicleId": "", ~/~/ ID объекта
620 +)))
355 355  
356 -{{{ "kind": "", // Вид периодичности по времени
357 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
358 - }
359 - ]}}}
622 +(((
623 + "name": "", ~/~/ Имя объекта
624 +)))
360 360  
361 -}
626 +(((
627 + "imei": "", ~/~/ IMEI объекта
628 +)))
362 362  
363 - **Удаление объекта**
630 +(((
631 + "deviceTypeId": , ~/~/ ID типа устройства
632 +)))
364 364  
365 -Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
634 +(((
635 + "deviceTypeName": "", ~/~/ Название типа устройства
636 +)))
366 366  
367 -Метод запроса: DELETE
638 +(((
639 + "sim1": "", ~/~/ Номер SIM1
640 +)))
368 368  
369 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
642 +(((
643 + "parentId": "", Номер SIM2
644 +)))
370 370  
371 -Параметр запроса: {id} - Guid объекта
646 +(((
647 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
648 +)))
372 372  
373 -В заголовках запроса: X-Auth: Токен авторизации
650 +(((
651 + "modelId": "", ID модели объекта
652 +)))
374 374  
375 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
654 +(((
655 + "modelName": "", Имя модели объекта
656 +)))
376 376  
377 - **Редактирование объекта**
658 +(((
659 + "createdAt": "", Дата создания объекта
660 +)))
378 378  
379 -Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
662 +(((
663 + "mileageCalcMethod": "", Выбранный метод расчета пробега
664 +)))
380 380  
381 -Метод запроса: PUT
666 +(((
667 + "counters": { ~/~/ Нормы
668 +)))
382 382  
383 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
670 +(((
671 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
672 +)))
384 384  
385 -В заголовках запроса: X-Auth: Токен авторизации
674 +(((
675 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
676 +)))
386 386  
387 -Параметры в теле запроса (JSON):
678 +(((
679 + "mileage": "", ~/~/ Пробег по нормам в метрах
680 +)))
388 388  
389 -//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
682 +(((
683 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
684 +)))
390 390  
391 -Ответ:
686 +(((
687 + },
688 +)))
392 392  
393 -{ «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»: «» //Сколько раз выполнить задание } ] }
690 +(((
691 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
692 +)))
394 394  
395 - **Изменение статуса объекта**
694 +(((
695 + {
696 +)))
396 396  
397 -Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
698 +(((
699 + "id": "", ~/~/ ID  задания
700 +)))
398 398  
399 -Метод запроса: POST
702 +(((
703 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
704 +)))
400 400  
401 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
706 +(((
707 + "name": "", ~/~/ Наименование задания
708 +)))
402 402  
403 -Параметр запроса: {vehicleId} - ID ТС
710 +(((
711 + "description": "", ~/~/ Описание задания
712 +)))
404 404  
405 -В заголовках запроса: X-Auth: Токен авторизации
714 +(((
715 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
716 +)))
406 406  
407 -Параметры в теле запроса (JSON): {
718 +(((
719 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
720 +)))
408 408  
409 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
410 - "date": "", // Дата смены статуса (null если сменить немедленно)
411 - "description": "", // Описание
412 - "data": "", // Данные
413 - "overwrite": false, // Флаг перезаписи
414 - "stage": "", // Состояние, может быть null}}}
722 +(((
723 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
724 +)))
415 415  
416 -}
726 +(((
727 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
728 +)))
417 417  
418 -Ответ: {
730 +(((
731 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
732 +)))
419 419  
420 -{{{ "status": "", // значение статуса
421 - "date": "", // Дата смены статуса
422 - "description": "", // Описание
423 - "data": "", // Данные
424 - "overwrite": false, // Флаг перезаписи
425 - "stage": "", // Состояние}}}
734 +(((
735 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
736 +)))
426 426  
738 +(((
739 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
740 +)))
741 +
742 +(((
743 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
744 +)))
745 +
746 +(((
747 + }
748 +)))
749 +
750 +(((
751 + ]
752 +)))
753 +
754 +(((
427 427  }
756 +)))
428 428  
429 - **Проверка авторизации**
758 +(% style="text-align:left" %)
759 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
430 430  
431 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
761 +(% style="text-align:left" %)
762 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
432 432  
433 -Метод запроса: GET
434 434  
435 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
765 +(% class="box successmessage" %)
766 +(((
767 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
768 +)))
436 436  
437 -В заголовках запроса: X-Auth: Токен авторизации
770 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
438 438  
439 -Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
772 +(% style="color:#000000" %)Метод запроса: **POST**
440 440  
441 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
774 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
775 +
776 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
777 +
778 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
779 +
780 +(% style="color:#000000" %){
781 +
782 + "parentId": "" , ~/~/ ID клиента
783 + "name": "" , ~/~/ имя ТС
784 + "imei": "" , ~/~/ IMEI
785 + "deviceTypeId": "" , ~/~/ ID типа устройства
786 + "modelId": "" , ~/~/ ID модели
787 + "unitId": "" , ~/~/ ID подразделения
788 + "sim1": "" , ~/~/ Номер SIM 1
789 + "sim2": "" , ~/~/ Номер SIM2
790 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
791 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
792 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
793 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
794 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
795 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
796 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
797 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
798 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
799 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
800 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
801 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
802 + "counters": ~/~/ счетчики
803 + {
804 + "mileage": "" , ~/~/ пробег
805 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
806 + "motohours": "" , ~/~/ моточасы
807 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
808 + },
809 + "cmsv6Parameters": { ~/~/ параметры CMSv6
810 + "enabled": true, ~/~/ флаг включения
811 + "id": "" , ~/~/ идентификатор
812 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
813 + "login": "" , ~/~/ имя учетной записи
814 + "password": "" ~/~/ пароль учетной записи
815 + },
816 + "inspectionTasks": ~/~/ задания на ТО
817 + {
818 + "enabled": "" , ~/~/ Признак включения
819 + "name": "" , ~/~/ Имя задания
820 + "description": "" , ~/~/ Описание задания
821 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
822 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
823 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
824 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
825 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
826 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
827 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
828 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
829 + }
830 +
831 +(% style="color:#000000" %) }
832 +
833 +(% style="color:#000000" %)Ответ:
834 +
835 +(% style="color:#000000" %){
836 +
837 + "vehicleId": "", ~/~/ID ТС 
838 + "parentId": "", ~/~/Guid владельца ТС
839 + "name": "", ~/~/Имя объекта
840 + "imei": "", ~/~/IMEI
841 + "deviceTypeId": "", ~/~/ID типа устройства
842 + "modelId": "", ~/~/ID модели
843 + "unitId": "", ~/~/ID подразделения
844 + "sim1": "", ~/~/SIM1
845 + "sim2": "", ~/~/SIM2
846 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
847 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
848 + "counters": { ~/~/Счётчики
849 + "mileageEnabled": true,
850 + "motohoursEnabled": true,
851 + "mileage": "",
852 + "motohours": 345.0
853 + },
854 + "cmsv6Parameters": { ~/~/Параметры CmsV6
855 + "id": null,
856 + "enabled": true, ~/~/флаг включения
857 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
858 + "login": "", ~/~/ имя учетной записи
859 + "password": "" ~/~/ пароль учетной записи
860 + },
861 + "inspectionTasks": { ~/~/ задания на ТО
862 + "id": "", ~/~/ ID задачи
863 + "enabled": false, ~/~/ Признак включения
864 + "name": "", ~/~/ Имя задания
865 + "description": "", ~/~/ Описание задания
866 + "mileageCondition": "", ~/~/ Условие по пробегу
867 + "lastMileage": "", ~/~/ Пробег (в метрах)
868 + "motohoursCondition": "", ~/~/ Условие по моточасам
869 + "lastMotohours": "", ~/~/ Моточасы
870 + "periodicCondition": "", ~/~/ Условие периодичности по времени
871 + "kind": "", ~/~/ Вид периодичности по времени 
872 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
873 + }
874 +
875 +(% style="text-align:left" %)
876 +(% style="color:#000000" %)}
877 +
878 +**Валидация:**
879 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
880 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
881 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
882 +
883 +
884 +(% class="box successmessage" %)
885 +(((
886 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
887 +)))
888 +
889 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
890 +
891 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
892 +
893 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
894 +
895 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
896 +
897 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
898 +
899 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
900 +
901 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
902 +
903 +(% style="color:#000000" %)Метод запроса: **POST**
904 +
905 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
906 +
907 +(% style="color:#000000" %)В заголовках запроса:
908 +
909 +(% style="color:#000000" %)− Content-Type: __**application/json**__
910 +
911 +(% style="color:#000000" %)− X-Auth: Токен авторизации
912 +
913 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
914 +
915 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
916 +
917 +(% class="western" style="color:#000000" %)##{##
918 +
919 +(((
920 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
921 + "name": null, ~/~/ Имя ТС (string, опционально)
922 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
923 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
924 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
925 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
926 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
927 +)))
928 +
929 +(((
930 +(% class="western" style="color:#000000" %) "customFields\": null ~/~/ значение любого из произвольных полей ТС(%%)
931 +(% style="color:#000000" %)}
932 +)))
933 +
934 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
935 +
936 +(% style="color:#000000" %)Ответ:
937 +
938 +(% style="color:#000000" %){
939 +
940 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
941 + "name": "" ~/~/ наименование объекта
942 + "imei": "" ~/~/ IMEI объекта
943 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
944 + "deviceTypeName": "" ~/~/ наименование типа устройства
945 + "sim1": "" ~/~/ первый номер телефона
946 + "sim2": "" ~/~/ второй номер телефона
947 + "parentId": "" ~/~/ идентификатор клиента-родителя
948 + "parentName": "" ~/~/ наименование клиента-родителя
949 + "modelId": "" ~/~/ идентификатор модели объекта
950 + "modelName": "" ~/~/ наименование модели объекта
951 + "unitId": "" ~/~/ идентификатор подразделения
952 + "unitName": "" ~/~/ наименование подразделения
953 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
954 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
955 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
956 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
957 +(% style="color:#000000" %)}
958 +
959 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
960 +
961 +
962 +(% class="box successmessage" %)
963 +(((
964 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
965 +)))
966 +
967 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
968 +
969 +(% style="color:#000000" %)Метод запроса: **POST**
970 +
971 +(% 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}
972 +
973 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
974 +
975 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
976 +
977 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
978 +
979 +(% style="color:#000000" %){
980 +
981 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
982 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
983 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
984 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
985 + "description": "", ~/~/ Описание
986 + "data": "", ~/~/ Данные
987 + "overwrite": false, ~/~/ Флаг перезаписи
988 + "stage": "", ~/~/ Состояние, может быть null
989 +
990 +(% style="color:#000000" %)}
991 +
992 +(% style="color:#000000" %)Ответ:
993 +
994 +(% style="color:#000000" %){
995 +
996 + "status": "", ~/~/ значение статуса
997 + "date": "", ~/~/ Дата смены статуса 
998 + "description": "", ~/~/ Описание
999 + "data": "", ~/~/ Данные
1000 + "overwrite": false, ~/~/ Флаг перезаписи
1001 + "stage": "", ~/~/ Состояние
1002 +
1003 +(% style="text-align:left" %)
1004 +(% style="color:#000000" %) }
1005 +
1006 +
1007 +(% class="box warningmessage" %)
1008 +(((
1009 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1010 +)))
1011 +
1012 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1013 +
1014 +(% style="color:#000000" %)Метод запроса: **PUT**
1015 +
1016 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1017 +
1018 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1019 +
1020 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
1021 +
1022 +(% style="color:#000000" %){    
1023 +
1024 +(((
1025 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1026 + "parentId": "", ~/~/ ID клиента
1027 + "name": "", ~/~/ имя ТС
1028 + "imei": "", ~/~/ IMEI
1029 + "deviceTypeId": "", ~/~/ ID типа устройства
1030 + "modelId": "", ~/~/ , ID модели    
1031 + "unitId": "", ~/~/ подразделения
1032 + "sim1": "", ~/~/ SIM 1
1033 + "sim2": "", ~/~/ SIM2     (%%)
1034 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1035 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1036 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1037 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1038 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1039 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1040 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1041 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1042 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1043 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1044 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1045 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1046 +(% style="color:#000000" %) "counters": 
1047 + {
1048 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1049 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1050 + "mileage": "", ~/~/ пробег, в метрах 
1051 + "motohours": "" ~/~/ моточасы, в секундах
1052 + }
1053 + "cmsv6Parameters": ~/~/ параметры CMSv6
1054 + {       
1055 + "id": "", ~/~/ идентификатор
1056 + "enabled": true, ~/~/ флаг включения
1057 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1058 + "login": "", ~/~/ имя учетной записи
1059 + "password": "", ~/~/ пароль учетной записи
1060 + }
1061 + "inspectionTasks": ~/~/ задания на ТО
1062 + {
1063 + "id": "", ~/~/ ID задания
1064 + "enabled": false, ~/~/ Признак включения
1065 + "name": "", ~/~/ Имя задания
1066 + "description": "", ~/~/ Описание задания
1067 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1068 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1069 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1070 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1071 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1072 + "kind": "", ~/~/ Вид периодичности по времени
1073 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1074 + } 
1075 +)))
1076 +
1077 +(% style="color:#000000" %)}
1078 +
1079 +(% style="color:#000000" %)Ответ:
1080 +
1081 +(% lang="en-US" style="text-align:left" %)
1082 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1083 +
1084 +(% lang="en-US" style="text-align:left" %)
1085 + "vehicleId": "", ~/~/ ID ТС
1086 + "parentId": "", ~/~/ ID клиента
1087 + "name": "", ~/~/ имя ТС
1088 + "imei": "", ~/~/ IMEI
1089 + "deviceTypeId": "", ~/~/ типа устройства
1090 + "modelId": "", ~/~/ ID модели
1091 + "unitId": "", ~/~/ ID подразделения
1092 + "sim1": "", ~/~/ SIM 1
1093 + "sim2": "", ~/~/ SIM2
1094 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1095 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1096 + "counters": 
1097 + {
1098 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1099 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1100 + "mileage": "", ~/~/ пробег
1101 + "motohours": "", ~/~/ моточасы
1102 + }
1103 + "cmsv6Parameters": ~/~/ параметры CMSv6
1104 + {
1105 + "id": ~/~/ идентификатор
1106 + "enabled": true, ~/~/ флаг включения
1107 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1108 + "login": "", ~/~/ имя учетной записи
1109 + "password": "", ~/~/ пароль учетной записи
1110 + }
1111 + "inspectionTasks": ~/~/ задания на ТО
1112 + {
1113 + "id": "", ~/~/ ID задания
1114 + "enabled": false, ~/~/ Признак включения
1115 + "name": "", ~/~/ Имя задания
1116 + "description": "", ~/~/ Описание задания
1117 + "mileageCondition": "", ~/~/ Условие по пробегу
1118 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1119 + "motohoursCondition": "", ~/~/ Условие по моточасам
1120 + "lastMotohours": "", ~/~/ Моточасы
1121 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1122 + "kind": "", ~/~/ Вид периодичности по времени
1123 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1124 + }
1125 +
1126 +(% lang="en-US" style="text-align:left" %)
1127 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1128 +
1129 +**валидация:**
1130 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1131 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1132 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1133 +
1134 +
1135 +(% class="box errormessage" %)
1136 +(((
1137 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1138 +)))
1139 +
1140 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1141 +
1142 +(% style="color:#000000" %)Метод запроса: **DELETE**
1143 +
1144 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1145 +
1146 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1147 +
1148 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1149 +
1150 +(% style="text-align:left" %)
1151 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1152 +
1153 +
1154 +(% class="box" lang="en-US" style="text-align: center;" %)
1155 +(((
1156 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1157 +)))
1158 +
1159 +(% class="box infomessage" %)
1160 +(((
1161 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1162 +)))
1163 +
1164 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1165 +
1166 +(% style="color:#000000" %)Метод запроса: **GET**
1167 +
1168 +(% 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]]
1169 +
1170 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1171 +
1172 +(% style="color:#000000" %)Ответ:
1173 +
1174 +(% style="color:#000000" %){
1175 +
1176 + "deviceTypeId" : "", ~/~/ ID типа устройства
1177 + "deviceTypeName" : "" ~/~/ Название типа устройства
1178 +
1179 +(% style="text-align:left" %)
1180 +(% style="color:#000000" %)}
1181 +
1182 +
1183 +(% class="box" style="text-align: center;" %)
1184 +(((
1185 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1186 +)))
1187 +
1188 +(% class="box infomessage" %)
1189 +(((
1190 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1191 +)))
1192 +
1193 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1194 +
1195 +(% style="color:#000000" %)Метод запроса: **GET**
1196 +
1197 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1198 +
1199 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1200 +
1201 +(% style="color:#000000" %)Ответ:
1202 +
1203 +(% style="color:#000000" %){
1204 +
1205 + "id": "", ~/~/ ID типа датчика 
1206 + "name": "", ~/~/ Название
1207 + "description": "", ~/~/ Описание
1208 +
1209 +(% style="text-align:left" %)
1210 +(% style="color:#000000" %)}
1211 +
1212 +
1213 +(% class="box" lang="en-US" style="text-align: center;" %)
1214 +(((
1215 +(% 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]] **
1216 +)))

Меню

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