From version 1.1 >
edited by Андрей Калиновский
on 2022/05/16 11:15
To version < 30.1 >
edited by Илья Крайнов
on 2022/10/24 14:18
>
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,884 @@
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": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
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": "" , ~/~/ группы пользователя, названия групп
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": "" , ~/~/ группы пользователя, «user» названия группы пользователя
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 warningmessage" %)
231 +(((
232 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 +)))
144 144  
145 -В заголовках запроса:X-Auth: Токен авторизации
235 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
146 146  
147 -Ответ: [
237 +(% style="color:#000000" %)Метод запроса: **PUT**
148 148  
149 -{{{ {
150 - "deviceTypeId" : "", // ID типа устройства
151 - "deviceTypeName" : "" // Название типа устройства
152 - },}}}
239 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
153 153  
154 - ]
241 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
155 155  
156 - **Получение списка типов датчиков**
243 +(% lang="en-US" style="text-align:left" %)
244 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
157 157  
158 -Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
246 +(% lang="en-US" style="text-align:left" %)
247 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
159 159  
160 -Метод запроса: GET
249 +(% lang="en-US" style="text-align:left" %)
250 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
251 + "lastName": "" , ~/~/ фамилия
252 + "firstName": "" , ~/~/ имя
253 + "position": "" , ~/~/ должность
254 + "phone": "" , ~/~/ телефон
255 + "organization": "" , ~/~/ организация
256 + "login": "" , ~/~/ логин
257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 + "email": "" , ~/~/ email
259 + "description": "" , ~/~/ описание
260 + "isEnabled": "" , ~/~/ признак включения
261 + "parentId": "" , ~/~/ Guid родительского агента
262 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 + "kind": "" , ~/~/ тип аутентификации
266 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
267 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
161 161  
162 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
269 +(% lang="en-US" style="text-align:left" %)
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
163 163  
164 -В заголовках запроса:X-Auth: Токен авторизации
272 +(% lang="en-US" style="text-align:left" %)
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
165 165  
166 -Ответ: [
275 +(% lang="en-US" style="text-align:left" %)
276 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
167 167  
168 -{{{ {}}}
278 +(% lang="en-US" style="text-align:left" %)
279 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
280 + "lastName": "" , ~/~/ фамилия
281 + "firstName": "" , ~/~/ имя
282 + "position": "" , ~/~/ должность
283 + "phone": "" , ~/~/ телефон
284 + "organization": "" , ~/~/ организация
285 + "login": "" , ~/~/ логин
286 + "password": "" , ~/~/ пароль 
287 + "email": "" , ~/~/ email
288 + "description": "" , ~/~/ описание
289 + "isEnabled": "" , ~/~/ признак включения
290 + "parentId": "" , ~/~/ Guid родительского агента
291 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 + "kind": "" , ~/~/ тип аутентификации
294 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
169 169  
170 -«id»: «», //ID типа датчика «name»: «», //Название
297 +(% lang="en-US" style="text-align:left" %)
298 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
171 171  
172 -{{{ "description": "" // Описание
173 - },}}}
174 174  
175 -… ]
301 +(% class="box warningmessage" %)
302 +(((
303 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 +)))
176 176  
177 - **Получение информации об объекте**
306 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
178 178  
179 -Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
308 +(% style="color:#000000" %)Метод запроса: **PUT**
180 180  
181 -Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
310 +(% 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}
182 182  
183 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
312 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
184 184  
185 -Метод запроса: GET
314 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
186 186  
187 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
316 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
188 188  
189 -Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
318 +(% style="color:#000000" %){
190 190  
191 -В заголовках запроса: X-Auth: Токен авторизации
320 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 + "description": "" , ~/~/ описание
322 + "data": "" , ~/~/ данные, связанные со сменой статуса
192 192  
193 -Ответ:
324 +(% style="color:#000000" %)}
194 194  
195 -{
326 +(% style="text-align:left" %)
327 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
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 - ...}}}
212 212  
213 -}
330 +(% class="box warningmessage" %)
331 +(((
332 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
333 +)))
214 214  
215 -Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
335 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
216 216  
217 - **Добавление пользователя**
337 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
218 218  
219 -Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
339 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
220 220  
221 -Метод запроса: POST
341 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
222 222  
223 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
343 + [ 
344 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
345 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
346 + ]
224 224  
225 -В заголовках запроса: 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»: [ // группы пользователя «», //названия групп «», «» ] }
349 +(% class="box warningmessage" %)
350 +(((
351 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/find**
352 +)))
228 228  
229 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuratio: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
354 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
230 230  
231 - **Редактирование пользователя**
356 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
232 232  
233 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
358 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
234 234  
235 -Метод запроса: PUT
360 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
236 236  
237 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
362 + [ 
363 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
364 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
365 + ]
238 238  
239 -В заголовках запроса: X-Auth: Токен авторизации
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 - блокирован)
368 +(% class="box errormessage" %)
369 +(((
370 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
371 +)))
242 242  
243 -{{{ "description": "", // описание
244 - "data": "" // данные, связанные со сменой статуса}}}
373 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
245 245  
246 -}
375 +(% style="color:#000000" %)Метод запроса: **DELETE**
247 247  
248 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
377 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
249 249  
250 - **Удаление пользователя**
379 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
251 251  
252 -Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
381 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
253 253  
254 -Метод запроса: DELETE
383 +(% style="text-align:left" %)
384 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
255 255  
256 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
257 257  
258 -Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
387 +(% class="box" style="text-align: center;" %)
388 +(((
389 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
390 +)))
259 259  
260 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
392 +(% class="box infomessage" %)
393 +(((
394 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
395 +)))
261 261  
262 - **Добавление объекта**
397 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
263 263  
264 -Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
399 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
265 265  
266 -Метод запроса: POST
401 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
267 267  
268 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
403 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
269 269  
270 -В заголовках запроса: X-Auth: Токен авторизации
405 +(% style="color:#000000" %)Метод запроса: **GET**
271 271  
272 -Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
407 +(% 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>
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": [ // задания на ТО
409 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
410 +
411 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
412 +
413 +(% style="color:#000000" %)Ответ:
414 +
415 +(% style="color:#000000" %){
416 +
417 + "vehicleId": "" , ~/~/ идентификатор объекта
418 + "name": "" , ~/~/ имя объекта
419 + "imei": "" , ~/~/ IMEI объекта
420 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
421 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
422 + "parentId": "" , ~/~/ идентификатор клиента-родителя
423 + "parentName": "" , ~/~/ наименование клиента-родителя,
424 + "modelId": "" , ~/~/ идентификатор модели объекта
425 + "modelName": "" , ~/~/ наименование модели объекта,
426 + "unitId": "" , ~/~/ идентификатор подразделения
427 + "unitName": "" , ~/~/ наименование подразделения
428 + "status": "" , ~/~/ статус объекта
429 +
430 +}
431 +
432 +(% style="text-align:left" %)
433 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
434 +
435 +(% style="text-align:left" %)
436 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
437 +
438 +
439 +(% class="box successmessage" %)
440 +(((
441 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
442 +)))
443 +
444 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
445 +
446 +(% style="color:#000000" %)Метод запроса: **POST**
447 +
448 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
449 +
450 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
451 +
452 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
453 +
454 +(% style="color:#000000" %){
455 +
456 + "parentId": "" , ~/~/ ID клиента
457 + "name": "" , ~/~/ имя ТС
458 + "imei": "" , ~/~/ IMEI
459 + "deviceTypeId": "" , ~/~/ ID типа устройства
460 + "modelId": "" , ~/~/ ID модели
461 + "unitId": "" , ~/~/ ID подразделения
462 + "sim1": "" , ~/~/ Номер SIM 1
463 + "sim2": "" , ~/~/ Номер SIM2
464 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
465 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
466 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
467 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
468 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
469 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
470 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
471 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
472 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
473 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
474 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
475 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
476 + "counters": ~/~/ счетчики
299 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 - однократно)
478 + "mileage": "" , ~/~/ пробег
479 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
480 + "motohours": "" , ~/~/ моточасы
481 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
311 311   },
312 - ]}}}
483 + "cmsv6Parameters": { ~/~/ параметры CMSv6
484 + "enabled": true, ~/~/ флаг включения
485 + "id": "" , ~/~/ идентификатор
486 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
487 + "login": "" , ~/~/ имя учетной записи
488 + "password": "" ~/~/ пароль учетной записи
489 + },
490 + "inspectionTasks": ~/~/ задания на ТО
491 + {
492 + "enabled": "" , ~/~/ Признак включения
493 + "name": "" , ~/~/ Имя задания
494 + "description": "" , ~/~/ Описание задания
495 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
496 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
497 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
498 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
499 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
500 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
501 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
502 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
503 + }
313 313  
314 - }
505 +(% style="color:#000000" %) }
315 315  
316 -Ответ:
507 +(% style="color:#000000" %)Ответ:
317 317  
318 -{
509 +(% style="color:#000000" %){
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": "", // Условие периодичности по времени}}}
511 + "vehicleId": "", ~/~/ID ТС 
512 + "parentId": "", ~/~/Guid владельца ТС
513 + "name": "", ~/~/Имя объекта
514 + "imei": "", ~/~/IMEI
515 + "deviceTypeId": "", ~/~/ID типа устройства
516 + "modelId": "", ~/~/ID модели
517 + "unitId": "", ~/~/ID подразделения
518 + "sim1": "", ~/~/SIM1
519 + "sim2": "", ~/~/SIM2
520 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
521 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
522 + "counters": { ~/~/Счётчики
523 + "mileageEnabled": true,
524 + "motohoursEnabled": true,
525 + "mileage": "",
526 + "motohours": 345.0
527 + },
528 + "cmsv6Parameters": { ~/~/Параметры CmsV6
529 + "id": null,
530 + "enabled": true, ~/~/флаг включения
531 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
532 + "login": "", ~/~/ имя учетной записи
533 + "password": "" ~/~/ пароль учетной записи
534 + },
535 + "inspectionTasks": { ~/~/ задания на ТО
536 + "id": "", ~/~/ ID задачи
537 + "enabled": false, ~/~/ Признак включения
538 + "name": "", ~/~/ Имя задания
539 + "description": "", ~/~/ Описание задания
540 + "mileageCondition": "", ~/~/ Условие по пробегу
541 + "lastMileage": "", ~/~/ Пробег (в метрах)
542 + "motohoursCondition": "", ~/~/ Условие по моточасам
543 + "lastMotohours": "", ~/~/ Моточасы
544 + "periodicCondition": "", ~/~/ Условие периодичности по времени
545 + "kind": "", ~/~/ Вид периодичности по времени 
546 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
547 + }
355 355  
356 -{{{ "kind": "", // Вид периодичности по времени
357 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
358 - }
359 - ]}}}
549 +(% style="text-align:left" %)
550 +(% style="color:#000000" %)}
360 360  
361 -}
552 +**Валидация:**
553 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
554 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
555 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
362 362  
363 - **Удаление объекта**
364 364  
365 -Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
558 +(% class="box successmessage" %)
559 +(((
560 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
561 +)))
366 366  
367 -Метод запроса: DELETE
563 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
368 368  
369 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
565 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
370 370  
371 -Параметр запроса: {id} - Guid объекта
567 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
372 372  
373 -В заголовках запроса: X-Auth: Токен авторизации
569 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
374 374  
375 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
571 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
376 376  
377 - **Редактирование объекта**
573 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
378 378  
379 -Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
575 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
380 380  
381 -Метод запроса: PUT
577 +(% style="color:#000000" %)Метод запроса: **POST**
382 382  
383 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
579 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
384 384  
385 -В заголовках запроса: X-Auth: Токен авторизации
581 +(% style="color:#000000" %)В заголовках запроса:
386 386  
387 -Параметры в теле запроса (JSON):
583 +(% style="color:#000000" %)− Content-Type: __**application/json**__
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»: «» //Сколько раз выполнить задание } ] }
585 +(% style="color:#000000" %)− X-Auth: Токен авторизации
390 390  
391 -Ответ:
587 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
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»: «» //Сколько раз выполнить задание } ] }
589 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
394 394  
395 - **Изменение статуса объекта**
591 +(% class="western" style="color:#000000" %)##{##
396 396  
397 -Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
593 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
594 + "name": null, ~/~/ Имя ТС (string, опционально) 
595 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
596 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
597 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
598 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
599 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
600 +(% style="color:#000000" %)}
398 398  
399 -Метод запроса: POST
602 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
400 400  
401 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
604 +(% style="color:#000000" %)Ответ:
402 402  
403 -Параметр запроса: {vehicleId} - ID ТС
606 +(% style="color:#000000" %){
404 404  
405 -В заголовках запроса: X-Auth: Токен авторизации
608 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
609 + "name": "" ~/~/ наименование объекта
610 + "imei": "" ~/~/ IMEI объекта
611 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
612 + "deviceTypeName": "" ~/~/ наименование типа устройства
613 + "sim1": "" ~/~/ первый номер телефона
614 + "sim2": "" ~/~/ второй номер телефона
615 + "parentId": "" ~/~/ идентификатор клиента-родителя
616 + "parentName": "" ~/~/ наименование клиента-родителя
617 + "modelId": "" ~/~/ идентификатор модели объекта
618 + "modelName": "" ~/~/ наименование модели объекта
619 + "unitId": "" ~/~/ идентификатор подразделения
620 + "unitName": "" ~/~/ наименование подразделения
621 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
622 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
623 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
624 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
625 +(% style="color:#000000" %)}
406 406  
407 -Параметры в теле запроса (JSON): {
627 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
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}}}
415 415  
416 -}
630 +(% class="box successmessage" %)
631 +(((
632 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
633 +)))
417 417  
418 -Ответ: {
635 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
419 419  
420 -{{{ "status": "", // значение статуса
421 - "date": "", // Дата смены статуса
422 - "description": "", // Описание
423 - "data": "", // Данные
424 - "overwrite": false, // Флаг перезаписи
425 - "stage": "", // Состояние}}}
637 +(% style="color:#000000" %)Метод запроса: **POST**
426 426  
427 -}
639 +(% 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}
428 428  
429 - **Проверка авторизации**
641 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
430 430  
431 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
643 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
432 432  
433 -Метод запроса: GET
645 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
434 434  
435 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
647 +(% style="color:#000000" %){
436 436  
437 -В заголовках запроса: X-Auth: Токен авторизации
649 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
650 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
651 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
652 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
653 + "description": "", ~/~/ Описание
654 + "data": "", ~/~/ Данные
655 + "overwrite": false, ~/~/ Флаг перезаписи
656 + "stage": "", ~/~/ Состояние, может быть null
438 438  
439 -Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «40
658 +(% style="color:#000000" %)}
440 440  
441 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
660 +(% style="color:#000000" %)Ответ:
661 +
662 +(% style="color:#000000" %){
663 +
664 + "status": "", ~/~/ значение статуса
665 + "date": "", ~/~/ Дата смены статуса 
666 + "description": "", ~/~/ Описание
667 + "data": "", ~/~/ Данные
668 + "overwrite": false, ~/~/ Флаг перезаписи
669 + "stage": "", ~/~/ Состояние
670 +
671 +(% style="text-align:left" %)
672 +(% style="color:#000000" %) }
673 +
674 +
675 +(% class="box warningmessage" %)
676 +(((
677 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
678 +)))
679 +
680 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
681 +
682 +(% style="color:#000000" %)Метод запроса: **PUT**
683 +
684 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
685 +
686 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
687 +
688 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
689 +
690 +(% style="color:#000000" %){    
691 +
692 +(((
693 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
694 + "parentId": "", ~/~/ ID клиента
695 + "name": "", ~/~/ имя ТС
696 + "imei": "", ~/~/ IMEI
697 + "deviceTypeId": "", ~/~/ ID типа устройства
698 + "modelId": "", ~/~/ , ID модели    
699 + "unitId": "", ~/~/ подразделения
700 + "sim1": "", ~/~/ SIM 1
701 + "sim2": "", ~/~/ SIM2     (%%)
702 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
703 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
704 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
705 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
706 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
707 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
708 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
709 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
710 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
711 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
712 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
713 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
714 +(% style="color:#000000" %) "counters": 
715 + {
716 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
717 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
718 + "mileage": «», пробег
719 + "motohours": «» моточасы
720 + }
721 + "cmsv6Parameters": ~/~/ параметры CMSv6
722 + {       
723 + "id": "", ~/~/ идентификатор
724 + "enabled": true, ~/~/ флаг включения
725 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
726 + "login": "", ~/~/ имя учетной записи
727 + "password": "", ~/~/ пароль учетной записи
728 + }
729 + "inspectionTasks": ~/~/ задания на ТО
730 + {
731 + "id": "", ~/~/ ID задания
732 + "enabled": false, ~/~/ Признак включения
733 + "name": "", ~/~/ Имя задания
734 + "description": "", ~/~/ Описание задания
735 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
736 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
737 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
738 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
739 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
740 + "kind": "", ~/~/ Вид периодичности по времени
741 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
742 + } 
743 +)))
744 +
745 +(% style="color:#000000" %)}
746 +
747 +(% style="color:#000000" %)Ответ:
748 +
749 +(% lang="en-US" style="text-align:left" %)
750 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
751 +
752 +(% lang="en-US" style="text-align:left" %)
753 + "vehicleId": "", ~/~/ ID ТС
754 + "parentId": "", ~/~/ ID клиента
755 + "name": "", ~/~/ имя ТС
756 + "imei": "", ~/~/ IMEI
757 + "deviceTypeId": "", ~/~/ типа устройства
758 + "modelId": "", ~/~/ ID модели
759 + "unitId": "", ~/~/ ID подразделения
760 + "sim1": "", ~/~/ SIM 1
761 + "sim2": "", ~/~/ SIM2
762 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
763 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
764 + "counters": 
765 + {
766 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
767 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
768 + "mileage": "", ~/~/ пробег
769 + "motohours": "", ~/~/ моточасы
770 + }
771 + "cmsv6Parameters": ~/~/ параметры CMSv6
772 + {
773 + "id": ~/~/ идентификатор
774 + "enabled": true, ~/~/ флаг включения
775 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
776 + "login": "", ~/~/ имя учетной записи
777 + "password": "", ~/~/ пароль учетной записи
778 + }
779 + "inspectionTasks": ~/~/ задания на ТО
780 + {
781 + "id": "", ~/~/ ID задания
782 + "enabled": false, ~/~/ Признак включения
783 + "name": "", ~/~/ Имя задания
784 + "description": "", ~/~/ Описание задания
785 + "mileageCondition": "", ~/~/ Условие по пробегу
786 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
787 + "motohoursCondition": "", ~/~/ Условие по моточасам
788 + "lastMotohours": "", ~/~/ Моточасы
789 + "periodicCondition": "", ~/~/ Условие периодичности по времени
790 + "kind": "", ~/~/ Вид периодичности по времени
791 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
792 + }
793 +
794 +(% lang="en-US" style="text-align:left" %)
795 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
796 +
797 +**валидация:**
798 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
799 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
800 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
801 +
802 +
803 +(% class="box errormessage" %)
804 +(((
805 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
806 +)))
807 +
808 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
809 +
810 +(% style="color:#000000" %)Метод запроса: **DELETE**
811 +
812 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
813 +
814 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
815 +
816 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
817 +
818 +(% style="text-align:left" %)
819 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
820 +
821 +
822 +(% class="box" lang="en-US" style="text-align: center;" %)
823 +(((
824 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
825 +)))
826 +
827 +(% class="box infomessage" %)
828 +(((
829 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
830 +)))
831 +
832 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
833 +
834 +(% style="color:#000000" %)Метод запроса: **GET**
835 +
836 +(% 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]]
837 +
838 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
839 +
840 +(% style="color:#000000" %)Ответ:
841 +
842 +(% style="color:#000000" %){
843 +
844 + "deviceTypeId" : "", ~/~/ ID типа устройства
845 + "deviceTypeName" : "" ~/~/ Название типа устройства
846 +
847 +(% style="text-align:left" %)
848 +(% style="color:#000000" %)}
849 +
850 +
851 +(% class="box" style="text-align: center;" %)
852 +(((
853 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
854 +)))
855 +
856 +(% class="box infomessage" %)
857 +(((
858 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
859 +)))
860 +
861 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
862 +
863 +(% style="color:#000000" %)Метод запроса: **GET**
864 +
865 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
866 +
867 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
868 +
869 +(% style="color:#000000" %)Ответ:
870 +
871 +(% style="color:#000000" %){
872 +
873 + "id": "", ~/~/ ID типа датчика 
874 + "name": "", ~/~/ Название
875 + "description": "", ~/~/ Описание
876 +
877 +(% style="text-align:left" %)
878 +(% style="color:#000000" %)}
879 +
880 +
881 +(% class="box" lang="en-US" style="text-align: center;" %)
882 +(((
883 +(% 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]] **
884 +)))

Меню

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