Mercedes.VehicleManagement.API

<back to all web services

DashboardCsvReportsRequest

Reports
Requires Authentication
The following routes are available for this service:
POST/v1/reports/CsvRetrieve Report by ReportName and Filters and return as CSV
package dtos

import (
	"time"
)

type DashboardReportResult struct {
	TotalCount   int           `json:"totalCount,omitempty"`
	ReportResult []interface{} `json:"reportResult"`
}

type ReportFilterType string

const (
	ReportFilterTypelist      ReportFilterType = "list"
	ReportFilterTypelist_like                  = "list_like"
	ReportFilterTypedate                       = "date"
	ReportFilterTyperange                      = "range"
)

type ReportFilter struct {
	Type       ReportFilterType `json:"type,omitempty"`
	Values     []string         `json:"values"`
	Start      *time.Time       `json:"start,omitempty"`
	End        *time.Time       `json:"end,omitempty"`
	HigherThan *int             `json:"higherThan,omitempty"`
	LowerThan  *int             `json:"lowerThan,omitempty"`
}

type DashboardCsvReportsRequest struct {
	/** @description Report Name */
	// @ApiMember(Description="Report Name", IsRequired=true, ParameterType="body")
	ReportName string `json:"reportName"`
	/** @description Filters */
	// @ApiMember(Description="Filters", IsRequired=true, ParameterType="body")
	Filters map[string]ReportFilter `json:"filters"`
}

Go DashboardCsvReportsRequest 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/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>