03-12-2018 23:59

Отчет по заявкам

POST   /bs-core/reports/loan-report-list/{dateFrom}/{dateTo}

Отчет формирует данные по всем заявкам созданным за указанный период. Для получения отчета всех заявок на заданный период в теле запроса передается пустая коллекция филбтров [ ].

Запрос

POST /bs-core/reports/loan-report-list/2016-01-01/2016-12-31?output-mode=file-sync
[
	{
		"entity":"com.pq.establ.dict.Client",
		"field":"firstName",
		"value1":"Мурад"
	}
]
Описание параметров
Параметр Обязателен Тип данных Описание
dateFrom R [date]

Начальная дата отчета в формате YYYY-MM-DD
dateTo R [date]

Конечная дата отчета в формате YYYY-MM-DD
count О [bool]

Cформировать количество записей в отчете. Этот параметр служит для быстрого получения информации о количестве записей информации. Если передать этот параметр, то будет возвращено количество записей в отчете в структуре джейсона, не формирую самого отчета. 

Например:

{
    "status": "ok",
    "timestamp": 1543479512046,
    "data": 157
}
В отчете будет произведено 157 записей.
output-mode О [string]

Дополнительный параметр адресной строки. Если передавать этот параметр, то отчет формируется в файловом хранилище и его можно скачать через интерфейс (если такой  имеется в наличии). Следует принять во внимание то, что если с этим параметром передается параметр count, то приоритет отдается параметру count и отчет не формируется. Более подробное описание флага output-mode смотрите здесь.
entity О [string]

Сущность по которой надо фильтровать. Возможные значения берутся из метода "Получение сущностей для фильтрации в отчете по Заявкам". 

Например, если метод "Получение сущностей для фильтрации в отчете по Заявкам" возвращает

{
    "status": "ok",
    "timestamp": 1502373007835,
    "data": [
        {
            "object": "com.pq.establ.dict.LoanApplication",
            "label": "Заявка на займ",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "com.pq.establ.dict.Client",
            "label": "Клиент",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "com.pq.establ.dict.LeadEmul",
            "label": "lead",
            "type": "DICTIONARY",
            "singleValue": true
        }
    ]
}

то в этом параметре передается все значения  поля "object". Например "entity":"com.pq.establ.dict.Client", "entity":"com.pq.establ.dict.LeadEmul" и т.д.
field О [string]

Поле по которому происходит фильтрация. Значение поля можно узнать из поля "оbject", возвращаемое методом "Получение полей сущности для фильтрации в отчете по Заявкам". Например метод возвращает 

{
    "status": "ok",
    "timestamp": 1543509507793,
    "data": [
        {
            "object": "email",
            "label": "emain",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "birthDate",
            "label": "Дата рождения",
            "type": "DATE",
            "singleValue": false
        },
        {
            "object": "creationDate",
            "label": "Дата создания",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "firstName",
            "label": "Имя",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "howYouKnow",
            "label": "Как вы о нас узнали",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "id",
            "label": "Номер лида",
            "type": "INTEGER",
            "singleValue": false
        },
        {
            "object": "passportNo",
            "label": "Номер паспорта",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "patronymic",
            "label": "Отчество",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "subdivision",
            "label": "Подразделение",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "passportSeria",
            "label": "Серия",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "leadCustomStatus",
            "label": "Статус лида",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "amount",
            "label": "Сумма",
            "type": "DOUBLE",
            "singleValue": false
        },
        {
            "object": "lastName",
            "label": "Фамилия",
            "type": "STRING",
            "singleValue": true
        }
    ]
}
 
тогда можем использовать значения creationDate, firstName, howYouKnow, id и т.д. Например "field":"id", "field":"creationDate".
value1 О [object]

Тип данных этого поля определяется в методе "Получение полей сущности для фильтрации в отчете по Заявкам" (какие значения нужно/можно передавать, узнаются из того же метода). Если типом данных например является "Dictionary", то передается идентификатор элемента этого справочника. 
value2 О [object]

Это поле нужно передавать в том случае, если значение передаваемого поля field предполагает ввод второго значения. Это видно из поля "singleValue" метода "Получение полей сущности для фильтрации в отчете по Заявкам", т.е. если значение поля "singleValue" false, то этот параметр нужно передавать. Этот второй параметр нужно передавать, если например сущности для отчета выбираются по клиентам создавшим заявку рожденных в определленный месяц, год, определённый промежуток времени и т.д.

Ответ


                        {
    "status": "ok",
    "timestamp": 1543584386017,
    "data": 4
}
Описание параметров
Параметр Обязателен Тип данных Описание
data О [int]

Количество записей в отчете. Если не передавать параметр count и output-mode, то возвращается excel-файл.