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

export class DashboardReportResult
{
    public totalCount: number;
    public reportResult: Object[];

    public constructor(init?: Partial<DashboardReportResult>) { (Object as any).assign(this, init); }
}

export enum ReportFilterType
{
    list = 'list',
    list_like = 'list_like',
    date = 'date',
    range = 'range',
}

export class ReportFilter
{
    public type: ReportFilterType;
    public values: string[];
    public start?: string;
    public end?: string;
    public higherThan?: number;
    public lowerThan?: number;

    public constructor(init?: Partial<ReportFilter>) { (Object as any).assign(this, init); }
}

export class ReportsPaging
{
    public page: number;
    public pageSize: number;

    public constructor(init?: Partial<ReportsPaging>) { (Object as any).assign(this, init); }
}

export enum ReportSortType
{
    asc = 'asc',
    desc = 'desc',
}

export class DashboardReportRequest implements IPost
{
    /** @description Report Name */
    // @ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")
    public reportName: string;

    /** @description Filters */
    // @ApiMember(Description="Filters", IsRequired=true, ParameterType="body")
    public filters: { [index:string]: ReportFilter; } = {};

    /** @description Paging */
    // @ApiMember(Description="Paging", ParameterType="body")
    public paging: ReportsPaging;

    /** @description Sorting */
    // @ApiMember(Description="Sorting", ParameterType="body")
    public sorting: { [index:string]: ReportSortType; } = {};

    public constructor(init?: Partial<DashboardReportRequest>) { (Object as any).assign(this, init); }
}

TypeScript DashboardReportRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"reportName":"String","filters":{"String":{"type":"list","start":"\/Date(-62135596800000-0000)\/","end":"\/Date(-62135596800000-0000)\/","higherThan":0,"lowerThan":0}},"paging":{"page":0,"pageSize":0},"sorting":{"String":"asc"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"totalCount":0}