Therefore Web API Programming Interface 1.0

GetUserDashboards

Scroll

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetUserDashboards

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetUserDashboards

Loads an user specific dashboard configuration

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetUserDashboards

Element Name	Element Type	Restrictions	Description
■ parameters
□ LoadDashboardData	xs:boolean	optional nillable	Defines if also the full dashboard configuration should be loaded
□ UserNo	xs:int	optional nillable	The user number to load the dashboard information for

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetUserDashboardsResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ UserDashboards		mandatory nillable	The dashboards and their order for the user
≡ WSUserDashboard		optional unbounded nillable
□ Dashboard		optional nillable	The dashboard no for this position
■ DashboardNo	xs:int	mandatory	Number of the dashboard
□ Name	xs:string	mandatory nillable	Name of the dashboard
■ CreatedByUserNo	xs:int	mandatory	User that created the dashboard
■ Created	xs:dateTime	mandatory	DateTime when the dashboard was last modified
■ Shared	xs:boolean	mandatory	Informs if the dashboard is shared
■ Guid	xs:string	optional GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}	Gets the GUID of the dashboard
■ FolderNo	xs:int	optional	Folder number which contains the dashboard
□ DashboardData	xs:string	mandatory nillable	JSON definition of the dashboard
■ Position	xs:int	optional	The position of the user dashboard in the list of dashboards

Legend:

■	Not nillable element.
□	Nillable element.
≡	Unbounded element (List of elements).
Normal	Optional element.
Bold	Mandatory element.