---
swagger: "2.0"
info:
  x-ibm-name: gbdrn-technical-data
  title: GbdrnTechnicalData API
  version: 1.0.0
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
  description: Предоставление сведений по техническим характеристикам первичного/вторичного
    объекта недвижимости из ГБД РН
schemes:
- https
basePath: /v1/gbdrn-technical-data
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  Authorization:
    type: oauth2
    description: Токен аутентификации, полученный при вызове сервиса авторизации
    flow: application
    scopes:
      bcc.application.govtech.api: Allow access to Goventment Services API
    tokenUrl: https://api.bcc.kz/bcc/production/v2/oauth/token
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /{idn}:
    post:
      responses:
        200:
          description: 200 OK
        400:
          description: 400 Bad Request
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: 404 Not Found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: 500 Internal Server Error
          schema:
            $ref: '#/definitions/FailureResponse'
      parameters:
      - name: idn
        type: string
        required: true
        in: path
        description: ИИН/БИН владельца НИ
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/Request'
        description: Тело запроса
      - $ref: '#/parameters/xib-trace-id'
definitions:
  FailureResponse:
    type: object
    properties:
      timestamp:
        type: string
        format: date-time
      error:
        type: string
      violations:
        type: array
        items:
          $ref: '#/definitions/Violation'
  Violation:
    type: object
    properties:
      name:
        type: string
      message:
        type: string
  Request:
    title: Тип, описывающий бизнес-данные запроса
    properties:
      cadastral:
        type: string
        description: Кадастровый номер объекта недвижимости
      address:
        description: Адрес объекта недвижимости
        $ref: '#/definitions/AddressRequest'
      objectTypeCode:
        type: string
        description: Код вида объекта недвижимости (1-Земельный участок, 3-Первичный
          объект, 4-Вторичный объект, 7-Гараж, 16-Дача)
    additionalProperties: false
    required:
    - objectTypeCode
    - address
  AddressRequest:
    properties:
      rka:
        type: string
        description: RKA
      streetCode:
        type: string
        description: StreetCode
      building:
        type: string
        description: Building
      corpus:
        type: string
        description: Corpus
      block:
        type: string
        description: Block
      flat:
        type: string
        description: Flat
    additionalProperties: false
    description: Адрес объекта недвижимости (Если у адреса нет РКА и нет номера дома,
      то нужно задать кадастровый номер)
    required:
    - streetCode
    - building
  GbdrnTechnicalDataResponseDto:
    title: Тип, описывающий бизнес-данные ответа
    type: object
    properties:
      result:
        $ref: '#/definitions/DictionaryTypeDto'
      technicalData:
        title: Технические характеристики найденных объектов недвижимости
        type: array
        items:
          $ref: '#/definitions/TechnicalDataTypeDto'
  DictionaryTypeDto:
    title: Тип, описывающий справочные значения
    type: object
    properties:
      code:
        title: Код
        type: string
      nameKz:
        title: Значение на государственном языке
        type: string
      nameRu:
        title: Значение на русском языке
        type: string
  TechnicalDataTypeDto:
    title: Тип, описывающий технические характеристики объекта недвижимости
    type: object
    properties:
      objectId:
        title: Уникальный идентификатор объекта недвижимости
        type: string
      address:
        $ref: '#/definitions/AddressResponseTypeDto'
      cadastral:
        title: Кадастровый номер объекта недвижимости
        type: string
      objectKind:
        $ref: '#/definitions/DictionaryTypeDto'
      objectType:
        $ref: '#/definitions/DictionaryTypeDto'
      functionalPurpose:
        $ref: '#/definitions/DictionaryTypeDto'
      descriptionPurposeKz:
        title: Описание целевого назначение на государственном языке
        type: string
      descriptionPurposeRu:
        title: Описание целевого назначение на русском языке
        type: string
      condominium:
        title: Кондоминиум?
        type: boolean
      countOfCondominiumFlats:
        title: Количество вторичных объектов (квартир, нежилых помещений), входящих
          в состав кондоминиума
        type: integer
      objectClose:
        title: Объект недвижимости утратил силу (признак закрытия)?
        type: boolean
      totalArea:
        title: Общая площадь
        type: number
      livingArea:
        title: Жилая площадь
        type: number
      usableArea:
        title: Полезная площадь
        type: number
      ceilingHeight:
        title: Высота потолков
        type: number
      countOfFlats:
        title: Количество вторичных объектов в МЖД
        type: integer
      countOfRooms:
        title: Количество помещений, комнат
        type: integer
      storeys:
        title: Описание этажности
        type: string
      wallMaterial:
        $ref: '#/definitions/DictionaryTypeDto'
      foundationMaterial:
        $ref: '#/definitions/DictionaryTypeDto'
      roofMaterial:
        $ref: '#/definitions/DictionaryTypeDto'
      yearBuild:
        title: Год постройки
        type: integer
      wear:
        title: Износ в процентах
        type: number
      specifications:
        $ref: '#/definitions/SpecificationsTypeDto'
  SpecificationsTypeDto:
    title: Тип, описывающий характеристики благоустройств из технического паспорта
    type: object
    properties:
      electricStove:
        title: Наличие электрической плиты
        type: boolean
        default: false
      gas:
        title: Наличие сетевого газа
        type: boolean
        default: false
      heatingTEC:
        title: Наличие отопления от ТЭЦ
        type: integer
        description: 0-Нет, 1-Газ, 2-Твердое топливо, 3-Жидкое топливо, 4-Электрическое
      heatingStove:
        title: Наличие печного отопления
        type: integer
        description: 0-Нет, 1-Газ, 2-Твердое топливо, 3-Жидкое топливо, 4-Электрическое
      heatingIndividual:
        title: Наличие отопления от индивидуальной установки
        type: integer
        description: 0-Нет, 1-Газ, 2-Твердое топливо, 3-Жидкое топливо, 4-Электрическое
      waterHot:
        title: Наличие горячего водоснабжения
        type: boolean
        default: false
      waterHotIndividual:
        title: Наличие горячего водоснабжения от индивидуальных водонагревателей
        type: boolean
        default: false
      water:
        title: Наличие водопровода
        type: boolean
        default: false
      sewerage:
        title: Наличие канализации
        type: boolean
        default: false
      bathroom:
        title: Наличие ванны или душа
        type: boolean
        default: false
  AddressResponseTypeDto:
    title: Тип, описывающий сведения об адресе для ответа
    type: object
    properties:
      rka:
        title: Код адресного ресурса
        type: string
      kato:
        title: Код КАТО
        type: string
      state:
        $ref: '#/definitions/ATEToponymTypeDto'
      districtState:
        $ref: '#/definitions/ATEToponymTypeDto'
      ruralDistrict:
        $ref: '#/definitions/ATEToponymTypeDto'
      districtCity:
        $ref: '#/definitions/ATEToponymTypeDto'
      toponyms:
        title: Улицы (объединения) в порядке следования
        type: array
        items:
          $ref: '#/definitions/ATEToponymTypeDto'
      building:
        title: Номер строения
        type: string
      corpus:
        title: Номер корпуса
        type: string
      block:
        title: Номер блока
        type: string
      flat:
        title: Номер квартиры (помещения)
        type: string
      descriptionLocation:
        title: Описание местоположения
        type: string
      addressKz:
        title: Адресная строка на казахском языке
        type: string
      addressRu:
        title: Адресная строка на русском языке
        type: string
  ATEToponymTypeDto:
    title: Тип, описывающий сведения об АТЕ или топониме (геониме)
    type: object
    properties:
      code:
        title: Код по справочнику ГБД РН
        type: string
      codeAR:
        title: Код по справочнику ИС АР
        type: string
      nameKz:
        title: Наименование на государственном языке
        type: string
      nameRu:
        title: Наименование на русском языке
        type: string
      typeCode:
        title: Код типа элемента АТЕ (топонима)
        type: string
      typeNameKz:
        title: Название типа элемента АТЕ (топонима) на государственном языке
        type: string
      typeNameRu:
        title: Название типа элемента АТЕ (топонима) на русском языке
        type: string
      typeShortNameKz:
        title: Сокращенное название типа элемента АТЕ (топонима) на государственном
          языке
        type: string
      typeShortNameRu:
        title: Сокращенное название типа элемента АТЕ (топонима) на русском языке
        type: string
tags: []
security:
- Authorization:
  - bcc.application.govtech.api
parameters:
  xib-trace-id:
    name: xib-trace-id
    type: string
    required: true
    in: header
    description: Уникальный идентификатор запроса
x-ibm-endpoints:
- endpointUrl: https://api.bcc.kz:10443/bcc/production
  description: Альтернативная точка подключения для вызова сервиса в продуктивной
    среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в
    режиме "PRODUCTION"
  type:
  - production
  - development
- endpointUrl: https://api.bcc.kz/bcc/production
  description: Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
  type:
  - production
- endpointUrl: https://api-test.bcc.kz/bcc/production
  description: Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
  type:
  - development
...