Mercedes.VehicleManagement.API

DashboardCsvReportsRequest

Reports

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

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class DashboardCsvReportsRequest implements IPost
    {
        /**
        * Report Name
        */
        @ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")
        public String reportName = null;

        /**
        * Filters
        */
        @ApiMember(Description="Filters", IsRequired=true, ParameterType="body")
        public HashMap<String,ReportFilter> filters = new HashMap<String,ReportFilter>();
        
        public String getReportName() { return reportName; }
        public DashboardCsvReportsRequest setReportName(String value) { this.reportName = value; return this; }
        public HashMap<String,ReportFilter> getFilters() { return filters; }
        public DashboardCsvReportsRequest setFilters(HashMap<String,ReportFilter> value) { this.filters = value; return this; }
    }

    public static class ReportFilter
    {
        public ReportFilterType type = null;
        public ArrayList<String> values = null;
        public Date start = null;
        public Date end = null;
        public Integer higherThan = null;
        public Integer lowerThan = null;
        
        public ReportFilterType getType() { return type; }
        public ReportFilter setType(ReportFilterType value) { this.type = value; return this; }
        public ArrayList<String> getValues() { return values; }
        public ReportFilter setValues(ArrayList<String> value) { this.values = value; return this; }
        public Date getStart() { return start; }
        public ReportFilter setStart(Date value) { this.start = value; return this; }
        public Date getEnd() { return end; }
        public ReportFilter setEnd(Date value) { this.end = value; return this; }
        public Integer getHigherThan() { return higherThan; }
        public ReportFilter setHigherThan(Integer value) { this.higherThan = value; return this; }
        public Integer getLowerThan() { return lowerThan; }
        public ReportFilter setLowerThan(Integer value) { this.lowerThan = value; return this; }
    }

    public static enum ReportFilterType
    {
        List,
        ListLike,
        Date,
        Range;
    }

    public static class DashboardReportResult
    {
        public Integer totalCount = null;
        public ArrayList<Object> reportResult = null;
        
        public Integer getTotalCount() { return totalCount; }
        public DashboardReportResult setTotalCount(Integer value) { this.totalCount = value; return this; }
        public ArrayList<Object> getReportResult() { return reportResult; }
        public DashboardReportResult setReportResult(ArrayList<Object> value) { this.reportResult = value; return this; }
    }

}

Java DashboardCsvReportsRequest DTOs

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

<DashboardCsvReportsRequest 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>
  <ReportName>String</ReportName>
</DashboardCsvReportsRequest>

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>