<
From version < 28.4 >
edited by Артем Шемяков
on 2022/09/22 09:52
To version < 13.1 >
edited by Артем Шемяков
on 2022/09/01 15:14
>
Change comment: There is no comment for this version

Summary

Details

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

Меню

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