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
namespace Mercedes.VehicleManagement.API.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DashboardReportResult() = 
        member val TotalCount:Int32 = new Int32() with get,set
        member val ReportResult:IEnumerable<Object> = null with get,set

    type ReportFilterType =
        | list = 0
        | list_like = 1
        | date = 2
        | range = 3

    [<AllowNullLiteral>]
    type ReportFilter() = 
        member val Type:ReportFilterType = new ReportFilterType() with get,set
        member val Values:IEnumerable<String> = null with get,set
        member val Start:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val End:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val HigherThan:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LowerThan:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type ReportsPaging() = 
        member val Page:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set

    type ReportSortType =
        | asc = 0
        | desc = 1

    [<AllowNullLiteral>]
    type DashboardReportRequest() = 
        interface IPost
        ///<summary>
        ///Report Name
        ///</summary>
        [<ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")>]
        member val ReportName:String = null with get,set

        ///<summary>
        ///Filters
        ///</summary>
        [<ApiMember(Description="Filters", IsRequired=true, ParameterType="body")>]
        member val Filters:Dictionary<String, ReportFilter> = null with get,set

        ///<summary>
        ///Paging
        ///</summary>
        [<ApiMember(Description="Paging", ParameterType="body")>]
        member val Paging:ReportsPaging = null with get,set

        ///<summary>
        ///Sorting
        ///</summary>
        [<ApiMember(Description="Sorting", ParameterType="body")>]
        member val Sorting:Dictionary<String, ReportSortType> = null with get,set

F# 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>