operations.tsp

using Http;

@tag("Responses")
namespace CoreSystem.Responses {
	@summary("Create Form Response")
	@doc("Create a new draft response for a form. Each user may have at most one response per form.")
	@route("/forms/{formId}/responses")
	@post
	op createFormResponse(@path formId: uuid): {
		@statusCode statusCode: 201;
		@body response: CreateResponse;
	} | {
		@statusCode statusCode: 400;
		@body error: BadRequest;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Submit Form Response")
	@doc("Submit all the answer in the form response.")
	@route("/responses/{responseId}/submit")
	@post
	op submitFormResponse(@path responseId: uuid, @body req: AnswersRequest): {
		@statusCode statusCode: 200;
        @body response: SubmitResponse;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Cancel Form Response Submission")
	@doc("Cancel a submitted response and revert it to draft. Only submitted responses can be canceled.")
	@route("/responses/{responseId}/cancel")
	@post
	op cancelFormResponseSubmission(@path responseId: uuid): {
		@statusCode statusCode: 200;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	} | {
		@statusCode statusCode: 400;
		@body error: BadRequest;
	};

	@summary("List Form Responses")
	@doc("List all responses for a specific form.")
	@route("/forms/{formId}/responses")
	@get
	op listFormResponses(@path formId: uuid): {
		@statusCode statusCode: 200;
		@body response: ListResponse;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Get My Form Responses")
	@doc("Get all responses submitted by the currently logged-in user for a specific form.")
	@route("/forms/{formId}/responses/me")
	@get
	op getMyFormResponses(@path formId: uuid): {
		@statusCode statusCode: 200;
		@body response: ListResponse;
	} | {
		@statusCode statusCode: 401;
		@body error: Unauthorized;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Get Form Response")
	@doc("Get the preview answer by response ID.")
	@route("/forms/{formId}/responses/{responseId}")
	@get
	op getFormResponse(@path formId: uuid, @path responseId: uuid): {
		@statusCode statusCode: 200;
		@body response: GetFormResponse;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Delete Form Response")
	@doc("Delete a response and all its associated data.")
	@route("/forms/{formId}/responses/{responseId}")
	@delete
	op deleteFormResponse(@path formId: uuid, @path responseId: uuid): {
		@statusCode statusCode: 204;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Preview Form Response Export")
	@doc("Get a preview of the form responses based on selected question IDs.")
	@route("/forms/{formId}/responses/export/preview")
	@post
	op previewFormResponseExport(@path formId: uuid, @body req: ExportPreviewRequest): {
		@statusCode statusCode: 200;
		@body response: ExportPreviewResponse;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Export Form Responses")
	@doc("Download form responses in XLSX format.")
	@route("/forms/{formId}/responses/export/download")
	@post
	op exportFormResponses(@path formId: uuid, @body req: ExportDownloadRequest): {
		@statusCode statusCode: 200;
		@header("Content-Type") contentType: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
		@header("Content-Disposition") contentDisposition: string;
		@body response: bytes;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};

	@summary("Filter And Query Form Responses")
	@doc("Filter and query form responses based on a list of selected question answers.")
	@route("/forms/{formId}/responses/query")
	@post
	op filterAndQueryFormResponses(@path formId: uuid, @body req: AnswerFilterRequest): {
		@statusCode statusCode: 200;
		@body response: AnswerFilterResponse;
	} | {
		@statusCode statusCode: 400;
		@body error: BadRequest;
	} | {
		@statusCode statusCode: 404;
		@body error: NotFound;
	};
}