27-09-2019 10:41

Поиск по клиентам

POST   /bs-core/main/clients/partial-load

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

Запрос

POST /bs-core/main/clients/partial-load
{       
	"fields": [
        "firstName",
        "patronymic",
        "birthDate",
        "birthPlace",
        "registrationNumber.manager"
        
        ],
        "orderBy": "birthDate",
        "orderDirection": "DESC",
        "orderByFields": [
        { "field": "creationDate" },
        { "field": "id", "direction": "desc" }
        ],
        "searchFields": [
        {
            "field": "creationDate",
            "value": ">=2017-09-11 00:00:00"
        },
        {
            "field": "birthDate",
            "value": ">=1986-09-11 00:00:00"
        }
    ],
    "countFrom": 0,
    "countTo": 10
}
Описание параметров
Параметр Обязателен Тип данных Описание
fields М [collection] Коллекция полей, которые должны вернуться в результатах поиска.
fields.{fieldName} М [string][255]

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

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

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

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

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

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

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

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

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

orderByFields М [collection]

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

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

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

searchFields М [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": "sex.id",
           "value": "101251"
       },

      {
           "field": "lastName",
           "value": "Иван%",
           "ornumber": "
1",
       },

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

Пример 2

      {
           "field": "lastName",
           "value": "Иван%",
           "ornumber": "
1",
       },

     {
           "field": "firstName",
           "value": "Иван%",
           "ornumber": "
1",
       },

    {
           "field": "maritalStatus.id",
           "value": "101151",
           "ornumber": "
2",
       },

     {
           "field": "maritalStatus.id",
           "value": "101152",
           "ornumber": "
2",
       },

 В  выражении языка SQL : (lastName like "Иван%" OR firstName like "Иван%) AND (maritalStatus.id = 101151 OR maritalStatus.id = 101152)

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

Ответ


                        {
    "status": "ok",
    "timestamp": 1505736027016,
    "data": [
        {
            "id": 101322759,
            "fields": {
                "firstName": "Катерина",
                "patronymic": "Юрьевна",
                "birthDate": "1992-02-14",
                "birthPlace": "г. Шахрисабз",
                "registrationNumber.manager": ""
            }
        },
        {
            "id": 101322757,
            "fields": {
                "firstName": "тест",
                "patronymic": "мониторинг",
                "birthDate": "1991-09-13",
                "birthPlace": "",
                "registrationNumber.manager": ""
            }
        }
    ]
}
                    
Описание параметров
Параметр Обязателен Тип данных Описание
id М [int] Идентификатор Клиента, который соотвествует заданным параметрам фильтрации
fields М [collection] коллекция полей, которые вернулись в ответ на запрос
fields.{field} М [mixed] Набор полей в ответе зависит от того, какие поля были переданы в коллекцию searchFields. Типы данных и значения следует смотреть в описании соответствующих сущностей.