Mercedes.VehicleManagement.API

DashboardReportRequest

Reports

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

"use strict";
export class DashboardReportResult {
    /** @param {{totalCount?:number,reportResult?:Object[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    totalCount;
    /** @type {Object[]} */
    reportResult;
}
/** @typedef {'list'|'list_like'|'date'|'range'} */
export var ReportFilterType;
(function (ReportFilterType) {
    ReportFilterType["list"] = "list"
    ReportFilterType["list_like"] = "list_like"
    ReportFilterType["date"] = "date"
    ReportFilterType["range"] = "range"
})(ReportFilterType || (ReportFilterType = {}));
export class ReportFilter {
    /** @param {{type?:ReportFilterType,values?:string[],start?:string,end?:string,higherThan?:number,lowerThan?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ReportFilterType} */
    type;
    /** @type {string[]} */
    values;
    /** @type {?string} */
    start;
    /** @type {?string} */
    end;
    /** @type {?number} */
    higherThan;
    /** @type {?number} */
    lowerThan;
}
export class ReportsPaging {
    /** @param {{page?:number,pageSize?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    page;
    /** @type {number} */
    pageSize;
}
/** @typedef {'asc'|'desc'} */
export var ReportSortType;
(function (ReportSortType) {
    ReportSortType["asc"] = "asc"
    ReportSortType["desc"] = "desc"
})(ReportSortType || (ReportSortType = {}));
export class DashboardReportRequest {
    /** @param {{reportName?:string,filters?:{ [index:string]: ReportFilter; },paging?:ReportsPaging,sorting?:{ [index:string]: ReportSortType; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Report Name */
    reportName;
    /**
     * @type {{ [index:string]: ReportFilter; }}
     * @description Filters */
    filters = {};
    /**
     * @type {ReportsPaging}
     * @description Paging */
    paging;
    /**
     * @type {{ [index:string]: ReportSortType; }}
     * @description Sorting */
    sorting = {};
}

JavaScript DashboardReportRequest 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 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>