VitalWare API

<back to all web services

Dashboard

The following routes are available for this service:
POST GET/dashboard/Gets Dashboard Items

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/Dashboard HTTP/1.1 
Host: api.vitalware.com 
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	},
	webinars: 
	[
		{
			entryId: 0,
			entryName: String,
			boldedEntryName: String,
			trainingUrl: String,
			scheduleOnText: String,
			displayOnText: String,
			timeZone: String,
			scheduleOn: 0001-01-01,
			displayOn: 0001-01-01,
			bolded: False
		}
	],
	featureDocuments: 
	[
		{
			productName: String,
			sourceUrl: String,
			mimeType: String
		}
	],
	trainingMaterials: 
	[
		{
			productName: String,
			mediaType: String,
			title: String,
			tooltip: String,
			htmlDescription: String,
			bolded: False,
			previewImageUrl: String
		}
	]
}