03-12-2018 23:59

Получение полей сущности для фильтрации кредитных отчетов

GET   /bs-core/reports/filters/credit-fields/{entityItem}

Метод позволяет получить поля сущности необходимых для фильтрации кредитных отчётов.

Запрос

GET /bs-core/reports/filters/credit-fields/com.pq.establ.dict.Client HTTP/1.1
Описание параметров
Параметр Обязателен Тип данных Описание
entityItem R [string]

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

Ответ


                        {
  "status": "ok",
  "timestamp": 1462927376455,
  "data": [
    {
      "object": "lastName",
      "label": "Фамилия",
      "type": "STRING",
      "singleValue": true
    },
    {
      "object": "firstName",
      "label": "Имя",
      "type": "STRING",
      "singleValue": true
    },
    {
      "object": "patronymic",
      "label": "Отчество",
      "type": "STRING",
      "singleValue": true
    },
    {
      "object": "naturalperson",
      "label": "Физ лицо",
      "type": "BOOLEAN",
      "singleValue": true
    },
    {
      "object": "title",
      "label": "Наименование",
      "type": "STRING",
      "singleValue": true
    },
    {
      "object": "sex",
      "label": "Пол",
      "type": "ENUM",
      "singleValue": true
    },
    {
      "object": "birthDate",
      "label": "Дата рождения",
      "type": "DATE",
      "singleValue": false
    },
    {
      "object": "birthCountry",
      "label": "Гражданство",
      "type": "DICTIONARY",
      "singleValue": true
    },
    {
      "object": "education",
      "label": "Образование",
      "type": "DICTIONARY",
      "singleValue": true
    },
    {
      "object": "profession",
      "label": "Профессия",
      "type": "DICTIONARY",
      "singleValue": true
    },
    {
      "object": "maritalStatus",
      "label": "Семейное положение",
      "type": "ENUM",
      "singleValue": true
    },
    {
      "object": "creditOfficer",
      "label": "Специалист по займам",
      "type": "DICTIONARY",
      "singleValue": true
    },
    {
      "object": "createSubdivision",
      "label": "Создан в подразделении",
      "type": "DICTIONARY",
      "singleValue": true
    },
    {
      "object": "manager",
      "label": "Менеджер по работе с клиентом",
      "type": "DICTIONARY",
      "singleValue": true
    }
  ]
}
                    
Описание параметров
Параметр Обязателен Тип данных Описание
object О [string]

Значение поля запрашиваемой сущности. Это значение нужно передавать в фильтрах в поле "field" например в отчетах "Активные займы".

label О [string]

Наименование поля запрашиваемой сущности. Значение самого поля указано в поле "object". 

type О [string]

Тип данных запрашиваемой сущности. Если значения этого поля "ENUM" или "DICTIONARY", то в методах использующих фильтры, нужно передавать идентификатор элемента справочника или энумератора ("ENUM"). В качестве примера можете посмотреть описание параметра "value1" метода "Активные займы". Параметр "value2" при этих значениях в таких методах не передатся. 

singleValue О [bool]

Это поле принимает значение true или false. Это поле определяет то, принимает ли сущность (object) одно значение или несколько.  Для лучшего понимания, смотрите примеры в методах "Получение полей сущности для ...", а также методы, использующие фильтры, смотрите описание параметров "value1", "value2" (например "Активные займы"). Если стоит значение false, то в методах, использующих фильтры нужно передавать значения и в параметре "value1" и "value2". Иначе передается только значение в параметре "value1".

Например:  

      {
            "object": "birthDate",
            "label": "Дата рождения",
            "type": "DATE",
            "singleValue": false
        } 

значение параметра  "singleValue": false, следовательно в методах использующих фильтры для фильтрации по полю birthDate передаем наример:

  {
    "entity": "com.pq.establ.dict.Client",
    "field": "birthDate",
    "value1": "1890-01-01",
    "value2": "2000-11-28"
  }