Add function for getting list of studies (#20)

actigraph · Jul 29, 2024 · 4acb4e0 · 4acb4e0
1 parent 1df8568
commit 4acb4e0
Show file tree

Hide file tree

Showing 4 changed files with 386 additions and 282 deletions.
diff --git a/actiapi/v3.py b/actiapi/v3.py
@@ -118,6 +118,20 @@ def get_study_info(self, study_id) -> List[Dict[str, Any]]:
         results = self._get_single(f"/centrepoint/v3/Studies/{study_id}", token)
         return results
 
+
+    def get_studies(self) -> List[Dict[str, Any]]:
+        """Save high-level study info to file.
+
+        Parameters
+        ----------
+        study_id:
+            Id of the study
+        """
+        token = self._get_access_token("CentrePoint")
+
+        results = self._get_paginated(f"/centrepoint/v3/Studies?", token)
+        return results
+
     def get_study_metadata(self, study_id) -> List[Dict[str, Any]]:
         """Save all study metadata to file.