Mercedes.VehicleManagement.API

DashboardReportRequest

Reports

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

const std = @import("std");

pub const DashboardReportResult = struct {
    totalCount: i32 = 0,
    reportResult: []std.json.Value = &.{},
};

pub const ReportFilterType = enum {
    list,
    list_like,
    date,
    range,
};

pub const ReportFilter = struct {
    type: ?ReportFilterType = null,
    values: [][]const u8 = &.{},
    start: ?[]const u8 = null,
    end: ?[]const u8 = null,
    higherThan: ?i32 = null,
    lowerThan: ?i32 = null,
};

pub const ReportsPaging = struct {
    page: i32 = 0,
    pageSize: i32 = 0,
};

pub const ReportSortType = enum {
    asc,
    desc,
};

pub const DashboardReportRequest = struct {
    /// Report Name
    // @ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")
    reportName: ?[]const u8 = null,

    /// Filters
    // @ApiMember(Description="Filters", IsRequired=true, ParameterType="body")
    filters: ?std.json.Value = null,

    /// Paging
    // @ApiMember(Description="Paging", ParameterType="body")
    paging: ?ReportsPaging = null,

    /// Sorting
    // @ApiMember(Description="Sorting", ParameterType="body")
    sorting: ?std.json.Value = null,
};

Zig 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>