Merge pull request #109 from tranpl/jan_2023_update

Jan 2023 update

README.md

@@ -80,21 +80,21 @@ __Install directly in Package Manager Console or Command Line Interface__
 ```C#
 Package Manager
 
-Install-Package RedcapAPI -Version 1.3.0
+Install-Package RedcapAPI -Version 1.3.1
 
 ```
 
 ```C#
 .NET CLI
 
-dotnet add package RedcapAPI --version 1.3.0
+dotnet add package RedcapAPI --version 1.3.1
 
  ```
 
 ```C#
 Paket CLI
 
-paket add RedcapAPI --version 1.3.0
+paket add RedcapAPI --version 1.3.1
 
 ```
 

RedcapApi/Models/RedcapFormat.cs

@@ -8,10 +8,11 @@ namespace Redcap.Models
     /// Format, 0 = json
     /// Format, 1 = csv [default]
     /// Format, 2 = xml 
+    /// </summary>
+    /// 
     public enum RedcapFormat
     {
 
-        /// </summary>
         /// <summary>
         /// Default Javascript Notation
         /// </summary>

RedcapApi/Models/RedcapReturnFormat.cs

@@ -6,14 +6,14 @@ namespace Redcap.Models
     /// Specifies the format of error messages
     /// 
     /// The format that the response object should be if there are errors generated when executing the http request.
-    /// OnErrorFormat, 0 = json
-    /// OnErrorFormat, 1 = csv
-    /// OnErrorFormat, 2 = xml
+    /// ReturnFormat, 0 = json
+    /// ReturnFormat, 1 = csv
+    /// ReturnFormat, 2 = xml
+    /// </summary>
     /// 
     public enum RedcapReturnFormat
     {
 
-        /// </summary>
         /// <summary>
         /// Default Javascript Notation
         /// </summary>

RedcapApi/Models/RedcapUser.cs

@@ -2,89 +2,177 @@
 
 namespace Redcap.Models
 {
+    /// <summary>
+    /// Redcap User Class
+    /// </summary>
     public class RedcapUser
     {
+        /// <summary>
+        /// username
+        /// </summary>
         [Display(Name = "username")]
         public string Username { get; set; }
 
+        /// <summary>
+        /// expiration date
+        /// </summary>
         [Display(Name = "expiration")]
         public string Expiration { get; set; }
 
+        /// <summary>
+        /// data access group
+        /// </summary>
         [Display(Name = "data_access_group")]
         public string DataAccessGroup { get; set; }
 
+        /// <summary>
+        /// design
+        /// </summary>
         [Display(Name = "design")]
         public string Design { get; set; }
 
+        /// <summary>
+        /// user rights
+        /// </summary>
         [Display(Name = "user_rights")]
         public string UserRights { get; set; }
 
+        /// <summary>
+        /// data access groups
+        /// </summary>
         [Display(Name = "data_access_groups")]
         public string DataAccessGroups { get; set; }
 
+        /// <summary>
+        /// data export
+        /// </summary>
         [Display(Name = "data_export")]
         public string DataExport { get; set; }
 
+        /// <summary>
+        /// reports
+        /// </summary>
         [Display(Name = "reports")]
         public string Reports { get; set; }
 
+        /// <summary>
+        /// stats and charts
+        /// </summary>
         [Display(Name = "stats_and_charts")]
         public string StatsAndCharts { get; set; }
 
+        /// <summary>
+        /// manage survey participants
+        /// </summary>
         [Display(Name = "manage_survey_participants")]
         public string ManageSurveyParticipants { get; set; }
 
+        /// <summary>
+        /// calendar
+        /// </summary>
         [Display(Name = "calendar")]
         public string Calendar { get; set; }
 
+        /// <summary>
+        /// data import tool
+        /// </summary>
         [Display(Name = "data_import_tool")]
         public string DataImportTool { get; set; }
 
+        /// <summary>
+        /// data comparison tool
+        /// </summary>
         [Display(Name = "data_comparison_tool")]
         public string DataComparisonTool { get; set; }
 
+        /// <summary>
+        /// logging
+        /// </summary>
         [Display(Name = "logging")]
         public string Logging { get; set; }
 
+
+        /// <summary>
+        /// file repository
+        /// </summary>
         [Display(Name = "file_repository")]
         public string FileRepository { get; set; }
 
+        /// <summary>
+        /// data quality create
+        /// </summary>
         [Display(Name = "data_quality_create")]
         public string DataQualityCreate { get; set; }
 
+        /// <summary>
+        /// data quality execute
+        /// </summary>
         [Display(Name = "data_quality_execute")]
         public string DataQualityExecute { get; set; }
 
+        /// <summary>
+        /// api export
+        /// </summary>
         [Display(Name = "api_export")]
         public string ApiExport { get; set; }
 
+        /// <summary>
+        /// api import
+        /// </summary>
         [Display(Name = "api_import")]
         public string ApiImport { get; set; }
 
+        /// <summary>
+        /// mobile app
+        /// </summary>
         [Display(Name = "mobile_app")]
         public string MobileApp { get; set; }
 
+        /// <summary>
+        /// record create tool
+        /// </summary>
         [Display(Name ="record_create_tool")]
         public string RecordCreateTool { get; set; }
 
+        /// <summary>
+        /// mobile app download data
+        /// </summary>
         [Display(Name = "mobile_app_download_data")]
         public string MobileAppDownloadData { get; set; }
 
+        /// <summary>
+        /// record create
+        /// </summary>
         [Display(Name = "record_create")]
         public string RecordCreate { get; set; }
 
+        /// <summary>
+        /// record rename
+        /// </summary>
         [Display(Name = "record_rename")]
         public string RecordRename { get; set; }
 
+        /// <summary>
+        /// record delete
+        /// </summary>
         [Display(Name = "record_delete")]
         public string RecordDelete { get; set; }
 
+        /// <summary>
+        /// lock records all forms
+        /// </summary>
         [Display(Name = "lock_records_all_forms")]
         public string LockRecordsAllForms { get; set; }
 
+        /// <summary>
+        /// lock records
+        /// </summary>
         [Display(Name = "lock_records")]
         public string LockRecords { get; set; }
 
+        /// <summary>
+        /// lock records customization
+        /// </summary>
         [Display(Name = "lock_records_customization")]
         public string LockRecordsCustomization { get; set; }
     }

RedcapApi/Redcap.csproj

@@ -10,20 +10,23 @@
     <Description>This library allows applications on the .NET platform to make http calls to REDCap instances.</Description>
     <Product>Redcap Api Library</Product>
     <PackageId>RedcapAPI</PackageId>
-    <Version>1.3.0</Version>
-    <AssemblyVersion>1.3.0</AssemblyVersion>
+    <Version>1.3.1</Version>
+    <AssemblyVersion>1.3.1</AssemblyVersion>
     <PackageTags>redcap api library vcu</PackageTags>
     <ApplicationIcon />
     <OutputType>Library</OutputType>
     <NeutralLanguage>en</NeutralLanguage>
-    <FileVersion>1.3.0</FileVersion>
+    <FileVersion>1.3.1</FileVersion>
     <Copyright>https://github.com/cctrbic/redcap-api/blob/master/LICENSE.md</Copyright>
     <icon>https://vortex.cctr.vcu.edu/images/ram_crest_160.png</icon>
     <PackageIcon>vcu.png</PackageIcon>
     <Title>Redcap Api</Title>
-    <PackageReleaseNotes>- add new api methods for FileRepository
-- update documentation</PackageReleaseNotes>
+    <PackageReleaseNotes>-update api documentation, 
+-multiple breaking changes
+-fix some apis where parameters were behind the releases
+-streamline api parameters to match official documentations</PackageReleaseNotes>
 	  <PackageReadmeFile>README.md</PackageReadmeFile>
+	  <GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
   <ItemGroup>
 	  <None Include="..\README.md">

RedcapApi/Utilities/Utils.cs

@@ -211,45 +211,45 @@ public static async Task<string> HandleReturnContent(this RedcapApi redcapApi, R
         /// <param name="onErrorFormat"></param>
         /// <param name="redcapDataType"></param>
         /// <returns>tuple, string, string, string</returns>
-        public static async Task<(string format, string onErrorFormat, string redcapDataType)> HandleFormat(this RedcapApi redcapApi, ReturnFormat? format = ReturnFormat.json, OnErrorFormat? onErrorFormat = OnErrorFormat.json, RedcapDataType? redcapDataType = RedcapDataType.flat)
+        public static async Task<(string format, string onErrorFormat, string redcapDataType)> HandleFormat(this RedcapApi redcapApi, RedcapFormat? format = RedcapFormat.json, RedcapReturnFormat? onErrorFormat = RedcapReturnFormat.json, RedcapDataType? redcapDataType = RedcapDataType.flat)
         {
             // default
-            var _format = ReturnFormat.json.ToString();
-            var _onErrorFormat = OnErrorFormat.json.ToString();
+            var _format = RedcapFormat.json.ToString();
+            var _onErrorFormat = RedcapReturnFormat.json.ToString();
             var _redcapDataType = RedcapDataType.flat.ToString();
 
             try
             {
 
                 switch (format)
                 {
-                    case ReturnFormat.json:
-                        _format = ReturnFormat.json.ToString();
+                    case RedcapFormat.json:
+                        _format = RedcapFormat.json.ToString();
                         break;
-                    case ReturnFormat.csv:
-                        _format = ReturnFormat.csv.ToString();
+                    case RedcapFormat.csv:
+                        _format = RedcapFormat.csv.ToString();
                         break;
-                    case ReturnFormat.xml:
-                        _format = ReturnFormat.xml.ToString();
+                    case RedcapFormat.xml:
+                        _format = RedcapFormat.xml.ToString();
                         break;
                     default:
-                        _format = ReturnFormat.json.ToString();
+                        _format = RedcapFormat.json.ToString();
                         break;
                 }
 
                 switch (onErrorFormat)
                 {
-                    case OnErrorFormat.json:
-                        _onErrorFormat = OnErrorFormat.json.ToString();
+                    case RedcapReturnFormat.json:
+                        _onErrorFormat = RedcapReturnFormat.json.ToString();
                         break;
-                    case OnErrorFormat.csv:
-                        _onErrorFormat = OnErrorFormat.csv.ToString();
+                    case RedcapReturnFormat.csv:
+                        _onErrorFormat = RedcapReturnFormat.csv.ToString();
                         break;
-                    case OnErrorFormat.xml:
-                        _onErrorFormat = OnErrorFormat.xml.ToString();
+                    case RedcapReturnFormat.xml:
+                        _onErrorFormat = RedcapReturnFormat.xml.ToString();
                         break;
                     default:
-                        _onErrorFormat = OnErrorFormat.json.ToString();
+                        _onErrorFormat = RedcapReturnFormat.json.ToString();
                         break;
                 }