Answer to the Ultimate Question of Life, the Universe, and Everything

Fixes #42
Adds format info, /Format webapp path, related docs

Author: eduard93

MDX2JSON/REST.cls.xml

@@ -24,13 +24,19 @@ To get information about possible Cube's filters and filters' values:<br><ul>
         <li>webapplication/FilterValues/:cube - to get all filters for DeepSee Cube in JSON format.</li> 
         <li>webapplication/FilterValues/:cube - Same but with POST { "Cube":"CubeName","Values":0} body. If values = 1, then filters' values would also be provided.</li> 
         <li>webapplication/FilterValues/:cube/:filter - to get all values for Filter for DeepSee Cube in JSON format.</li></ul> 
-Example: send HTTP GET request to web application with Dispatch class <b>MDX2JSON.REST</b> and URL:<br>
-/FilterValues/HoleFoods/[DateOfSale].[Actual].[MonthSold] -  to get information about possible values of [DateOfSale].[Actual].[MonthSold] in HoleFoods Cube.<br>
-
+        
 To get information about pivot:<br><ul>
         <li>webapplication/DataSource- to get info about pivot (POST {DataSource:"Name of DS"})</li> </ul> 
+        
+To get information about system-wide defaults (format):<br><ul>
+        <li>webapplication/Format - to get info about system-wide defaults (format). GET request </li> </ul> 
+        
 You can add a param Namespace to request to execute MDX in desired namespace (MDX2JSON package must be mapped to that namespace):<br>
-webapplication/MDX?Namespace=Samples<br>]]></Description>
+webapplication/MDX?Namespace=Samples<br>
+
+Example: send HTTP GET request to web application with Dispatch class <b>MDX2JSON.REST</b> and URL:<br>
+/FilterValues/HoleFoods/[DateOfSale].[Actual].[MonthSold] -  to get information about possible values of [DateOfSale].[Actual].[MonthSold] in HoleFoods Cube.<br>
+]]></Description>
 <IncludeCode>MDX2JSON.MDX2JSON</IncludeCode>
 <Super>MDX2JSON.AbstractREST</Super>
 <TimeCreated>63165,65257.8179</TimeCreated>
@@ -52,6 +58,9 @@ webapplication/MDX?Namespace=Samples<br>]]></Description>
    <!-- Get info about widgets-->
    <Route Url="/Dashboards" Method="GET" Call="GetDashboardList"/> 
    <Route Url="/Widgets" Method="POST" Call="GetWidgetsList" Body="Dashboard"/>
+   
+   <!-- Get info about system format and locale-->
+   <Route Url="/Format" Method="GET" Call="GetFormat"/> 
        
    <!-- Get info about pivot-->
    <Route Url="/DataSource" Method="POST" Call="GetDataSource" Body="DataSource"/>   
@@ -255,5 +264,14 @@ Converts incoming request object and calls abovementioned method.]]></Descriptio
 <Implementation><![CDATA[    return ##class(MDX2JSON.Utils).WriteXMLAfromMDX(%request.Content.MDX)
 ]]></Implementation>
 </Method>
+
+<Method name="GetFormat">
+<Description>
+Wrapper for ##class(MDX2JSON.Utils).GetFormat()</Description>
+<ClassMethod>1</ClassMethod>
+<ReturnType>%Status</ReturnType>
+<Implementation><![CDATA[    return ##class(MDX2JSON.Utils).GetFormat()
+]]></Implementation>
+</Method>
 </Class>
 </Export>

MDX2JSON/Utils.cls.xml

@@ -219,5 +219,35 @@ Using dashboard name get JSON representation (array of ("type","title","mdx")) o
     return st
 ]]></Implementation>
 </Method>
+
+<Method name="GetFormat">
+<Description>
+Get format defaults.</Description>
+<ClassMethod>1</ClassMethod>
+<ReturnType>%Status</ReturnType>
+<Implementation><![CDATA[
+	set st = $$$OK
+	set datelist="DD Mmm [YY]YY^MM/DD/[YY]^DD Mmm [YY]YY^YYYY-MM-DD^DD/MM/[YY]YY^Mmm D, YYYY^Mmm D YYYY^Mmm DD [YY]YY^YYYYMMDD^Mmmmmm D, YYYY^W^Www^Wwwwww^[D]D/[M]M/YYYY^nnn"	
+	set timelist="hh:mm:ss,hh:mm,hh:mm:ss[AM/PM],hh:mm[AM/PM]" // lists taken from %CSP.UI.Portal.NLSEdit - DrawProperties
+	set proplist = "AM,DateSeparator,DecimalSeparator,MinusSign,MonthAbbr,MonthName,NumericGroupSeparator,NumericGroupSize,PM,PlusSign,TimePrecision,TimeSeparator,WeekdayAbbr,WeekdayName"
+	set obj = ##class(%ZEN.proxyObject).%New()
+	
+    try {
+		for i = 1:1:$L(proplist, ",") {
+			set property = $P(proplist, ",", i)
+		    do obj.%DispatchSetProperty(property,##class(%SYS.NLS.Format).GetFormatItem(property))
+		}
+		
+		// that's why we cant just do ##class(%ZEN.Auxiliary.jsonProvider).%ObjectToJSON()
+		set obj.DateFormat = $P(datelist, "^",##class(%SYS.NLS.Format).GetFormatItem("DateFormat"))
+		set obj.TimeFormat = $P(timelist, ",",##class(%SYS.NLS.Format).GetFormatItem("TimeFormat"))
+		
+		do obj.%ToJSON()	   
+    } catch ex {
+        set st = ex.AsStatus()
+    }
+    return st
+]]></Implementation>
+</Method>
 </Class>
 </Export>

README.md

@@ -39,6 +39,7 @@ These are the possible requests to web application (add param ?Namespace={Desire
 | FilterValues/:cube          | GET  |                             | JSON      | All filters for DeepSee Cube   |
 | FilterValues                | POST |{ "Cube":"Cube Name","Values":1}| JSON   | All filters for DeepSee Cube with values (if Values = 1, set to 0 or omit otherwise)|
 | FilterValues/:cube/:filter  | GET  |                             | JSON      | All possible values for filter |
+| Format                      | GET  |                             | JSON      | Default formatting             |
 | Test                        | GET  |                             | JSON      | Test info                      |
 
 Example