feat: add API v3 routes for questions

Signed-off-by: Christian Hartmann <chris-hartmann@gmx.de>
nextcloud · Jun 25, 2024 · b52972b · b52972b
1 parent f810413
commit b52972b
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/appinfo/routes.php b/appinfo/routes.php
@@ -59,12 +59,16 @@
 		],
 
 		// API routes v3
+		// Forms
 		['name' => 'api#getForms', 'url' => '/api/{apiVersion}/forms', 'verb' => 'GET', 'requirements' => $requirements_v3],
 		['name' => 'api#newForm', 'url' => '/api/{apiversion}/forms', 'verb' => 'POST', 'requirements' => $requirements_v3],
 		['name' => 'api#getForm', 'url' => '/api/{apiVersion}/forms/{id}', 'verb' => 'GET', 'requirements' => $requirements_v3],
 		['name' => 'api#updateForm', 'url' => '/api/{apiVersion}/forms/{id}', 'verb' => 'PATCH', 'requirements' => $requirements_v3],
 		['name' => 'api#deleteForm', 'url' => '/api/{apiVersion}/forms/{id}', 'verb' => 'DELETE', 'requirements' => $requirements_v3],
 
+		// Questions
+		['name' => 'api#getQuestions', 'url' => '/api/{apiVersion}/forms/{id}/questions', 'verb' => 'GET', 'requirements' => $requirements_v3],
+
 		// Legacy v2 routes (TODO: remove with Forms v5)
 		// Forms
 		['name' => 'api#getFormsLegacy', 'url' => '/api/{apiVersion}/forms', 'verb' => 'GET', 'requirements' => [

diff --git a/lib/Controller/ApiController.php b/lib/Controller/ApiController.php
@@ -96,6 +96,7 @@ public function __construct(
 	}
 
 	// API v3 methods
+	// Forms
 	/**
 	 * @CORS
 	 * @NoAdminRequired
@@ -357,6 +358,36 @@ public function deleteForm(int $id): DataResponse {
 		return new DataResponse($id);
 	}
 
+	// Questions
+	/**
+	 * @CORS
+	 * @NoAdminRequired
+	 *
+	 * Read all questions (including options)
+	 *
+	 * @param int $id FormId
+	 * @return DataResponse
+	 * @throws OCSBadRequestException
+	 * @throws OCSForbiddenException
+	 */
+	public function getQuestions(int $id): DataResponse {
+		try {
+			$form = $this->formMapper->findById($id);
+		} catch (IMapperException $e) {
+			$this->logger->debug('Could not find form');
+			throw new OCSBadRequestException();
+		}
+
+		if (!$this->formsService->hasUserAccess($form)) {
+			$this->logger->debug('User has no permissions to get this form');
+			throw new OCSForbiddenException();
+		}
+
+		$questionData = $this->formsService->getQuestions($id);;
+
+		return new DataResponse($questionData);
+	}
+
 	/*
 	/* Legacy API v2 methods (TODO: remove with Forms v5)
 	 */