Хрестоматийное api


Добавление расходной категории



страница2/3
Дата08.11.2016
Размер0.63 Mb.
Просмотров269
Скачиваний0
1   2   3

Добавление расходной категории


Запрос: category.php

Элемент сообщения

Тип

Комментарий

Обязательность

operation

string

Константа со значением «add»

Да

name

string

Название категории

Да

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

integer

Статус ответа

Да
    1. Редактирование расходной категории


Запрос: /category.do

Элемент сообщения

Тип

Комментарий

Обязательность

operation

string

Константа со значением «update»

Да

id

integer

Идентификатор категории

Да

name

string

Название категории

Да

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

integer

Статус ответа

Да
    1. Удаление расходной категории


Запрос: /private/finances/category.php

Элемент сообщения

Тип

Комментарий

Обязательность

operation

string

Константа со значением «remove»

Да

id

integer

Идентификатор категории

Да

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

integer

Статус ответа

Да



    1. Структура расходов по категориям

Запрос: /finances/operationCategories.php

Элемент сообщения

Тип

Комментарий

Обязательность

operation

string

Константа со значением «filter»

Да

from

Date (dd.mm.yyyy)

Дата начала построения списка операций

Да

to

Date (dd.mm.yyyy)

Дата окончания построения списка операций

Да

showCash

boolean

Показывать ли операции с наличными

Да

showCashPayments

boolean

Отображать траты наличными

Да

selectedId

string

Выбранные карты

Актуальное множество возможных значений для конкретного клиента, в зависимости от типов существующих у него карт, будет получено только в первом ответе (поле cardFilter). Т.е. на первом запросе возможные значения еще не известны, поэтому в нем можно не передавать параметр (в этом случае приходит информация по всем картам).



Нет

excludeCategories

String

Исключаемые категории операций

Нет




TransferBetweenАccounts

перевод между своими счетами


TransferToDeposit

перевод на вклад

TransferFromCard

перевод с карты

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

integer

Статус ответа

Да

categories

Список категорий

Нет





category

Категория

Нет




id

intereg

Идентификатор категории

Да

name

string

Наименование категории

Да

nationalSum

Money

Сумма операций по категории. В национальной валюте.

Да

budget

Информация о бюджете по категории

Нет




budgetSum

Money

Величина бюджета в рублях

Да

isAvg

boolean

true – если бюджет по категории рассчитан как среднее значение за последние 6 месяцев

false – бюджет по категории установлен клиентом



Нет























    1. Редактирование и разбивка операции


В случае разбивки операции в запросе должны присутствовать 3 проиндексированных массива параметров: newOperationTitle[i], newOperationCategoryId[i], newOperationSum[i], где i – 0-based индекс, при этом элементы с одинаковым индексом описывают одну новую операцию.

Запрос: /operations/edit.php



Элемент сообщения

Тип

Комментарий

Обязательность

action

string

Константа «save»

Да

operationId

integer

Идентификатор операции

Да

operationTitle

string

Название операции

Да

operationCategoryId

integer

Идентификатор категории

Да

newOperationTitle[i]

string

Название новой операции

Нет

newOperationCategoryId[i]

integer

Идентификатор категории

выбирать можно только из availableCategories



Нет

newOperationSum[i]

Amount

Сумма новой операции в валюте исходной операции

Сумма всех операций не должна превышать сумму исходной операции



Знак каждой новой операции должен совпадать со знаком исходной

Нет

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

integer

Статус ответа

Да



    1. Операции с разбивкой по категориям

Запрос: / finances/operations/list.php

Элемент сообщения

Тип

Комментарий

Обязательность

from

Date (dd.mm.yyyy)

Дата начала построения списка операций

Да

to

Date (dd.mm.yyyy)

Дата окончания построения списка операций

Да

categoryId

integer

Идентификатор категории

Нет

selectedCardId

integer

Идентификатор карты

Нет

income

boolean

Признак приходной операции

Да

showCash

boolean

Показывать ли операции с наличными

Да

showCashPayments

boolean

Отображать траты наличными

Да

showOtherAccounts

boolean

Показывать ли операции по дополнительным картам к чужим счетам

Да

paginationSize

integer

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

Нет

paginationOffset

integer

Смещение относительно начала выборки. По умолчанию равно нулю.

Нет

excludeCategories

String

Исключаемые категории операций

Нет




TransferBetweenАccounts

перевод между своими счетами


TransferToDeposit

перевод на вклад

TransferFromCard

перевод с карты

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

integer

Статус ответа

Да

operations

Список операций

Нет





operation

Операция

Да




id

integer

Идентификатор операции

Да

date

Date (dd.mm.yyyy)

Дата

Да

comment

string

Комментарий

Да

categoryId

integer

Идентификатор категории операции

Да

categoryName

string

Название категории операции

Да

cardNumber

string

Маскированный номер карты. Для трат наличными выводится "Наличные"

Да

cardAmount

Money

Сумма в валюте карты. Пустое для трат наличными.

Да

nationalAmount

Money

Сумма в рублях

Да

availableCategories

Доступные для операции категории

Да




category

Категория

Да




id

integer

Идентификатор

Да

name

string

Название

Да



    1. Повтор операций из истории/Оплата по шаблону

Описанные ниже методы могут быть использованы для повтора операции из истории, либо для оплаты существующего шаблона

Шаг 1. Получение формы

Запрос: operations/do.php



Элемент сообщения

Тип

Комментарий

Обязательность

operation

string

Константа со значением «open»

Да

id

integer

Идентификатор операции, повтор которой необходимо произвести

Да

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

Status

Integer

Статус ответа

Да

message

String

Текст для отображения клиенту. Может присутствовать в случае ошибки или наличия информационного сообщения.

Нет

id

integer

Идентификатор операции

Да

page

Page

Страница – набор полей к проверке или заполнению

да

Шаг 2. Заполнение и отправка формы формы

Запрос: operations/ do.php



Элемент сообщения

Тип

Комментарий

Обязательность

action

string

Константа со значением «repeat»

Да

id

integer

Идентификатор операции, повтор которой необходимо произвести

Да

page

Page

Заполненная пользователем форма




Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

Status

integer

Статус ответа

Да

message

String

Текст для отображения клиенту. Может присутствовать в случае ошибки или наличия информационного сообщения.

Нет

operationID

integer

Идентификатор операции (новой)

Нет

page

Page

Страница

Нет

confirmationSMS

boolean

Признак, указывающий нужно ли подтверждать операцию одноразовым кодом из СМС

Нет

Шаг 3. Подтверждение

Запрос: operations/ do.php



Элемент сообщения

Тип

Комментарий

Обязательность

operation

string

Константа со значением «confirm»

Да

operationID

integer

Идентификатор операции

Да

smsPassword

integer

Пароль из СМС (нужен только в случае, если в ответ на первый шаг пришло требование подтверждения паролем)

Нет

page

Page

Заполненная пользователем форма

Да

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

Status

integer

Статус ответа

Да

message

String

Текст для отображения клиенту. Может присутствовать в случае ошибки или наличия информационного сообщения.

Нет

operationStatus

integer

Статус операции:

1 – Исполнена

2 – Принята к исполнению

3 – Отказано в исполнении



Да

page

Page

Страница – набор полей к проверке или заполнению

Да



    1. Адресная книга. Синхронизация контактов

Сервис поможет определить пользователей Сбербанка, получить аватар (если есть), и получить список избранных номеров.

Запрос: /contacts.php



Элемент сообщения

Тип

Комментарий

Обязательность

contacts

Справочник контактов. Формат – xml-подобная строка. К именам контактов необходимо применить xml escaping.

Да




contact

Контакт

Да







name

string

Имя контакта

Да







phone

string

Номер телефона(Пример: 79260000000)

Да

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

Status

Статус ответа

Да

Contacts

Список контактов

contact

Контакт

Да




name

string

Имя контакта

Да

phone

string

Номер телефона(Пример: 79260000000)

Да




favorites

boolean

Признак,указывающий на то, что контакт является избранным

Нет




client

boolean

Признак,указывающий на то, что контакт является клиентом сбербанка

Да




avatar

string

url на аватар пользователя

Нет



    1. Новости

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

Запрос: /news/list.php

Элемент сообщения

Тип

Комментарий

Обязательность

from

Date

Дата начала

Необходимо передавать данные параметры только в паре.

нет

to

Date

Дата окончания

pageSize

integer

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

Нет

pageOffset

integer

Смещение относительно начала выборки. По умолчанию равно нулю.

Нет

Ответ:

Элемент сообщения

Тип

Комментарий

Обязательность

status

Status

Статус ответа

Да

newsList




Нет




news




Нет




id

integer

Id новости

Да

title

string(1-40)

Заголовок. Могут присутствовать html спецсимволы.

Да

date

Date

Дата новости

Да

shortText

string(1-150)

Короткое описание. Отформатированный html тегами текст.

Да





      1. Поделитесь с Вашими друзьями:
1   2   3


База данных защищена авторским правом ©nethash.ru 2019
обратиться к администрации

войти | регистрация
    Главная страница


загрузить материал