<
From version < 15.1 >
edited by Артем Шемяков
on 2022/09/01 15:23
To version < 25.1 >
edited by Артем Шемяков
on 2022/09/02 16:59
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API ==
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
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,46 +17,44 @@
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 23  (% class="box infomessage" %)
24 24  (((
25 -(% 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**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
31 -
32 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
33 -
34 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
35 -
36 36  (% style="color:#000000" %)Метод запроса: **GET**
37 37  
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>
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]]
39 39  
40 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
41 41  
42 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
36 +(% lang="en-US" %)
37 +(% style="color:#000000" %)**Ответ:**
43 43  
44 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
39 +(% lang="en-US" %)
40 +(% style="color:#000000" %){
45 45  
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" %)]
42 +(% lang="en-US" %)
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
47 47  
46 +(% lang="en-US" %)
47 +}
48 48  
49 -(% class="box" style="text-align: center;" %)
50 -(((
51 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
52 -)))
49 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
53 53  
51 +
54 54  (% class="box infomessage" %)
55 55  (((
56 56  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
57 57  )))
58 58  
59 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
60 60  
61 61  (% style="color:#000000" %)Метод запроса: **GET**
62 62  
... ... @@ -68,116 +68,166 @@
68 68  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
69 69  
70 70  
71 -(% class="box infomessage" %)
69 +(% class="box" style="text-align: center;" %)
72 72  (((
73 -(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
71 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
74 74  )))
75 75  
76 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
77 -
78 -(% style="color:#000000" %)Метод запроса: **GET**
79 -
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]]
81 -
82 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
83 -
84 -(% lang="en-US" %)
85 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
86 -
87 -
88 -(% class="box" lang="en-US" style="text-align: center;" %)
89 -(((
90 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
91 -)))
92 -
93 93  (% class="box infomessage" %)
94 94  (((
95 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
76 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
96 96  )))
97 97  
98 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
99 99  
81 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82 +
83 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 +
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
86 +
100 100  (% style="color:#000000" %)Метод запроса: **GET**
101 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]]
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>
103 103  
91 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
92 +
104 104  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
105 105  
106 -(% style="color:#000000" %)Ответ: [
95 +(% style="color:#000000" %)Ответ:
107 107  
108 -(% class="western" %)
109 -{{{ {
110 - "deviceTypeId" : "", // ID типа устройства
111 - "deviceTypeName" : "" // Название типа устройства
112 - },}}}
97 +(% style="color:#000000" %){
98 + "agentId": "", ~/~/ идентификатор клиента
99 + "parentId": "", ~/~/ идентификатор клиента-родителя
100 + "name": "", ~/~/ наименование клиента
101 + "fullName": "", ~/~/ полное наименование клиента
102 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 + "status": "", ~/~/ статус клиента
104 +}
113 113  
114 -(% style="text-align:left" %)
115 -(% style="color:#000000" %)…** **]
116 116  
117 -
118 118  (% class="box" style="text-align: center;" %)
119 119  (((
120 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
109 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
121 121  )))
122 122  
123 -(% class="box infomessage" %)
112 +(% class="box successmessage" %)
124 124  (((
125 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
114 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
126 126  )))
127 127  
128 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
129 129  
130 -(% style="color:#000000" %)Метод запроса: **GET**
119 +(% style="color:#000000" %)Метод запроса: **POST**
131 131  
132 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
121 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
133 133  
134 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
123 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
135 135  
136 -(% style="color:#000000" %)Ответ: [
125 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
137 137  
138 -(% class="western" style="margin-bottom:19px" %)
139 -{{{ {}}}
127 +(% style="color:#000000" %){ 
128 + "lastName": "", ~/~/ фамилия
129 + "firstName": "", ~/~/ имя
130 + "position": "", ~/~/ должность
131 + "phone": "", ~/~/ телефон
132 + "organization": "", ~/~/ организация
133 + "login": "", ~/~/ логин
134 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 + "email": "", ~/~/ email
136 + "description": "", ~/~/ описание
137 + "isEnabled": "", ~/~/ признак включения
138 + "parentId": "", ~/~/ Guid родительского агента
139 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
140 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
141 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 + "groups": "" , ~/~/ группы пользователя, названия групп
145 +}
140 140  
141 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
147 +(% style="text-align:left" %)
148 +(% style="color:#000000; font-weight:normal" %)Ответ:
142 142  
143 -(% class="western" %)
144 -{{{ "description": "" // Описание
145 - },}}}
150 +(% style="text-align:left" %)
151 +(% style="color:#000000; font-weight:normal" %){    
146 146  
147 147  (% style="text-align:left" %)
148 -(% style="color:#000000" %)… ]
154 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
155 + "lastName": "" , ~/~/ Фамилия ,
156 + "firstName": "" , ~/~/ Имя
157 + "position": "" , ~/~/ Должность
158 + "phone": "" , ~/~/ Телефон
159 + "organization": "" , ~/~/ Организация
160 + "login": "" , ~/~/ Логин
161 + "password": "" , ~/~/ Пароль
162 + "email": "" , ~/~/ Email
163 + "description": "" , ~/~/ Описание
164 + "isEnabled": "" , ~/~/ Признак включения
165 + "parentId": "" , ~/~/ Guid родительского агента
166 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
167 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 + "kind": "" , ~/~/ тип аутентификации
169 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
149 149  
172 +(% style="text-align:left" %)
173 +(% style="color:#000000; font-weight:normal" %)}
150 150  
151 -(% class="box" style="text-align: center;" %)
152 -(((
153 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
154 -)))
155 155  
156 156  (% class="box successmessage" %)
157 157  (((
158 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
178 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
159 159  )))
160 160  
161 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
181 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
162 162  
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
184 +
163 163  (% style="color:#000000" %)Метод запроса: **POST**
164 164  
165 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
187 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
166 166  
167 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
189 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
168 168  
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»: [ // группы пользователя «», //названия групп «», «» ] }
191 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
170 170  
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» //названия групп ] }
193 +(% style="color:#000000" %){
173 173  
195 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
196 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
197 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
198 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
174 174  
200 +(% style="color:#000000" %)}
201 +
202 +(% style="color:#000000" %)Ответ:
203 +
204 +(% style="color:#000000" %){         (%%)
205 +
206 + "id": "" , ~/~/ идентификатор пользователя
207 + "lastName": "" , ~/~/ фамилия
208 + "firstName": "" , ~/~/ имя
209 + "position": "" , ~/~/ должность
210 + "phone": "" , ~/~/ телефон
211 + "parentId": "" , ~/~/ идентификатор клиента-родителя
212 + "parentName": "" , ~/~/ наименование клиента-родителя
213 + "organization": "" , ~/~/ организация
214 + "login": "" , ~/~/ логин
215 + "email": "" , ~/~/ E-mail
216 + "sessionDuration":"", ~/~/ длительность сессии в минутах
217 + "status": "1",  ~/~/ статус пользователя
218 + "astLogged": "", ~/~/ дата/время последней авторизации
219 +
220 +(% style="color:#000000" %)}
221 +
222 +
175 175  (% class="box warningmessage" %)
176 176  (((
177 177  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
178 178  )))
179 179  
180 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
181 181  
182 182  (% style="color:#000000" %)Метод запроса: **PUT**
183 183  
... ... @@ -186,62 +186,90 @@
186 186  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
187 187  
188 188  (% lang="en-US" style="text-align:left" %)
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» //названия групп ] }  //
237 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
190 190  
239 +(% lang="en-US" style="text-align:left" %)
240 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
191 191  
192 -(% class="box warningmessage" %)
193 -(((
194 -(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
195 -)))
242 +(% lang="en-US" style="text-align:left" %)
243 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
244 + "lastName": "" , ~/~/ фамилия
245 + "firstName": "" , ~/~/ имя
246 + "position": "" , ~/~/ должность
247 + "phone": "" , ~/~/ телефон
248 + "organization": "" , ~/~/ организация
249 + "login": "" , ~/~/ логин
250 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 + "email": "" , ~/~/ email
252 + "description": "" , ~/~/ описание
253 + "isEnabled": "" , ~/~/ признак включения
254 + "parentId": "" , ~/~/ Guid родительского агента
255 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
256 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
257 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
258 + "kind": "" , ~/~/ тип аутентификации
259 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
260 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
196 196  
197 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
262 +(% lang="en-US" style="text-align:left" %)
263 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
198 198  
199 -(% style="color:#000000" %)Метод запроса: **PUT**
265 +(% lang="en-US" style="text-align:left" %)
266 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
200 200  
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} Параметр запроса:
268 +(% lang="en-US" style="text-align:left" %)
269 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
202 202  
203 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
271 +(% lang="en-US" style="text-align:left" %)
272 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
273 + "lastName": "" , ~/~/ фамилия
274 + "firstName": "" , ~/~/ имя
275 + "position": "" , ~/~/ должность
276 + "phone": "" , ~/~/ телефон
277 + "organization": "" , ~/~/ организация
278 + "login": "" , ~/~/ логин
279 + "password": "" , ~/~/ пароль 
280 + "email": "" , ~/~/ email
281 + "description": "" , ~/~/ описание
282 + "isEnabled": "" , ~/~/ признак включения
283 + "parentId": "" , ~/~/ Guid родительского агента
284 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
285 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
286 + "kind": "" , ~/~/ тип аутентификации
287 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
288 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
204 204  
205 -(% class="western" %)
206 -{{{ "description": "", // описание
207 - "data": "" // данные, связанные со сменой статуса}}}
290 +(% lang="en-US" style="text-align:left" %)
291 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
208 208  
209 -(% style="color:#000000" %)}
210 210  
211 -(% style="text-align:left" %)
212 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
213 -
214 -
215 -(% class="box successmessage" %)
294 +(% class="box warningmessage" %)
216 216  (((
217 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
296 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
218 218  )))
219 219  
220 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
221 221  
222 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
301 +(% style="color:#000000" %)Метод запроса: **PUT**
223 223  
224 -(% style="color:#000000" %)Метод запроса: **POST**
303 +(% 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}
225 225  
226 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
305 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
227 227  
228 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
307 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
229 229  
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 - неважно}}}
309 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
235 235  
236 -(% style="color:#000000" %)}
311 +(% style="color:#000000" %){
237 237  
238 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
313 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
314 + "description": "" , ~/~/ описание
315 + "data": "" , ~/~/ данные, связанные со сменой статуса
239 239  
240 -(% class="western" style="margin-bottom:19px" %)
241 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
317 +(% style="color:#000000" %)}
242 242  
243 -(% lang="en-US" style="text-align:left" %)
244 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
319 +(% style="text-align:left" %)
320 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
245 245  
246 246  
247 247  (% class="box errormessage" %)
... ... @@ -249,14 +249,16 @@
249 249  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
250 250  )))
251 251  
252 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
253 253  
254 254  (% style="color:#000000" %)Метод запроса: **DELETE**
255 255  
256 256  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
257 257  
258 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
334 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
259 259  
336 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337 +
260 260  (% style="text-align:left" %)
261 261  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
262 262  
... ... @@ -266,25 +266,6 @@
266 266  (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
267 267  )))
268 268  
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 -
288 288  (% class="box infomessage" %)
289 289  (((
290 290  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -292,17 +292,17 @@
292 292  
293 293  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
294 294  
295 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
296 296  
297 297  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
298 298  
299 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
358 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
300 300  
301 301  (% style="color:#000000" %)Метод запроса: **GET**
302 302  
303 303  (% 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>
304 304  
305 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
364 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
306 306  
307 307  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
308 308  
... ... @@ -310,24 +310,20 @@
310 310  
311 311  (% style="color:#000000" %){
312 312  
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 - ...}}}
372 + "vehicleId": "" , ~/~/ идентификатор объекта
373 + "name": "" , ~/~/ имя объекта
374 + "imei": "" , ~/~/ IMEI объекта
375 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
376 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
377 + "parentId": "" , ~/~/ идентификатор клиента-родителя
378 + "parentName": "" , ~/~/ наименование клиента-родителя,
379 + "modelId": "" , ~/~/ идентификатор модели объекта
380 + "modelName": "" , ~/~/ наименование модели объекта,
381 + "unitId": "" , ~/~/ идентификатор подразделения
382 + "unitName": "" , ~/~/ наименование подразделения
383 + "status": "" , ~/~/ статус объекта
329 329  
330 -(% style="color:#000000" %)}
385 +}
331 331  
332 332  (% style="text-align:left" %)
333 333  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -341,7 +341,7 @@
341 341  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
342 342  )))
343 343  
344 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
345 345  
346 346  (% style="color:#000000" %)Метод запроса: **POST**
347 347  
... ... @@ -349,235 +349,399 @@
349 349  
350 350  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
351 351  
352 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
407 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
353 353  
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": "" // пароль учетной записи
409 +(% style="color:#000000" %){
410 +
411 + "parentId": "" , ~/~/ ID клиента
412 + "name": "" , ~/~/ имя ТС
413 + "imei": "" , ~/~/ IMEI
414 + "deviceTypeId": "" , ~/~/ ID типа устройства
415 + "modelId": "" , ~/~/ ID модели
416 + "unitId": "" , ~/~/ ID подразделения
417 + "sim1": "" , ~/~/ Номер SIM 1
418 + "sim2": "" , ~/~/ Номер SIM2
419 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 + "counters": {
423 + "mileage": "" , ~/~/ пробег
424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 + "motohours": "" , ~/~/ моточасы
426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
378 378   },
379 - "inspectionTasks": [ // задания на ТО
380 - {
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 - однократно)
428 + "cmsv6Parameters": { ~/~/ параметры CMSv6
429 + "enabled": true, ~/~/ флаг включения
430 + "id": "" , ~/~/ идентификатор
431 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 + "login": "" , ~/~/ имя учетной записи
433 + "password": "" ~/~/ пароль учетной записи
392 392   },
393 - ]}}}
435 + "inspectionTasks": ~/~/ задания на ТО
436 + {
437 + "enabled": "" , ~/~/ Признак включения
438 + "name": "" , ~/~/ Имя задания
439 + "description": "" , ~/~/ Описание задания
440 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
441 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
442 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
443 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
444 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
445 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
446 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
447 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
448 + }
394 394  
395 -(% style="color:#000000" %) }
450 +(% style="color:#000000" %) }
396 396  
397 397  (% style="color:#000000" %)Ответ:
398 398  
399 399  (% style="color:#000000" %){
400 400  
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 - ]}}}
456 + "vehicleId": "", ~/~/ID ТС 
457 + "parentId": "", ~/~/Guid владельца ТС
458 + "name": "", ~/~/Имя объекта
459 + "imei": "", ~/~/IMEI
460 + "deviceTypeId": "", ~/~/ID типа устройства
461 + "modelId": "", ~/~/ID модели
462 + "unitId": "", ~/~/ID подразделения
463 + "sim1": "", ~/~/SIM1
464 + "sim2": "", ~/~/SIM2
465 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
466 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
467 + "counters": { ~/~/Счётчики
468 + "mileageEnabled": true,
469 + "motohoursEnabled": true,
470 + "mileage": "",
471 + "motohours": 345.0
472 + },
473 + "cmsv6Parameters": { ~/~/Параметры CmsV6
474 + "id": null,
475 + "enabled": true, ~/~/флаг включения
476 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
477 + "login": "", ~/~/ имя учетной записи
478 + "password": "" ~/~/ пароль учетной записи
479 + },
480 + "inspectionTasks": { ~/~/ задания на ТО
481 + "id": "", ~/~/ ID задачи
482 + "enabled": false, ~/~/ Признак включения
483 + "name": "", ~/~/ Имя задания
484 + "description": "", ~/~/ Описание задания
485 + "mileageCondition": "", ~/~/ Условие по пробегу
486 + "lastMileage": "", ~/~/ Пробег (в метрах)
487 + "motohoursCondition": "", ~/~/ Условие по моточасам
488 + "lastMotohours": "", ~/~/ Моточасы
489 + "periodicCondition": "", ~/~/ Условие периодичности по времени
490 + "kind": "", ~/~/ Вид периодичности по времени 
491 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
492 + }
441 441  
442 442  (% style="text-align:left" %)
443 443  (% style="color:#000000" %)}
444 444  
445 445  
446 -(% class="box warningmessage" %)
498 +(% class="box successmessage" %)
447 447  (((
448 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
500 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
449 449  )))
450 450  
451 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
503 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
452 452  
453 -(% style="color:#000000" %)Метод запроса: **PUT**
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
454 454  
455 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
507 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
456 456  
457 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
509 +(% style="color:#000000" %) возвращает информацию об объектах с учетом заданных настроек видимости объектов;
458 458  
511 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
512 +
513 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
514 +
515 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
516 +
517 +(% style="color:#000000" %)Метод запроса: **POST**
518 +
519 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
520 +
521 +(% style="color:#000000" %)В заголовках запроса:
522 +
523 +(% style="color:#000000" %)− Content-Type: __**application/json**__
524 +
525 +(% style="color:#000000" %)− X-Auth: Токен авторизации
526 +
527 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
528 +
459 459  (% style="color:#000000" %)Параметры в теле запроса (JSON):
460 460  
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»: «» //Сколько раз выполнить задание } ] }
531 +(% class="western" style="color:#000000" %)##{##
462 462  
533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 + "name": null, ~/~/ Имя ТС (string, опционально) 
535 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
540 +(% style="color:#000000" %)}
541 +
542 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
543 +
463 463  (% style="color:#000000" %)Ответ:
464 464  
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»: «» //Сколько раз выполнить задание } ] }
546 +(% style="color:#000000" %){
467 467  
548 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
549 + "name": "" ~/~/ наименование объекта
550 + "imei": "" ~/~/ IMEI объекта
551 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
552 + "deviceTypeName": "" ~/~/ наименование типа устройства
553 + "sim1": "" ~/~/ первый номер телефона
554 + "sim2": "" ~/~/ второй номер телефона
555 + "parentId": "" ~/~/ идентификатор клиента-родителя
556 + "parentName": "" ~/~/ наименование клиента-родителя
557 + "modelId": "" ~/~/ идентификатор модели объекта
558 + "modelName": "" ~/~/ наименование модели объекта
559 + "unitId": "" ~/~/ идентификатор подразделения
560 + "unitName": "" ~/~/ наименование подразделения
561 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
562 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
563 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
564 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
565 +(% style="color:#000000" %)}
468 468  
567 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
568 +
569 +
469 469  (% class="box successmessage" %)
470 470  (((
471 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
572 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
472 472  )))
473 473  
474 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиентодитель).
575 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
475 475  
476 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
577 +(% style="color:#000000" %)Метод запроса: **POST**
477 477  
478 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
579 +(% 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}
479 479  
480 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
581 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
481 481  
482 -(% style="color:#000000" %) информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
583 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
483 483  
484 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
585 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
485 485  
486 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
587 +(% style="color:#000000" %){
487 487  
488 -(% style="color:#000000" %)Метод запроса: **POST**
589 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
590 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
591 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
592 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
593 + "description": "", ~/~/ Описание
594 + "data": "", ~/~/ Данные
595 + "overwrite": false, ~/~/ Флаг перезаписи
596 + "stage": "", ~/~/ Состояние, может быть null
489 489  
490 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
598 +(% style="color:#000000" %)}
491 491  
492 -(% style="color:#000000" %)В заголовках запроса:
600 +(% style="color:#000000" %)Ответ:
493 493  
494 -(% style="color:#000000" %)− Content-Type: application/json
602 +(% style="color:#000000" %){
495 495  
496 -(% style="color:#000000" %)− X-Auth: Токен авторизации
604 + "status": "", ~/~/ значение статуса
605 + "date": "", ~/~/ Дата смены статуса 
606 + "description": "", ~/~/ Описание
607 + "data": "", ~/~/ Данные
608 + "overwrite": false, ~/~/ Флаг перезаписи
609 + "stage": "", ~/~/ Состояние
497 497  
498 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
611 +(% style="text-align:left" %)
612 +(% style="color:#000000" %) }
499 499  
500 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
501 501  
502 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
615 +(% class="box warningmessage" %)
616 +(((
617 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
618 +)))
503 503  
504 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
620 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
505 505  
506 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
622 +(% style="color:#000000" %)Метод запроса: **PUT**
507 507  
508 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
624 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
509 509  
510 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
626 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
511 511  
512 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
628 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
513 513  
514 -(% style="color:#000000" %)0 - «Блокировка»
630 +(% style="color:#000000" %){    
515 515  
516 -(% style="color:#000000" %)1 - «Активен»,
632 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
633 + "parentId": "", ~/~/ ID клиента
634 + "name": "", ~/~/ имя ТС
635 + "imei": "", ~/~/ IMEI
636 + "deviceTypeId": "", ~/~/ ID типа устройства
637 + "modelId": "", ~/~/ , ID модели    
638 + "unitId": "", ~/~/ подразделения
639 + "sim1": "", ~/~/ SIM 1
640 + "sim2": "", ~/~/ SIM2
641 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
642 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
643 + "counters": 
644 + {
645 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
646 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
647 + "mileage": «», пробег
648 + "motohours": «» моточасы
649 + }
650 + "cmsv6Parameters": ~/~/ параметры CMSv6
651 + {       
652 + "id": "", ~/~/ идентификатор
653 + "enabled": true, ~/~/ флаг включения
654 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
655 + "login": "", ~/~/ имя учетной записи
656 + "password": "", ~/~/ пароль учетной записи
657 + }
658 + "inspectionTasks": ~/~/ задания на ТО
659 + {
660 + "id": "", ~/~/ ID задания
661 + "enabled": false, ~/~/ Признак включения
662 + "name": "", ~/~/ Имя задания
663 + "description": "", ~/~/ Описание задания
664 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
665 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
666 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
667 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
668 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
669 + "kind": "", ~/~/ Вид периодичности по времени
670 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
671 + } 
517 517  
518 -(% style="color:#000000" %)2 - «Отменен»
673 +(% style="color:#000000" %)}
519 519  
520 -(% style="color:#000000" %)3 - «Оборудован»
675 +(% style="color:#000000" %)Ответ:
521 521  
522 -(% style="color:#000000" %)4 - «Диагностика»
677 +(% lang="en-US" style="text-align:left" %)
678 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
523 523  
524 -(% style="color:#000000" %)5 - «Сервис»
680 +(% lang="en-US" style="text-align:left" %)
681 + "vehicleId": "", ~/~/ ID ТС
682 + "parentId": "", ~/~/ ID клиента
683 + "name": "", ~/~/ имя ТС
684 + "imei": "", ~/~/ IMEI
685 + "deviceTypeId": "", ~/~/ типа устройства
686 + "modelId": "", ~/~/ ID модели
687 + "unitId": "", ~/~/ ID подразделения
688 + "sim1": "", ~/~/ SIM 1
689 + "sim2": "", ~/~/ SIM2
690 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
691 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
692 + "counters": 
693 + {
694 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
695 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
696 + "mileage": "", ~/~/ пробег
697 + "motohours": "", ~/~/ моточасы
698 + }
699 + "cmsv6Parameters": ~/~/ параметры CMSv6
700 + {
701 + "id": ~/~/ идентификатор
702 + "enabled": true, ~/~/ флаг включения
703 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
704 + "login": "", ~/~/ имя учетной записи
705 + "password": "", ~/~/ пароль учетной записи
706 + }
707 + "inspectionTasks": ~/~/ задания на ТО
708 + {
709 + "id": "", ~/~/ ID задания
710 + "enabled": false, ~/~/ Признак включения
711 + "name": "", ~/~/ Имя задания
712 + "description": "", ~/~/ Описание задания
713 + "mileageCondition": "", ~/~/ Условие по пробегу
714 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
715 + "motohoursCondition": "", ~/~/ Условие по моточасам
716 + "lastMotohours": "", ~/~/ Моточасы
717 + "periodicCondition": "", ~/~/ Условие периодичности по времени
718 + "kind": "", ~/~/ Вид периодичности по времени
719 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
720 + }
525 525  
526 -(% style="color:#000000" %)6 - «Демонтаж»
722 +(% lang="en-US" style="text-align:left" %)
723 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
527 527  
528 -(% style="color:#000000" %)7 - «Монтаж»
529 529  
530 -(% style="color:#000000" %)8 - «Дозаказ»
726 +(% class="box errormessage" %)
727 +(((
728 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
729 +)))
531 531  
532 -(% style="color:#000000" %)9 - «Обслужен»
731 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
533 533  
534 -(% style="color:#000000" %)10 - «Списан»
733 +(% style="color:#000000" %)Метод запроса: **DELETE**
535 535  
536 -(% style="color:#000000" %)11 - «Неисправен»
735 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
537 537  
538 -(% style="color:#000000" %)12 - «Проверен»
737 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
539 539  
739 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
740 +
540 540  (% style="text-align:left" %)
541 -(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
742 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
542 542  
543 543  
544 -(% class="box successmessage" %)
745 +(% class="box" lang="en-US" style="text-align: center;" %)
545 545  (((
546 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта**(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
747 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
547 547  )))
548 548  
549 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
750 +(% class="box infomessage" %)
751 +(((
752 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
753 +)))
550 550  
551 -(% style="color:#000000" %)Метод запроса: **POST**
755 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
552 552  
553 -(% 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}
757 +(% style="color:#000000" %)Метод запроса: **GET**
554 554  
555 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
759 +(% 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]]
556 556  
557 557  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
558 558  
559 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
763 +(% style="color:#000000" %)Ответ:
560 560  
561 -(% class="western" %)
562 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
563 - "date": "", // Дата смены статуса (null если сменить немедленно)
564 - "description": "", // Описание
565 - "data": "", // Данные
566 - "overwrite": false, // Флаг перезаписи
567 - "stage": "", // Состояние, может быть null}}}
765 +(% style="color:#000000" %){
568 568  
767 + "deviceTypeId" : "", ~/~/ ID типа устройства
768 + "deviceTypeName" : "" ~/~/ Название типа устройства
769 +
770 +(% style="text-align:left" %)
569 569  (% style="color:#000000" %)}
570 570  
571 -(% style="color:#000000" %)Ответ: {
572 572  
573 -(% class="western" %)
574 -{{{ "status": "", // значение статуса
575 - "date": "", // Дата смены статуса
576 - "description": "", // Описание
577 - "data": "", // Данные
578 - "overwrite": false, // Флаг перезаписи
579 - "stage": "", // Состояние}}}
774 +(% class="box" style="text-align: center;" %)
775 +(((
776 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
777 +)))
580 580  
779 +(% class="box infomessage" %)
780 +(((
781 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
782 +)))
783 +
784 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
785 +
786 +(% style="color:#000000" %)Метод запроса: **GET**
787 +
788 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
789 +
790 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
791 +
792 +(% style="color:#000000" %)Ответ:
793 +
794 +(% style="color:#000000" %){
795 +
796 + "id": "", ~/~/ ID типа датчика 
797 + "name": "", ~/~/ Название
798 + "description": "", ~/~/ Описание
799 +
581 581  (% style="text-align:left" %)
582 582  (% style="color:#000000" %)}
583 583  

Меню

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