POST | /v1/reports/Csv | Retrieve Report by ReportName and Filters and return as CSV |
---|
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 DashboardCsvReportsRequest
: 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();
}
}
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,
}
}
C# DashboardCsvReportsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>