855.367.3511 | CONTACT US
Public Member Functions | List of all members
ReportManager.Controllers.ReportViewerController Class Reference

Inherits ApiController.

Public Member Functions

HttpResponseMessage AcceptLanguage ()
 Returns acceptable language choices as defined by the browser More...
 
HttpResponseMessage Image (string SessionID, string ImageID, string instance=null)
 Used to get report images from the server. Called from the Report Renderer. More...
 
HttpResponseMessage Thumbnail (string ReportPath, string SessionID, int PageNumber, double maxHeightToWidthRatio=1.2, string instance=null)
 Returns a thumbnail image of the given ReportPath for the specified page More...
 
HttpResponseMessage LoadReportDefinition (LoadReportDefPostBack postBackValue)
 Retrieves the session ID for the report created with the given RDL specified PageNumber. More...
 
HttpResponseMessage ReportJSON (ParametersPostBack postBackValue)
 Retrieves the JSON representation ReportPath given the ParameterList for the specified PageNumber. More...
 
HttpResponseMessage ParameterJSON (ParametersPostBack postBackValue)
 Returns the parameters for the given ReportPath, PageNumber and current ParameterList. More...
 
HttpResponseMessage ResetExecution (string SessionID, string instance=null)
 Resets the report, to get new data More...
 
HttpResponseMessage DocMapJSON (string SessionID, string instance=null)
 Returns the document map structure for the current SessionID More...
 
HttpResponseMessage SortReport (string SessionID, string SortItem, string Direction, bool ClearExistingSort=true, string instance=null)
 Will sort the current report based upon the SortItem and Direction More...
 
HttpResponseMessage PingSession (string PingSessionID, string instance=null)
 Used to keep the current session active More...
 
void WriteClientErrorLog (string ReportPath, string ErrorMsg)
 Not implemented More...
 
HttpResponseMessage NavigateTo (string NavType, string SessionID, string UniqueID, string instance=null)
 Used to navigate to bookmarks, drill through reports, etc. More...
 
HttpResponseMessage FindString (string SessionID, int StartPage, int EndPage, string FindValue, string instance=null)
 Used to find the given FindValue within the specified page range More...
 
HttpResponseMessage ExportReport (string ReportPath, string SessionID, string ExportType, string instance=null)
 Returns a mime object based on the given ExportType More...
 
HttpResponseMessage PrintReport (string ReportPath, string SessionID, string PrintPropertyString, string instance=null)
 Causes the print dialog of the PDF viewer to automatically be launched for printing. No ActiveX control (yeah!). More...
 
HttpResponseMessage LoginUrl ()
 Returns the LoginUrl More...
 

Member Function Documentation

HttpResponseMessage ReportManager.Controllers.ReportViewerController.AcceptLanguage ( )

Returns acceptable language choices as defined by the browser

Returns
JSON array. E.g., ["en","en-US"]
HttpResponseMessage ReportManager.Controllers.ReportViewerController.DocMapJSON ( string  SessionID,
string  instance = null 
)

Returns the document map structure for the current SessionID

Parameters
SessionIDCurrent session id
instance
Returns
JSON object containing the document map
HttpResponseMessage ReportManager.Controllers.ReportViewerController.ExportReport ( string  ReportPath,
string  SessionID,
string  ExportType,
string  instance = null 
)

Returns a mime object based on the given ExportType

Parameters
ReportPathPath to the report
SessionIDCurrent session id
ExportTypeExport type: "XML", "CSV", "PDF", "MHTML", "EXCELOPENXML", "IMAGE" or "WORDOPENXML"
instance
Returns
Mime object corresponding to the given ExportType
HttpResponseMessage ReportManager.Controllers.ReportViewerController.FindString ( string  SessionID,
int  StartPage,
int  EndPage,
string  FindValue,
string  instance = null 
)

Used to find the given FindValue within the specified page range

Parameters
SessionIDCurrent session id
StartPageStart page
EndPageEnd page
FindValueFind value
instance
Returns
JSON object indicating the result of the find. E.g., { "NewPage":1 }
HttpResponseMessage ReportManager.Controllers.ReportViewerController.Image ( string  SessionID,
string  ImageID,
string  instance = null 
)

Used to get report images from the server. Called from the Report Renderer.

Parameters
SessionIDCurrent session id
ImageIDImage id
instance
Returns
Image mime type. E.g., "image/jpeg"
HttpResponseMessage ReportManager.Controllers.ReportViewerController.LoadReportDefinition ( LoadReportDefPostBack  postBackValue)

Retrieves the session ID for the report created with the given RDL specified PageNumber.

Parameters
postBackValueRDL
Returns
JSON object with SessionID and any warnings to dynamic report
HttpResponseMessage ReportManager.Controllers.ReportViewerController.LoginUrl ( )

Returns the LoginUrl

Returns
JSON object containing the Login URL. E.g., { "LoginUrl" : "~/Login/Login" }
HttpResponseMessage ReportManager.Controllers.ReportViewerController.NavigateTo ( string  NavType,
string  SessionID,
string  UniqueID,
string  instance = null 
)

Used to navigate to bookmarks, drill through reports, etc.

Parameters
NavType"toggle", "bookmark", "drillthrough" or "documentMap"
SessionIDCurrent session id
UniqueIDUnique id of the NavigateTo action
instance
Returns
JSON object indicating status. E.g. { "Result":true, "ToggleID":"48iT0R0x0" }
HttpResponseMessage ReportManager.Controllers.ReportViewerController.ParameterJSON ( ParametersPostBack  postBackValue)

Returns the parameters for the given ReportPath, PageNumber and current ParameterList.

Parameters
postBackValueJSON object
Returns
JSON object containing the parameter list
HttpResponseMessage ReportManager.Controllers.ReportViewerController.PingSession ( string  PingSessionID,
string  instance = null 
)

Used to keep the current session active

Parameters
PingSessionIDCurrent Session is
instance
Returns
JSON object indicating status
HttpResponseMessage ReportManager.Controllers.ReportViewerController.PrintReport ( string  ReportPath,
string  SessionID,
string  PrintPropertyString,
string  instance = null 
)

Causes the print dialog of the PDF viewer to automatically be launched for printing. No ActiveX control (yeah!).

Parameters
ReportPathReport path
SessionIDCurrent session id
PrintPropertyStringPrint string. E.g., {"PrintPropertyList":[{"key":"PageHeight", "value":"11"},{"key":"PageWidth","value":"8.5"},{"key":"MarginTop","value":"1"},{"key":"MarginBottom", "value":"1"},{"key":"MarginLeft","value":"1"},{"key":"MarginRight","value":"1"}]}
instance
Returns
"application/pdf" object
HttpResponseMessage ReportManager.Controllers.ReportViewerController.ReportJSON ( ParametersPostBack  postBackValue)

Retrieves the JSON representation ReportPath given the ParameterList for the specified PageNumber.

Parameters
postBackValueJSON object
Returns
JSON object used to render the report
HttpResponseMessage ReportManager.Controllers.ReportViewerController.ResetExecution ( string  SessionID,
string  instance = null 
)

Resets the report, to get new data

Parameters
SessionIDCurrent session id
instance
HttpResponseMessage ReportManager.Controllers.ReportViewerController.SortReport ( string  SessionID,
string  SortItem,
string  Direction,
bool  ClearExistingSort = true,
string  instance = null 
)

Will sort the current report based upon the SortItem and Direction

Parameters
SessionIDCurrent Session id
SortItemSort Item
DirectionDirection
ClearExistingSortDefaults to true
instance
Returns
JSON object indicating status
HttpResponseMessage ReportManager.Controllers.ReportViewerController.Thumbnail ( string  ReportPath,
string  SessionID,
int  PageNumber,
double  maxHeightToWidthRatio = 1.2,
string  instance = null 
)

Returns a thumbnail image of the given ReportPath for the specified page

Parameters
ReportPathReport Path
SessionIDCurrent Session id
PageNumberPage number
maxHeightToWidthRatioDefaults to 1.2
instance
Returns
Mime type "image/JPEG"
void ReportManager.Controllers.ReportViewerController.WriteClientErrorLog ( string  ReportPath,
string  ErrorMsg 
)

Not implemented

Parameters
ReportPath
ErrorMsg