ServiceVehicleSelects Web Service

ServiceVehicleSelects

Click here for a complete list of operations.

GetVehicle

Get a single vehicle

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /ServiceVehicleSelect.asmx HTTP/1.1
Host: api.dealerbase.co.nz
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.dealerbase.co.nz/GetVehicle"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <Authentication xmlns="http://api.dealerbase.co.nz/">
      <Ticket>string</Ticket>
      <ServiceResult>int</ServiceResult>
      <ServiceResultDescription>string</ServiceResultDescription>
    </Authentication>
  </soap:Header>
  <soap:Body>
    <GetVehicle xmlns="http://api.dealerbase.co.nz/">
      <vehicleId>long</vehicleId>
    </GetVehicle>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <Authentication xmlns="http://api.dealerbase.co.nz/">
      <Ticket>string</Ticket>
      <ServiceResult>int</ServiceResult>
      <ServiceResultDescription>string</ServiceResultDescription>
    </Authentication>
  </soap:Header>
  <soap:Body>
    <GetVehicleResponse xmlns="http://api.dealerbase.co.nz/">
      <GetVehicleResult>
        <Vehicle>
          <BranchId>int</BranchId>
          <CompanyName>string</CompanyName>
          <ManufacturerName>string</ManufacturerName>
          <ModelName>string</ModelName>
          <RegionId>int</RegionId>
          <RegionName>string</RegionName>
          <Id>long</Id>
          <AxleConfiguration>string</AxleConfiguration>
          <CcRating>short</CcRating>
          <ChassisNumber>string</ChassisNumber>
          <Condition>string</Condition>
          <Comments>string</Comments>
          <DeckLength>short</DeckLength>
          <Differential>string</Differential>
          <Efficiency>decimal</Efficiency>
          <EfficiencyInfoLastErrorCode>short</EfficiencyInfoLastErrorCode>
          <EfficiencyInfoLastError>string</EfficiencyInfoLastError>
          <EfficiencyInfoLastUpdated>dateTime</EfficiencyInfoLastUpdated>
          <EfficiencyRating>decimal</EfficiencyRating>
          <EngineDetails>string</EngineDetails>
          <EstimatedFuelCost>int</EstimatedFuelCost>
          <ExtColour>string</ExtColour>
          <FeatureString>string</FeatureString>
          <FuelCapacity>decimal</FuelCapacity>
          <FuelType>string</FuelType>
          <Gvm>int</Gvm>
          <HasWof>boolean</HasWof>
          <Height>short</Height>
          <Horsepower>decimal</Horsepower>
          <ImageCount>unsignedByte</ImageCount>
          <ImageIndexList>string</ImageIndexList>
          <InteriorDetails>string</InteriorDetails>
          <IsDamaged>boolean</IsDamaged>
          <IsNew>boolean</IsNew>
          <IsPremium>boolean</IsPremium>
          <IsRetail>boolean</IsRetail>
          <IsSpecial>boolean</IsSpecial>
          <IsTradeIn>boolean</IsTradeIn>
          <Length>short</Length>
          <LockTime>dateTime</LockTime>
          <LockUserId>int</LockUserId>
          <ManufacturerModel>string</ManufacturerModel>
          <ModelCode>string</ModelCode>
          <ModelDetail>string</ModelDetail>
          <Month>short</Month>
          <Odometer>int</Odometer>
          <Payload>int</Payload>
          <RecordAdded>dateTime</RecordAdded>
          <Registration>string</Registration>
          <RetailPrice>decimal</RetailPrice>
          <Seats>short</Seats>
          <StockNumber>string</StockNumber>
          <Tare>int</Tare>
          <TyreSize>string</TyreSize>
          <ViewsAutobase>long</ViewsAutobase>
          <ViewsTrademe>long</ViewsTrademe>
          <VinNumber>string</VinNumber>
          <WaterCapacity>decimal</WaterCapacity>
          <WheelBase>short</WheelBase>
          <WholesalePrice>decimal</WholesalePrice>
          <Width>short</Width>
          <Year>short</Year>
          <TransmissionType>short</TransmissionType>
          <Transmission>string</Transmission>
          <VehicleTypeName>string</VehicleTypeName>
          <StatusId>short</StatusId>
          <ModelId>int</ModelId>
          <TransmissionId>int</TransmissionId>
          <VehicleTypeId>int</VehicleTypeId>
          <ManufacturerId>int</ManufacturerId>
          <BranchNumber>string</BranchNumber>
          <CategoryId>int</CategoryId>
          <CategoryName>string</CategoryName>
          <TradingName>string</TradingName>
          <GstSwitchText>string</GstSwitchText>
          <GstIncludedDefault>boolean</GstIncludedDefault>
          <OrcSwitchText>string</OrcSwitchText>
          <OrcIncludedDefault>boolean</OrcIncludedDefault>
          <OrcIncluded>boolean</OrcIncluded>
          <TrademeId>long</TrademeId>
          <SalePrice>decimal</SalePrice>
          <_x_ExtraColumns>
            <_x_ExtraColumns xsi:nil="true" />
            <_x_ExtraColumns xsi:nil="true" />
          </_x_ExtraColumns>
        </Vehicle>
        <Images>
          <Images>
            <UrlThumb>string</UrlThumb>
            <UrlMedium>string</UrlMedium>
            <UrlLarge>string</UrlLarge>
          </Images>
          <Images>
            <UrlThumb>string</UrlThumb>
            <UrlMedium>string</UrlMedium>
            <UrlLarge>string</UrlLarge>
          </Images>
        </Images>
      </GetVehicleResult>
    </GetVehicleResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ServiceVehicleSelect.asmx HTTP/1.1
Host: api.dealerbase.co.nz
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <Authentication xmlns="http://api.dealerbase.co.nz/">
      <Ticket>string</Ticket>
      <ServiceResult>int</ServiceResult>
      <ServiceResultDescription>string</ServiceResultDescription>
    </Authentication>
  </soap12:Header>
  <soap12:Body>
    <GetVehicle xmlns="http://api.dealerbase.co.nz/">
      <vehicleId>long</vehicleId>
    </GetVehicle>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <Authentication xmlns="http://api.dealerbase.co.nz/">
      <Ticket>string</Ticket>
      <ServiceResult>int</ServiceResult>
      <ServiceResultDescription>string</ServiceResultDescription>
    </Authentication>
  </soap12:Header>
  <soap12:Body>
    <GetVehicleResponse xmlns="http://api.dealerbase.co.nz/">
      <GetVehicleResult>
        <Vehicle>
          <BranchId>int</BranchId>
          <CompanyName>string</CompanyName>
          <ManufacturerName>string</ManufacturerName>
          <ModelName>string</ModelName>
          <RegionId>int</RegionId>
          <RegionName>string</RegionName>
          <Id>long</Id>
          <AxleConfiguration>string</AxleConfiguration>
          <CcRating>short</CcRating>
          <ChassisNumber>string</ChassisNumber>
          <Condition>string</Condition>
          <Comments>string</Comments>
          <DeckLength>short</DeckLength>
          <Differential>string</Differential>
          <Efficiency>decimal</Efficiency>
          <EfficiencyInfoLastErrorCode>short</EfficiencyInfoLastErrorCode>
          <EfficiencyInfoLastError>string</EfficiencyInfoLastError>
          <EfficiencyInfoLastUpdated>dateTime</EfficiencyInfoLastUpdated>
          <EfficiencyRating>decimal</EfficiencyRating>
          <EngineDetails>string</EngineDetails>
          <EstimatedFuelCost>int</EstimatedFuelCost>
          <ExtColour>string</ExtColour>
          <FeatureString>string</FeatureString>
          <FuelCapacity>decimal</FuelCapacity>
          <FuelType>string</FuelType>
          <Gvm>int</Gvm>
          <HasWof>boolean</HasWof>
          <Height>short</Height>
          <Horsepower>decimal</Horsepower>
          <ImageCount>unsignedByte</ImageCount>
          <ImageIndexList>string</ImageIndexList>
          <InteriorDetails>string</InteriorDetails>
          <IsDamaged>boolean</IsDamaged>
          <IsNew>boolean</IsNew>
          <IsPremium>boolean</IsPremium>
          <IsRetail>boolean</IsRetail>
          <IsSpecial>boolean</IsSpecial>
          <IsTradeIn>boolean</IsTradeIn>
          <Length>short</Length>
          <LockTime>dateTime</LockTime>
          <LockUserId>int</LockUserId>
          <ManufacturerModel>string</ManufacturerModel>
          <ModelCode>string</ModelCode>
          <ModelDetail>string</ModelDetail>
          <Month>short</Month>
          <Odometer>int</Odometer>
          <Payload>int</Payload>
          <RecordAdded>dateTime</RecordAdded>
          <Registration>string</Registration>
          <RetailPrice>decimal</RetailPrice>
          <Seats>short</Seats>
          <StockNumber>string</StockNumber>
          <Tare>int</Tare>
          <TyreSize>string</TyreSize>
          <ViewsAutobase>long</ViewsAutobase>
          <ViewsTrademe>long</ViewsTrademe>
          <VinNumber>string</VinNumber>
          <WaterCapacity>decimal</WaterCapacity>
          <WheelBase>short</WheelBase>
          <WholesalePrice>decimal</WholesalePrice>
          <Width>short</Width>
          <Year>short</Year>
          <TransmissionType>short</TransmissionType>
          <Transmission>string</Transmission>
          <VehicleTypeName>string</VehicleTypeName>
          <StatusId>short</StatusId>
          <ModelId>int</ModelId>
          <TransmissionId>int</TransmissionId>
          <VehicleTypeId>int</VehicleTypeId>
          <ManufacturerId>int</ManufacturerId>
          <BranchNumber>string</BranchNumber>
          <CategoryId>int</CategoryId>
          <CategoryName>string</CategoryName>
          <TradingName>string</TradingName>
          <GstSwitchText>string</GstSwitchText>
          <GstIncludedDefault>boolean</GstIncludedDefault>
          <OrcSwitchText>string</OrcSwitchText>
          <OrcIncludedDefault>boolean</OrcIncludedDefault>
          <OrcIncluded>boolean</OrcIncluded>
          <TrademeId>long</TrademeId>
          <SalePrice>decimal</SalePrice>
          <_x_ExtraColumns>
            <_x_ExtraColumns xsi:nil="true" />
            <_x_ExtraColumns xsi:nil="true" />
          </_x_ExtraColumns>
        </Vehicle>
        <Images>
          <Images>
            <UrlThumb>string</UrlThumb>
            <UrlMedium>string</UrlMedium>
            <UrlLarge>string</UrlLarge>
          </Images>
          <Images>
            <UrlThumb>string</UrlThumb>
            <UrlMedium>string</UrlMedium>
            <UrlLarge>string</UrlLarge>
          </Images>
        </Images>
      </GetVehicleResult>
    </GetVehicleResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /ServiceVehicleSelect.asmx/GetVehicle?vehicleId=string HTTP/1.1
Host: api.dealerbase.co.nz

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<VehicleProxy xmlns="http://api.dealerbase.co.nz/">
  <Vehicle>
    <BranchId>int</BranchId>
    <CompanyName>string</CompanyName>
    <ManufacturerName>string</ManufacturerName>
    <ModelName>string</ModelName>
    <RegionId>int</RegionId>
    <RegionName>string</RegionName>
    <Id>long</Id>
    <AxleConfiguration>string</AxleConfiguration>
    <CcRating>short</CcRating>
    <ChassisNumber>string</ChassisNumber>
    <Condition>string</Condition>
    <Comments>string</Comments>
    <DeckLength>short</DeckLength>
    <Differential>string</Differential>
    <Efficiency>decimal</Efficiency>
    <EfficiencyInfoLastErrorCode>short</EfficiencyInfoLastErrorCode>
    <EfficiencyInfoLastError>string</EfficiencyInfoLastError>
    <EfficiencyInfoLastUpdated>dateTime</EfficiencyInfoLastUpdated>
    <EfficiencyRating>decimal</EfficiencyRating>
    <EngineDetails>string</EngineDetails>
    <EstimatedFuelCost>int</EstimatedFuelCost>
    <ExtColour>string</ExtColour>
    <FeatureString>string</FeatureString>
    <FuelCapacity>decimal</FuelCapacity>
    <FuelType>string</FuelType>
    <Gvm>int</Gvm>
    <HasWof>boolean</HasWof>
    <Height>short</Height>
    <Horsepower>decimal</Horsepower>
    <ImageCount>unsignedByte</ImageCount>
    <ImageIndexList>string</ImageIndexList>
    <InteriorDetails>string</InteriorDetails>
    <IsDamaged>boolean</IsDamaged>
    <IsNew>boolean</IsNew>
    <IsPremium>boolean</IsPremium>
    <IsRetail>boolean</IsRetail>
    <IsSpecial>boolean</IsSpecial>
    <IsTradeIn>boolean</IsTradeIn>
    <Length>short</Length>
    <LockTime>dateTime</LockTime>
    <LockUserId>int</LockUserId>
    <ManufacturerModel>string</ManufacturerModel>
    <ModelCode>string</ModelCode>
    <ModelDetail>string</ModelDetail>
    <Month>short</Month>
    <Odometer>int</Odometer>
    <Payload>int</Payload>
    <RecordAdded>dateTime</RecordAdded>
    <Registration>string</Registration>
    <RetailPrice>decimal</RetailPrice>
    <Seats>short</Seats>
    <StockNumber>string</StockNumber>
    <Tare>int</Tare>
    <TyreSize>string</TyreSize>
    <ViewsAutobase>long</ViewsAutobase>
    <ViewsTrademe>long</ViewsTrademe>
    <VinNumber>string</VinNumber>
    <WaterCapacity>decimal</WaterCapacity>
    <WheelBase>short</WheelBase>
    <WholesalePrice>decimal</WholesalePrice>
    <Width>short</Width>
    <Year>short</Year>
    <TransmissionType>short</TransmissionType>
    <Transmission>string</Transmission>
    <VehicleTypeName>string</VehicleTypeName>
    <StatusId>short</StatusId>
    <ModelId>int</ModelId>
    <TransmissionId>int</TransmissionId>
    <VehicleTypeId>int</VehicleTypeId>
    <ManufacturerId>int</ManufacturerId>
    <BranchNumber>string</BranchNumber>
    <CategoryId>int</CategoryId>
    <CategoryName>string</CategoryName>
    <TradingName>string</TradingName>
    <GstSwitchText>string</GstSwitchText>
    <GstIncludedDefault>boolean</GstIncludedDefault>
    <OrcSwitchText>string</OrcSwitchText>
    <OrcIncludedDefault>boolean</OrcIncludedDefault>
    <OrcIncluded>boolean</OrcIncluded>
    <TrademeId>long</TrademeId>
    <SalePrice>decimal</SalePrice>
    <_x_ExtraColumns>
      <_x_ExtraColumns>
        <Key />
        <Value />
      </_x_ExtraColumns>
      <_x_ExtraColumns>
        <Key />
        <Value />
      </_x_ExtraColumns>
    </_x_ExtraColumns>
  </Vehicle>
  <Images>
    <Images>
      <UrlThumb>string</UrlThumb>
      <UrlMedium>string</UrlMedium>
      <UrlLarge>string</UrlLarge>
    </Images>
    <Images>
      <UrlThumb>string</UrlThumb>
      <UrlMedium>string</UrlMedium>
      <UrlLarge>string</UrlLarge>
    </Images>
  </Images>
</VehicleProxy>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /ServiceVehicleSelect.asmx/GetVehicle HTTP/1.1
Host: api.dealerbase.co.nz
Content-Type: application/x-www-form-urlencoded
Content-Length: length

vehicleId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<VehicleProxy xmlns="http://api.dealerbase.co.nz/">
  <Vehicle>
    <BranchId>int</BranchId>
    <CompanyName>string</CompanyName>
    <ManufacturerName>string</ManufacturerName>
    <ModelName>string</ModelName>
    <RegionId>int</RegionId>
    <RegionName>string</RegionName>
    <Id>long</Id>
    <AxleConfiguration>string</AxleConfiguration>
    <CcRating>short</CcRating>
    <ChassisNumber>string</ChassisNumber>
    <Condition>string</Condition>
    <Comments>string</Comments>
    <DeckLength>short</DeckLength>
    <Differential>string</Differential>
    <Efficiency>decimal</Efficiency>
    <EfficiencyInfoLastErrorCode>short</EfficiencyInfoLastErrorCode>
    <EfficiencyInfoLastError>string</EfficiencyInfoLastError>
    <EfficiencyInfoLastUpdated>dateTime</EfficiencyInfoLastUpdated>
    <EfficiencyRating>decimal</EfficiencyRating>
    <EngineDetails>string</EngineDetails>
    <EstimatedFuelCost>int</EstimatedFuelCost>
    <ExtColour>string</ExtColour>
    <FeatureString>string</FeatureString>
    <FuelCapacity>decimal</FuelCapacity>
    <FuelType>string</FuelType>
    <Gvm>int</Gvm>
    <HasWof>boolean</HasWof>
    <Height>short</Height>
    <Horsepower>decimal</Horsepower>
    <ImageCount>unsignedByte</ImageCount>
    <ImageIndexList>string</ImageIndexList>
    <InteriorDetails>string</InteriorDetails>
    <IsDamaged>boolean</IsDamaged>
    <IsNew>boolean</IsNew>
    <IsPremium>boolean</IsPremium>
    <IsRetail>boolean</IsRetail>
    <IsSpecial>boolean</IsSpecial>
    <IsTradeIn>boolean</IsTradeIn>
    <Length>short</Length>
    <LockTime>dateTime</LockTime>
    <LockUserId>int</LockUserId>
    <ManufacturerModel>string</ManufacturerModel>
    <ModelCode>string</ModelCode>
    <ModelDetail>string</ModelDetail>
    <Month>short</Month>
    <Odometer>int</Odometer>
    <Payload>int</Payload>
    <RecordAdded>dateTime</RecordAdded>
    <Registration>string</Registration>
    <RetailPrice>decimal</RetailPrice>
    <Seats>short</Seats>
    <StockNumber>string</StockNumber>
    <Tare>int</Tare>
    <TyreSize>string</TyreSize>
    <ViewsAutobase>long</ViewsAutobase>
    <ViewsTrademe>long</ViewsTrademe>
    <VinNumber>string</VinNumber>
    <WaterCapacity>decimal</WaterCapacity>
    <WheelBase>short</WheelBase>
    <WholesalePrice>decimal</WholesalePrice>
    <Width>short</Width>
    <Year>short</Year>
    <TransmissionType>short</TransmissionType>
    <Transmission>string</Transmission>
    <VehicleTypeName>string</VehicleTypeName>
    <StatusId>short</StatusId>
    <ModelId>int</ModelId>
    <TransmissionId>int</TransmissionId>
    <VehicleTypeId>int</VehicleTypeId>
    <ManufacturerId>int</ManufacturerId>
    <BranchNumber>string</BranchNumber>
    <CategoryId>int</CategoryId>
    <CategoryName>string</CategoryName>
    <TradingName>string</TradingName>
    <GstSwitchText>string</GstSwitchText>
    <GstIncludedDefault>boolean</GstIncludedDefault>
    <OrcSwitchText>string</OrcSwitchText>
    <OrcIncludedDefault>boolean</OrcIncludedDefault>
    <OrcIncluded>boolean</OrcIncluded>
    <TrademeId>long</TrademeId>
    <SalePrice>decimal</SalePrice>
    <_x_ExtraColumns>
      <_x_ExtraColumns>
        <Key />
        <Value />
      </_x_ExtraColumns>
      <_x_ExtraColumns>
        <Key />
        <Value />
      </_x_ExtraColumns>
    </_x_ExtraColumns>
  </Vehicle>
  <Images>
    <Images>
      <UrlThumb>string</UrlThumb>
      <UrlMedium>string</UrlMedium>
      <UrlLarge>string</UrlLarge>
    </Images>
    <Images>
      <UrlThumb>string</UrlThumb>
      <UrlMedium>string</UrlMedium>
      <UrlLarge>string</UrlLarge>
    </Images>
  </Images>
</VehicleProxy>

Parameter	Value
vehicleId: