Методы API для работы с ГЛОНАССSoft

1

(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)

2

(((

3

**Содержание страницы:**

)))

= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =

10

11

(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).

12

13

(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).

14

15

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

16

17

(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!

18

19

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =

20

21

== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==

22

23

(% class="box infomessage" %)

24

(((

25

(% lang="en-US" %)**POST /api/v3/auth/login**

26

)))

27

28

(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.

29

30

(% style="color:#000000" %)Метод запроса: **POST**

31

32

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]

33

34

(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».

35

36

(% style="color:#000000" %)Параметры в теле запроса (JSON):

37

38

(% style="color:#000000" %){

39

"login": "testuser",

40

"password": "testuser"

}

(% style="color:#000000" %)**Ответ:**

45

46

(% lang="en-US" %)

47

(% style="color:#000000" %){

48

49

(% lang="en-US" %)

50

(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации

51

"User": "testuser" , ~/~/ имя пользователя

(% lang="en-US" %)

}

**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.

57

58

== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==

59

60

(% class="box infomessage" %)

61

(((

62

(% lang="en-US" %)**GET /api/v3/auth/check**

63

)))

64

65

(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

66

67

(% style="color:#000000" %)Метод запроса: **GET**

68

69

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]

70

71

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

72

73

(% lang="en-US" %)

74

(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**

75

76

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =

77

78

== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==

79

80

(% class="box infomessage" %)

81

(((

82

**GET api/v3/agents/{id}**

83

)))

84

85

Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):

86

87

(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;

88

89

(% style="color:#000000" %)Метод запроса: **GET**

90

91

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}

92

93

Запрос должен содержать данные параметра "**agentId**"

94

95

(% style="color:#000000" %)Ответ:

96

97

{

98

"agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%)

99

"parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)

100

"parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)

101

"name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)

102

"fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)

103

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)

104

"isForeign": true/false, ~/~/ Иностранный контрагент

105

"district": "string", ~/~/ округ

106

"region": "string", ~/~/ регион

107

"city": "string", ~/~/ город

108

"inn": "string", ~/~/ ИНН клиента

109

"kpp": "string", ~/~/ КПП клиента

110

"address": "string", ~/~/ юридический адрес

111

"addressFact": "string", ~/~/ фактический адрес

112

"email": "string", ~/~/ почта

113

"director": "string", ~/~/ ФИО руководителя

114

"bankName": "string", ~/~/ Банк

115

"bankBIK": "string", ~/~/ БИК

116

"bankRS": "string", ~/~/ Номер счета

117

"bankKS": "string" ~/~/ Корр. счет

118

}

119

120

== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==

121

122

(% class="box infomessage" %)

123

(((

124

(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**

125

)))

126

127

(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):

128

129

(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;

130

131

(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;

132

133

(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».

134

135

(% style="color:#000000" %)Метод запроса: **POST**

136

137

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find

138

139

(% style="color:#000000" %)Параметр запроса:

140

141

(% style="color:#000000" %){

"parentId": "string"

}

(% style="color:#000000" %)Ответ:

146

147

{

148

"agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%)

149

"parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)

150

"parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)

151

"name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)

152

"fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)

153

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)

154

"status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)

155

}

156

157

== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==

158

159

(% class="box successmessage" %)

160

(((

161

**POST /api/v3/agents **

162

)))

163

164

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

165

166

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

167

168

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

169

170

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

171

172

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

173

174

{

175

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

176

"name": "string", ~/~/ имя

177

"fullName": "string", ~/~/ полное наименование

178

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)

179

"isForeign": true, ~/~/ иностранный контрагент

180

"district": "string", ~/~/ округ

181

"region": "string", ~/~/ регион

182

"city": "string", ~/~/ город

183

"inn": "string", ~/~/ ИНН

184

"kpp": "string", ~/~/ КПП

185

"address": "string", ~/~/ юридический адрес

186

"addressFact": "string", ~/~/ фактический адрес

187

"email": "string", ~/~/ email

188

"director": "string", ~/~/ ФИО руководителя

189

"bankName": "string", ~/~/ банк

190

"bankBIK": "string", ~/~/ БИК

191

"bankRS": "string", ~/~/ номер счёта

192

"bankKS": "string" ~/~/ корр. счёт

}

Ответ:

{

"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента

200

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

201

"name": "string", ~/~/ имя

202

"fullName": "string", ~/~/ полное наименование

203

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)

204

"isForeign": true, ~/~/ иностранный контрагент

205

"district": "string", ~/~/ округ

206

"region": "string", ~/~/ регион

207

"city": "string", ~/~/ город

208

"inn": "string", ~/~/ ИНН

209

"kpp": "string", ~/~/ КПП

210

"address": "string", ~/~/ юридический адрес

211

"addressFact": "string", ~/~/ фактический адрес

212

"email": "string", ~/~/ email

213

"director": "string", ~/~/ ФИО руководителя

214

"bankName": "string", ~/~/ банк

215

"bankBIK": "string", ~/~/ БИК

216

"bankRS": "string", ~/~/ номер счёта

217

"bankKS": "string" ~/~/ корр. счёт

218

}

219

220

== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==

221

222

(% class="box warningmessage" %)

223

(((

224

**PUT /api/v3/agents**

225

)))

226

227

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

228

229

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

230

231

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

232

233

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

234

235

236

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

237

238

{

239

"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента

240

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

241

"name": "string", ~/~/ имя

242

"fullName": "string", ~/~/ полное наименование

243

"agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)

244

"isForeign": true, ~/~/ иностранный контрагент

245

"district": "string", ~/~/ округ

246

"region": "string", ~/~/ регион

247

"city": "string", ~/~/ город

248

"inn": "string", ~/~/ ИНН

249

"kpp": "string", ~/~/ КПП

250

"address": "string", ~/~/ юридический адрес

251

"addressFact": "string", ~/~/ фактический адрес

252

"email": "string", ~/~/ email

253

"director": "string", ~/~/ ФИО руководителя

254

"bankName": "string", ~/~/ банк

255

"bankBIK": "string", ~/~/ БИК

256

"bankRS": "string", ~/~/ номер счёта

257

"bankKS": "string" ~/~/ корр. счёт

}

Ответ:

{

"agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента

265

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

266

"name": "string", ~/~/ имя

267

"fullName": "string", ~/~/ полное наименование

268

"isForeign": true, ~/~/ иностранный контрагент

269

"district": "string", ~/~/ округ

270

"region": "string", ~/~/ регион

271

"city": "string", ~/~/ город

272

"inn": "string", ~/~/ ИНН

273

"kpp": "string", ~/~/ КПП

274

"address": "string", ~/~/ юридический адрес

275

"addressFact": "string", ~/~/ фактический адрес

276

"email": "string", ~/~/ email

277

"director": "string", ~/~/ ФИО руководителя

278

"bankName": "string", ~/~/ банк

279

"bankBIK": "string", ~/~/ БИК

280

"bankRS": "string", ~/~/ номер счёта

281

"bankKS": "string" ~/~/ корр. счёт

282

}

283

284

== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==

285

286

(% class="box errormessage" %)

287

(((

288

**DELETE /api/v3/agents/{clientId}**

289

)))

290

291

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

292

293

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

294

295

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**

296

297

Параметр запроса: **{clientId}** - Guid пользователя

298

299

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

300

301

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

302

303

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =

304

305

== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==

306

307

(% class="box successmessage" %)

308

(((

309

(% lang="en-US" %)**POST /api/v3/users**

310

)))

311

312

(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

313

314

(% style="color:#000000" %)Метод запроса: **POST**

315

316

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

317

318

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

319

320

(% style="color:#000000" %)Параметры в теле запроса (JSON):

321

322

(% style="color:#000000" %){

323

"lastName": "", ~/~/ фамилия

324

"firstName": "", ~/~/ имя

325

"position": "", ~/~/ должность

326

"phone": "", ~/~/ телефон

327

"organization": "", ~/~/ организация

328

"login": "", ~/~/ логин (обязателен)

329

"password": "", ~/~/ пароль (обязателен)

330

"email": "", ~/~/ email (обязателен)

331

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

332

"isEnabled": "", ~/~/ признак включения

333

"parentId": "", ~/~/ Guid родительского агента

334

"leaderId": "", ~/~/ Guid руководителя (null - не задан)

335

"sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)

336

"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации

337

"kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)

338

"target": "" , ~/~/ в случае аутентификации по email - email-адрес

339

"groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)

340

}

341

342

(% style="text-align:left" %)

343

(% style="color:#000000; font-weight:normal" %)Ответ:

344

345

(% style="text-align:left" %)

346

(% style="color:#000000; font-weight:normal" %){

347

348

(% style="text-align:left" %)

349

(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя

350

"lastName": "" , ~/~/ Фамилия ,

351

"firstName": "" , ~/~/ Имя

352

"position": "" , ~/~/ Должность

353

"phone": "" , ~/~/ Телефон

354

"organization": "" , ~/~/ Организация

355

"login": "" , ~/~/ Логин

356

"password": "" , ~/~/ Пароль

357

"email": "" , ~/~/ Email

358

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

359

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

360

"parentId": "" , ~/~/ Guid родительского агента

361

"sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах

362

"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации

363

"kind": "" , ~/~/ тип аутентификации

364

"target": "" , ~/~/ в случае аутентификации по email - email-адрес

365

"groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя

366

367

(% style="text-align:left" %)

368

(% style="color:#000000; font-weight:normal" %)}

369

370

== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==

371

372

(% class="box infomessage" %)

373

(((

374

(% lang="en-US" %)**POST /api/v3/users/find**

375

)))

376

377

(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.

378

379

(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.

380

381

(% style="color:#000000" %)Метод запроса: **POST**

382

383

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]

384

385

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

386

387

(% style="color:#000000" %)Параметры в теле запроса (JSON):

388

389

(% style="color:#000000" %){

390

391

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

392

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

393

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

394

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

395

396

(% style="color:#000000" %)}

397

398

(% style="color:#000000" %)Ответ:

399

400

(% style="color:#000000" %){ (%%)

401

402

"id": "" , ~/~/ идентификатор пользователя

403

"lastName": "" , ~/~/ фамилия

404

"firstName": "" , ~/~/ имя

405

"position": "" , ~/~/ должность

406

"phone": "" , ~/~/ телефон

407

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

408

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

409

"organization": "" , ~/~/ организация

410

"login": "" , ~/~/ логин

411

"email": "" , ~/~/ E-mail

412

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

413

"status": "1", ~/~/ статус пользователя

414

"astLogged": "", ~/~/ дата/время последней авторизации

415

416

(% style="color:#000000" %)}

417

418

== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==

419

420

(% class="box infomessage" %)

421

(((

422

(% lang="en-US" %)**GET /api/v3/users/{GUID}**

423

)))

424

425

(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.

426

427

(% style="color:#000000" %)Метод запроса: **GET**

428

429

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]

430

431

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

432

433

(% style="color:#000000" %)Ответ:

(((

(((

{

"id": "", ~/~/ GUID пользователя

439

"lastName": "", ~/~/ Фамилия

440

"firstName": "", ~/~/ Имя

441

"position": "", ~/~/ Должность

442

"phone": "", ~/~/ Номер телефона

443

"parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь

444

"parentName": "", Наименование клиента, которому принадлежит пользователь

445

"organization": "", ~/~/ Организация

446

"login": "", ~/~/ Логин пользователя

447

"email": "", ~/~/ Адрес электронной почты

448

"language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский

449

"isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено

450

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

451

"isEnabled": , ~/~/ Включен, true - включен, false - отключен

452

"doubleAuth":

453

{

454

"kind": "None", ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен

455

"target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации

456

},

457

"isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен

458

"sessionDuration": 30, ~/~/ Длительность сессии в минутах

459

"status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован

460

"lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя

461

"groups": [], ~/~/ Список ролей пользователя

462

"customGroups": [], ~/~/ Список клиентских ролей пользователя

463

"authDevices": [ ], ~/~/ Список авторизованных устройств

464

"mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств

465

"pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления

}

)))

)))

== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==

471

472

(% class="box warningmessage" %)

473

(((

474

(% lang="en-US" %)**PUT /api/v3/users**

475

)))

476

477

(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

478

479

(% style="color:#000000" %)Метод запроса: **PUT**

480

481

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

482

483

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

484

485

(% lang="en-US" style="text-align:left" %)

486

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):

487

488

(% lang="en-US" style="text-align:left" %)

489

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

490

491

(% lang="en-US" style="text-align:left" %)

492

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя

493

"lastName": "" , ~/~/ фамилия

494

"firstName": "" , ~/~/ имя

495

"position": "" , ~/~/ должность

496

"phone": "" , ~/~/ телефон

497

"organization": "" , ~/~/ организация

498

"login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%)

499

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)

500

"email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%)

501

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание

502

"isEnabled": "" , ~/~/ признак включения

503

"parentId": "" , ~/~/ Guid родительского агента

504

"leaderId": "" , ~/~/ Guid руководителя (null - не задан)

505

"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)

506

"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации

507

"kind": "" , ~/~/ тип аутентификации

508

"target": "" , ~/~/ в случае аутентификации по email - email-адрес

509

"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя

510

511

(% lang="en-US" style="text-align:left" %)

512

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__

513

514

(% lang="en-US" style="text-align:left" %)

515

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://

516

517

(% lang="en-US" style="text-align:left" %)

518

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

519

520

(% lang="en-US" style="text-align:left" %)

521

(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя

522

"lastName": "" , ~/~/ фамилия

523

"firstName": "" , ~/~/ имя

524

"position": "" , ~/~/ должность

525

"phone": "" , ~/~/ телефон

526

"organization": "" , ~/~/ организация

527

"login": "" , ~/~/ логин

528

"password": "" , ~/~/ пароль

529

"email": "" , ~/~/ email

530

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

531

"isEnabled": "" , ~/~/ признак включения

532

"parentId": "" , ~/~/ Guid родительского агента

533

"sessionDuration": "" , ~/~/ продолжительность сессии, в минутах

534

"doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации

535

"kind": "" , ~/~/ тип аутентификации

536

"target": "" , ~/~/ в случае аутентификации по email - email-адрес

537

"groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя

538

539

(% lang="en-US" style="text-align:left" %)

540

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

541

542

== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==

543

544

(% class="box warningmessage" %)

545

(((

546

(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**

547

)))

548

549

(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

550

551

(% style="color:#000000" %)Метод запроса: **PUT**

552

553

(% 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}

554

555

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя

556

557

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

558

559

(% style="color:#000000" %)Параметры в теле запроса (JSON):

560

561

(% style="color:#000000" %){

562

563

"status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)

564

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

565

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

566

567

(% style="color:#000000" %)}

568

569

(% style="text-align:left" %)

570

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**

571

572

== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==

573

574

(% class="box warningmessage" %)

575

(((

576

**POST /api/v3/users/disable**

577

)))

578

579

Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

580

581

(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**

582

583

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]

584

585

(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):

586

587

[

588

"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",

589

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

590

]

591

592

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**

593

594

== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==

595

596

(% class="box warningmessage" %)

597

(((

598

**POST /api/v3/users/enable**

599

)))

600

601

Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

602

603

(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**

604

605

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]

606

607

(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):

608

609

[

610

"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",

611

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

612

]

613

614

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)

615

\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__

(((

В теле ответа:

{

"errorMessages": [

"Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."

622

],

623

"users": [

624

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

625

]

626

}

627

\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.

628

"users" - массив id пользователей, которых не удалось включить или отключить.

629

)))

630

631

== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==

632

633

(% class="box errormessage" %)

634

(((

635

(% lang="en-US" %)**DELETE /api/v3/users/{id}**

636

)))

637

638

(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

639

640

(% style="color:#000000" %)Метод запроса: **DELETE**

641

642

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}

643

644

(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя

645

646

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

647

648

(% style="text-align:left" %)

649

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

650

651

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =

652

653

== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==

654

655

(% class="box infomessage" %)

656

(((

657

(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**

658

)))

659

660

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

661

662

(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):

663

664

(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;

665

666

(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.

667

668

(% style="color:#000000" %)Метод запроса: **GET**

669

670

(% 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>

671

672

(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)

673

674

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

675

676

(% style="color:#000000" %)Ответ:

(((

{

"vehicleId": "", ~/~/ ID объекта

681

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

682

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

683

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

684

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

685

"sim1": "", ~/~/ Номер SIM1

686

"parentId": "", Номер SIM2

687

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

688

"modelId": "", ID модели объекта

689

"modelName": "", Имя модели объекта

690

"createdAt": "", Дата создания объекта

691

"mileageCalcMethod": "", Выбранный метод расчета пробега

692

"counters": { ~/~/ Нормы

693

"mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)

694

"motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)

695

"mileage": "", ~/~/ Пробег по нормам в метрах

696

"motohours": "" ~/~/ Моточасы по нормам, в секундах

697

"mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега

698

"motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов

699

},

700

"inspectionTasks": [ ~/~/ Задания на тех. обслуживание

701

{

702

"id": "", ~/~/ ID задания

703

"enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)

704

"name": "", ~/~/ Наименование задания

705

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

706

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

707

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

708

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

709

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

710

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

711

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

712

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

713

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

}

]

}

)))

(% style="text-align:left" %)

720

Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:

721

722

(% style="text-align:left" %)

723

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

724

725

== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==

726

727

(% class="box successmessage" %)

728

(((

729

(% lang="en-US" %)**POST /api/v3/vehicles**

730

)))

731

732

(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).

733

734

(% style="color:#000000" %)Метод запроса: **POST**

735

736

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

737

738

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

739

740

(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON

741

742

(% style="color:#000000" %){

743

744

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

745

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

746

"imei": "" , ~/~/ IMEI

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

756

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

757

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

758

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

759

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

760

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

761

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

762

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

763

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

764

"counters": ~/~/ счетчики

765

{

766

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

767

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

768

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

769

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

770

},

771

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

772

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

773

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

774

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

775

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

776

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

777

},

778

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

779

{

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

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

788

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

789

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

790

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

791

}

792

793

(% style="color:#000000" %) }

794

795

(% style="color:#000000" %)Ответ:

796

797

(% style="color:#000000" %){

798

799

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

800

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

801

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

802

"imei": "", ~/~/IMEI

803

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

804

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

805

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

806

"sim1": "", ~/~/SIM1

807

"sim2": "", ~/~/SIM2

808

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

809

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

810

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

811

"mileageEnabled": true,

812

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

817

"id": null,

818

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

819

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

820

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

821

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

822

},

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

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

835

}

836

837

(% style="text-align:left" %)

838

(% style="color:#000000" %)}

839

840

**Валидация:**

841

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

842

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

843

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

844

845

== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==

846

847

(% class="box infomessage" %)

848

(((

849

(% lang="en-US" %)**POST /api/v3/vehicles/find**

850

)))

851

852

(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

853

854

(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):

855

856

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

857

858

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

859

860

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

861

862

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

863

864

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

865

866

(% style="color:#000000" %)Метод запроса: **POST**

867

868

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

869

870

(% style="color:#000000" %)В заголовках запроса:

871

872

(% style="color:#000000" %)− Content-Type: __**application/json**__

873

874

(% style="color:#000000" %)− X-Auth: Токен авторизации

875

876

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

877

878

(% style="color:#000000" %)Параметры в теле запроса (JSON):

879

880

{

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

"customFields": null ~/~/ значение любого из произвольных полей ТС

889

}

890

891

(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

892

893

(% style="color:#000000" %)Ответ:

894

895

(% style="color:#000000" %){

896

897

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

898

"name": "" ~/~/ наименование объекта

899

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

900

"deviceTypeId": "" ~/~/ идентификатор типа устройства

901

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

902

"sim1": "" ~/~/ первый номер телефона

903

"sim2": "" ~/~/ второй номер телефона

904

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

905

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

906

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

907

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

908

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

909

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

910

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

911

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

912

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

913

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов

914

"customFields": [

915

{

916

"id": "", ~/~/ идентификатор произвольного поля

917

"name": "", ~/~/ имя произвольного поля

918

"value": "", ~/~/ значение произвольного поля

919

"forClient": true, ~/~/ право на отображение у клиента

920

"forTooltip": false, ~/~/ право на отображение в подсказке

921

"forReport": false ~/~/ право на отображение в отчетах

922

}(%%)

923

(% style="color:#000000" %)}

924

925

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

926

927

== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==

928

929

(% class="box successmessage" %)

930

(((

931

(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

932

)))

933

934

(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

935

936

(% style="color:#000000" %)Метод запроса: **POST**

937

938

(% 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}

939

940

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

941

942

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

943

944

(% style="color:#000000" %)Параметры в теле запроса (JSON):

945

946

(% style="color:#000000" %){

947

948

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

949

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

950

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

951

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

952

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

953

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

954

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

955

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

956

957

(% style="color:#000000" %)}

958

959

(% style="color:#000000" %)Ответ:

960

961

(% style="color:#000000" %){

962

963

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

964

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

965

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

966

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

967

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

968

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

969

970

(% style="text-align:left" %)

971

(% style="color:#000000" %) }

972

973

== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==

974

975

(% class="box warningmessage" %)

976

(((

977

(% lang="en-US" %)**PUT /api/v3/vehicles**

978

)))

979

980

(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

981

982

(% style="color:#000000" %)Метод запроса: **PUT**

983

984

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

985

986

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

987

988

(% style="color:#000000" %)Параметры в теле запроса (JSON):

989

990

(% style="color:#000000" %){

991

992

(((

993

(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС

994

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

995

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

996

"imei": "", ~/~/ IMEI

997

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

998

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

999

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

1000

"sim1": "", ~/~/ SIM 1

1001

"sim2": "", ~/~/ SIM2 (%%)

1002

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

1003

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

1004

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

1005

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

1006

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

1007

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

1008

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

1009

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

1010

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

1011

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

1012

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

1013

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

1014

(% style="color:#000000" %) "counters":

1015

{

1016

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

1017

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

1018

"mileage": "", ~/~/ пробег, в метрах

1019

"motohours": "" ~/~/ моточасы, в секундах

1020

}

1021

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

1022

{

1023

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

1024

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

1025

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

1026

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

1027

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

1028

}

1029

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

1030

{

1031

"id": "", ~/~/ ID задания

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

}

)))

(% style="color:#000000" %)}

1046

1047

(% style="color:#000000" %)Ответ:

1048

1049

(% lang="en-US" style="text-align:left" %)

1050

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

1051

1052

(% lang="en-US" style="text-align:left" %)

1053

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

1054

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

1055

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

1056

"imei": "", ~/~/ IMEI

1057

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

1058

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

1059

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

1060

"sim1": "", ~/~/ SIM 1

1061

"sim2": "", ~/~/ SIM2

1062

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

1063

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

1064

"counters":

1065

{

1066

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

1067

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

1068

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

1069

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

1070

}

1071

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

1072

{

1073

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

1074

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

1075

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

1076

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

1077

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

1078

}

1079

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

1080

{

1081

"id": "", ~/~/ ID задания

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

1092

}

1093

1094

(% lang="en-US" style="text-align:left" %)

1095

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

1096

1097

**валидация:**

1098

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

1099

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

1100

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

1101

1102

== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==

1103

1104

(% class="box errormessage" %)

1105

(((

1106

(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

1107

)))

1108

1109

(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

1110

1111

(% style="color:#000000" %)Метод запроса: **DELETE**

1112

1113

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

1114

1115

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

1116

1117

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1118

1119

(% style="text-align:left" %)

1120

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

1121

1122

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =

1123

1124

== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==

1125

1126

(% class="box infomessage" %)

1127

(((

1128

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**

1129

)))

1130

1131

(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

1132

1133

(% style="color:#000000" %)Метод запроса: **GET**

1134

1135

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

1136

1137

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1138

1139

(% style="color:#000000" %)Ответ:

1140

1141

(% style="color:#000000" %){

1142

1143

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

1144

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

1145

1146

(% style="text-align:left" %)

1147

(% style="color:#000000" %)}

1148

1149

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =

1150

1151

== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==

1152

1153

(% class="box infomessage" %)

1154

(((

1155

(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

1156

)))

1157

1158

(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

1159

1160

(% style="color:#000000" %)Метод запроса: **GET**

1161

1162

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

1163

1164

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1165

1166

(% style="color:#000000" %)Ответ:

1167

1168

(% style="color:#000000" %){

1169

1170

"id": "", ~/~/ ID типа датчика

1171

"name": "", ~/~/ Название

1172

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

1173

1174

(% style="text-align:left" %)

1175

(% style="color:#000000" %)}

1176

1177

= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =

1178

1179

== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==

1180

1181

(% class="box infomessage" style="text-align: left;" %)

1182

(((

1183

**POST /api/v3/terminalMessages/count**

1184

)))

1185

1186

(% style="text-align: left;" %)

1187

Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

1188

1189

(% style="text-align: left;" %)

1190

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

1191

1192

(% style="text-align: left;" %)

1193

(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count

1194

1195

(% style="text-align: left;" %)

1196

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

1197

1198

(% style="text-align: left;" %)

1199

{

1200

"vehicleIds": [

1201

id ~/~/ здесь передается список идентификаторов объектов

1202

],

1203

"from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос

1204

"to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос

1205

}

1206

1207

(% style="text-align: left;" %)

1208

Ответ:

1209

1210

(% style="text-align: left;" %)

1211

[

1212

{

1213

"vehicleId": 0, ~/~/ идентификатор объекта

1214

"count": 0 ~/~/ количество сообщений за период

}

]

(% class="box" lang="en-US" style="text-align: center;" %)

1220

(((

1221

(% 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]] **

1222

)))

Исходный код вики Методы API для работы с ГЛОНАССSoft