03-12-2018 23:59

Поиск лидов по списку идентификаторов

GET   /bs-core/main/leads/find/{ids}

Поиск лидов по списку идентификаторов, разделённых запятыми. При передаче методу параметра preserveOrder со значением true, метод возвратит лиды в JSON-файле именно в том порядке, который был передан методу. Если этот параметр не передается, то лиды возвращаются по возрастающим идентификаторам.

Запрос

GET /bs-core/main/leads/find/2484,2472,2550,2475 HTTP/1.1

или 

GET /bs-core/main/leads/find/2484,2472,2550,2475?preserveOrder=true HTTP/1.1
Описание параметров
Нет описанных параметров

Ответ


                        {
    "status": "ok",
    "timestamp": 1508837393081,
    "data": [
        {
            "id": 2472,
            "channel": "LOAN_APPLICATION",
            "naturalPerson": true,
            "firstName": "Max",
            "lastName": "Mustermann",
            "patronymic": "",
            "title": "",
            "registrationNumber": "",
            "sexId": 101251,
            "birthDate": "1977-05-22",
            "birthPlace": "",
            "birthCountryId": 101049,
            "passport": {
                "id": 101114182,
                "seria": "0782",
                "no": "078257",
                "extraNumber": null,
                "issueDate": "2012-01-23",
                "closeDate": null,
                "manager": "",
                "subdivisionCode": "",
                "complementaryDocTypeId": null
            },
            "inn": "",
            "snils": "",
            "mobilePhone": "77057223528",
            "email": "",
            "howYouKnowId": null,
            "subdivisionId": 101791,
            "relatives": [],
            "leadDebts": [],
            "managerId": 1010812,
            "creditProductId": 10133143,
            "amount": 10000,
            "period": 30,
            "periodUnit": "DAYS",
            "gettingMoneyMethodId": 102395,
            "goods": [],
            "extraFields": [],
            "storeTypeId": null,
            "cardNumber": "",
            "cardHolder": "",
            "validThruMonth": "",
            "validThruYear": "",
            "cardCvc": "",
            "employerTitle": "",
            "employerInn": "",
            "childrenCount": 0,
            "adultChildrenCount": 0,
            "dependentsCount": 0,
            "meanIncome": 0,
            "averageMonthlyCost": 0,
            "monthlyCreditPayment": 0,
            "closedCreditsCount": 0,
            "delinquencyCount": 0,
            "payedDelinquencyCount": 0,
            "writtenDelinquencyCount": 0,
            "activeCreditsCount": 0,
            "activeCreditsAmount": 0,
            "activeDelinquencyAmount": 0,
            "mobilePhoneCheck": false,
            "ipAndRegionMatch": false,
            "ipAndRegAddressMatch": false,
            "rosfinmonitoringCheck": true,
            "ufmsCheck": false,
            "approvedByScorista": false,
            "denialReasonId": null,
            "creationDate": 1507728287671,
            "storeCode": null,
            "orderCode": null,
            "ipAddress": "",
            "macAddress": "",
            "deviceTypeId": null,
            "referralLink": "",
            "currentStatus": "APPROVED",
            "currentBusinessStatus": "NEW_CONTRACT",
            "clientId": 101322764,
            "loanApplicationId": 101132226,
            "contractId": 101341619,
            "intRate": 730,
            "totalAmount": 16300,
            "totalAmountDelinq30": 16544.5,
            "addressData": {
                "id": 101268031,
                "countryId": 101042,
                "fiasId": "",
                "fullAddressText": "",
                "fiasChainText": null,
                "houseNo": "",
                "blockNo": "",
                "buildingNo": "",
                "apartmentNo": "",
                "telephone": "",
                "postalCode": "",
                "regDate": null,
                "housingType": "",
                "metroStation": "",
                "regionName": null,
                "localityName": null,
                "streetName": "",
                "oldAddressText": ""
            },
            "registrationAddressData": {
                "id": 101268032,
                "countryId": 101042,
                "fiasId": "",
                "fullAddressText": "",
                "fiasChainText": null,
                "houseNo": "",
                "blockNo": "",
                "buildingNo": "",
                "apartmentNo": "",
                "telephone": "",
                "postalCode": "",
                "regDate": null,
                "housingType": "",
                "metroStation": "",
                "regionName": null,
                "localityName": null,
                "streetName": "",
                "oldAddressText": ""
            },
            "addresses": null
        },
        {
            "id": 2484,
            "channel": "LOAN_APPLICATION",
            "naturalPerson": true,
            "firstName": "Max",
            "lastName": "Mustermann",
            "patronymic": "",
            "title": "",
            "registrationNumber": "",
            "sexId": 101251,
            "birthDate": "1977-05-22",
            "birthPlace": "",
            "birthCountryId": 101049,
            "passport": {
                "id": 101114194,
                "seria": "0782",
                "no": "078257",
                "extraNumber": null,
                "issueDate": "2012-01-23",
                "closeDate": null,
                "manager": "",
                "subdivisionCode": "",
                "complementaryDocTypeId": null
            },
            "inn": "",
            "snils": "",
            "mobilePhone": "77057223528",
            "email": "",
            "howYouKnowId": null,
            "subdivisionId": 101791,
            "relatives": [],
            "leadDebts": [],
            "managerId": 1010812,
            "creditProductId": 10133143,
            "amount": 10000,
            "period": 30,
            "periodUnit": "DAYS",
            "gettingMoneyMethodId": 102395,
            "goods": [],
            "extraFields": [],
            "storeTypeId": null,
            "cardNumber": "",
            "cardHolder": "",
            "validThruMonth": "",
            "validThruYear": "",
            "cardCvc": "",
            "employerTitle": "",
            "employerInn": "",
            "childrenCount": 0,
            "adultChildrenCount": 0,
            "dependentsCount": 0,
            "meanIncome": 0,
            "averageMonthlyCost": 0,
            "monthlyCreditPayment": 0,
            "closedCreditsCount": 0,
            "delinquencyCount": 0,
            "payedDelinquencyCount": 0,
            "writtenDelinquencyCount": 0,
            "activeCreditsCount": 0,
            "activeCreditsAmount": 0,
            "activeDelinquencyAmount": 0,
            "mobilePhoneCheck": false,
            "ipAndRegionMatch": false,
            "ipAndRegAddressMatch": false,
            "rosfinmonitoringCheck": false,
            "ufmsCheck": false,
            "approvedByScorista": false,
            "denialReasonId": null,
            "creationDate": 1507802250038,
            "storeCode": null,
            "orderCode": null,
            "ipAddress": "",
            "macAddress": "",
            "deviceTypeId": null,
            "referralLink": "",
            "currentStatus": "APPROVED",
            "currentBusinessStatus": "NEW_CONTRACT",
            "clientId": 101322764,
            "loanApplicationId": 101132238,
            "contractId": 101341627,
            "intRate": 730,
            "totalAmount": 16300,
            "totalAmountDelinq30": 16544.5,
            "addressData": {
                "id": 101268055,
                "countryId": 101042,
                "fiasId": "",
                "fullAddressText": "",
                "fiasChainText": null,
                "houseNo": "",
                "blockNo": "",
                "buildingNo": "",
                "apartmentNo": "",
                "telephone": "",
                "postalCode": "",
                "regDate": null,
                "housingType": "",
                "metroStation": "",
                "regionName": null,
                "localityName": null,
                "streetName": "",
                "oldAddressText": ""
            },
            "registrationAddressData": {
                "id": 101268056,
                "countryId": 101042,
                "fiasId": "",
                "fullAddressText": "",
                "fiasChainText": null,
                "houseNo": "",
                "blockNo": "",
                "buildingNo": "",
                "apartmentNo": "",
                "telephone": "",
                "postalCode": "",
                "regDate": null,
                "housingType": "",
                "metroStation": "",
                "regionName": null,
                "localityName": null,
                "streetName": "",
                "oldAddressText": ""
            },
            "addresses": null
        }
    ]
}
                    
Описание параметров
Параметр Обязателен Тип данных Описание
id М [int][20] Идентификатор лида
channel М [enum]

Канал поступления лида

Список каналов:

  • PRESCORE
  • GENERATOR
  • SITE
  • ECOMM
  • UNO_MOMENTO
  • LOAN_APPLICATION
naturalPerson М [bool] Физическое лицо (да/нет), по умолчанию стоит true.
firstName М [string][50] Имя
lastName М [string][50] Фамилия
patronymic М [string][50] Отчество
title М [string][500] Наименование организации (Для Юридического лица)
registrationNumber М [string][50] Регистрационный номер (ОГРН) (для лида юр.лица)
sexId М [int][20]

Пол:

  • 101251 - Мужчина
  • 101252 - Женщина
birthDate М [date] Дата рождения (YYYY-MM-DD)
birthPlace М [string][100] Место рождения
birthCountryId М [int][20] Идентификатор страны гражданства
passport М [object] Паспорт
passport.id М [int][20] Паспорт. Идентификационный номер.
passport.seria М [string][25] Паспорт серия
passport.no М [string][25] Паспорт номер
passport.extraNumber М [string][100] Дополнительный номер
passport.issueDate М [date] Дата выдачи паспорта. (YYYY-MM-DD)
passport.closeDate М [date] Дата окончания действия паспорта. (YYYY-MM-DD)
passport.manager М [string][255] Орган выдачи паспорта
passport.subdivisionCode М [string][10] Код подразделения
passport.complementaryDocTypeId М [int][20]

Идентификатор типа документа:

  • 102121 - Водительское удостоверение
  • 102122 - СНИЛС
  • 102123 - Заграничный паспорт
  • 102126 - Паспорт
  • 102127 - Другой документ
  • 102128 - Нет

В настоящее время, хотя этот параметр и присутствует, у него в паспорте будет проставляться значение null,

так как существует объект complementaryDoc который содержит параметр complementaryDocTypeId, который имеет значение (смотрите

например описание этого метода).

inn М [string][50] ИНН
snils М [string][50] СНИЛС
mobilePhone М [string][50] Указываются только цифры в международном формате 79886542301
email М [string][100] Электронная почта
howYouKnowId М [int][20]

Как вы о нас узнали:

  • 102171 - Транспорт
  • 102172 - Телевидение
  • 102173 - Газета
  • 102174 - Наружная реклама
  • 102175 - Знакомые
  • 102176 - Интернет
subdivisionId М [int][20]

Идентификатор подразделения

  • 101791 - Москва
  • 101792 - Москва - интернет
  • 101793 - Севастополь-1
  • 101794 - Красногорск
  • 101795 - Севастополь-2
  • 101798 - Седьмое
  • 1017910 - На "Посадской"
  • 101796 - Первое
  • 101797 - Второе
  • 101799 - Касса долька
relatives М [collection] Список родственников
relatives._.id М [int][20] Идентификатор родственника
relatives._.lastName М [string][50] Фамилия родственника
relatives._.firstName М [string][50] Имя родственника
relatives._.patronymic М [string][50] Отчество родственника
relatives._.resident М [bool] Резидент
relatives._.passport М [object] Паспорт родственника.
relatives._.passport._.id М [int][20] Паспорт родственника. Идентификационный номер.
relatives._.passport._.seria М [string][25] Паспорт серия родственника
relatives._.passport._.no М [string][25] Паспорт номер родственника
relatives._.passport._.extraNumber М [string][100] Дополнительный номер родственника
relatives._.passport._.issueDate М [date] Дата выдачи паспорта родственника. (YYYY-MM-DD)
relatives._.passport._.closeDate М [date] Дата окончания действия паспорта родственника. (YYYY-MM-DD)
relatives._.passport._.manager М [string][255] Орган выдачи паспорта родственника
relatives._.passport._.subdivisionCode М [string][10] Код подразделения
relatives._.passport._.complementaryDocTypeId М [int][20]

Идентификатор типа документа:

  • 102121 - Водительское удостоверение
  • 102122 - СНИЛС
  • 102123 - Заграничный паспорт
  • 102126 - Паспорт
  • 102127 - Другой документ
  • 102128 - Нет

В настоящее время, хотя этот параметр и присутствует, у него в паспорте будет проставляться значение null,

так как существует объект complementaryDoc который содержит параметр complementaryDocTypeId, который имеет значение (смотрите

например описание этого метода).

relatives._.rnn М [string][50] ИНН родственника
relatives._.telephone М [string][100] Номер телефона родственника
relatives._.email М [string][50] Электронная почта родственника
relatives._.workPlace М [string][50] Место работы родственника
relatives._.address М [string][255] Адрес родственника
relatives._.birthDate М [date] Дата рождения родственника (YYYY-MM-DD)
relatives._.collateralRelId М [int][20]

Идентификатор степени родства:

  • 102141 - Жена
  • 102142 - Муж
  • 102143 - Мама
  • 102144 - Папа
  • 102145 - Дочь
  • 102146 - Сын
  • 102147 - Брат
  • 102148 - Сестра
  • 102149 - Коллеги
  • 1021410 - Друзья
  • 1021411 - Бабушка
  • 1021412 - Дедушка
  • 1021413 - Дядя
  • 1021414 - Тетя
  • 1021415 - Иное
relatives._.verified М [bool] Верифицирован
relatives._.comments М [string][255] Комментарии по родственникам
leadDebts М [collection] Действующие кредиты и займы
leadDebts._.id М [int][20] Идентификатор действующего кредита или займа
leadDebts._.debtName М [string][200] Наименование действующего кредита или займа
leadDebts._.debtAmount М [float] Сумма действующего кредита или займа
leadDebts._.bank М [string][100] Банк действующего кредита или займа
leadDebts._.debtBankId М [int][20] Идентификатор объекта банк действующего кредита или займа
leadDebts._.remainderDebt М [float] Остаток долга действующего кредита или займа
leadDebts._.monthlyPayment М [float] Ежемесячный платеж действующего кредита или займа
leadDebts._.availabilityDelays М [string][200] Наличие просрочек действующего кредита или займа
leadDebts._.paymentPeriodicity М [string][50] Периодичность выплат действующего кредита или займа
leadDebts._.lastFactPaymentDate М [date] Дата последнего фактического платежа по действующему кредиту или займу в формате YYYY-MM-DD
leadDebts._.intRate М [float] Процентная ставка действующего кредита или займа
leadDebts._.contractNameAndDate М [string][100] Номер/Дата договора действующего кредита или займа
leadDebts._.requisites М [string][200] Реквизиты действующего кредита или займа
managerId М [int][20]

Идентификатор специалиста по займам

creditProductId М [int][20]

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

  • 101339 - Короткие займы под з/п.
  • 1013310 - Займ на год (аннуитет).
  • 1013311 - Займ на год (с распределенной ОС)(Пятак).
  • 1013312 - Остаточный с льготными траншами
  • .........
amount М [float] Сумма займа
period М [int][11] Запрашиваемый срок займа
periodUnit О [enum]

Единица измерения срока:

  • DAYS - Дни
  • MONTHS - Месяцы
  • YEARS - Годы
  • WEEKS - Недели
gettingMoneyMethodId М [int][20]

Способа получения займа

goods М [collection] Список товаров
goods._.id М [int][20] Идентификатор товара
goods._.name М [string][100] Наименование товара
goods._.article М [string][50] Артикул товара
goods._.description М [string][1024] Описание товара
goods._.quantity М [int][11] Количество товара
goods._.amount М [float] Сумма товара
extraFields М [collection] Дополнительные поля
extraFields._.id М [int][20]

Идентификатор дополнительного поля.

extraFields._.key М [string][255]

Название дополнительного поля.

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

то нужно их передать следующим образом:

  • client.field_name - для помещения поля в клиента
  • loanApplication.field_name - для помещения поля в заявку
  • contract.field_name - для помещения поля в контракт
extraFields._.value М [string][255] Значение дополнительного поля
storeTypeId М [int][20] Идентификатор категории магазина.
cardNumber М [string][25] Номер банковской карты, только цифры, без пробелов и других знаков
cardHolder М [string][75] Держатель карты (Для хранения данных карты необходимо наличие сертификата PCI DSS у клиента)
validThruMonth М [string][2] Срок действия карты месяц, формат: ММ
validThruYear М [string][2] Срок действия карты год, формат: ГГ
cardCvc М [string][10] CVC код, 3 цифры
employerTitle М [string][100] Наименование работодателя
employerInn М [string][25] ИНН работодателя.
childrenCount М [int][20] Количество детей.
adultChildrenCount М [int][20] Количество совершеннолетних детей.
dependentsCount М [int][11] Количество иждивенцев.
meanIncome М [float] Среднемесячный доход.
averageMonthlyCost М [float] Среднемесячный расходы
monthlyCreditPayment М [float] Ежемесячные платежи по кредитам
closedCreditsCount М [int][11] Количество закрытых кредитов
delinquencyCount М [int][11] Количество просрочек в прошлом
payedDelinquencyCount М [int][11] Количество закрытых просрочек
writtenDelinquencyCount М [int][11] Количество списанных просрочек
activeCreditsCount М [int][11] Количество активных кредитов
activeCreditsAmount М [float] Сумма текущей задолженности
activeDelinquencyAmount М [float] Сумма текущих просроченных платежей
mobilePhoneCheck М [bool] Флаг верификации телефона.
ipAndRegionMatch М [bool] Совпадает ли заявленный регион в фактическом адресе (адресе проживания) с IP адресом заявителя
ipAndRegAddressMatch М [bool] Совпадает ли заявленный регион в адресе регистрации с IP адресом заявителя
rosfinmonitoringCheck М [bool] Пройдена проверка Росфинмониторинг
ufmsCheck М [bool] Пройдена проверка по базе паспортов УФМС
approvedByScorista М [bool] Одобрено скорингом Scorista
denialReasonId М [int][20] Идентификатор причины отказа
creationDate М [timestamp] Дата создания лида
storeCode М [string][50] Идентификатор магазина для создания лидов.
orderCode М [string][50] Код заказа поступивший от партнеров.
ipAddress М [string][50] IP адрес
macAddress М [string][50] МАС адрес
deviceTypeId М [int][20] Идентификатор типа устройств
referralLink М [string][255] Реферальная ссылка
currentStatus М [enum]

Текущий статус лида:

  • WAITING - Ожидает
  • CHECK - Проверка
  • ROSFINMON_OK - Пройдена проверка Росфинмониторинга
  • SCORISTA_OK - Одобрено скорингом Скориста
  • CARD_CHECK_OK - пройдена проверка номера карты
  • CLIENT_CHECK_OK - Пройдена проверка клиента
  • COMPANY_CHECK_OK - Пройдена проверка компании
  • PC_CHECK_OK - Пройдена проверка компьютера
  • MOBILE_CHECK_OK - Пройдена проверка мобильного телефона
  • FMS_CHECK_OK - Пройдена проверка паспорта ФМС
  • EQUIFAX_OK - Выполнен запрос кредитной истории Equifax
  • EMAIL_CHECK_OK - Пройдена проверка e-mail адреса
  • NBKI_CHECK_OK - Пройдена проверка НБКИ
  • NBKI_SCORING_OK - Выполнен скоринг НБКИ
  • IP_CHECK_OK - Проверка по IP
  • INN_CHECK_OK - Проверка по ИНН
  • SNILS_CHECK_OK - Проверка по СНИЛС
  • PSP_SERIA_CHECK_OK - Проверка по серии паспорта
  • PSP_NO_CHECK_OK - Проверка по номеру паспорта
  • BIRTHDATE_CHECK_OK - Проверка по дате рождения
  • CONSOLIDATION_OK - Выполнена консолидация лида с данными клиента
  • INNER_SCORING_OK - Одобрено внутренним скорингом
  • CLIENT_SNILS_CHECK_OK - Проверка клиента по СНИЛС
  • DRIVING_LICENSE_CHECK_OK - Проверка водительского удостоверения
  • FSSP_DEBT_CHECK_OK - Проверка суммы задолженности по сайту ФССП
  • TAX_DEBT_CHECK_OK - Проверка суммы задолженности по налогам
  • BANKRUPTCY_CHECK_OK - Проверка "Банкротных" дел
  • DISQUALIFIED_PERSON_CHECK_OK - Проверка списка дисквалифицированных лиц
  • BANK_BLACKLIST_CHECK_OK - Проверка клиента в ЧС банка
  • FINANCIAL_POSITION_CHECK_OK - Проверка финансового положения клиента
  • PYRUS_CHECK_OK - Проверка Pyrus
  • APPROVED - Одобрено
  • DENIED - Отказано
  • UNDEFINED - Не определено
  • TIMEOUT - Таймаут (при проверке лида)
  • CLIENT_REFUSAL - Отказ клиента
  • VALIDATION_ERROR - Ошибка валидации
  • TECH_FAULT - Технический сбой
  • CONTRACT - Прошла выдача
currentBusinessStatus М [enum]

Текущий бизнес-статус лида:

  • NEW_LEAD - Новый лид
  • AUTO_CHECK - Автоматическая проверка
  • MANUAL_CHECK - Ручная верификация
  • FAILED - Неуспех (отказ по заявке, отказ клиента, таймаут, тех.ошибка и т.п.)
  • NEW_CONTRACT - Новый контракт
  • CONTRACT_FOR_ISSUE - Контракт согласован (К выдаче)
  • CONTRACT_ISSUED - Контракт выдан
  • CONTRACT_CLOSED - Контракт закрыт
clientId М [int][20] Ссылка на клиента (либо созданного по лиду, либо найденного из существующих)
loanApplicationId М [int][20] Идентификатор заявки (Если заполнен, значит по лиду создана заявка)
contractId М [int][20] Идентификатор контракта (Если заполнен, значит по лиду создан контракт)
intRate М [float] Процентная ставка
totalAmount М [float] Общая сумма с процентами
totalAmountDelinq30 М [float] Общая сумма с процентами и штрафами (в случае просрочки 30 дней)
addressData М [object]

Адрес проживания (для юр.лиц Фактический адрес).

При добавлении адреса в систему Brainysoft можно использовать один из двух вариантов:

  1. Заполнить только поля fullAddressText(вписать сюда полный адрес) и fiasId(код фиас, которых соответствует fullAddressText), остальные поля адреса ( countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName ) будут заполнены автоматически
  2. Заполнить поля адреса: countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName

Вариант 1 является предпочтительным.

addressData.id М [int][20] Идентификатор адреса проживания.
addressData.countryId М [int][20] Идентификатор страны проживания.
addressData.fiasId М [string][50] Код ФИАС (уровня улицы).
addressData.fullAddressText М [string][1024] Строка адреса ФИАС.
addressData.fiasChainText М [string][2048] Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
addressData.houseNo М [string][15] Номер дома.
addressData.blockNo М [string][15] Номер корпуса.
addressData.buildingNo М [string][15] Номер строения.
addressData.apartmentNo М [string][25] Номер квартиры.
addressData.telephone М [string][50] Стационарный номер телефона.
addressData.postalCode М [string][25] Почтовый индекс.
addressData.regDate М [date] Дата регистрации (YYYY-MM-DD).
addressData.housingType М [string][100] Тип жилья
addressData.metroStation М [string][100] Ближайшая станция метро.
addressData.regionName М [string][50] Название региона
addressData.localityName М [string][75] Название города.
addressData.streetName М [string][75] Название улицы.
addressData.oldAddressText М [string][1024] Строка адреса введенная вручную (не актуальный адрес как в паспорте)
registrationAddressData М [object]

Адрес прописки (для юр.лиц Юридический адрес).

При добавлении адреса в систему Brainysoft можно использовать один из двух вариантов:

  1. Заполнить только поля fullAddressText(вписать сюда полный адрес) и fiasId(код фиас, которых соответствует fullAddressText), остальные поля адреса ( countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName ) будут заполнены автоматически
  2. Заполнить поля адреса: countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName

Вариант 1 является предпочтительным.

registrationAddressData.id М [int][20] Идентификатор адреса проживания.
registrationAddressData.countryId М [int][20] Идентификатор страны проживания.
registrationAddressData.fiasId М [string][50] Код ФИАС (уровня улицы).
registrationAddressData.fullAddressText М [string][1024] Строка адреса ФИАС.
registrationAddressData.fiasChainText М [string][2048] Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
registrationAddressData.houseNo М [string][15] Номер дома.
registrationAddressData.blockNo М [string][15] Номер корпуса.
registrationAddressData.buildingNo М [string][15] Номер строения.
registrationAddressData.apartmentNo М [string][25] Номер квартиры.
registrationAddressData.telephone М [string][50] Стационарный номер телефона.
registrationAddressData.postalCode М [string][25] Почтовый индекс.
registrationAddressData.regDate М [date] Дата регистрации (YYYY-MM-DD).
registrationAddressData.housingType М [string][100] Тип жилья
registrationAddressData.metroStation М [string][100] Ближайшая станция метро.
registrationAddressData.regionName М [string][50] Название региона
registrationAddressData.localityName М [string][75] Название города.
registrationAddressData.streetName М [string][75] Название улицы.
registrationAddressData.oldAddressText М [string][1024] Строка адреса введенная вручную (не актуальный адрес как в паспорте)
addresses М [collection]

Коллекция привязанных дополнительных адресов.
В дополнительных адресах все свойства совпадают с основными адресами.

 

При добавлении адреса в систему Brainysoft можно использовать один из двух вариантов:

  1. Заполнить только поля fullAddressText(вписать сюда полный адрес) и fiasId(код фиас, которых соответствует fullAddressText), остальные поля адреса ( countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName ) будут заполнены автоматически
  2. Заполнить поля адреса: countryId, houseNo, blockNo(опционально), buildingNo(опционально), apartmentNo(опционально), postalCode, regionName, localityName, streetName

Вариант 1 является предпочтительным.

addresses._.id М [int][20] Идентификатор адреса.
addresses._.countryId М [int][20] Идентификатор страны.
addresses._.fiasId М [string][50] Код ФИАС (уровня улицы).
addresses._.fullAddressText М [string][1024] Строка адреса ФИАС.
addresses._.fiasChainText М [string][2048] Цепочка адреса в формате JSON (временно, пока не будет реализован поиск адреса в ФИАСе по Id).
addresses._.houseNo М [string][15] Номер дома.
addresses._.blockNo М [string][15] Номер корпуса.
addresses._.buildingNo М [string][15] Номер строения.
addresses._.apartmentNo М [string][25] Номер квартиры.
addresses._.telephone М [string][50] Стационарный номер телефона.
addresses._.postalCode М [string][25] Почтовый индекс.
addresses._.regDate М [date] Дата регистрации (YYYY-MM-DD).
addresses._.housingType М [string][100] Тип жилья
addresses._.metroStation М [string][100] Ближайшая станция метро.
addresses._.regionName М [string][50] Название региона
addresses._.localityName М [string][75] Название города.
addresses._.streetName О [string][300]

Название улицы.

addresses._.oldAddressText М [string][1024] Строка адреса введенная вручную (не актуальный адрес как в паспорте)
addresses._.purposeId М [int][20] Назначение адреса (регистрации, места работы итп.)