Merge pull request #28 from tranpl/master

impliment apis and more tests

Author: tranpl

RedcapApi/Api/Redcap.cs

@@ -1,8 +1,17 @@
 namespace Redcap.Models
 {
+    /// <summary>
+    /// Used to erase existing arms in the project or only add new ones
+    /// </summary>
     public enum Override
     {
+        /// <summary>
+        ///   true — You may use override=1 as a 'delete all + import' action in order to erase all existing Arms in the project while importing new Arms.
+        /// </summary>
         True = 1,
+        /// <summary>
+        ///  false [default] If override=0, then you can only add new Arms or rename existing ones. 
+        /// </summary>
         False = 0
     }
 }

RedcapApi/Interfaces/IRedcap.cs

@@ -6,7 +6,13 @@
     /// </summary>
     public enum OverwriteBehavior
     {
+        /// <summary>
+        /// blank/empty values will be ignored [default]
+        /// </summary>
         normal = 0,
+        /// <summary>
+        /// blank/empty values are valid and will overwrite data
+        /// </summary>
         overwrite = 1
     }
 }

RedcapApi/Models/Override.cs

@@ -4,8 +4,14 @@
 
 namespace Redcap.Models
 {
+    /// <summary>
+    /// A record should contain a set of key/value pair.
+    /// </summary>
     public class Record
     {
+        /// <summary>
+        /// A record value contains a key and its associated value.
+        /// </summary>
         public KeyValuePair<string, string> Value { get; set; }
     }
 }

RedcapApi/Models/OverwriteBehavior.cs

@@ -1,8 +1,17 @@
 namespace Redcap.Models
 {
+    /// <summary>
+    /// Arms are only available for longitudinal projects.
+    /// </summary>
     public class RedcapArm
     {
+        /// <summary>
+        /// Number associated with the event, e.g "1"
+        /// </summary>
         public string arm_num { get; set; }
+        /// <summary>
+        /// Name of the event. e.g "event1_arm_1"
+        /// </summary>
         public string name { get; set; }
     }
 }

RedcapApi/Models/Record.cs

@@ -9,9 +9,21 @@
     /// </summary>
     public enum RedcapDataType
     {
+        /// <summary>
+        /// output as one record per row [default]
+        /// </summary>
         flat = 0,
+        /// <summary>
+        /// input as one data point per row
+        /// </summary>
         eav = 1,
+        /// <summary>
+        /// EAV: Non-longitudinal: Will have the fields - record*, field_name, value
+        /// </summary>
         nonlongitudinal = 2,
+        /// <summary>
+        /// EAV: Longitudinal: Will have the fields - record*, field_name, value, redcap_event_name
+        /// </summary>
         longitudinal = 3
     }
 }

RedcapApi/Models/RedcapArm.cs

@@ -8,8 +8,17 @@
     /// </summary>
     public enum InputFormat
     {
+        /// <summary>
+        /// Default Javascript Notation
+        /// </summary>
         json = 0,
+        /// <summary>
+        /// Comma Seperated Values
+        /// </summary>
         csv = 1,
+        /// <summary>
+        /// Extensible Markup Language
+        /// </summary>
         xml = 2
     }
 }

RedcapApi/Models/RedcapConfigurations.cs

@@ -7,7 +7,13 @@
     /// </summary>
     public enum ReturnContent
     {
+        /// <summary>
+        /// ids - a list of all record IDs that were imported
+        /// </summary>
         ids = 0,
+        /// <summary>
+        ///  count [default] - the number of records imported
+        /// </summary>
         count = 1
     }
 }