Mercedes.VehicleManagement.API

DashboardReportRequest

Reports

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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Mercedes.VehicleManagement.API.ServiceModel;
using Mercedes.VehicleManagement.API.Shared.POCO;

namespace Mercedes.VehicleManagement.API.ServiceModel
{
    public partial class DashboardReportRequest
        : IPost
    {
        ///<summary>
        ///Report Name
        ///</summary>
        [ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")]
        public virtual string ReportName { get; set; }

        ///<summary>
        ///Filters
        ///</summary>
        [ApiMember(Description="Filters", IsRequired=true, ParameterType="body")]
        public virtual Dictionary<string, ReportFilter> Filters { get; set; } = new();

        ///<summary>
        ///Paging
        ///</summary>
        [ApiMember(Description="Paging", ParameterType="body")]
        public virtual ReportsPaging Paging { get; set; }

        ///<summary>
        ///Sorting
        ///</summary>
        [ApiMember(Description="Sorting", ParameterType="body")]
        public virtual Dictionary<string, ReportSortType> Sorting { get; set; } = new();
    }

}

namespace Mercedes.VehicleManagement.API.Shared.POCO
{
    public partial class DashboardReportResult
    {
        public virtual int TotalCount { get; set; }
        public virtual IEnumerable<Object> ReportResult { get; set; }
    }

    public partial class ReportFilter
    {
        public virtual ReportFilterType Type { get; set; }
        public virtual IEnumerable<string> Values { get; set; }
        public virtual DateTime? Start { get; set; }
        public virtual DateTime? End { get; set; }
        public virtual int? HigherThan { get; set; }
        public virtual int? LowerThan { get; set; }
    }

    public enum ReportFilterType
    {
        list,
        list_like,
        date,
        range,
    }

    public enum ReportSortType
    {
        asc,
        desc,
    }

    public partial class ReportsPaging
    {
        public virtual int Page { get; set; }
        public virtual int PageSize { get; set; }
    }

}

C# DashboardReportRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reportName: String,
	filters: 
	{
		String: 
		{
			type: list,
			start: 0001-01-01,
			end: 0001-01-01,
			higherThan: 0,
			lowerThan: 0
		}
	},
	paging: 
	{
		page: 0,
		pageSize: 0
	},
	sorting: 
	{
		String: asc
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	totalCount: 0
}