{ "openapi": "3.0.0", "info": { "title": "epa-csb-server", "version": "8.1.0", "license": { "name": "CC0-1.0" }, "description": "U.S. EPA CSB Rebate Forms Application" }, "paths": { "/login": { "get": { "summary": "/login", "responses": { "302": { "description": "Found" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/login/assert": { "post": { "summary": "/login/assert", "parameters": [], "responses": { "302": { "description": "Found", "content": { "text/html": { "schema": { "type": "string", "example": "

Found. Redirecting to http://localhost:3000/

" }, "examples": { "post_login_assert302Example": { "summary": "Default post_login_assert 302 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/login/fail": { "get": { "summary": "/login/fail", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/logout": { "get": { "summary": "/logout", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/logout/callback": { "get": { "summary": "/logout/callback", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "summary": "/logout/callback", "responses": { "200": { "description": "OK" } }, "tags": [], "parameters": [], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/metadata": { "get": { "summary": "/metadata", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "get_metadata200Example": { "summary": "Default get_metadata 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/user": { "get": { "summary": "Get user data from EPA Gateway/Login.gov.", "parameters": [], "responses": { "200": { "description": "An object with a user's data from EPA Gateway/Login.gov.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mail": { "type": "string", "example": "last.first@epa.gov" }, "memberof": { "type": "string", "example": "csb_admin,csb_helpdesk" }, "exp": { "type": "number", "example": 1661376902 } } }, "examples": { "get_api_user200Example": { "summary": "Default get_api_user 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/config/public": { "get": { "summary": "Get CSB App Specific Public Configuration (csb App Login Status and Static Content)", "parameters": [], "responses": { "200": { "description": "CSB app login status and static content from S3.", "content": { "application/json": { "schema": { "type": "object", "properties": { "loginEnabled": { "type": "boolean", "example": true }, "staticContent": { "type": "object" } } }, "examples": { "get_api_config_public200Example": { "summary": "Default get_api_config_public 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/config/private": { "get": { "summary": "Get CSB App Specific Private Configuration (form Open Enrollment Status, Etc.)", "parameters": [], "responses": { "200": { "description": "Formio base URL and project name, CSB rebate year and open enrollment status.", "content": { "application/json": { "schema": { "type": "object", "properties": { "formioBaseUrl": { "type": "string", "example": "https://api.form.io" }, "formioProjectName": { "type": "string", "example": "forms" }, "formioPremiumKey": { "type": "string", "example": "secret" }, "rebateYear": { "type": "string", "example": "2024" }, "submissionPeriodOpen": { "type": "object", "properties": { "2022": { "type": "object", "properties": { "frf": { "type": "boolean", "example": true }, "prf": { "type": "boolean", "example": true }, "crf": { "type": "boolean", "example": true } } }, "2023": { "type": "object", "properties": { "frf": { "type": "boolean", "example": true }, "prf": { "type": "boolean", "example": true }, "crf": { "type": "boolean", "example": true } } }, "2024": { "type": "object", "properties": { "frf": { "type": "boolean", "example": true }, "prf": { "type": "boolean", "example": true }, "crf": { "type": "boolean", "example": true } } } } } } }, "examples": { "get_api_config_private200Example": { "summary": "Default get_api_config_private 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/bap/sam": { "get": { "summary": "Get User's SAM.gov Data from the BAP.", "parameters": [], "responses": { "200": { "description": "A boolean indicating whether any SAM.gov results were returned (to support helpdesk users without SAM.gov entities), along with an array of SAM.gov entities.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "boolean", "example": true }, "entities": { "type": "array", "items": { "type": "object" } } } }, "examples": { "get_api_bap_sam200Example": { "summary": "Default get_api_bap_sam 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/bap/submissions": { "get": { "summary": "Get User's Form Submissions Statuses from the BAP.", "parameters": [], "responses": { "200": { "description": "An array of form submission statuses, and other relevant fields.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "get_api_bap_submissions200Example": { "summary": "Default get_api_bap_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" } } }, "/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" } } }, "/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" } }, "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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } }, "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" } } }, "/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" } } }, "/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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/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" } }, "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" } } }, "/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" } } }, "/api/help/formio/s3/{rebateYear}/{formType}/storage/s3": { "get": { "summary": "Download Formio File Attachment from S3 for a Submission.", "parameters": [ { "$ref": "#/components/parameters/rebateYear" }, { "$ref": "#/components/parameters/formType" }, { "$ref": "#/components/parameters/bucket" }, { "$ref": "#/components/parameters/key" } ], "responses": { "200": { "description": "OK" }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/help/formio/submission/{rebateYear}/{formType}/{id}": { "get": { "summary": "Get an Existing Form's Submission Data from Formio.", "parameters": [ { "$ref": "#/components/parameters/rebateYear" }, { "$ref": "#/components/parameters/formType" }, { "in": "path", "name": "id", "description": "The CSB Rebate ID or Formio MongoDB ObjectId.", "required": true, "example": "000000", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "rebateId": { "type": "string", "nullable": true, "example": "000000" }, "schema": { "type": "object", "nullable": true }, "formio": { "type": "object", "nullable": true }, "bap": { "type": "object", "nullable": true, "properties": { "modified": { "type": "string", "example": "2024-01-01T12:00:00.000Z" }, "comboKey": { "type": "string", "example": "0000000000000000" }, "mongoId": { "type": "string", "example": "000000000000000000000000" }, "rebateId": { "type": "string", "example": "000000" }, "reviewItemId": { "type": "string", "example": "000000A01" }, "status": { "type": "string", "example": "Accepted" }, "reimbursementNeeded": { "type": "boolean", "example": false } } } } }, "examples": { "get_api_help_formio_submission_{rebateYear}_{formType}_{id}200Example": { "summary": "Default get_api_help_formio_submission_{rebateYear}_{formType}_{id} 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "summary": "Post an Update to an Existing Form Submission to Formio (change Submission to 'draft').", "parameters": [ { "$ref": "#/components/parameters/rebateYear" }, { "$ref": "#/components/parameters/formType" }, { "in": "path", "name": "id", "description": "The CSB Rebate ID or Formio MongoDB ObjectId.", "required": true, "example": "000000000000000000000000", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } }, "responses": { "200": { "description": "The updated form submission.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "post_api_help_formio_submission_{rebateYear}_{formType}_{id}200Example": { "summary": "Default post_api_help_formio_submission_{rebateYear}_{formType}_{id} 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/help/formio/actions/{formId}/{mongoId}": { "get": { "summary": "Get All Actions Associated with a Form's Submission from Formio.", "parameters": [ { "$ref": "#/components/parameters/formId" }, { "$ref": "#/components/parameters/mongoId" } ], "responses": { "200": { "description": "An array of actions associated with the form's submission.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "get_api_help_formio_actions_{formId}_{mongoId}200Example": { "summary": "Default get_api_help_formio_actions_{formId}_{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" } } }, "/api/help/formio/pdf/{formId}/{mongoId}": { "get": { "summary": "Get a PDF of an Existing Form's Submission from Formio.", "parameters": [ { "$ref": "#/components/parameters/formId" }, { "$ref": "#/components/parameters/mongoId" } ], "responses": { "200": { "description": "A PDF of the form's submission.", "content": { "*/*": { "schema": { "type": "string", "format": "byte" }, "examples": { "get_api_help_formio_pdf_{formId}_{mongoId}200Example": { "summary": "Default get_api_help_formio_pdf_{formId}_{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" } } }, "/api/status/app": { "get": { "summary": "CSB App Health Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/bap/sam": { "get": { "summary": "CSB SAM.gov Connection Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2022/frf": { "get": { "summary": "CSB Formio 2022 FRF Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2022/prf": { "get": { "summary": "CSB Formio 2022 PRF Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2022/crf": { "get": { "summary": "CSB Formio 2022 CRF Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2022/change": { "get": { "summary": "CSB Formio 2022 Change Request Form Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2023/frf": { "get": { "summary": "CSB Formio 2023 FRF Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2023/prf": { "get": { "summary": "CSB Formio 2023 PRF Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2023/crf": { "get": { "summary": "CSB Formio 2023 CRF Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2023/change": { "get": { "summary": "CSB Formio 2023 Change Request Form Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2024/frf": { "get": { "summary": "CSB Formio 2024 FRF Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/status/formio/2024/change": { "get": { "summary": "CSB Formio 2024 Change Request Form Schema Check.", "parameters": [], "responses": { "200": { "description": "OK" } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "parameters": { "rebateYear": { "in": "path", "name": "rebateYear", "description": "The Clean School Bus Rebate year (2022, 2023, 2024).", "required": true, "example": "2022", "schema": { "type": "string" } }, "formType": { "in": "path", "name": "formType", "description": "The Formio form type (frf, prf, crf).", "required": true, "example": "frf", "schema": { "type": "string" } }, "formId": { "in": "path", "name": "formId", "description": "The Formio form's MongoDB ObjectId.", "required": true, "example": "000000000000000000000000", "schema": { "type": "string" } }, "mongoId": { "in": "path", "name": "mongoId", "description": "The Formio submission's MongoDB ObjectId.", "required": true, "example": "000000000000000000000000", "schema": { "type": "string" } }, "rebateId": { "in": "path", "name": "rebateId", "description": "The CSB Rebate ID", "required": true, "example": "000000", "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" } }, "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" } } }, "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": {} } } } } } }