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

Summary

Details

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

Меню

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