---
swagger: "2.0"
info:
  x-ibm-name: gbdrn-report303
  title: GbdrnReport303 API
  version: 1.0.0
  description: Сервис выдачи справки о зарегистрированных правах (обременениях) на
    недвижимое имущество и его технических характеристиках ЮЛ
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/gbdrn-report303
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:
  /send:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/DataResponseShortInfoDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: Not Found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: Different errors
          schema:
            $ref: '#/definitions/FailureResponse'
      operationId: SendRequest
      summary: Получить информацию о недвижимости ЮЛ
    parameters:
    - name: RequestBody
      required: true
      in: body
      schema:
        $ref: '#/definitions/RequestDto'
    - $ref: '#/parameters/xib-trace-id'
  /check-status/{bin}/{correlationId}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/StatusResponse'
      parameters:
      - name: correlationId
        type: string
        required: true
        in: path
        description: Идентификатор цепочки сообщения в системе получателя запроса
      - name: bin
        type: string
        required: true
        in: path
        description: БИН
      operationId: CheckStatus
    parameters:
    - $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
  OrganizationRequisitesTypeDto:
    type: object
    properties:
      name:
        type: string
        description: Название ЮЛ на русс
      nameKz:
        type: string
        description: Название ЮЛ на каз
      rnn:
        type: string
        description: РНН
      bin:
        type: string
        description: БИН ЮЛ
      registrationNumber:
        type: string
      organizationFormId:
        type: string
  OwnerShortDto:
    type: object
    properties:
      lastName:
        type: string
      firstName:
        type: string
      middleName:
        type: string
  RealEstateObjectAddressTypeDto:
    type: object
    properties:
      arCode:
        type: string
      streetCode:
        type: string
      conStreetCode:
        type: string
      cooperativeCode:
        type: string
      building:
        type: string
      corpus:
        type: string
      flat:
        type: string
      addrStr:
        type: string
  RegistredRightsOrganizationRequestDto:
    type: object
    properties:
      owner:
        $ref: '#/definitions/OrganizationRequisitesTypeDto'
        description: Собственник
      ownerShort:
        $ref: '#/definitions/OwnerShortDto'
        description: Собственник крат.
      objectType:
        type: string
        description: Вид объекта недвижимости
      objectLocation:
        $ref: '#/definitions/RealEstateObjectAddressTypeDto'
        description: Код РК
      cadastralNumber:
        type: string
        description: Кадастровый номер
      language:
        type: string
        enum:
        - RU
        - KZ
        - ALL
        description: Язык запроса
  RequestDto:
    type: object
    properties:
      requestNumber:
        type: string
      declarantId:
        type: string
      requestDate:
        type: string
        format: date-time
      registredRightsOrganizationRequest:
        $ref: '#/definitions/RegistredRightsOrganizationRequestDto'
  DataResponseShortInfoDto:
    type: object
    properties:
      messageId:
        type: string
        description: Идентификатор сообщения в системе получателя (заполняет система
          получателя запроса (система отрабатывающая сообщение)
        example: "415810776"
      correlationId:
        type: string
        description: 'Идентификатор цепочки сообщения в системе получателя запроса '
        example: "4344354"
      statusCode:
        type: string
        description: 'Код статуса (проставляется системой получателя запроса). Примеры:
          ''SCSS001'' для успешной обработки, ''SCE001'' - ''SCE007'' для различных
          ошибок. Обратите внимание, что коды ошибок начиная с ''SCE001'' предназначены
          для синхронного канала'
        example: SCSS001
      statusMessage:
        type: string
        description: 'Сообщение о статусе. Примеры: ''Сервис отработал штатно'' -
          для успешной обработки, ''Сообщение не соответствует формату'', ''Неправильный
          логин или пароль'', ''Пользователь не имеет прав на сервис'', ''Сервис не
          существует'', ''Транспортная подпись не актуальная'', ''Не верная транспортная
          подпись'', ''Сообщение не подписано'' - для ошибок синхронного канала'
        example: Сервис отработал штатно
      sessionId:
        type: string
        description: Идентификатор сессии на ВШЭП. Устанавливается на ВШЭП. При отправки
          ответа системой получателя запроса заполнять не нужно.
        example: '{7a53f7b3-6d2b-4be3-9682-8d19e5a1c0e6}'
  StatusResponse:
    properties:
      correlationId:
        type: string
        description: Идентификатор корреляции
      messageType:
        type: string
        description: 'Тип сообщения: (NOTIFICATION | RESPONSE)'
      rawData:
        type: string
        description: XML ответ от ГО
      data:
        type: string
        description: JSON ответ в зависимости от сервиса
      status:
        type: string
        description: Статус ответа (SUCCESS | FAILURE)
      statusMessage:
        type: string
        description: описание статуса ответа
    additionalProperties: false
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
...