---
swagger: "2.0"
info:
  x-ibm-name: eds-scandoc-upload
  title: EDS_SCANDOC_UPLOAD API
  version: 1.0.0
  description: Сервис для загрузки сканированных документов в подсистему ЕХЭД
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/eds-scandoc-upload
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/ResponseDto'
        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'
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
  DocumentUserInfoDto:
    title: Информация о пользователе документа
    required:
    - accessType
    - userId
    type: object
    properties:
      userId:
        type: string
        description: Идентификатор пользователя
      accessType:
        type: string
        description: Тип доступа пользователя
        enum:
        - READ_ONLY
        - EDIT
        - OWNER
      expirationDateTime:
        type: string
        description: Дата и время окончания действия доступа
        format: date-time
      expirationTimeout:
        type: integer
        description: Время в миллисекундах, по истечении которого доступ будет закрыт
        format: int64
    description: Информация о пользователях
  FileInfoDto:
    title: Содержимое файла и его порядковый номер; порядковый номер используется,
      если загружается набор изображений
    required:
    - content
    type: object
    properties:
      orderNum:
        title: Порядковый номер, для сортировки
        type: integer
        format: int32
      content:
        type: array
        items:
          type: string
          format: byte
    description: Файлы, загружаемые в модуль сканированных документов
  PropertiesDto:
    title: Свойства
    type: object
    properties:
      properties:
        type: array
        description: Элементы
        items:
          $ref: '#/definitions/PropertyDto'
    description: Мета информация документа. Код метаинформации сохраняется в Property.key
  PropertyDto:
    title: Свойство
    required:
    - key
    - value
    type: object
    properties:
      key:
        type: string
        description: Ключ
      value:
        type: string
        description: Значение
    description: Элементы
  RequestDto:
    title: Данные запроса на загрузку документа
    required:
    - documentType
    - files
    - uploadType
    - userId
    type: object
    properties:
      userId:
        type: string
        description: Идентификатор пользователя, осуществляющего операцию
      documentId:
        type: string
        description: Идентификатор документа - заполняется, если загружается новая
          версия существующего документа
      files:
        type: array
        description: Файлы, загружаемые в модуль сканированных документов
        items:
          $ref: '#/definitions/FileInfoDto'
      documentName:
        type: string
        description: Название документа
      documentType:
        type: string
        description: Код типа документа
      meta:
        $ref: '#/definitions/PropertiesDto'
      categories:
        type: array
        description: Коды категорий документа
        items:
          type: string
          description: Коды категорий документа
      userInfos:
        type: array
        description: Информация о пользователях
        items:
          $ref: '#/definitions/DocumentUserInfoDto'
      uploadType:
        type: string
        description: |-
          Тип загрузки:
          SINGLE - один файл любого типа
          PICTURES - несколько изображений формата "bmp", "jpeg", "png", "gif"; при загрузке склеиваются в pdf-файл
        enum:
        - SINGLE
        - PICTURES
  ProcessStatusDto:
    title: Статус
    type: object
    properties:
      code:
        type: string
        description: Код статуса
      status:
        type: string
        description: Текст статуса
      message:
        type: string
        description: Детальное сообщение
    description: Статус процесса
  ResponseDto:
    title: Результат загрузки документа
    type: object
    properties:
      processStatus:
        $ref: '#/definitions/ProcessStatusDto'
      documentId:
        type: string
        description: Идентификатор документа
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
...