Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
<
>
edited by Андрей Калиновский
on 2024/03/18 10:54
on 2024/03/18 10:54
edited by Андрей Калиновский
on 2024/07/19 13:24
on 2024/07/19 13:24
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -60,6 +60,9 @@ 60 60 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 61 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 62 63 +(% class="wikigeneratedid" %) 64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 65 + 63 63 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 64 64 65 65 (% class="box infomessage" %) ... ... @@ -1428,7 +1428,7 @@ 1428 1428 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1429 1429 ))) 1430 1430 1431 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1434 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1432 1432 1433 1433 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1434 1434 ... ... @@ -4045,35 +4045,38 @@ 4045 4045 |driverName|Имя водителя 4046 4046 |driverRfid|Номер Карты-метки 4047 4047 4048 -(% style="color:#000000; font-size:18.6667px" %)Раздел: Топливные карты 4051 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4049 4049 4050 -=== ===**Запрос транзакций по топливным картам** ======4053 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4051 4051 4052 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК» 4055 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4053 4053 4054 4054 (% class="box infomessage" %) 4055 4055 ((( 4056 - **POST**/api/v3/fuelcards/transactions4059 +POST /api/v3/fuelcards/transactions 4057 4057 ))) 4058 4058 4059 - Запрос должен содержатьпараметры:4062 +Метод запроса: POST 4060 4060 4064 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4065 +\\В заголовках запроса: X-Auth: Токен авторизации 4066 + 4067 +Параметры в теле запроса (JSON): 4068 + 4061 4061 { 4062 4062 4063 - "startDate": "2024-0 3-14T13:10:21.797Z", ~/~/Дата началапериодапостроения4071 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4064 4064 4065 - "endDate": "2024-0 3-14T13:10:21.797Z", ~/~/Датаокончанияпериодапостроения4073 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4066 4066 4067 4067 "ids": [ 4068 4068 4069 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт4077 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4070 4070 4071 4071 ], 4072 4072 4073 - "timezone": 0 ,~/~/Часовойпояс4081 + "timezone": 0 ~/~/Таймзона 4074 4074 4075 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца 4076 - 4077 4077 } 4078 4078 4079 4079 Ответ: ... ... @@ -4080,37 +4080,235 @@ 4080 4080 4081 4081 { 4082 4082 4083 - "date": "2024-0 3-14T13:14:26.212Z", ~/~/4089 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4084 4084 4085 - " Имя водителя4091 + "driver": "string", ~/~/Водители, привязанные к ТК 4086 4086 4087 - " amount":0, ~/~/Количествотоплива4093 + "object": "string", ~/~/Наименование ТС 4088 4088 4089 - "amount Dut": 0, ~/~/по ДУТ4095 + "amount": 0, ~/~/Количество топлива 4090 4090 4091 - "amountD iff": 0, ~/~/Разница влитрах4097 + "amountDut": 0, ~/~/Количество по ДУТ 4092 4092 4093 - "amountDiff Perc": 0, ~/~/в %4099 + "amountDiff": 0, ~/~/Разница, л 4094 4094 4095 - " summa": 0, ~/~/Стоимостьв руб.4101 + "amountDiffPerc": 0, ~/~/Разница, % 4096 4096 4097 - "s erviceName":"string", ~/~/Типтоплива4103 + "summa": 0, ~/~/Стоимость, руб 4098 4098 4099 - " price":0, ~/~/Цена залитрвруб.4105 + "serviceName": "string", ~/~/Тип топлива 4100 4100 4101 - " cardName":"string", ~/~/НаименованиеТК4107 + "price": 0, ~/~/Цена за литр, руб 4102 4102 4103 - "cardN um": "string", ~/~/омерТК4109 + "cardName": "string", ~/~/Наименование ТК 4104 4104 4105 - " operator": "string", ~/~/ОператорТК4111 + "cardNum": "string", ~/~/Номер ТК 4106 4106 4107 - "a ddress": "string", ~/~/Адрес АЗС4113 + "operator": "string", ~/~/Оператор ТК 4108 4108 4109 - " id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/Guid топливной карты4115 + "address": "string" ~/~/Адрес АЗС 4110 4110 4111 4111 } 4112 - 4113 4113 4119 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4120 + 4121 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4122 + 4123 + 4124 +(% class="box infomessage" %) 4125 +((( 4126 +GET api/v3/Vehicles/recyclebin/all 4127 +))) 4128 + 4129 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4130 + 4131 +Параметр запроса: {parentId} - идентификатор агента 4132 + 4133 +В заголовках запроса: X-Auth: Токен авторизации 4134 + 4135 +Ответ: 4136 + 4137 +[ 4138 + 4139 + { 4140 + 4141 + "recordTime": "", ~/~/Время записи 4142 + 4143 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4144 + 4145 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4146 + 4147 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4148 + 4149 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4150 + 4151 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4152 + 4153 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4154 + 4155 + "items": [ ~/~/ [ 4156 + 4157 +nullable: true ~/~/Детали 4158 + 4159 + { 4160 + 4161 + "name": "string", ~/~/наименование столбца 4162 + 4163 + "value": "string" ~/~/содержание столбца 4164 + 4165 + } 4166 + 4167 + ] 4168 + 4169 + }, 4170 + 4171 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4172 + 4173 + "string" 4174 + 4175 + ] 4176 + 4177 + } 4178 + 4179 +] 4180 + 4181 + 4182 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4183 + 4184 +(% class="box infomessage" %) 4185 +((( 4186 +POST/api/v3/Vehicles/recyclebin/erase 4187 +))) 4188 + 4189 +В заголовках запроса: X-Auth: Токен авторизации 4190 + 4191 +Пример запроса: 4192 + 4193 + 4194 +[ 4195 + 4196 + 0 4197 + 4198 +] 4199 + 4200 + 4201 +Пример ответа: 4202 + 4203 +[ 4204 + 4205 + { 4206 + 4207 + "recordTime": "", ~/~/Время записи 4208 + 4209 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4210 + 4211 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4212 + 4213 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4214 + 4215 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4216 + 4217 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4218 + 4219 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4220 + 4221 + "items": [ ~/~/Детали 4222 + 4223 + { 4224 + 4225 + "name": "", ~/~/Имя свойства 4226 + 4227 + "value": "" ~/~/Значение свойства 4228 + 4229 + } 4230 + 4231 + ] 4232 + 4233 + }, 4234 + 4235 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4236 + 4237 + "" 4238 + 4239 + ] 4240 + 4241 + } 4242 + 4243 +] 4244 + 4245 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4246 + 4247 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4248 + 4249 +(% class="box infomessage" %) 4250 +((( 4251 +POST/api/v3/Vehicles/recyclebin/restore 4252 +))) 4253 + 4254 +В заголовках запроса: X-Auth: Токен авторизации 4255 + 4256 +Параметры в теле запроса (JSON): 4257 + 4258 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4259 + 4260 +В заголовках запроса: X-Auth: Токен авторизации 4261 + 4262 + 4263 +Пример запроса: 4264 + 4265 +[ 4266 + 4267 + 0 4268 + 4269 +] 4270 + 4271 + 4272 +Пример ответа: 4273 + 4274 +[ 4275 + 4276 + { 4277 + 4278 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4279 + 4280 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4281 + 4282 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4283 + 4284 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4285 + 4286 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4287 + 4288 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4289 + 4290 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4291 + 4292 + "items": [ ~/~/Детали 4293 + 4294 + { 4295 + 4296 + "name": "string", ~/~/Имя свойства 4297 + 4298 + "value": "string" ~/~/Значение свойства 4299 + 4300 + } 4301 + 4302 + ] 4303 + 4304 + }, 4305 + 4306 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4307 + 4308 + "string" 4309 + 4310 + ] 4311 + 4312 + } 4313 + 4314 +] 4315 + 4316 + 4317 + 4114 4114 (% class="box" lang="en-US" style="text-align: center;" %) 4115 4115 ((( 4116 4116 (% 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]] **