openapi: 3.0.3
info:
  title: EPA Air Quality System (AQS) Account Type Codes Formio API
  description: 'The Air Quality System (AQS) Data Mart API provides programmatic access to ambient air

    sample data collected by state, local, tribal and federal air pollution control agencies

    from thousands of monitors across the United States. The API exposes monitor metadata,

    raw sample observations, daily/quarterly/annual aggregates, and quality assurance results.

    '
  version: '1.0'
  contact:
    name: AQS Data Mart Support
    email: aqsdatamart@epa.gov
    url: https://aqs.epa.gov/aqsweb/documents/data_api.html
  license:
    name: U.S. Government Work / Public Domain
    url: https://www.usa.gov/government-works
servers:
- url: https://aqs.epa.gov/data/api
  description: Production AQS Data Mart API
security:
- emailKey: []
tags:
- name: Formio
paths:
  /api/formio/2022/district/{rebateId}:
    get:
      summary: Get the School District Info Associated with a Provided CSB Rebate ID
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: An object containing school district info associated with the CSB Rebate ID.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2022_district_{rebateId}200Example:
                  summary: Default get_api_formio_2022_district_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/s3/{formType}/{mongoId}/{comboKey}/storage/s3:
    get:
      summary: Download Formio File Attachment from S3 for a 2022 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/key'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Upload Formio File Attachment to S3 for a 2022 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    delete:
      summary: Delete Formio File Attachment from S3 for a 2022 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/pdf/{formType}/{mongoId}:
    get:
      summary: Download a PDF of a 2022 Form Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/frf-submissions:
    get:
      summary: Get User's 2022 FRF Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2022 FRF submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2022_frf-submissions200Example:
                  summary: Default get_api_formio_2022_frf-submissions 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/frf-submission:
    post:
      summary: Post a New 2022 FRF Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2022 FRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2022_frf-submission200Example:
                  summary: Default post_api_formio_2022_frf-submission 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/frf-submission/{mongoId}:
    get:
      summary: Get an Existing 2022 FRF's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: The 2022 FRF schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2022_frf-submission_{mongoId}200Example:
                  summary: Default get_api_formio_2022_frf-submission_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post an Update to an Existing Draft 2022 FRF Submission to Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The updated 2022 FRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2022_frf-submission_{mongoId}200Example:
                  summary: Default post_api_formio_2022_frf-submission_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/prf-submissions:
    get:
      summary: Get User's 2022 PRF Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2022 PRF submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2022_prf-submissions200Example:
                  summary: Default get_api_formio_2022_prf-submissions 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/prf-submission:
    post:
      summary: Post a New 2022 PRF Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2022 PRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2022_prf-submission200Example:
                  summary: Default post_api_formio_2022_prf-submission 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/prf-submission/{rebateId}:
    get:
      summary: Get an Existing 2022 PRF's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: The 2022 PRF schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2022_prf-submission_{rebateId}200Example:
                  summary: Default get_api_formio_2022_prf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post an Update to an Existing Draft 2022 PRF Submission to Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The updated 2022 PRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2022_prf-submission_{rebateId}200Example:
                  summary: Default post_api_formio_2022_prf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/delete-prf-submission:
    post:
      summary: Delete an Existing 2022 PRF Submission from Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/crf-submissions:
    get:
      summary: Get User's 2022 CRF Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2022 CRF submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2022_crf-submissions200Example:
                  summary: Default get_api_formio_2022_crf-submissions 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/crf-submission:
    post:
      summary: Post a New 2022 CRF Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2022 CRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2022_crf-submission200Example:
                  summary: Default post_api_formio_2022_crf-submission 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/crf-submission/{rebateId}:
    get:
      summary: Get an Existing 2022 CRF's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: The 2022 CRF schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2022_crf-submission_{rebateId}200Example:
                  summary: Default get_api_formio_2022_crf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post an Update to an Existing Draft 2022 CRF Submission to Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The updated 2022 CRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2022_crf-submission_{rebateId}200Example:
                  summary: Default post_api_formio_2022_crf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2022/changes:
    get:
      summary: Get User's 2022 Change Request Form Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2022 Change Request form submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2022_changes200Example:
                  summary: Default get_api_formio_2022_changes 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/check-vin/{vin}:
    get:
      summary: Check for Duplicate VINs in the BAP.
      parameters:
      - in: path
        name: vin
        description: The bus VIN to search for.
        required: true
        example: '11111111111111111'
        schema:
          type: string
      - in: query
        name: rebateId
        description: The CSB Rebate ID of the current submission.
        required: false
        example: '123456'
        schema:
          type: string
      - in: query
        name: debug
        description: Return debug info from the BAP in the response.
        required: false
        example: true
        schema:
          type: boolean
      responses:
        '200':
          description: An object containing the duplicate VIN data.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2023_check-vin_{vin}200Example:
                  summary: Default get_api_formio_2023_check-vin_{vin} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/nces/{searchText}:
    get:
      summary: Search 2023 NCES Data with the Provided NCES ID and Return a Match.
      parameters:
      - in: path
        name: searchText
        description: The NCES ID to search for.
        required: true
        example: A999999
        schema:
          type: string
      responses:
        '200':
          description: An object containing the matched NCES data.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2023_nces_{searchText}200Example:
                  summary: Default get_api_formio_2023_nces_{searchText} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/district/{rebateId}:
    get:
      summary: Get the School District Info Associated with a Provided CSB Rebate ID
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: An object containing school district info associated with the CSB Rebate ID.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2023_district_{rebateId}200Example:
                  summary: Default get_api_formio_2023_district_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/contacts/{rebateId}:
    get:
      summary: Get Contacts Associated with a Provided CSB Rebate ID
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: An array of objects containing contact data associated with the CSB Rebate ID.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2023_contacts_{rebateId}200Example:
                  summary: Default get_api_formio_2023_contacts_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/s3/{formType}/{mongoId}/{comboKey}/storage/s3:
    get:
      summary: Download Formio File Attachment from S3 for a 2023 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/key'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Upload Formio File Attachment to S3 for a 2023 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    delete:
      summary: Delete Formio File Attachment from S3 for a 2023 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/pdf/{formType}/{mongoId}:
    get:
      summary: Download a PDF of a 2023 Form Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/frf-submissions:
    get:
      summary: Get User's 2023 FRF Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2023 FRF submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2023_frf-submissions200Example:
                  summary: Default get_api_formio_2023_frf-submissions 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/frf-submission:
    post:
      summary: Post a New 2023 FRF Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2023 FRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2023_frf-submission200Example:
                  summary: Default post_api_formio_2023_frf-submission 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/frf-submission/{mongoId}:
    get:
      summary: Get an Existing 2023 FRF's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: The 2023 FRF schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2023_frf-submission_{mongoId}200Example:
                  summary: Default get_api_formio_2023_frf-submission_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post an Update to an Existing Draft 2023 FRF Submission to Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The updated 2023 FRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2023_frf-submission_{mongoId}200Example:
                  summary: Default post_api_formio_2023_frf-submission_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/prf-submissions:
    get:
      summary: Get User's 2023 PRF Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2023 PRF submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2023_prf-submissions200Example:
                  summary: Default get_api_formio_2023_prf-submissions 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/prf-submission:
    post:
      summary: Post a New 2023 PRF Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2023 PRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2023_prf-submission200Example:
                  summary: Default post_api_formio_2023_prf-submission 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/prf-submission/{rebateId}:
    get:
      summary: Get an Existing 2023 PRF's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: The 2023 PRF schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2023_prf-submission_{rebateId}200Example:
                  summary: Default get_api_formio_2023_prf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post an Update to an Existing Draft 2023 PRF Submission to Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The updated 2023 PRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2023_prf-submission_{rebateId}200Example:
                  summary: Default post_api_formio_2023_prf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/delete-prf-submission:
    post:
      summary: Delete an Existing 2023 PRF Submission from Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/crf-submissions:
    get:
      summary: Get User's 2023 CRF Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2023 CRF submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2023_crf-submissions200Example:
                  summary: Default get_api_formio_2023_crf-submissions 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/crf-submission:
    post:
      summary: Post a New 2023 CRF Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2023 CRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2023_crf-submission200Example:
                  summary: Default post_api_formio_2023_crf-submission 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/crf-submission/{rebateId}:
    get:
      summary: Get an Existing 2023 CRF's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: The 2023 CRF schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2023_crf-submission_{rebateId}200Example:
                  summary: Default get_api_formio_2023_crf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post an Update to an Existing Draft 2023 CRF Submission to Formio.
      parameters:
      - $ref: '#/components/parameters/rebateId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The updated 2023 CRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2023_crf-submission_{rebateId}200Example:
                  summary: Default post_api_formio_2023_crf-submission_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/changes:
    get:
      summary: Get User's 2023 Change Request Form Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2023 Change Request form submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2023_changes200Example:
                  summary: Default get_api_formio_2023_changes 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/change:
    get:
      summary: Get the 2023 Change Request Form's Schema from Formio.
      parameters: []
      responses:
        '200':
          description: The 2023 Change Request form's schema.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2023_change200Example:
                  summary: Default get_api_formio_2023_change 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post a New 2023 Change Request Form Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2023 Change Request form submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2023_change200Example:
                  summary: Default post_api_formio_2023_change 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2023/change/{mongoId}:
    get:
      summary: Get an Existing 2023 Change Request Form's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: The 2023 Change Request form's schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2023_change_{mongoId}200Example:
                  summary: Default get_api_formio_2023_change_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/nces/{searchText}:
    get:
      summary: Search 2024 NCES Data with the Provided NCES ID and Return a Match.
      parameters:
      - in: path
        name: searchText
        description: The NCES ID to search for.
        required: true
        example: A999999
        schema:
          type: string
      responses:
        '200':
          description: An object containing the matched NCES data.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2024_nces_{searchText}200Example:
                  summary: Default get_api_formio_2024_nces_{searchText} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/district/{rebateId}:
    get:
      summary: Get the School District Info Associated with a Provided CSB Rebate ID
      parameters:
      - $ref: '#/components/parameters/rebateId'
      responses:
        '200':
          description: An object containing school district info associated with the CSB Rebate ID.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2024_district_{rebateId}200Example:
                  summary: Default get_api_formio_2024_district_{rebateId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/s3/{formType}/{mongoId}/{comboKey}/storage/s3:
    get:
      summary: Download Formio File Attachment from S3 for a 2024 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      - $ref: '#/components/parameters/bucket'
      - $ref: '#/components/parameters/key'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Upload Formio File Attachment to S3 for a 2024 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: OK
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    delete:
      summary: Delete Formio File Attachment from S3 for a 2024 Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      - $ref: '#/components/parameters/comboKey'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/pdf/{formType}/{mongoId}:
    get:
      summary: Download a PDF of a 2024 Form Submission.
      parameters:
      - $ref: '#/components/parameters/formType'
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/frf-submissions:
    get:
      summary: Get User's 2024 FRF Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2024 FRF submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2024_frf-submissions200Example:
                  summary: Default get_api_formio_2024_frf-submissions 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/frf-submission:
    post:
      summary: Post a New 2024 FRF Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2024 FRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2024_frf-submission200Example:
                  summary: Default post_api_formio_2024_frf-submission 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/frf-submission/{mongoId}:
    get:
      summary: Get an Existing 2024 FRF's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: The 2024 FRF schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2024_frf-submission_{mongoId}200Example:
                  summary: Default get_api_formio_2024_frf-submission_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post an Update to an Existing Draft 2024 FRF Submission to Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The updated 2024 FRF submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2024_frf-submission_{mongoId}200Example:
                  summary: Default post_api_formio_2024_frf-submission_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/changes:
    get:
      summary: Get User's 2024 Change Request Form Submissions from Formio.
      parameters: []
      responses:
        '200':
          description: An array of 2024 Change Request form submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                get_api_formio_2024_changes200Example:
                  summary: Default get_api_formio_2024_changes 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/change:
    get:
      summary: Get the 2024 Change Request Form's Schema from Formio.
      parameters: []
      responses:
        '200':
          description: The 2024 Change Request form's schema.
          content:
            application/json:
              schema:
                type: object
              examples:
                get_api_formio_2024_change200Example:
                  summary: Default get_api_formio_2024_change 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
    post:
      summary: Post a New 2024 Change Request Form Submission to Formio.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The newly created 2024 Change Request form submission.
          content:
            application/json:
              schema:
                type: object
              examples:
                post_api_formio_2024_change200Example:
                  summary: Default post_api_formio_2024_change 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
  /api/formio/2024/change/{mongoId}:
    get:
      summary: Get an Existing 2024 Change Request Form's Schema and Submission Data from Formio.
      parameters:
      - $ref: '#/components/parameters/mongoId'
      responses:
        '200':
          description: The 2024 Change Request form's schema, form submission, and user access status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormioSchemaAndSubmission'
              examples:
                get_api_formio_2024_change_{mongoId}200Example:
                  summary: Default get_api_formio_2024_change_{mongoId} 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    message: Example response
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Formio
components:
  parameters:
    rebateId:
      in: path
      name: rebateId
      description: The CSB Rebate ID
      required: true
      example: '000000'
      schema:
        type: string
    key:
      in: query
      name: key
      description: The S3 object key for the file.
      required: true
      example: placeholder-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.png
      schema:
        type: string
    formType:
      in: path
      name: formType
      description: The Formio form type (frf, prf, crf).
      required: true
      example: frf
      schema:
        type: string
    comboKey:
      in: path
      name: comboKey
      description: The SAM.gov entity's UEI/EFTI combo key.
      required: true
      example: '0000000000000000'
      schema:
        type: string
    bucket:
      in: query
      name: bucket
      description: The S3 bucket name where the file is stored.
      required: true
      example: cleanschoolbus
      schema:
        type: string
    mongoId:
      in: path
      name: mongoId
      description: The Formio submission's MongoDB ObjectId.
      required: true
      example: '000000000000000000000000'
      schema:
        type: string
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthorized
  schemas:
    FormioSchemaAndSubmission:
      type: object
      properties:
        access:
          type: boolean
          example: true
        schema:
          type: object
          nullable: true
          example: {}
        submission:
          type: object
          example: {}
  securitySchemes:
    emailKey:
      type: apiKey
      in: query
      name: key
      description: 'AQS requires `email` and `key` query parameters on every request. Register at

        `/signup?email=YOUR_EMAIL` to receive a key by email.

        '