Mercedes.VehicleManagement.API

<back to all web services

MotabilityVehiclesRequest

Vehicle
Requires Authentication
The following routes are available for this service:
GET/v1/{VehicleType}/Vehicle/MotabilityGet motability vehicle data
package dtos

import (
	"time"
)

type VehicleDataBase struct {
	Vin                                   string     `json:"vin"`
	Description                           string     `json:"description"`
	Model                                 string     `json:"model"`
	Otr                                   string     `json:"otr"`
	RetailPriceExVAT                      string     `json:"retailPriceExVAT"`
	ActualPrice                           string     `json:"actualPrice"`
	P11D                                  string     `json:"p11D"`
	FuelType                              string     `json:"fuelType"`
	Transmission                          string     `json:"transmission"`
	TransmissionType                      string     `json:"transmissionType"`
	Colour                                string     `json:"colour"`
	ColourCode                            string     `json:"colourCode"`
	ColourDescription                     string     `json:"colourDescription"`
	CommissionNumber                      string     `json:"commissionNumber"`
	OfferAvailable                        bool       `json:"offerAvailable,omitempty"`
	CampaignDiscountOfferTotal            int        `json:"campaignDiscountOfferTotal,omitempty"`
	CampaignDiscountOfferTotalCurrent     int        `json:"campaignDiscountOfferTotalCurrent,omitempty"`
	CampaignDiscountOfferTotalPending     int        `json:"campaignDiscountOfferTotalPending,omitempty"`
	CampaignServiceOfferTotal             int        `json:"campaignServiceOfferTotal,omitempty"`
	CampaignServiceOfferTotalCurrent      int        `json:"campaignServiceOfferTotalCurrent,omitempty"`
	CampaignServiceOfferTotalPending      int        `json:"campaignServiceOfferTotalPending,omitempty"`
	CampaignCustomOfferTotal              int        `json:"campaignCustomOfferTotal,omitempty"`
	CampaignPersonalisedOfferTotalCurrent int        `json:"campaignPersonalisedOfferTotalCurrent,omitempty"`
	CampaignPersonalisedOfferTotalPending int        `json:"campaignPersonalisedOfferTotalPending,omitempty"`
	CampaignPersonalisedOfferTotal        int        `json:"campaignPersonalisedOfferTotal,omitempty"`
	CampaignCustomOfferTotalCurrent       int        `json:"campaignCustomOfferTotalCurrent,omitempty"`
	CampaignCustomOfferTotalPending       int        `json:"campaignCustomOfferTotalPending,omitempty"`
	CampaignOtherOfferTotal               int        `json:"campaignOtherOfferTotal,omitempty"`
	CampaignOtherOfferTotalCurrent        int        `json:"campaignOtherOfferTotalCurrent,omitempty"`
	CampaignOtherOfferTotalPending        int        `json:"campaignOtherOfferTotalPending,omitempty"`
	RetailerDiscountOfferTotal            int        `json:"retailerDiscountOfferTotal,omitempty"`
	RetailerDiscountOfferTotalCurrent     int        `json:"retailerDiscountOfferTotalCurrent,omitempty"`
	RetailerDiscountOfferTotalPending     int        `json:"retailerDiscountOfferTotalPending,omitempty"`
	RetailerServiceOfferTotal             int        `json:"retailerServiceOfferTotal,omitempty"`
	RetailerServiceOfferTotalCurrent      int        `json:"retailerServiceOfferTotalCurrent,omitempty"`
	RetailerServiceOfferTotalPending      int        `json:"retailerServiceOfferTotalPending,omitempty"`
	RetailerCustomOfferTotal              int        `json:"retailerCustomOfferTotal,omitempty"`
	RetailerCustomOfferTotalCurrent       int        `json:"retailerCustomOfferTotalCurrent,omitempty"`
	RetailerCustomOfferTotalPending       int        `json:"retailerCustomOfferTotalPending,omitempty"`
	RetailerWarrantyOfferTotal            int        `json:"retailerWarrantyOfferTotal,omitempty"`
	RetailerWarrantyOfferTotalCurrent     int        `json:"retailerWarrantyOfferTotalCurrent,omitempty"`
	RetailerWarrantyOfferTotalPending     int        `json:"retailerWarrantyOfferTotalPending,omitempty"`
	RetailerOfferTotal                    int        `json:"retailerOfferTotal,omitempty"`
	RetailerOfferTotalCurrent             int        `json:"retailerOfferTotalCurrent,omitempty"`
	RetailerOfferTotalPending             int        `json:"retailerOfferTotalPending,omitempty"`
	CampaignOfferTotal                    int        `json:"campaignOfferTotal,omitempty"`
	CampaignOfferTotalCurrent             int        `json:"campaignOfferTotalCurrent,omitempty"`
	CampaignOfferTotalPending             int        `json:"campaignOfferTotalPending,omitempty"`
	CampaignAndOfferTotal                 int        `json:"campaignAndOfferTotal,omitempty"`
	CampaignAndOfferTotalCurrent          int        `json:"campaignAndOfferTotalCurrent,omitempty"`
	CampaignAndOfferTotalPending          int        `json:"campaignAndOfferTotalPending,omitempty"`
	OfferTotal                            int        `json:"offerTotal,omitempty"`
	OfferTotalCurrent                     int        `json:"offerTotalCurrent,omitempty"`
	OfferTotalPending                     int        `json:"offerTotalPending,omitempty"`
	Creation                              string     `json:"creation"`
	Modified                              string     `json:"modified"`
	ElectricRange                         int        `json:"electricRange,omitempty"`
	ElectricConsumption                   int        `json:"electricConsumption,omitempty"`
	PortArrivalDate                       *time.Time `json:"portArrivalDate,omitempty"`
	DaysSincePortArrival                  *int       `json:"daysSincePortArrival,omitempty"`
	RetailPriceIncVAT                     float64    `json:"retailPriceIncVAT,omitempty"`
	BodyStyle                             string     `json:"bodyStyle"`
	Upholstery                            string     `json:"upholstery"`
	UpholsteryCode                        string     `json:"upholsteryCode"`
	UpholsteryType                        string     `json:"upholsteryType"`
	PackageNames                          []string   `json:"packageNames"`
	Line                                  string     `json:"line"`
	MappedLine                            string     `json:"mappedLine"`
	CurrentRetailerOfferPrice             float64    `json:"currentRetailerOfferPrice,omitempty"`
	RetailPrice                           string     `json:"retailPrice"`
	VatQualifying                         bool       `json:"vatQualifying,omitempty"`
	RetailerId                            int        `json:"retailerId,omitempty"`
	GssnId                                string     `json:"gssnId"`
	NoImage                               bool       `json:"noImage,omitempty"`
	ImageUrl                              string     `json:"imageUrl"`
	IsAvailableOnline                     bool       `json:"isAvailableOnline,omitempty"`
	IsBackOrdered                         bool       `json:"isBackOrdered,omitempty"`
	CreationDate                          string     `json:"creationDate"`
	MaintenanceDate                       string     `json:"maintenanceDate"`
	RegistrationNumber                    string     `json:"registrationNumber"`
	RegistrationDate                      *time.Time `json:"registrationDate,omitempty"`
	Mileage                               *int       `json:"mileage,omitempty"`
	TradeInDate                           *time.Time `json:"tradeInDate,omitempty"`
	Source                                string     `json:"source"`
	VehicleType                           string     `json:"vehicleType"`
	OfferAmount                           string     `json:"offerAmount"`
	OfferExpiry                           string     `json:"offerExpiry"`
	ActiveOffers                          []int      `json:"activeOffers"`
	CampaignMessagesTotal                 int        `json:"campaignMessagesTotal,omitempty"`
	UnderOffer                            bool       `json:"underOffer,omitempty"`
	IsDisplayStock                        bool       `json:"isDisplayStock,omitempty"`
	DisplayRetailer                       string     `json:"displayRetailer"`
	DisplayRetailerGssnId                 string     `json:"displayRetailerGssnId"`
	Location                              string     `json:"location"`
	Account                               string     `json:"account"`
	AccountType                           string     `json:"accountType"`
	UsageCode                             string     `json:"usageCode"`
	Bm7NST                                string     `json:"bm7NST"`
	IsSellable                            bool       `json:"isSellable,omitempty"`
	Secured                               bool       `json:"secured,omitempty"`
	Specialist                            bool       `json:"specialist,omitempty"`
	IsMotabilityRetailer                  bool       `json:"isMotabilityRetailer,omitempty"`
	UpholsteryDescription                 string     `json:"upholsteryDescription"`
	InBackOrderAccount                    bool       `json:"inBackOrderAccount,omitempty"`
	FullModelYearCode                     *string    `json:"fullModelYearCode,omitempty"`
	Baumuster                             string     `json:"baumuster"`
	IsMotability                          bool       `json:"isMotability,omitempty"`
	PipAdvanceRentalGross                 *float64   `json:"pipAdvanceRentalGross,omitempty"`
	WpmsAdvanceRentalGross                *float64   `json:"wpmsAdvanceRentalGross,omitempty"`
	IspVehicleCustomerDescriptions        []string   `json:"ispVehicleCustomerDescriptions,omitempty"`
	EligibleForMaTransfer                 bool       `json:"eligibleForMaTransfer,omitempty"`
	ConfirmedProductionDate               *string    `json:"confirmedProductionDate,omitempty"`
	ForecastedArrivalDate                 *string    `json:"forecastedArrivalDate,omitempty"`
}

type VehicleData struct {
	VehicleDataBase
	Engine string `json:"engine"`
}

type Equipment struct {
	Id          *int    `json:"id,omitempty"`
	Code        *string `json:"code,omitempty"`
	Description *string `json:"description,omitempty"`
}

type VehicleIdentifierData struct {
	VehicleData
	Retailer           string      `json:"retailer"`
	HasMotabilityError bool        `json:"hasMotabilityError,omitempty"`
	Equipment          []Equipment `json:"equipment"`
	VehicleClass       *string     `json:"vehicleClass,omitempty"`
}

type VehiclesByRetailerResponse struct {
	Vehicles []VehicleIdentifierData `json:"vehicles"`
}

type MotabilityVehiclesRequest struct {
	VehicleType string `json:"vehicleType"`
}

Go MotabilityVehiclesRequest 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.

GET /v1/{VehicleType}/Vehicle/Motability HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VehiclesByRetailerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO">
  <Vehicles>
    <VehicleIdentifierData>
      <Account>String</Account>
      <AccountType>String</AccountType>
      <ActiveOffers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ActiveOffers>
      <ActualPrice>String</ActualPrice>
      <Baumuster>String</Baumuster>
      <Bm7NST>String</Bm7NST>
      <BodyStyle>String</BodyStyle>
      <CampaignAndOfferTotal>0</CampaignAndOfferTotal>
      <CampaignAndOfferTotalCurrent>0</CampaignAndOfferTotalCurrent>
      <CampaignAndOfferTotalPending>0</CampaignAndOfferTotalPending>
      <CampaignCustomOfferTotal>0</CampaignCustomOfferTotal>
      <CampaignCustomOfferTotalCurrent>0</CampaignCustomOfferTotalCurrent>
      <CampaignCustomOfferTotalPending>0</CampaignCustomOfferTotalPending>
      <CampaignDiscountOfferTotal>0</CampaignDiscountOfferTotal>
      <CampaignDiscountOfferTotalCurrent>0</CampaignDiscountOfferTotalCurrent>
      <CampaignDiscountOfferTotalPending>0</CampaignDiscountOfferTotalPending>
      <CampaignMessagesTotal>0</CampaignMessagesTotal>
      <CampaignOfferTotal>0</CampaignOfferTotal>
      <CampaignOfferTotalCurrent>0</CampaignOfferTotalCurrent>
      <CampaignOfferTotalPending>0</CampaignOfferTotalPending>
      <CampaignOtherOfferTotal>0</CampaignOtherOfferTotal>
      <CampaignOtherOfferTotalCurrent>0</CampaignOtherOfferTotalCurrent>
      <CampaignOtherOfferTotalPending>0</CampaignOtherOfferTotalPending>
      <CampaignPersonalisedOfferTotal>0</CampaignPersonalisedOfferTotal>
      <CampaignPersonalisedOfferTotalCurrent>0</CampaignPersonalisedOfferTotalCurrent>
      <CampaignPersonalisedOfferTotalPending>0</CampaignPersonalisedOfferTotalPending>
      <CampaignServiceOfferTotal>0</CampaignServiceOfferTotal>
      <CampaignServiceOfferTotalCurrent>0</CampaignServiceOfferTotalCurrent>
      <CampaignServiceOfferTotalPending>0</CampaignServiceOfferTotalPending>
      <Colour>String</Colour>
      <ColourCode>String</ColourCode>
      <ColourDescription>String</ColourDescription>
      <CommissionNumber>String</CommissionNumber>
      <ConfirmedProductionDate>String</ConfirmedProductionDate>
      <Creation>String</Creation>
      <CreationDate>String</CreationDate>
      <CurrentRetailerOfferPrice>0</CurrentRetailerOfferPrice>
      <DaysSincePortArrival>0</DaysSincePortArrival>
      <Description>String</Description>
      <DisplayRetailer>String</DisplayRetailer>
      <DisplayRetailerGssnId>String</DisplayRetailerGssnId>
      <ElectricConsumption>0</ElectricConsumption>
      <ElectricRange>0</ElectricRange>
      <EligibleForMaTransfer>false</EligibleForMaTransfer>
      <ForecastedArrivalDate>String</ForecastedArrivalDate>
      <FuelType>String</FuelType>
      <FullModelYearCode>String</FullModelYearCode>
      <GssnId>String</GssnId>
      <ImageUrl>String</ImageUrl>
      <InBackOrderAccount>false</InBackOrderAccount>
      <IsAvailableOnline>false</IsAvailableOnline>
      <IsBackOrdered>false</IsBackOrdered>
      <IsDisplayStock>false</IsDisplayStock>
      <IsMotability>false</IsMotability>
      <IsMotabilityRetailer>false</IsMotabilityRetailer>
      <IsSellable>false</IsSellable>
      <IspVehicleCustomerDescriptions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </IspVehicleCustomerDescriptions>
      <Line>String</Line>
      <Location>String</Location>
      <MaintenanceDate>String</MaintenanceDate>
      <MappedLine>String</MappedLine>
      <Mileage>0</Mileage>
      <Model>String</Model>
      <Modified>String</Modified>
      <NoImage>false</NoImage>
      <OfferAmount>String</OfferAmount>
      <OfferAvailable>false</OfferAvailable>
      <OfferExpiry>String</OfferExpiry>
      <OfferTotal>0</OfferTotal>
      <OfferTotalCurrent>0</OfferTotalCurrent>
      <OfferTotalPending>0</OfferTotalPending>
      <Otr>String</Otr>
      <P11D>String</P11D>
      <PackageNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </PackageNames>
      <PipAdvanceRentalGross>0</PipAdvanceRentalGross>
      <PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate>
      <RegistrationDate>0001-01-01T00:00:00</RegistrationDate>
      <RegistrationNumber>String</RegistrationNumber>
      <RetailPrice>String</RetailPrice>
      <RetailPriceExVAT>String</RetailPriceExVAT>
      <RetailPriceIncVAT>0</RetailPriceIncVAT>
      <RetailerCustomOfferTotal>0</RetailerCustomOfferTotal>
      <RetailerCustomOfferTotalCurrent>0</RetailerCustomOfferTotalCurrent>
      <RetailerCustomOfferTotalPending>0</RetailerCustomOfferTotalPending>
      <RetailerDiscountOfferTotal>0</RetailerDiscountOfferTotal>
      <RetailerDiscountOfferTotalCurrent>0</RetailerDiscountOfferTotalCurrent>
      <RetailerDiscountOfferTotalPending>0</RetailerDiscountOfferTotalPending>
      <RetailerId>0</RetailerId>
      <RetailerOfferTotal>0</RetailerOfferTotal>
      <RetailerOfferTotalCurrent>0</RetailerOfferTotalCurrent>
      <RetailerOfferTotalPending>0</RetailerOfferTotalPending>
      <RetailerServiceOfferTotal>0</RetailerServiceOfferTotal>
      <RetailerServiceOfferTotalCurrent>0</RetailerServiceOfferTotalCurrent>
      <RetailerServiceOfferTotalPending>0</RetailerServiceOfferTotalPending>
      <RetailerWarrantyOfferTotal>0</RetailerWarrantyOfferTotal>
      <RetailerWarrantyOfferTotalCurrent>0</RetailerWarrantyOfferTotalCurrent>
      <RetailerWarrantyOfferTotalPending>0</RetailerWarrantyOfferTotalPending>
      <Secured>false</Secured>
      <Source>String</Source>
      <Specialist>false</Specialist>
      <TradeInDate>0001-01-01T00:00:00</TradeInDate>
      <Transmission>String</Transmission>
      <TransmissionType>String</TransmissionType>
      <UnderOffer>false</UnderOffer>
      <Upholstery>String</Upholstery>
      <UpholsteryCode>String</UpholsteryCode>
      <UpholsteryDescription>String</UpholsteryDescription>
      <UpholsteryType>String</UpholsteryType>
      <UsageCode>String</UsageCode>
      <VATQualifying>false</VATQualifying>
      <VehicleType>String</VehicleType>
      <Vin>String</Vin>
      <WpmsAdvanceRentalGross>0</WpmsAdvanceRentalGross>
      <Engine>String</Engine>
      <Equipment xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
        <d4p1:Equipment>
          <d4p1:Code>String</d4p1:Code>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:Id>0</d4p1:Id>
        </d4p1:Equipment>
      </Equipment>
      <HasMotabilityError>false</HasMotabilityError>
      <Retailer>String</Retailer>
      <VehicleClass>String</VehicleClass>
    </VehicleIdentifierData>
  </Vehicles>
</VehiclesByRetailerResponse>