<
From version < 4.1 >
edited by Андрей Калиновский
on 2022/08/31 14:11
To version < 28.3 >
edited by Артем Шемяков
on 2022/09/22 09:49
>
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.Artem
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,440 +1,827 @@
1 -== Описание ГЛОНАССSoft Public API ==
1 +(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
2 2  
3 3  == ==
4 4  
5 - **Действующие ограничения**
6 -
6 +(% class="box" style="text-align: center;" %)
7 +(((
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 +)))
7 7  
8 -- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
11 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
9 9  
10 -- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
11 11  
12 12  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
13 -\\
16 +
14 14  
15 - **Авторизация**
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
16 16  
17 -Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами 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 +)))
18 18  
19 -Метод запроса: GET
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
20 20  
21 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
30 +(% style="color:#000000" %)Метод запроса: **POST**
22 22  
23 -В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
24 24  
25 -Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
26 26  
27 - **Получение списка объектов**
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
28 28  
29 -Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}(%%)
42 +
30 30  
31 -−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
44 +(% style="color:#000000" %)**Ответ:**
32 32  
33 -−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
46 +(% lang="en-US" %)
47 +(% style="color:#000000" %){
34 34  
35 -−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
49 +(% lang="en-US" %)
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
36 36  
37 -−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
53 +(% lang="en-US" %)
54 +}
38 38  
39 -−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
56 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 40  
41 -Метод запроса: POST
42 42  
43 -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 +)))
44 44  
45 -В заголовках запроса:
64 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
46 46  
47 -−Content-Type: application/json
66 +(% style="color:#000000" %)Метод запроса: **GET**
48 48  
49 -−X-Auth: Токен авторизации
68 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
50 50  
51 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
70 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
52 52  
53 -{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
72 +(% lang="en-US" %)
73 +(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
54 54  
55 -Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
56 56  
57 -Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
76 +(% class="box" style="text-align: center;" %)
77 +(((
78 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 +)))
58 58  
59 -Параметры «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 +)))
60 60  
61 -0 - «Блокировка»
86 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
62 62  
63 -1 - «Активен»,
88 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
64 64  
65 -2 - «Отменен»
90 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
66 66  
67 -3 - «Оборудован»
92 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
68 68  
69 -4 - «Диагностика»
94 +(% style="color:#000000" %)Метод запроса: **GET**
70 70  
71 -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>
72 72  
73 -6 - «Демонтаж»
98 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
74 74  
75 -7 - «Монтаж»
100 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
76 76  
77 -8 - «Дозаказ»
102 +(% style="color:#000000" %)Ответ:
78 78  
79 -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 +}
80 80  
81 -10 - «Списан»
82 82  
83 -11 - «Неисправен»
114 +(% class="box" style="text-align: center;" %)
115 +(((
116 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
117 +)))
84 84  
85 -12 - «Проверен»
119 +(% class="box successmessage" %)
120 +(((
121 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 +)))
86 86  
87 -13 - «Не эксплуатируется»
124 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
88 88  
89 - **Получение списка клиентов.**
126 +(% style="color:#000000" %)Метод запроса: **POST**
90 90  
91 -Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
128 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
92 92  
93 -−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
130 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
95 -−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
96 96  
97 -−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
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 +}
98 98  
99 -Метод запроса: GET
154 +(% style="text-align:left" %)
155 +(% style="color:#000000; font-weight:normal" %)Ответ:
100 100  
101 -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" %){    
102 102  
103 -Параметр запроса: <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» названия группы пользователя
104 104  
105 -В заголовках запроса: X-Auth: Токен авторизации
179 +(% style="text-align:left" %)
180 +(% style="color:#000000; font-weight:normal" %)}
106 106  
107 -Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
108 108  
109 -Примечание. Возможные значение параметра agentInfoType:
183 +(% class="box successmessage" %)
184 +(((
185 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
186 +)))
110 110  
111 - **Получение списка пользователей.**
188 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
112 112  
113 -Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
190 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
114 114  
115 -Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
192 +(% style="color:#000000" %)Метод запроса: **POST**
116 116  
117 -Метод запроса: POST
194 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
118 118  
119 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
196 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
120 120  
121 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
198 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
122 122  
123 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
124 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
125 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
126 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
200 +(% style="color:#000000" %){
127 127  
128 -}
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 - неважно
129 129  
130 -Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
207 +(% style="color:#000000" %)}
131 131  
132 -{{{ "sessionDuration": "", // длительность сессии в минутах}}}
209 +(% style="color:#000000" %)Ответ:
133 133  
134 - «status»: 1, //статус пользователя «lastLogge«» //дата/время последней авторизации }, … ]
211 +(% style="color:#000000" %){         (%%)
135 135  
136 - **Получение списка типов устройств**
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": "", ~/~/ дата/время последней авторизации
137 137  
138 -Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Aut)
227 +(% style="color:#000000" %)}
139 139  
140 -Метод запроса: GET
141 141  
142 -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 +)))
143 143  
144 -В заголовках запроса:X-Auth: Токен авторизации
235 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
145 145  
146 -Ответ: [
237 +(% style="color:#000000" %)Метод запроса: **PUT**
147 147  
148 -{{{ {
149 - "deviceTypeId" : "", // ID типа устройства
150 - "deviceTypeName" : "" // Название типа устройства
151 - },}}}
239 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
152 152  
153 - ]
241 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
154 154  
155 - **Получение списка типов датчиков**
243 +(% lang="en-US" style="text-align:left" %)
244 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
156 156  
157 -Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
246 +(% lang="en-US" style="text-align:left" %)
247 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
158 158  
159 -Метод запроса: 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» названия группы пользователя
160 160  
161 -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" %)__}__
162 162  
163 -В заголовках запроса:X-Auth: Токен авторизации
272 +(% lang="en-US" style="text-align:left" %)
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
164 164  
165 -Ответ: [
275 +(% lang="en-US" style="text-align:left" %)
276 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
166 166  
167 -{{{ {}}}
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» названия группы пользователя
168 168  
169 -«id»: «», //ID типа датчика «name»: «», //Название
297 +(% lang="en-US" style="text-align:left" %)
298 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
170 170  
171 -{{{ "description": "" // Описание
172 - },}}}
173 173  
174 -… ]
301 +(% class="box warningmessage" %)
302 +(((
303 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 +)))
175 175  
176 - **Получение информации об объекте**
306 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
177 177  
178 -Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
308 +(% style="color:#000000" %)Метод запроса: **PUT**
179 179  
180 -Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «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}
181 181  
182 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
312 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
183 183  
184 -Метод запроса: GET
314 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
185 185  
186 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
316 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
187 187  
188 -Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
318 +(% style="color:#000000" %){
189 189  
190 -В заголовках запроса: X-Auth: Токен авторизации
320 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 + "description": "" , ~/~/ описание
322 + "data": "" , ~/~/ данные, связанные со сменой статуса
191 191  
192 -Ответ:
324 +(% style="color:#000000" %)}
193 193  
194 -{
326 +(% style="text-align:left" %)
327 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
195 195  
196 -{{{ "vehicleId": “”, // идентификатор объекта
197 - "name": "", // имя объекта
198 - "imei": "", // IMEI объекта
199 - "deviceTypeId": “”, // идентификатор устройства объекта
200 - "deviceTypeName": "" // наименование устройства объекта
201 - "parentId": "", // идентификатор клиента-родителя
202 - "parentName": "" // наименование клиента-родителя,
203 - "modelId": "", // идентификатор модели объекта
204 - "modelName": "" // наименование модели объекта,
205 - "unitId": "", // идентификатор подразделения
206 - "unitName": "", // наименование подразделения
207 - "status": “”, // статус объекта
208 - ...
209 - },
210 - ...}}}
211 211  
212 -}
330 +(% class="box errormessage" %)
331 +(((
332 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
333 +)))
213 213  
214 -Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
335 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
215 215  
216 - **Добавление пользователя**
337 +(% style="color:#000000" %)Метод запроса: **DELETE**
217 217  
218 -Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
339 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
219 219  
220 -Метод запроса: POST
341 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
221 221  
222 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
343 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
223 223  
224 -В заголовках запроса: X-Auth: Токен авторизации
345 +(% style="text-align:left" %)
346 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
225 225  
226 -Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
227 227  
228 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
349 +(% class="box" style="text-align: center;" %)
350 +(((
351 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
352 +)))
229 229  
230 - **Редактирование пользователя**
354 +(% class="box infomessage" %)
355 +(((
356 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
357 +)))
231 231  
232 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
359 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
233 233  
234 -Метод запроса: PUT
361 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
235 235  
236 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
363 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
237 237  
238 -В заголовках запроса: X-Auth: Токен авторизации
365 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
239 239  
240 -Параметры в теле запроса (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 - блокирован)
367 +(% style="color:#000000" %)Метод запроса: **GET**
241 241  
242 -{{{ "description": "", // описание
243 - "data": "" // данные, связанные со сменой статуса}}}
369 +(% 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>
244 244  
245 -}
371 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
246 246  
247 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
373 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
248 248  
249 - **Удаление пользователя**
375 +(% style="color:#000000" %)Ответ:
250 250  
251 -Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Aut)
377 +(% style="color:#000000" %){
252 252  
253 -Метод запроса: DELETE
379 + "vehicleId": "" , ~/~/ идентификатор объекта
380 + "name": "" , ~/~/ имя объекта
381 + "imei": "" , ~/~/ IMEI объекта
382 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 + "parentId": "" , ~/~/ идентификатор клиента-родителя
385 + "parentName": "" , ~/~/ наименование клиента-родителя,
386 + "modelId": "" , ~/~/ идентификатор модели объекта
387 + "modelName": "" , ~/~/ наименование модели объекта,
388 + "unitId": "" , ~/~/ идентификатор подразделения
389 + "unitName": "" , ~/~/ наименование подразделения
390 + "status": "" , ~/~/ статус объекта
254 254  
255 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
392 +}
256 256  
257 -Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
394 +(% style="text-align:left" %)
395 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
258 258  
259 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
397 +(% style="text-align:left" %)
398 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
260 260  
261 - **Добавление объекта**
262 262  
263 -Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
401 +(% class="box successmessage" %)
402 +(((
403 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
404 +)))
264 264  
265 -Метод запроса: POST
406 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
266 266  
267 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
408 +(% style="color:#000000" %)Метод запроса: **POST**
268 268  
269 -В заголовках запроса: X-Auth: Токен авторизации
410 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
270 270  
271 -Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
412 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
272 272  
273 -{{{ "parentId": "", // ID клиента
274 - "name": "", // имя ТС
275 - "imei": "", // IMEI
276 - "deviceTypeId": "",// ID типа устройства
277 - "modelId": "",
278 - "unitId": "", // ID подразделения
279 - "sim1": "", // Номер SIM 1
280 - "sim2": "", // Номер SIM2
281 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
282 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
283 - "consumptionIdle": "",// Расход топлива на холостом ходу
284 - "counters": {
285 - "mileage": "", // пробег
286 - "mileageEnabled": true, // флаг активности счётчика "пробег"
287 - "motohours":"", // моточасы
288 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
289 - },
290 - "cmsv6Parameters": { // параметры CMSv6
291 - "enabled": true, // флаг включения
292 - //"id": "", // идентификатор
293 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
294 - "login": "", // имя учетной записи
295 - "password": "" // пароль учетной записи
414 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
415 +
416 +(% style="color:#000000" %){
417 +
418 + "parentId": "" , ~/~/ ID клиента
419 + "name": "" , ~/~/ имя ТС
420 + "imei": "" , ~/~/ IMEI
421 + "deviceTypeId": "" , ~/~/ ID типа устройства
422 + "modelId": "" , ~/~/ ID модели
423 + "unitId": "" , ~/~/ ID подразделения
424 + "sim1": "" , ~/~/ Номер SIM 1
425 + "sim2": "" , ~/~/ Номер SIM2
426 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
427 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
428 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
429 + "consumptionPer100KmSeasonal": 0, \ Расход топлива на 100 км (Сезонные нормы - если задано - возвращаем)
430 + "consumptionPerHourSeasonal": 0, \ Расход топлива за моточас (Сезонные нормы - если задано - возвращаем)
431 + "consumptionIdleSeasonal": 0, \ Расход топлива на холостом ходу (Сезонные нормы - если задано - возвращаем)
432 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ параметры начала применения значений сезонных норм
433 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ параметры окончания применения значений сезонных норм
434 + "consumptionPerHourSeasonalBegin": "" , ~/~/ параметры начала применения значений сезонных норм
435 + "consumptionPerHourSeasonalEnd": "" , ~/~/параметры окончания применения значений сезонных норм
436 + "consumptionIdleSeasonalBegin": "" , ~/~/ параметры начала применения значений сезонных норм
437 + "consumptionIdleSeasonalEnd": "" , ~/~/ параметры окончания применения значений сезонных норм
438 + "counters": {
439 + "mileage": "" , ~/~/ пробег
440 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
441 + "motohours": "" , ~/~/ моточасы
442 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
296 296   },
297 - "inspectionTasks": [ // задания на ТО
298 - {
299 - "enabled": "", // Признак включения
300 - "name": "", // Имя задания
301 - "description": "", // Описание задания
302 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
303 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
304 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
305 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
306 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
307 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
308 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
309 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
444 + "cmsv6Parameters": { ~/~/ параметры CMSv6
445 + "enabled": true, ~/~/ флаг включения
446 + "id": "" , ~/~/ идентификатор
447 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
448 + "login": "" , ~/~/ имя учетной записи
449 + "password": "" ~/~/ пароль учетной записи
310 310   },
311 - ]}}}
451 + "inspectionTasks": ~/~/ задания на ТО
452 + {
453 + "enabled": "" , ~/~/ Признак включения
454 + "name": "" , ~/~/ Имя задания
455 + "description": "" , ~/~/ Описание задания
456 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
457 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
458 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
459 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
460 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
461 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
462 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
463 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
464 + }
312 312  
313 - }
466 +(% style="color:#000000" %) }
314 314  
315 -Ответ:
468 +(% style="color:#000000" %)Ответ:
316 316  
317 -{
470 +(% style="color:#000000" %){
318 318  
319 -{{{ "vehicleId": "", //ID ТС
320 - "parentId": "", //Guid владельца ТС
321 - "name": "", //Имя объекта
322 - "imei": "", //IMEI
323 - "deviceTypeId": "", //ID типа устройства
324 - "modelId": "", //ID модели
325 - "unitId": "", //ID подразделения
326 - "sim1": "", //SIM1
327 - "sim2": "", //SIM2
328 - "consumptionPer100Km": "", //Расход топлива на 100 км
329 - "consumptionIdle": "", //Расход топлива на холостом ходу
330 - "counters": { //Счётчики
331 - "mileageEnabled": true,
332 - "motohoursEnabled": true,
333 - "mileage": "",
334 - "motohours": 345.0
335 - },
336 - "cmsv6Parameters": { //Параметры CmsV6
337 - "id": null,
338 - "enabled": true, //флаг включения
339 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
340 - "login": "", // имя учетной записи
341 - "password": "" // пароль учетной записи
342 - },
343 - "inspectionTasks": [ // задания на ТО
344 - {
345 - "id": "", // ID задачи
346 - "enabled": false, // Признак включения
347 - "name": "", // Имя задания
348 - "description": "", // Описание задания
349 - "mileageCondition": "", // Условие по пробегу
350 - "lastMileage": "", // Пробег (в метрах)
351 - "motohoursCondition": "", // Условие по моточасам
352 - "lastMotohours": "", // Моточасы
353 - "periodicCondition": "", // Условие периодичности по времени}}}
472 + "vehicleId": "", ~/~/ID ТС 
473 + "parentId": "", ~/~/Guid владельца ТС
474 + "name": "", ~/~/Имя объекта
475 + "imei": "", ~/~/IMEI
476 + "deviceTypeId": "", ~/~/ID типа устройства
477 + "modelId": "", ~/~/ID модели
478 + "unitId": "", ~/~/ID подразделения
479 + "sim1": "", ~/~/SIM1
480 + "sim2": "", ~/~/SIM2
481 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
482 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
483 + "counters": { ~/~/Счётчики
484 + "mileageEnabled": true,
485 + "motohoursEnabled": true,
486 + "mileage": "",
487 + "motohours": 345.0
488 + },
489 + "cmsv6Parameters": { ~/~/Параметры CmsV6
490 + "id": null,
491 + "enabled": true, ~/~/флаг включения
492 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
493 + "login": "", ~/~/ имя учетной записи
494 + "password": "" ~/~/ пароль учетной записи
495 + },
496 + "inspectionTasks": { ~/~/ задания на ТО
497 + "id": "", ~/~/ ID задачи
498 + "enabled": false, ~/~/ Признак включения
499 + "name": "", ~/~/ Имя задания
500 + "description": "", ~/~/ Описание задания
501 + "mileageCondition": "", ~/~/ Условие по пробегу
502 + "lastMileage": "", ~/~/ Пробег (в метрах)
503 + "motohoursCondition": "", ~/~/ Условие по моточасам
504 + "lastMotohours": "", ~/~/ Моточасы
505 + "periodicCondition": "", ~/~/ Условие периодичности по времени
506 + "kind": "", ~/~/ Вид периодичности по времени 
507 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
508 + }
354 354  
355 -{{{ "kind": "", // Вид периодичности по времени
356 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
357 - }
358 - ]}}}
510 +(% style="text-align:left" %)
511 +(% style="color:#000000" %)}
359 359  
360 -}
513 +**Валидация:**
514 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
515 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
516 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
361 361  
362 - **Удаление объекта**
518 +(% class="box successmessage" %)
519 +(((
520 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
521 +)))
363 363  
364 -Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
523 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
365 365  
366 -Метод запроса: DELETE
525 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
367 367  
368 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
527 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
369 369  
370 -Параметр запроса: {id} - Guid объекта
529 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
371 371  
372 -В заголовках запроса: X-Auth: Токен авторизации
531 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
373 373  
374 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
533 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
375 375  
376 - **Редактирование объекта**
535 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
377 377  
378 -Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
537 +(% style="color:#000000" %)Метод запроса: **POST**
379 379  
380 -Метод запроса: PUT
539 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
381 381  
382 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
541 +(% style="color:#000000" %)В заголовках запроса:
383 383  
384 -В заголовках запроса: X-Auth: Токен авторизации
543 +(% style="color:#000000" %)− Content-Type: __**application/json**__
385 385  
386 -Параметры в теле запроса (JSON):
545 +(% style="color:#000000" %)− X-Auth: Токен авторизации
387 387  
388 -//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
547 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
389 389  
390 -Ответ:
549 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
391 391  
392 -{ «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»: «», //имя учетной записи «passwor: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
551 +(% class="western" style="color:#000000" %)##{##
393 393  
394 - **Изменение статуса объекта**
553 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
554 + "name": null, ~/~/ Имя ТС (string, опционально) 
555 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
556 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
557 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
558 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
559 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
560 +(% style="color:#000000" %)}
395 395  
396 -Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
562 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
397 397  
398 -Метод запроса: POST
564 +(% style="color:#000000" %)Ответ:
399 399  
400 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
566 +(% style="color:#000000" %){
401 401  
402 -Параметр запроса: {vehicleId} - ID ТС
568 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
569 + "name": "" ~/~/ наименование объекта
570 + "imei": "" ~/~/ IMEI объекта
571 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
572 + "deviceTypeName": "" ~/~/ наименование типа устройства
573 + "sim1": "" ~/~/ первый номер телефона
574 + "sim2": "" ~/~/ второй номер телефона
575 + "parentId": "" ~/~/ идентификатор клиента-родителя
576 + "parentName": "" ~/~/ наименование клиента-родителя
577 + "modelId": "" ~/~/ идентификатор модели объекта
578 + "modelName": "" ~/~/ наименование модели объекта
579 + "unitId": "" ~/~/ идентификатор подразделения
580 + "unitName": "" ~/~/ наименование подразделения
581 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
582 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
583 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
584 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
585 +(% style="color:#000000" %)}
403 403  
404 -В заголовках запроса: X-Auth: Токен авторизации
587 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
405 405  
406 -Параметры в теле запроса (JSON): {
407 407  
408 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
409 - "date": "", // Дата смены статуса (null если сменить немедленно)
410 - "description": "", // Описание
411 - "data": "", // Данные
412 - "overwrite": false, // Флаг перезаписи
413 - "stage": "", // Состояние, может быть null}}}
590 +(% class="box successmessage" %)
591 +(((
592 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
593 +)))
414 414  
415 -}
595 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
416 416  
417 -Ответ: {
597 +(% style="color:#000000" %)Метод запроса: **POST**
418 418  
419 -{{{ "status": "", // значение статуса
420 - "date": "", // Дата смены статуса
421 - "description": "", // Описание
422 - "data": "", // Данные
423 - "overwrite": false, // Флаг перезаписи
424 - "stage": "", // Состояние}}}
599 +(% 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}
425 425  
426 -}
601 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
427 427  
428 - **Проверка авторизации**
603 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
429 429  
430 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
605 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
431 431  
432 -Метод запроса: GET
607 +(% style="color:#000000" %){
433 433  
434 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
609 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
610 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
611 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
612 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
613 + "description": "", ~/~/ Описание
614 + "data": "", ~/~/ Данные
615 + "overwrite": false, ~/~/ Флаг перезаписи
616 + "stage": "", ~/~/ Состояние, может быть null
435 435  
436 -В заголовках запроса: X-Auth: Токен авторизации
618 +(% style="color:#000000" %)}
437 437  
438 -Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
620 +(% style="color:#000000" %)Ответ:
439 439  
440 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
622 +(% style="color:#000000" %){
623 +
624 + "status": "", ~/~/ значение статуса
625 + "date": "", ~/~/ Дата смены статуса 
626 + "description": "", ~/~/ Описание
627 + "data": "", ~/~/ Данные
628 + "overwrite": false, ~/~/ Флаг перезаписи
629 + "stage": "", ~/~/ Состояние
630 +
631 +(% style="text-align:left" %)
632 +(% style="color:#000000" %) }
633 +
634 +
635 +(% class="box warningmessage" %)
636 +(((
637 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
638 +)))
639 +
640 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
641 +
642 +(% style="color:#000000" %)Метод запроса: **PUT**
643 +
644 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
645 +
646 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
647 +
648 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
649 +
650 +(% style="color:#000000" %){    
651 +
652 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
653 + "parentId": "", ~/~/ ID клиента
654 + "name": "", ~/~/ имя ТС
655 + "imei": "", ~/~/ IMEI
656 + "deviceTypeId": "", ~/~/ ID типа устройства
657 + "modelId": "", ~/~/ , ID модели    
658 + "unitId": "", ~/~/ подразделения
659 + "sim1": "", ~/~/ SIM 1
660 + "sim2": "", ~/~/ SIM2
661 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
662 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
663 + "counters": 
664 + {
665 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
666 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
667 + "mileage": «», пробег
668 + "motohours": «» моточасы
669 + }
670 + "cmsv6Parameters": ~/~/ параметры CMSv6
671 + {       
672 + "id": "", ~/~/ идентификатор
673 + "enabled": true, ~/~/ флаг включения
674 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
675 + "login": "", ~/~/ имя учетной записи
676 + "password": "", ~/~/ пароль учетной записи
677 + }
678 + "inspectionTasks": ~/~/ задания на ТО
679 + {
680 + "id": "", ~/~/ ID задания
681 + "enabled": false, ~/~/ Признак включения
682 + "name": "", ~/~/ Имя задания
683 + "description": "", ~/~/ Описание задания
684 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
685 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
686 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
687 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
688 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
689 + "kind": "", ~/~/ Вид периодичности по времени
690 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
691 + } 
692 +
693 +(% style="color:#000000" %)}
694 +
695 +(% style="color:#000000" %)Ответ:
696 +
697 +(% lang="en-US" style="text-align:left" %)
698 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
699 +
700 +(% lang="en-US" style="text-align:left" %)
701 + "vehicleId": "", ~/~/ ID ТС
702 + "parentId": "", ~/~/ ID клиента
703 + "name": "", ~/~/ имя ТС
704 + "imei": "", ~/~/ IMEI
705 + "deviceTypeId": "", ~/~/ типа устройства
706 + "modelId": "", ~/~/ ID модели
707 + "unitId": "", ~/~/ ID подразделения
708 + "sim1": "", ~/~/ SIM 1
709 + "sim2": "", ~/~/ SIM2
710 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
711 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
712 + "counters": 
713 + {
714 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
715 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
716 + "mileage": "", ~/~/ пробег
717 + "motohours": "", ~/~/ моточасы
718 + }
719 + "cmsv6Parameters": ~/~/ параметры CMSv6
720 + {
721 + "id": ~/~/ идентификатор
722 + "enabled": true, ~/~/ флаг включения
723 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
724 + "login": "", ~/~/ имя учетной записи
725 + "password": "", ~/~/ пароль учетной записи
726 + }
727 + "inspectionTasks": ~/~/ задания на ТО
728 + {
729 + "id": "", ~/~/ ID задания
730 + "enabled": false, ~/~/ Признак включения
731 + "name": "", ~/~/ Имя задания
732 + "description": "", ~/~/ Описание задания
733 + "mileageCondition": "", ~/~/ Условие по пробегу
734 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
735 + "motohoursCondition": "", ~/~/ Условие по моточасам
736 + "lastMotohours": "", ~/~/ Моточасы
737 + "periodicCondition": "", ~/~/ Условие периодичности по времени
738 + "kind": "", ~/~/ Вид периодичности по времени
739 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
740 + }
741 +
742 +(% lang="en-US" style="text-align:left" %)
743 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
744 +
745 +
746 +(% class="box errormessage" %)
747 +(((
748 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
749 +)))
750 +
751 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
752 +
753 +(% style="color:#000000" %)Метод запроса: **DELETE**
754 +
755 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
756 +
757 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
758 +
759 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
760 +
761 +(% style="text-align:left" %)
762 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
763 +
764 +
765 +(% class="box" lang="en-US" style="text-align: center;" %)
766 +(((
767 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
768 +)))
769 +
770 +(% class="box infomessage" %)
771 +(((
772 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
773 +)))
774 +
775 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
776 +
777 +(% style="color:#000000" %)Метод запроса: **GET**
778 +
779 +(% 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]]
780 +
781 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
782 +
783 +(% style="color:#000000" %)Ответ:
784 +
785 +(% style="color:#000000" %){
786 +
787 + "deviceTypeId" : "", ~/~/ ID типа устройства
788 + "deviceTypeName" : "" ~/~/ Название типа устройства
789 +
790 +(% style="text-align:left" %)
791 +(% style="color:#000000" %)}
792 +
793 +
794 +(% class="box" style="text-align: center;" %)
795 +(((
796 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
797 +)))
798 +
799 +(% class="box infomessage" %)
800 +(((
801 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
802 +)))
803 +
804 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
805 +
806 +(% style="color:#000000" %)Метод запроса: **GET**
807 +
808 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
809 +
810 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
811 +
812 +(% style="color:#000000" %)Ответ:
813 +
814 +(% style="color:#000000" %){
815 +
816 + "id": "", ~/~/ ID типа датчика 
817 + "name": "", ~/~/ Название
818 + "description": "", ~/~/ Описание
819 +
820 +(% style="text-align:left" %)
821 +(% style="color:#000000" %)}
822 +
823 +
824 +(% class="box" lang="en-US" style="text-align: center;" %)
825 +(((
826 +(% 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]] **
827 +)))

Меню

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