API - Wiki-ГЛОНАССSoft

1

== Описание ГЛОНАССSoft Public API

2

==

3

4

**Действующие ограничения**

5

6

Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).

7

8

Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.

**Авторизация**

Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.

Метод запроса: GET

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]]

17

18

В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».

19

20

Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]

21

22

**Получение списка объектов**

23

24

Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):

25

26

−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

27

28

−возвращает информацию об объектах с учетом заданных настроек видимости объектов;

29

30

−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;

31

32

−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;

33

34

−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

39

40

В заголовках запроса:

41

42

−Content-Type: application/json

43

44

−X-Auth: Токен авторизации

45

46

Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):

47

48

{{{ {"vehicleId": null,//84350, // ID ТС (int, опционально)

49

"name": null, // Имя ТС (string, опционально)

50

"imei": null,//"710179307", // IMEI (string, опционально)

51

"sim": null,//"938112", // Номер телефона (string, опционально)

52

"deviceTypeId": null,//5 // ID типа устройства (short, опционально)

53

"parentId": null, // ID клиента (Guid, опционально)

54

"unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}

55

56

Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».

57

58

Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «» // статус объекта }, … ]

59

60

Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.

0 - «Блокировка»

1 - «Активен»,

2 - «Отменен»

3 - «Оборудован»

4 - «Диагностика»

5 - «Сервис»

6 - «Демонтаж»

7 - «Монтаж»

8 - «Дозаказ»

9 - «Обслужен»

10 - «Списан»

11 - «Неисправен»

12 - «Проверен»

13 - «Не эксплуатируется»

89

90

**Получение списка клиентов.**

91

92

Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

93

94

−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;

95

96

−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;

97

98

−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>

103

104

Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)

105

106

В заголовках запроса: X-Auth: Токен авторизации

107

108

Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ]

109

110

Примечание. Возможные значение параметра agentInfoType:

111

112

**Получение списка пользователей.**

113

114

Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.

115

116

Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]

121

122

Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {

123

124

{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента

125

//"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно

126

"login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно

127

//"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}

}

Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail

132

133

{{{ "sessionDuration": "", // длительность сессии в минутах}}}

134

135

«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]

136

137

**Получение списка типов устройств**

138

139

Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]

144

145

В заголовках запроса:X-Auth: Токен авторизации

Ответ: [

{{{ {

"deviceTypeId" : "", // ID типа устройства

151

"deviceTypeName" : "" // Название типа устройства

},}}}

… ]

**Получение списка типов датчиков**

157

158

Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

163

164

В заголовках запроса:X-Auth: Токен авторизации

Ответ: [

{{{ {}}}

«id»: «», //ID типа датчика «name»: «», //Название

171

172

{{{ "description": "" // Описание

},}}}

… ]

**Получение информации об объекте**

178

179

Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».

180

181

Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):

182

183

−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>

188

189

Параметр запроса: <vehicleid> - идентификатор объекта (опционально)

190

191

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

{

{{{ "vehicleId": “”, // идентификатор объекта

198

"name": "", // имя объекта

199

"imei": "", // IMEI объекта

200

"deviceTypeId": “”, // идентификатор устройства объекта

201

"deviceTypeName": "" // наименование устройства объекта

202

"parentId": "", // идентификатор клиента-родителя

203

"parentName": "" // наименование клиента-родителя,

204

"modelId": "", // идентификатор модели объекта

205

"modelName": "" // наименование модели объекта,

206

"unitId": "", // идентификатор подразделения

207

"unitName": "", // наименование подразделения

208

"status": “”, // статус объекта

...

},

...}}}

}

Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»

216

217

**Добавление пользователя**

218

219

Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

224

225

В заголовках запроса: X-Auth: Токен авторизации

226

227

Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }

228

229

Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }

230

231

**Редактирование пользователя**

232

233

Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: PUT

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

238

239

В заголовках запроса: X-Auth: Токен авторизации

240

241

Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)

242

243

{{{ "description": "", // описание

244

"data": "" // данные, связанные со сменой статуса}}}

}

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»

249

250

**Удаление пользователя**

251

252

Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

253

254

Метод запроса: DELETE

255

256

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}

257

258

Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации

259

260

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»

261

262

**Добавление объекта**

263

264

Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

269

270

В заголовках запроса: X-Auth: Токен авторизации

271

272

Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {

273

274

{{{ "parentId": "", // ID клиента

275

"name": "", // имя ТС

276

"imei": "", // IMEI

277

"deviceTypeId": "",// ID типа устройства

278

"modelId": "",

279

"unitId": "", // ID подразделения

280

"sim1": "", // Номер SIM 1

281

"sim2": "", // Номер SIM2

282

"consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

283

"consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

284

"consumptionIdle": "",// Расход топлива на холостом ходу

285

"counters": {

286

"mileage": "", // пробег

287

"mileageEnabled": true, // флаг активности счётчика "пробег"

288

"motohours":"", // моточасы

289

"motohoursEnabled": true // флаг активности счётчика "моточасы"

290

},

291

"cmsv6Parameters": { // параметры CMSv6

292

"enabled": true, // флаг включения

293

//"id": "", // идентификатор

294

"host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6

295

"login": "", // имя учетной записи

296

"password": "" // пароль учетной записи

297

},

298

"inspectionTasks": [ // задания на ТО

299

{

300

"enabled": "", // Признак включения

301

"name": "", // Имя задания

302

"description": "", // Описание задания

303

"mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)

304

"lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)

305

"motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)

306

"lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)

307

"periodicCondition": "", // Условие периодичности по времени (null - условие не работает)

308

"kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

309

"lastInspectionDate": "", // Дата последнего ТО (null - не указано)

310

"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)

},

]}}}

… }

Ответ:

{

{{{ "vehicleId": "", //ID ТС

321

"parentId": "", //Guid владельца ТС

322

"name": "", //Имя объекта

323

"imei": "", //IMEI

324

"deviceTypeId": "", //ID типа устройства

325

"modelId": "", //ID модели

326

"unitId": "", //ID подразделения

327

"sim1": "", //SIM1

328

"sim2": "", //SIM2

329

"consumptionPer100Km": "", //Расход топлива на 100 км

330

"consumptionIdle": "", //Расход топлива на холостом ходу

331

"counters": { //Счётчики

332

"mileageEnabled": true,

333

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

"cmsv6Parameters": { //Параметры CmsV6

338

"id": null,

339

"enabled": true, //флаг включения

340

"host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6

341

"login": "", // имя учетной записи

342

"password": "" // пароль учетной записи

343

},

344

"inspectionTasks": [ // задания на ТО

345

{

346

"id": "", // ID задачи

347

"enabled": false, // Признак включения

348

"name": "", // Имя задания

349

"description": "", // Описание задания

350

"mileageCondition": "", // Условие по пробегу

351

"lastMileage": "", // Пробег (в метрах)

352

"motohoursCondition": "", // Условие по моточасам

353

"lastMotohours": "", // Моточасы

354

"periodicCondition": "", // Условие периодичности по времени}}}

355

356

{{{ "kind": "", // Вид периодичности по времени

357

"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)

}

]}}}

}

**Удаление объекта**

Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

366

367

Метод запроса: DELETE

368

369

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}

370

371

Параметр запроса: {id} - Guid объекта

372

373

В заголовках запроса: X-Auth: Токен авторизации

374

375

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»

376

377

**Редактирование объекта**

378

379

Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: PUT

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

384

385

В заголовках запроса: X-Auth: Токен авторизации

386

387

Параметры в теле запроса (JSON):

388

389

//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }

Ответ:

{ «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»: «» //Сколько раз выполнить задание } ] }

394

395

**Изменение статуса объекта**

396

397

Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}

402

403

Параметр запроса: {vehicleId} - ID ТС

404

405

В заголовках запроса: X-Auth: Токен авторизации

406

407

Параметры в теле запроса (JSON): {

408

409

{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

410

"date": "", // Дата смены статуса (null если сменить немедленно)

411

"description": "", // Описание

412

"data": "", // Данные

413

"overwrite": false, // Флаг перезаписи

414

"stage": "", // Состояние, может быть null}}}

}

Ответ: {

{{{ "status": "", // значение статуса

421

"date": "", // Дата смены статуса

422

"description": "", // Описание

423

"data": "", // Данные

424

"overwrite": false, // Флаг перезаписи

425

"stage": "", // Состояние}}}

}

**Проверка авторизации**

430

431

Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]

436

437

В заголовках запроса: X-Auth: Токен авторизации

438

439

Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»

440

441

**Расширенное описание API доступно по запросу на support@glonasssoft.ru**

Wiki source code of API

Меню