Mercedes.VehicleManagement.API

<back to all web services

DashboardReportRequest

Reports
Requires Authentication
The following routes are available for this service:
POST/v1/reportsRetrieve Report by ReportName and Filters
DashboardReportRequest Parameters:
NameParameterData TypeRequiredDescription
ReportNamebodystringYesReport Name
FiltersbodyDictionary<string, ReportFilter>YesFilters
PagingbodyReportsPagingYesPaging
SortingbodyDictionary<string, ReportSortType>YesSorting
ReportFilter Parameters:
NameParameterData TypeRequiredDescription
TypeformReportFilterTypeNo
ValuesformIEnumerable<string>Yes
StartformDateTime?No
EndformDateTime?No
HigherThanformint?No
LowerThanformint?No
ReportFilterType Enum:
list
list_like
date
range
ReportsPaging Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
PageSizeformintNo
ReportSortType Enum:
asc
desc
DashboardReportResult Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
ReportResultformIEnumerable<Object>Yes

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 /v1/reports HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reportName: String,
	filters: 
	{
		String: 
		{
			type: list,
			start: 0001-01-01,
			end: 0001-01-01,
			higherThan: 0,
			lowerThan: 0
		}
	},
	paging: 
	{
		page: 0,
		pageSize: 0
	},
	sorting: 
	{
		String: asc
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	totalCount: 0
}