DashboardProvider Service

Namespace
http://airportal.service.cbtweb.cbt.com/
WSDL
airportal.wsdl
Path
/DashboardProviderService

getWidgetLocations Operation

Get all the dashboard widget locations for a specific user

Input Parameters
name type description
dashboardId long  
Return Value
type description
list of dashboardLocation dashboardLocationList

getOtherDashboardWidgets Operation

Get all widgets available to a dashboard

Input Parameters
name type description
dashboardId long The id of the dashboard
Return Value
type description
list of widgetDashboard A list of WidgetDashboard objects, that contain the widget, the dashboard, and whether it is a default widget

appendWidget Operation

Adds a widget to the end of the user's dashboard locations

Input Parameters
name type description
widgetId long  
dashboardId long  
Return Value
type description
dashboardLocation The DashboardLocation or null if the widget could not be added

addWidget Operation

A function to swap the position of two widgets. If there was no previous widget in that position, then it will simply be added. This applies to the settings of a single user only.

Input Parameters
name type description
widgetId long the id of the widget being moved.
newposition int the position that the widget was moved to, this is the position of the other widget being moved also.
dashboardId long  
Return Value
type description
string  

swapWidget Operation

A function to swap the position of two widgets. If there was no previous widget in that position, then it will simply be added. This applies to the settings of a single user only.

Input Parameters
name type description
widgetId long the id of the widget being moved.
newposition int the position that the widget was moved to, this is the position of the other widget being moved also.
dashboardId long  
Return Value
type description
string  

removeWidget Operation

A function to remove a widget for the user that is logged in.

Input Parameters
name type description
widgetId long the id of the widget being removed.
dashboardId long  
Return Value
type description
string  

getQuickLinksForLoggedInUser Operation

Get a list of quicklinks that belong to the client and dashboard

Input Parameters
name type description
dashboardId long  
Return Value
type description
list of quickLink  

Add/update a quicklink so that it can be added to clients later.

Input Parameters
name type description
record quickLink The quicklink to add or update.
Return Value
type description
quickLink The quicklink that was created.

Search quick links

Input Parameters
name type description
searchList searchList  
Return Value
type description
list of quickLink  

setWidgetConfig Operation

Sets the config string for a user's widget

Input Parameters
name type description
dashboardLocationId long The id of the user's widget
config string The string to set the config to.

getWidgetConfig Operation

Sets the config string for a user's widget

Input Parameters
name type description
dashboardLocationId long The id of the user's widget
Return Value
type description
string  

saveLayout Operation

Save a user's dashboard layout. This endpoint removes the old and adds the new, so there will be some id inflation

Input Parameters
name type description
layout list of dashboardLocation  
dashboardId long  

getManagedWidgets Operation

Get all available widgets for the given dashboard

Input Parameters
name type description
dashboardId long  
Return Value
type description
list of managedWidget  

getCustomLinkById Operation

Get custom link by id

Input Parameters
name type description
id long  
Return Value
type description
customLink  

getCustomLinksForDashboard Operation

Get a dashboard's permissioned quicklinks for logged in user

Input Parameters
name type description
dashboardId long The dashboard to get quicklinks for
Return Value
type description
list of customLink  

getCustomLinksForClient Operation

Get the custom links for a client

Input Parameters
name type description
clientId long  
Return Value
type description
list of customLink  

Save a custom link

Input Parameters
name type description
customLink customLink  
Return Value
type description
customLink  

Delete a custom link

Input Parameters
name type description
id long