11-11-2019 17:19

Поиск по заявкам

POST   /bs-core/main/loan-apps/partial-load

Метод предназначен для поиска по заявкам с возможность задавать набор полей в ответе и порядок сортировки элементов. 

Запрос

POST /bs-core/main/loan-apps/partial-load

{
   "fields": [
       "client.lastName",
       "client.firstName",
       "loanAmount"
   ],
   "orderBy": "id",
   "orderDirection": "ASC",
   "orderByFields": [
     { "field": "creationDate" },
     { "field": "id", "direction": "desc" }
   ],
   "searchFields": [
       {
           "field": "creationDate",
           "value": ">=2017-09-01 00:00:00"
       }
   ]
}
Описание параметров
Параметр Обязателен Тип данных Описание
fields R [collection] Коллекция полей, которые должны вернуться в результатах поиска.
fields.{fieldName} М [string][255]

В качестве элементов списка могут быть указаны любые поля из сущности Заявка, которые не являются внешними ключами.

Например: "name", "CreationDate" и так далее. 

Признаком внешнего ключа является указание в описание параметра на метод, который позволяет по ID (по значению параметра - получить объект). Пример: clientId.

Для полей, которые являются внешними ключами - возможно получение любых полей объекта, ID котрого указано в поле. Например: в объекте Заявка есть поле clientId, котрое является внешним ключом. Это значит, что мы можем запросить любое поле объекта клиент: client.id, client.lastName и так далее. Также возможны варианты, при которых мы можем запросить поля из более глубоких сущностей, при наличии внешних ключей в объекте. 

Например: client.passport.seria - позволяет получить серию паспорта клиента, от которого оформлена заявка.

orderBy R [string][255] Название поля, по которому надо делать сортировку. С релиза 2.0.0-65 для сортировки следует использовать коллецию orderByFields. ​
orderDirection R [enum]

Направление сортировки результатов поиска

  • DESC - по убыванию
  • ASC - по позрастанию

С релиза 2.0.0-65 для направления сортировки следует передавать направление в коллекции orderByFields.

orderByFields R [collection]

Массив полей, по которым происходит сортировка.

"orderByFields": [
     { "field": "creationDate" },
     { "field": "id", "direction": "desc" }
    ]

В этом примере сортировка происходит по полям creationDate и id. Также результат сортируется по убыванию. Для направления сортировки используется параметр id. Если поле direction не указан, то сортировка по полю выполняется по возрастанию. Если в запросе на ядро переданы оба способа сортировки, то старый способ задания сортировки игнорируется. Эти изменения действуют с релиза 2.0.0-65. Смотрите также описание параметров orderBy и orderDirection.

searchFields R [collection]

Условия поиска (фильтрации) заявки на займ, наличие параметра searchFields является обязательным, однако это может быть пустая коллекция (условия поиска могут быть не заданы). Строго рекомендуется задавать параметры фильтрации. 

searchFields._.field М [string][255]

Название поля, по которому нужно сделать фильтрацию. Правила формирования этого поля следующие: 

В качестве элементов списка могут быть указаны любые поля из сущности Заявка, которые не являются внешними ключами.

Например: "name", "CreationDate" и так далее. 

Признаком внешнего ключа является указание в описание параметра на метод, который позволяет по ID (по значению параметра - получить объект). Пример: clientId.

Для полей, которые являются внешними ключами - возможно получение любых полей объекта, ID котрого указано в поле. Например: в объекте Заявка есть поле clientId, котрое является внешним ключом. Это значит, что мы можем запросить любое поле объекта клиент: client.id, client.lastName и так далее. Также возможны варианты, при которых мы можем запросить поля из более глубоких сущностей, при наличии внешних ключей в объекте. 

Например: client.passport.seria - позволяет получить серию паспорта клиента, от которого оформлена заявка.

searchFields._.value М [string][255]

Значение для фильтрации. 

В значении параметра может указывается как точное значение, так и нет. Для значений не полного соответствия используются различные параметры.

Для указания значений этого параметра можно использовать следующие операторы: %, like, !=, null, not null, >, <, >=, <=.

Для передачи даты используется следующий формат YYYY-MM-DD (действует с 2.0.0-65 релиза) например 2018-05-25, а для передачи даты и времени YYYY-MM-DD hh:mm:ss (например 2018-05-25 12:22:35).

Пример: 

      {
           "field": "client.id",
           "value": "123"
       },

Так и условия строгого и нестрогого неравенства, например: 

      {
           "field": "creationDate",
           "value": ">=2017-09-01 00:00:00"
       },

      {
           "field": "creationDate",
           "value": "<=2017-09-01 00:00:00"
       }

searchFields._.ornumber М [string][255]

Значение для группировки параметров поиска (фильтрации) в условии OR.
Поле не обязательное и используется в случаях когда нужно искать не все условия по И, но и в том числе условия по ИЛИ.
Например, нужно найти все записи у которых в поле1 указано значение XXXX, при этом в поле2 указано YYYY или ZZZZ.
В этом случае можно использовать поле ornumber. Значение может быть числом или символом, но уникальным в рамках одной группы условий ИЛИ. Зарезервированным значением является  -1

Пример 1: 

      {
           "field": "contract.id",
           "value": "10134756"
       },

      {
           "field": "loanAmount",
           "value": "10000",
           "ornumber": "1",
       },

     {
           "field": "name",
           "value": "5%",
           "ornumber": "1",
       },
 В этом примере будут искаться все записи, у которых в поле contract.id указано 10134756 и при этом одновременно выполняется одно из условий поле loanAmount равно 10000 или поле name начинается с 5.
То есть, в выражении языка SQL : contract.id = 10134756 AND (loanAmount = 10000 OR name like "5%")

Пример 2: 

      {
           "field": "name",
           "value": "1%",
           "ornumber": "1",
       },

     {
           "field": "name",
           "value": "5%",
           "ornumber": "1",
       },

    {
           "field": "loanAmount",
           "value": "10000",
           "ornumber": "2",
       },

     {
           "field": "loanAmount",
           "value": "20000",
           "ornumber": "2",
       },

 В  выражении языка SQL : (name like "1%" OR name like "5%" ) AND (loanAmount = 10000 OR loanAmount = 20000)

countFrom R [int] Смещение от начала поиска, т.е. если хотим получить с 10 записи, то передаем 10
countTo R [int ] Лимит (сколько записей будет возвращено)

Ответ


                        {
    "timestamp": 1504848202281,
    "data": [
        {
            "id": 10269296,
            "fields": {
                "client.lastName": "Иванцов",
                "client.firstName": "Иван",
                "loanAmount": 10000,
                "client.passport.seria": "0000"
            }
        },
        {
            "id": 10270155,
            "fields": {
                "client.lastName": "Иванцов",
                "client.firstName": "Александр",
                "loanAmount": 35000,
                "client.passport.seria": "0001"
            }
        },
        {
            "id": 10270259,
            "fields": {
                "client.lastName": "Иванцов",
                "client.firstName": "Дмитрий",
                "loanAmount": 30000,
                "client.passport.seria": "0002"
            }
        }
    ],
    "status": "ok"
}
                    
Описание параметров
Параметр Обязателен Тип данных Описание
id R [int] Идентификатор Заявки, которая соотвествует заданным параметрам фильтрации
fields R [collection] коллекция полей, которые вернулись в ответ на запрос
fields.{field} R [mixed] Набор полей в ответе зависит от того, какие поля были переданы в коллекцию searchFields. Типы данных и значения следует смотреть в описании соответствующих сущностей.