GET /dealer/wallet/recharges
Возвращает список пополнений кошелька.
Формат запроса
GET https://apiauto.ru/1.0/dealer/wallet/recharges
? from=<string>
& [to=<string>]
& [pageNum=<integer>]
& [pageSize=<integer>]
from* |
Начало интервала дат для поиска пополнений кошелька в формате |
to |
Конец интервала дат для поиска пополнений кошелька в формате |
pageNum |
Номер страницы, с которой необходимо начать вывод. Отсчет начинается с единицы. |
pageSize |
Необходимое количество объектов на странице. |
* Обязательный параметр
Заголовки запроса
Заголовок |
Описание |
|
Идентификатор клиента. Используется для работы под учетной записью агентства. |
|
Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login. |
Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.
Формат ответа
{
"recharges": [
{
"timestamp": "{string}",
"amount": "{string}"
},
{
"timestamp": "{string}",
"amount": "{string}"
}
],
"paging": {
"page": {
"num": {integer},
"size": {integer}
},
"total": {integer},
"page_count": {integer}
},
"status": "{string}"
}
recharges |
Массив объектов. Список пополнений кошелька. |
-
timestamp
Дата пополнения кошелька в формате ISO 8601 со смещением относительно UTC. Например,
2017-07-08T11:29:16+03:00
.
amount
Сумма пополнения кошелька в рублях.
paging |
Пагинация результатов запроса. |
-
page
Информация о текущей странице с результатами.
-
num
Номер текущей страницы. Отсчет начинается с единицы.
size
Количество объектов на странице.
total
Общее количество объектов.
page_count
Общее количество страниц.
-
status |
Статус ответа. |
Коды ответа
Код |
Причина |
Описание |
200 |
OK |
Успешный запрос. |
400 |
BAD_REQUEST |
Синтаксическая ошибка в запросе. |
401 |
NO_AUTH |
Не удалось авторизовать пользователя по переданным данным. |
500 |
INTERNAL SERVER ERROR |
Внутренняя ошибка сервера. |
Пример
Запрос:
curl -i -X GET 'https://apiauto.ru/1.0/dealer/wallet/recharges?from=2018-06-01&to=2018-07-24&pageNum=1&pageSize=2' -H 'x-authorization: 2dtrer432...' -H 'Accept: application/json' -H 'x-session-id: 112_aoR02Tpv...'
Ответ:
HTTP/1.1 200 OK Server: nginx Date: Tue, 24 Jul 2018 15:19:41 GMT Content-Type: application/json Connection: keep-alive { "recharges": [ { "timestamp": "2018-06-27T08:54:40.075Z", "amount": "34324" }, { "timestamp": "2018-06-27T08:54:27.170Z", "amount": "33333" } ], "paging": { "page": { "num": 1, "size": 2 }, "total": 4 }, "status": "SUCCESS" }
Начало интервала дат для поиска пополнений кошелька в формате YYYY-MM-DD
.
Конец интервала дат для поиска пополнений кошелька в формате YYYY-MM-DD
.
Номер страницы, с которой необходимо начать вывод. Отсчет начинается с единицы.
Необходимое количество объектов на странице.
* Обязательный параметр