openapi: 3.0.2
info:
  title: API получения информации по делу на сайте суда (СУДРФ)
  description: Сервис позволяет получить информацию по делу на сайте суда по URL дела на sudrf.ru. Все запросы требуют указания ключа доступа (`key`).
  version: 1.0.0
servers:
  - url: https://parser-api.com/parser/sudrf_custom_api
paths:
  /:
    get:
      summary: Получение информации по делу
      description: Для получения информации по делу на сайте суда используйте следующий запрос.
      parameters:
        - name: key
          in: query
          required: true
          schema:
            type: string
          description: Ключ доступа (обязательный).
        - name: url
          in: query
          required: true
          schema:
            type: string
          description: URL дела на сайте суда, обязательно urlencoded (обязательный).
      responses:
        '200':
          description: Успешная валидация и обработка запроса.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: integer
                    description: Флаг успешности выполнения запроса. При получении 0 сделайте повторный запрос сразу же или через несколько минут.
                    example: 1
                  title:
                    type: string
                    description: Заголовок таблицы с основной информацией по делу.
                    example: Производство в суде первой инстанции
                  type_title:
                    type: string
                    description: Тип производства.
                    example: Производство по гражданским и административным делам
                  case_title:
                    type: string
                    description: Заголовок дела.
                    example: "ДЕЛО № 2-632/2020 ~ М-608/2020"
                  court_title:
                    type: string
                    description: Наименование суда.
                    example: Алейский городской суд Алтайского края
                  court_address:
                    type: string
                    description: Адрес суда.
                    example: "454000, г. Челябинск, ул.Кирова, д. 161"
                  court_phone:
                    type: string
                    description: Телефон суда.
                    example: "(351) 728-76-01, 728-76-51 (ф.)"
                  court_email:
                    type: string
                    description: Email суда.
                    example: 7kas@sudrf.ru
                  document_name:
                    type: string
                    description: Наименование документа.
                    example: Определение
                  document_url:
                    type: string
                    description: Ссылка на документ.
                    example: "/modules.php?name=sud_delo&srv_num=1&name_op=doc&number=13423456&delo_id=4&new=4&text_number=1"
                  attributes:
                    type: array
                    description: Основные атрибуты дела.
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Наименование атрибута.
                          example: Уникальный идентификатор дела
                        value:
                          type: string
                          description: Значение атрибута.
                          example: 50RS0021-01-2019-004289-49
                  events:
                    type: array
                    description: Движения дела.
                    items:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Наименование атрибута события.
                            example: Наименование события
                          value:
                            type: string
                            description: Значение.
                            example: Регистрация иска (заявления, жалобы) в суде и принятие его к производству
                  sides:
                    type: array
                    description: Стороны по делу.
                    items:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Наименование атрибута стороны.
                            example: Вид лица, участвующего в деле
                          value:
                            type: string
                            description: Значение.
                            example: ОТВЕТЧИК
                  enforcement_orders:
                    type: array
                    description: Исполнительные листы.
                    items:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Наименование атрибута.
                            example: Дата выдачи
                          value:
                            type: string
                            description: Значение.
                            example: "30.09.2020"
                  appeals:
                    type: array
                    description: Обжалования.
                    items:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Наименование атрибута.
                            example: Вид жалобы (представления)
                          value:
                            type: string
                            description: Значение.
                            example: Апелляционная (кассационная до 2013г) жалоба
              examples:
                success:
                  value:
                    success: 1
                    title: Производство в суде первой инстанции
                    type_title: Производство по гражданским и административным делам
                    case_title: "ДЕЛО № 2-632/2020 ~ М-608/2020"
                    court_title: Алейский городской суд Алтайского края
                    court_address: "454000, г. Челябинск, ул.Кирова, д. 161"
                    court_phone: "(351) 728-76-01, 728-76-51 (ф.)"
                    court_email: 7kas@sudrf.ru
                    document_name: Определение
                    document_url: "/modules.php?name=sud_delo&srv_num=1&name_op=doc&number=13423456&delo_id=4&new=4&text_number=1"
                    attributes:
                      - name: Уникальный идентификатор дела
                        value: 50RS0021-01-2019-004289-49
                      - name: Дата поступления
                        value: "05.11.2019"
                      - name: Категория дела
                        value: "Отношения, связанные с защитой прав потребителей"
                      - name: Судья
                        value: Брижевская И.П.
                    events:
                      - - name: Наименование события
                          value: Регистрация иска (заявления, жалобы) в суде и принятие его к производству
                        - name: Дата
                          value: "05.11.2019"
                        - name: Время
                          value: "16:07"
                    sides:
                      - - name: Вид лица, участвующего в деле
                          value: ИСТЕЦ
                        - name: Фамилия / наименование
                          value: Шашина Марина Михайловна
                    enforcement_orders:
                      - - name: Дата выдачи
                          value: "30.09.2020"
                        - name: Серия, номер бланка
                          value: "ФС № 028683952"
                        - name: Статус
                          value: Выдан
                    appeals:
                      - - name: Дата поступления
                          value: "28.09.2020"
                        - name: Вид жалобы (представления)
                          value: Апелляционная (кассационная до 2013г) жалоба
        '400':
          description: Ошибка валидации запроса.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Подробное описание ошибки.
                    example: "url must contain sudrf.ru"
                  error_code:
                    type: integer
                    description: Код ошибки.
                    example: 40001
        '403':
          description: Ограничение доступа к сервису.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Подробное описание ошибки.
                    example: Invalid access key
                  error_code:
                    type: integer
                    description: Код ошибки.
                    example: 40301
              examples:
                invalidKey:
                  value:
                    error: Invalid access key
                    error_code: 40301
                expiredSubscription:
                  value:
                    error: The subscription period has expired
                    error_code: 40302
                invalidIP:
                  value:
                    error: Invalid IP
                    error_code: 40303
                dayLimitExceeded:
                  value:
                    error: Day limit of requests exceeded
                    error_code: 40304
                monthLimitExceeded:
                  value:
                    error: Month limit of requests exceeded
                    error_code: 40305