abit-rest.yml

swagger: '2.0'
info:
  version: '0.0.1'
  title: 'Abiturient Online mobile API'
host: 'api.abit.herzen.spb.ru'
basePath: /
schemes:
 - https
produces:
 - application/json
consumes:
 - application/json
securityDefinitions:
  token:
    type: apiKey
    in: header
    name: api_key
security:
  - token: []
paths:
 # Authorization
  /login:
    post:
      tags: ['Authorization']
      description: Вход в систему
      parameters:
        - name: auth_data
          in: body
          description: "Логин и пароль"
          required: true
          schema:
            type: object
            properties:
              username:
                type: string
              password:
                type: string
      responses:
        200:
          description: Успешный вход в систему
          schema:
            type: object
            properties:
              token:
                type: string
                description: Универсальный uuid сессии
        401:
          description: Ошибка при входе
          schema:
            $ref: '#/definitions/Status'
  /logoff:
    get:
      tags: ['Authorization']
      description: Покинуть систему в систему
      responses:
        200:
          description: Успешно покинули систему
          schema:
            $ref: '#/definitions/Status'
  # Dicts
  /grades:
    get:
      tags: ['Dict']
      description: Получить словарь уровней образования (бакалавриват и т.д.)
      responses:
        200:
          description: Получен словарь уровней образования
          schema:
            type: array
            items:
              $ref: '#/definitions/DictItem'
  /forms:
    get:
      tags: ['Dict']
      description: Получить словарь форм образоваения (очная и т.д.)
      responses:
        200:
          description: Получен словарь форм образоваения
          schema:
            type: array
            items:
              $ref: '#/definitions/DictItem'
  /financing:
    get:
      tags: ['Dict']
      description: Получить словарь форм финансирования (бюджет и т.д.)
      responses:
        200:
          description: Получен словарь форм финансирования
          schema:
            type: array
            items:
              $ref: '#/definitions/DictItem'
  /departments:
    get:
      tags: ['Dict']
      description: Получить словарь факультетов (Факультет Информационных Технологий и т.д.)
      responses:
        200:
          description: Получен словарь факультетов
          schema:
            type: array
            items:
              $ref: '#/definitions/DictItem'
  # Competitive group
  /cg/list/{grade}/{department}:
    get:
      tags: ['Competitive Group']
      description: Получить информацию о конкурсных группах для уровня образования и факультета
      parameters:
        - name: grade
          description: id уровня образования из словаря
          in: path
          type: number
          required: true
        - name: department
          description: id факультета из словаря
          in: path
          type: number
          required: true
      responses:
        200:
          description: Получена информация о конкурсных группах
          schema:
            $ref: '#/definitions/FFGroup'
  /cg/get/{cgid}:
    get:
      tags: ['Competitive Group']
      description: Получить информацию о конкурсной группе с данным id
      parameters:
        - name: cgid
          description: id конкурсной группы
          in: path
          type: number
          required: true
      responses:
        200:
          description: Получена информация о конкурсной группе
          schema:
            $ref: '#/definitions/CompetitionGroup'
  # /cg/remove/{cgid}:
  #   get:
  #     parameters:
  #       - name: cgid
  #         description: id конкурсной группы
  #         in: path
  #         type: number
  #         required: true
  #     responses:
  #       200:
  #         description: Удаление выбранной конкурсной группы
  #         schema:
  #           $ref: '#/definitions/Status'
  /applications/{cgid}:
    get:
      tags: ['Application']
      parameters:
        - name: cgid
          description: id конкурсной группы
          in: path
          type: number
          required: true
      responses:
        200:
          description: Список заявлений на поступление для данной конкурсной группы
          schema:
            type: array
            items:
              $ref: '#/definitions/Application'
  /personal_data:
    get:
      description: Запрос информации о текущем авторизованом пользователе
      tags: ['Personal Data']
      responses:
        200:
          description: Выдана информация о текущем пользователе
          schema:
            $ref: '#/definitions/PersonalData'
        404:
          description: Информация текущем пользователе не найдена в источнике
          schema:
            $ref: '#/definitions/Status'
#    post:
#      tags: ['Personal Data']
#      responses:
#        200:
#          description: Данные обновлены
#          schema:
#            $ref: '#/definitions/Status'
definitions:
  DictItem:
    type: object
    properties:
      id:
        type: number
        description: id записи в словоре
      name:
        type: string
        description: Имя записи в словоре
  Application:
    type: object
    properties:
      login:
        type: string
      fio:
        type: string
      score:
        type: number
      # cond:
      #   type: number
      # candidate:
      #   type: boolean
      # status:
      #   type: number
      # same:
      #   type: boolean
      # original:
      #   type: boolean
      # priority:
      #   type: number
      # rating:
      #   type: number
  FFGroup:
    type: array
    items:
      type: object
      properties:
        financing:
          type: number
          description: id формы финансирования
        form:
          type: number
          description: id формы образоваения
        groups:
          type: array
          description: Список конкурсных групп
          items:
            $ref: '#/definitions/CompetitionGroup'
  CompetitionGroup:
    type: object
    properties:
      id:
        type: number
        description: id конкурсной группы
      num:
        type: string
        description: Номер конкурсной группы
      name:
        type: string
        description: Имя конкурсной группы
      profile:
        type: string
        description: Название профиля конкурсной группы
      financing:
        type: number
        description: id формы финансирования
      form:
        type: number
        description: id формы образоваения
  PersonalData:
    type: object
    properties:
     # scenario:
      #   type: string
      # date_issue_document:
      #   type: string
      # need_hostel:
      #   type: string
      # region:
      #   type: string
      # olympiad:
      #   type: boolean
      # phone:
      #   type: string
       gender:
         type: string
      # form_edu:
      #   type: string
      # level_edu:
      #   type: string
      firstname:
        description: Имя абитуриента
        type: string
      middlename:
        description: Отчество абитуриента
        type: string
      lastname:
        description: Фамилия абитуриента
        type: string
      # birthdate:
      #   type: string
      # email:
      #   type: string
      # room:
      #   type: string
      # country:
      #   type: string
      # citizenship:
      #   type: string
      # region_edu:
      #   type: string
      document_type:
        description: Тип документа, удостоверяющего личность
        type: string
      series_document:
        description: Серия документа, удостоверяющего личность
        type: string
      number_document:
        description: Номер документа, удостоверяющего личность
        type: string
      # address:
      #   type: string
      # locality:
      #   type: string
      # year_end_edu:
      #   type: string
      type_document_edu:
        description: Тип документа об образовании
        type: string
      series_document_edu:
        description: Серия документа об образовании
        type: string
      number_document_edu:
        description: Номер документа об образовании
        type: string
      # issued_by_document:
      #   type: string
      # date_issue_document_edu:
      #   type: string
      # honour:
      #   type: string
      # name_edu:
      #   type: string
      # locality_edu:
      #   type: string
      # type_edu:
      #   type: string
  Status:
    type: object
    properties:
      message:
        type: string
      text:
        type: string