added the new fields in the API documentation

aces · Jan 10, 2019 · ef40a59 · ef40a59
1 parent 96f5246
commit ef40a59
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/docs/API/LorisRESTAPI_v0.0.3.md b/docs/API/LorisRESTAPI_v0.0.3.md
@@ -581,7 +581,14 @@ Returns file level QC information. It will return a JSON object of the form:
         "File" : $Filename
     },
     "QC" : "Pass|Fail",
-    "Selected" : boolean
+    "Selected" : boolean,
+    "Caveats" : {
+      "Severity" : $severity,
+      "Header" : $header,
+      "Value" : $headerValue,
+      "ValidRange" : $headerValidRange,
+      "ValidRegex" : $headerValidRegex
+    }
 }
 ```
 
@@ -668,7 +675,7 @@ will return a JSON object of the form:
     "Description" : {
         "SeriesName" : "",
         "SeriesDescription"  : ""
-    }
+    },
     "Dimensions" : {
         "XSpace" : {
             "Length" : "",
@@ -686,6 +693,13 @@ will return a JSON object of the form:
             "Length" : "",
             "StepSize" : ""
         }
+    },
+    "ScannerInfo" : {
+      "Manufacturer" : $scannerManufacturer,
+      "Model" : $scannerModel,
+      "SoftwareVersion" : $scannerSoftwareVersion,
+      "SerialNumber" : $scannerSerialNumber,
+      "FieldStrength" : $scannerFieldStrength
     }
 }
 ```