Mercedes.VehicleManagement.API

DashboardReportRequest

Reports

The following routes are available for this service:
POST	/v1/reports	Retrieve Report by ReportName and Filters

**DashboardReportRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ReportName	body	string	Yes	Report Name
Filters	body	Dictionary<string, ReportFilter>	Yes	Filters
Paging	body	ReportsPaging	Yes	Paging
Sorting	body	Dictionary<string, ReportSortType>	Yes	Sorting

**ReportFilter** Parameters:
Name	Parameter	Data Type	Required
Type	form	ReportFilterType	No
Values	form	IEnumerable<string>	Yes
Start	form	DateTime?	No
End	form	DateTime?	No
HigherThan	form	int?	No
LowerThan	form	int?	No

**ReportFilterType** Enum:
list
list_like
date
range

**ReportsPaging** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	int	No
PageSize	form	int	No

**ReportSortType** Enum:
asc
desc

**DashboardReportResult** Parameters:
Name	Parameter	Data Type	Required	Description
TotalCount	form	int	No
ReportResult	form	IEnumerable<Object>	Yes

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DashboardReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.ServiceModel">
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringReportFilterI2Pv2xeL>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO">
        <d4p1:End>0001-01-01T00:00:00</d4p1:End>
        <d4p1:HigherThan>0</d4p1:HigherThan>
        <d4p1:LowerThan>0</d4p1:LowerThan>
        <d4p1:Start>0001-01-01T00:00:00</d4p1:Start>
        <d4p1:Type>list</d4p1:Type>
        <d4p1:Values i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringReportFilterI2Pv2xeL>
  </Filters>
  <Paging xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO">
    <d2p1:Page>0</d2p1:Page>
    <d2p1:PageSize>0</d2p1:PageSize>
  </Paging>
  <ReportName>String</ReportName>
  <Sorting xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringReportSortTypeI2Pv2xeL>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>asc</d2p1:Value>
    </d2p1:KeyValueOfstringReportSortTypeI2Pv2xeL>
  </Sorting>
</DashboardReportRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardReportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO">
  <ReportResult xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <TotalCount>0</TotalCount>
</DashboardReportResult>