<
From version < 8.1 >
edited by Артем Шемяков
on 2022/09/01 14:45
To version < 20.7 >
edited by Артем Шемяков
on 2022/09/01 17:44
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,10 +1,11 @@
1 -(% class="western" %)
2 -== Описание ГЛОНАССSoft Public API
3 - ==
1 +(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
4 4  
5 -(% class="box" %)
4 +== ==
5 +
6 +(% class="box" style="text-align: center;" %)
6 6  (((
7 -**Действующие ограничения**
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
8 8  )))
9 9  
10 10  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
... ... @@ -16,46 +16,44 @@
16 16  
17 17  (% class="box" style="text-align: center;" %)
18 18  (((
19 -(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Клиенты**
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
20 20  )))
21 21  
22 22  (% class="box infomessage" %)
23 23  (((
24 -(% style="color:#000000" %)**Получение основных параметров клиента (% lang="en-US" %)GET (%%)/(% lang="en-US" %)api/v3/agents(%%)**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 25  )))
26 26  
27 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 28  
29 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
30 -
31 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
32 -
33 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
34 -
35 35  (% style="color:#000000" %)Метод запроса: **GET**
36 36  
37 -(% 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>
32 +(% 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]]
38 38  
39 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
40 40  
41 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
36 +(% lang="en-US" %)
37 +(% style="color:#000000" %)**Ответ:**
42 42  
43 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
39 +(% lang="en-US" %)
40 +(% style="color:#000000" %){
44 44  
45 -(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% lang="en-US" style="font-variant: normal; color: rgb(0, 0, 0); font-family: Liberation Serif, serif; font-size: 12pt; font-style: normal; font-weight: normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" lang="en-US" %)]
42 +(% lang="en-US" %)
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
46 46  
46 +(% lang="en-US" %)
47 + }
47 47  
48 -(% class="box" style="text-align: center;" %)
49 -(((
50 -(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Авторизация**
51 -)))
49 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
52 52  
51 +
53 53  (% class="box infomessage" %)
54 54  (((
55 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Проверка авторизации — G(% lang="en-US" %)ET /api/v3/auth/check(%%)**
54 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)****(% lang="en-US" %)**GET /api/v3/auth/check**
56 56  )))
57 57  
58 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**.
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
59 59  
60 60  (% style="color:#000000" %)Метод запроса: **GET**
61 61  
... ... @@ -64,116 +64,167 @@
64 64  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
65 65  
66 66  (% lang="en-US" %)
67 -(% style="color:#000000" %)Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».
66 +(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
68 68  
69 69  
70 -(% class="box infomessage" %)
69 +(% class="box" style="text-align: center;" %)
71 71  (((
72 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Авторизация — GE(% lang="en-US" %)T /api/v3/auth/login(%%)**
71 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
73 73  )))
74 74  
75 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
76 -
77 -(% style="color:#000000" %)Метод запроса: **GET**
78 -
79 -(% 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]]
80 -
81 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
82 -
83 -(% lang="en-US" %)
84 -(% style="color:#000000" %)Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
85 -
86 -
87 -(% class="box" lang="en-US" style="text-align: center;" %)
88 -(((
89 -(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел (% lang="ru-RU" %)Устройства(%%)**
90 -)))
91 -
92 92  (% class="box infomessage" %)
93 93  (((
94 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов устройств - GE(% lang="en-US" %)T /api/v3/devices/types(%%)**
76 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
95 95  )))
96 96  
97 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
98 98  
81 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82 +
83 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 +
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86 +
99 99  (% style="color:#000000" %)Метод запроса: **GET**
100 100  
101 -(% 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]]
89 +(% 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>
102 102  
91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92 +
103 103  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
104 104  
105 -(% style="color:#000000" %)Ответ: [
95 +(% style="color:#000000" %)Ответ:
106 106  
107 -(% class="western" %)
108 -{{{ {
109 - "deviceTypeId" : "", // ID типа устройства
110 - "deviceTypeName" : "" // Название типа устройства
111 - },}}}
97 +(% style="color:#000000" %){
98 + "agentId": "", ~/~/ идентификатор клиента
99 + "parentId": "", ~/~/ идентификатор клиента-родителя
100 + "name": "", ~/~/ наименование клиента
101 + "fullName": "", ~/~/ полное наименование клиента
102 + "agentInfoType": "", ~/~/ тип клиента1
103 + "status": "", ~/~/ статус клиента
104 + }
112 112  
113 -(% style="text-align:left" %)
114 -(% style="color:#000000" %)…** **]
115 115  
107 +(% 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" %)]
116 116  
109 +
117 117  (% class="box" style="text-align: center;" %)
118 118  (((
119 -(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Датчики**
112 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
120 120  )))
121 121  
122 -(% class="box infomessage" %)
115 +(% class="box successmessage" %)
123 123  (((
124 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов датчиков - GE(% lang="en-US" %)T /api/v3/sensors/types(%%)**
117 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя **(% lang="en-US" %)**POST /api/v3/users**
125 125  )))
126 126  
127 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
120 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
128 128  
129 -(% style="color:#000000" %)Метод запроса: **GET**
122 +(% style="color:#000000" %)Метод запроса: **POST**
130 130  
131 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
124 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
132 132  
133 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
126 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
134 134  
135 -(% style="color:#000000" %)Ответ: [
128 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
136 136  
137 -(% class="western" style="margin-bottom:19px" %)
138 -{{{ {}}}
130 +(% style="color:#000000" %){ 
131 + "lastName": "", ~/~/ фамилия
132 + "firstName": "", ~/~/ имя
133 + "position": "", ~/~/ должность
134 + "phone": "", ~/~/ телефон
135 + "organization": "", ~/~/ организация
136 + "login": "", ~/~/ логин
137 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 + "email": "", ~/~/ email
139 + "description": "", ~/~/ описание
140 + "isEnabled": "", ~/~/ признак включения
141 + "parentId": "", ~/~/ Guid родительского агента
142 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
143 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
144 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 + "groups": "" , ~/~/ группы пользователя, названия групп
148 + }
139 139  
140 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
150 +(% style="text-align:left" %)
151 +(% style="color:#000000; font-weight:normal" %)Ответ:
141 141  
142 -(% class="western" %)
143 -{{{ "description": "" // Описание
144 - },}}}
153 +(% style="text-align:left" %)
154 +(% style="color:#000000; font-weight:normal" %){
145 145  
146 146  (% style="text-align:left" %)
147 -(% style="color:#000000" %)… ]
157 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
158 + "lastName": "" , ~/~/ Фамилия ,
159 + "firstName": "" , ~/~/ Имя
160 + "position": "" , ~/~/ Должность
161 + "phone": "" , ~/~/ Телефон
162 + "organization": "" , ~/~/ Организация
163 + "login": "" , ~/~/ Логин
164 + "password": "" , ~/~/ Пароль
165 + "email": "" , ~/~/ Email
166 + "description": "" , ~/~/ Описание
167 + "isEnabled": "" , ~/~/ Признак включения
168 + "parentId": "" , ~/~/ Guid родительского агента
169 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
170 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 + "kind": "" , ~/~/ тип аутентификации
172 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
148 148  
175 +(% style="text-align:left" %)
176 +(% style="color:#000000; font-weight:normal" %) }
149 149  
150 -(% class="box" style="text-align: center;" %)
151 -(((
152 -(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Пользователи**
153 -)))
154 154  
155 155  (% class="box successmessage" %)
156 156  (((
157 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление пользователя — (% lang="en-US" %)POST /api/v3/users(%%)**
181 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей**(% lang="en-US" %)**POST /api/v3/users/find**
158 158  )))
159 159  
160 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
184 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
161 161  
186 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
187 +
162 162  (% style="color:#000000" %)Метод запроса: **POST**
163 163  
164 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
190 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
165 165  
166 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
167 167  
168 -(% 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»: [ // группы пользователя «», //названия групп «», «» ] }
194 +(% style="color:#000000" %){
169 169  
170 -(% style="text-align:left" %)
171 -(% style="color: rgb(0, 0, 0); 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» //названия групп ] }
196 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
197 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
198 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
172 172  
201 +(% style="color:#000000" %) }
173 173  
203 +(% style="color:#000000" %)Ответ:
204 +
205 +(% style="color:#000000" %){ (%%)
206 +
207 + "id": "" , ~/~/ идентификатор пользователя
208 + "lastName": "" , ~/~/ фамилия
209 + "firstName": "" , ~/~/ имя
210 + "position": "" , ~/~/ должность
211 + "phone": "" , ~/~/ телефон
212 + "parentId": "" , ~/~/ идентификатор клиента-родителя
213 + "parentName": "" , ~/~/ наименование клиента-родителя
214 + "organization": "" , ~/~/ организация
215 + "login": "" , ~/~/ логин
216 + "email": "" , ~/~/ E-mail
217 + "sessionDuration":"", ~/~/ длительность сессии в минутах
218 + "status": "1",  ~/~/ статус пользователя
219 + "astLogged": "", ~/~/ дата/время последней авторизации
220 +
221 +(% style="color:#000000" %) }
222 +
223 +
174 174  (% class="box warningmessage" %)
175 175  (((
176 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование пользователя — (% lang="en-US" %)PUT /api/v3/users(%%)**
226 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
177 177  )))
178 178  
179 179  (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
... ... @@ -185,67 +185,95 @@
185 185  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
186 186  
187 187  (% lang="en-US" style="text-align:left" %)
188 -(% lang="ru-RU" style="color: rgb(0, 0, 0); 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» //названия групп ] } //
238 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
189 189  
240 +(% lang="en-US" style="text-align:left" %)
241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
190 190  
191 -(% class="box warningmessage" %)
192 -(((
193 -(% style="color:#000000" %)**Изменить статус пользователя**// //**— (% lang="en-US" %)PUT /api/v3/users/status/{id}(%%)**
194 -)))
243 +(% lang="en-US" style="text-align:left" %)
244 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
245 + "lastName": "" , ~/~/ фамилия
246 + "firstName": "" , ~/~/ имя
247 + "position": "" , ~/~/ должность
248 + "phone": "" , ~/~/ телефон
249 + "organization": "" , ~/~/ организация
250 + "login": "" , ~/~/ логин
251 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
252 + "email": "" , ~/~/ email
253 + "description": "" , ~/~/ описание
254 + "isEnabled": "" , ~/~/ признак включения
255 + "parentId": "" , ~/~/ Guid родительского агента
256 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
257 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
258 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
259 + "kind": "" , ~/~/ тип аутентификации
260 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
261 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
195 195  
196 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
263 +(% lang="en-US" style="text-align:left" %)
264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
197 197  
198 -(% style="color:#000000" %)Метод запроса: **PUT**
266 +(% lang="en-US" style="text-align:left" %)
267 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
199 199  
200 -(% 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} Параметр запроса:
269 +(% lang="en-US" style="text-align:left" %)
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ //
201 201  
202 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
272 +(% lang="en-US" style="text-align:left" %)
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
274 + "lastName": "" , ~/~/ фамилия
275 + "firstName": "" , ~/~/ имя
276 + "position": "" , ~/~/ должность
277 + "phone": "" , ~/~/ телефон
278 + "organization": "" , ~/~/ организация
279 + "login": "" , ~/~/ логин
280 + "password": "" , ~/~/ пароль 
281 + "email": "" , ~/~/ email
282 + "description": "" , ~/~/ описание
283 + "isEnabled": "" , ~/~/ признак включения
284 + "parentId": "" , ~/~/ Guid родительского агента
285 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
286 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
287 + "kind": "" , ~/~/ тип аутентификации
288 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
203 203  
204 -(% class="western" %)
205 -{{{ "description": "", // описание
206 - "data": "" // данные, связанные со сменой статуса}}}
291 +(% lang="en-US" style="text-align:left" %)
292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
207 207  
208 -(% style="color:#000000" %)}
209 209  
210 -(% style="text-align:left" %)
211 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
212 -
213 -
214 -(% class="box successmessage" %)
295 +(% class="box warningmessage" %)
215 215  (((
216 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка пользователей — (% lang="en-US" %)POST /api/v3/users/find(%%)**
297 +(% style="color:#000000" %)**Изменение статуса пользователя**// //****(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
217 217  )))
218 218  
219 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
300 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
220 220  
221 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
302 +(% style="color:#000000" %)Метод запроса: **PUT**
222 222  
223 -(% style="color:#000000" %)Метод запроса: **POST**
304 +(% 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 224  
225 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
226 226  
227 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
308 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
228 228  
229 -(% class="western" %)
230 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
231 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
232 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
233 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
310 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
234 234  
235 -(% style="color:#000000" %)}
312 +(% style="color:#000000" %){
236 236  
237 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
314 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
315 + "description": "" , ~/~/ описание
316 + "data": "" , ~/~/ данные, связанные со сменой статуса
238 238  
239 -(% class="western" style="margin-bottom:19px" %)
240 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
318 + (% style="color:#000000" %)}
241 241  
242 -(% lang="en-US" style="text-align:left" %)
243 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
320 +(% style="text-align:left" %)
321 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
244 244  
245 245  
246 246  (% class="box errormessage" %)
247 247  (((
248 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление пользователя — (% lang="en-US" %)DELETE /api/v3/users/{id}(%%)**
326 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
249 249  )))
250 250  
251 251  (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
... ... @@ -262,31 +262,12 @@
262 262  
263 263  (% class="box" style="text-align: center;" %)
264 264  (((
265 -(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Транспортные средства**
343 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
266 266  )))
267 267  
268 -(% class="box errormessage" %)
269 -(((
270 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление объекта — D(% lang="en-US" %)ELETE /api/v3/vehicles/{vehicleId}(%%)**
271 -)))
272 -
273 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
274 -
275 -(% style="color:#000000" %)Метод запроса: **DELETE**
276 -
277 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
278 -
279 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
280 -
281 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
282 -
283 -(% style="text-align:left" %)
284 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
285 -
286 -
287 287  (% class="box infomessage" %)
288 288  (((
289 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение информации об объекте — (% lang="en-US" %)GET /api/v3/vehicles/{vehicleId}(%%)**
348 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
290 290  )))
291 291  
292 292  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
... ... @@ -337,7 +337,7 @@
337 337  
338 338  (% class="box successmessage" %)
339 339  (((
340 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление объекта — (% lang="en-US" %)POST /api/v3/vehicles(%%)**
399 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
341 341  )))
342 342  
343 343  (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
... ... @@ -442,32 +442,9 @@
442 442  (% style="color:#000000" %)}
443 443  
444 444  
445 -(% class="box warningmessage" %)
446 -(((
447 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование объекта — (% lang="en-US" %)PUT /api/v3/vehicles(%%)**
448 -)))
449 -
450 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
451 -
452 -(% style="color:#000000" %)Метод запроса: **PUT**
453 -
454 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
455 -
456 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
457 -
458 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
459 -
460 -(% 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»: «» //Сколько раз выполнить задание } ] }
461 -
462 -(% style="color:#000000" %)Ответ:
463 -
464 -(% lang="en-US" style="text-align:left" %)
465 -(% lang="ru-RU" style="color: rgb(0, 0, 0); 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»: «» //Сколько раз выполнить задание } ] }
466 -
467 -
468 468  (% class="box successmessage" %)
469 469  (((
470 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка объектов — P(% lang="en-US" %)OST /api/v3/vehicles(%%)**
506 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
471 471  )))
472 472  
473 473  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
... ... @@ -496,8 +496,14 @@
496 496  
497 497  (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
498 498  
499 -(% 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" %)}
535 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
500 500  
537 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
538 +
539 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
540 +
541 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
542 +
501 501  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
502 502  
503 503  (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
... ... @@ -504,39 +504,12 @@
504 504  
505 505  (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
506 506  
507 -(% style="color:#000000" %)0 - «Блокировка»
549 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
508 508  
509 -(% style="color:#000000" %)1 - «Активен»,
510 510  
511 -(% style="color:#000000" %)2 - «Отменен»
512 -
513 -(% style="color:#000000" %)3 - «Оборудован»
514 -
515 -(% style="color:#000000" %)4 - «Диагностика»
516 -
517 -(% style="color:#000000" %)5 - «Сервис»
518 -
519 -(% style="color:#000000" %)6 - «Демонтаж»
520 -
521 -(% style="color:#000000" %)7 - «Монтаж»
522 -
523 -(% style="color:#000000" %)8 - «Дозаказ»
524 -
525 -(% style="color:#000000" %)9 - «Обслужен»
526 -
527 -(% style="color:#000000" %)10 - «Списан»
528 -
529 -(% style="color:#000000" %)11 - «Неисправен»
530 -
531 -(% style="color:#000000" %)12 - «Проверен»
532 -
533 -(% style="text-align:left" %)
534 -(% style="font-weight: normal; color: rgb(0, 0, 0)" %)13 - «Не эксплуатируется»
535 -
536 -
537 537  (% class="box successmessage" %)
538 538  (((
539 -(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Изменение статуса объекта — (% lang="en-US" %)POST /api/v3/vehicles/changeStatus/{vehicleId}(%%)**
554 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
540 540  )))
541 541  
542 542  (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
... ... @@ -552,7 +552,9 @@
552 552  (% style="color:#000000" %)Параметры в теле запроса (JSON): {
553 553  
554 554  (% class="western" %)
555 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
570 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
571 +  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
572 +  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
556 556   "date": "", // Дата смены статуса (null если сменить немедленно)
557 557   "description": "", // Описание
558 558   "data": "", // Данные
... ... @@ -575,7 +575,112 @@
575 575  (% style="color:#000000" %)}
576 576  
577 577  
595 +(% class="box warningmessage" %)
596 +(((
597 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
598 +)))
599 +
600 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
601 +
602 +(% style="color:#000000" %)Метод запроса: **PUT**
603 +
604 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
605 +
606 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
607 +
608 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
609 +
610 +(% 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»: «» //Сколько раз выполнить задание } ] }
611 +
612 +(% style="color:#000000" %)Ответ:
613 +
614 +(% lang="en-US" style="text-align:left" %)
615 +(% 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»: «» //Сколько раз выполнить задание } ] }
616 +
617 +
618 +(% class="box errormessage" %)
619 +(((
620 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
621 +)))
622 +
623 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
624 +
625 +(% style="color:#000000" %)Метод запроса: **DELETE**
626 +
627 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
628 +
629 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
630 +
631 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
632 +
633 +(% style="text-align:left" %)
634 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
635 +
636 +
578 578  (% class="box" lang="en-US" style="text-align: center;" %)
579 579  (((
580 -(% style="color: rgb(0, 0, 0); font-size: 14pt" lang="ru-RU" %)**Расширенное описание PUBLIC API 3.0 доступно по запросу на support@glonasssoft.ru**
639 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
581 581  )))
641 +
642 +(% class="box infomessage" %)
643 +(((
644 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
645 +)))
646 +
647 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
648 +
649 +(% style="color:#000000" %)Метод запроса: **GET**
650 +
651 +(% 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]]
652 +
653 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
654 +
655 +(% style="color:#000000" %)Ответ: [
656 +
657 +(% class="western" %)
658 +{{{ {
659 + "deviceTypeId" : "", // ID типа устройства
660 + "deviceTypeName" : "" // Название типа устройства
661 + },}}}
662 +
663 +(% style="text-align:left" %)
664 +(% style="color:#000000" %)…** **]
665 +
666 +
667 +(% class="box" style="text-align: center;" %)
668 +(((
669 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
670 +)))
671 +
672 +(% class="box infomessage" %)
673 +(((
674 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
675 +)))
676 +
677 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
678 +
679 +(% style="color:#000000" %)Метод запроса: **GET**
680 +
681 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
682 +
683 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
684 +
685 +(% style="color:#000000" %)Ответ: [
686 +
687 +(% class="western" style="margin-bottom:19px" %)
688 +{{{ {}}}
689 +
690 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
691 +
692 +(% class="western" %)
693 +{{{ "description": "" // Описание
694 + },}}}
695 +
696 +(% style="text-align:left" %)
697 +(% style="color:#000000" %)… ]
698 +
699 +
700 +(% class="box" lang="en-US" style="text-align: center;" %)
701 +(((
702 +(% 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]] **
703 +)))

Меню

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