WebAPI

<back to all web services

CreateVehicles

Create a new vehicle for the given account id.

The following routes are available for this service:
POST/CreateVehiclesSOAP calls use POST HTTP verb with variables embedded in the body

To override the Content-type in your clients 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 /xml/reply/CreateVehicles HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<CreateVehicles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <AccountId>0</AccountId>
  <NewVehicles xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:VehicleVM>
      <d2p1:BodyCode>String</d2p1:BodyCode>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:GroupName>String</d2p1:GroupName>
      <d2p1:IsMonthlyPassAutoRenewal>false</d2p1:IsMonthlyPassAutoRenewal>
      <d2p1:LicPlateNo>String</d2p1:LicPlateNo>
      <d2p1:OrderTag>false</d2p1:OrderTag>
      <d2p1:PlatePlan>0</d2p1:PlatePlan>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:SeatCapacity>0</d2p1:SeatCapacity>
      <d2p1:TaxClassId>0</d2p1:TaxClassId>
      <d2p1:TradePlate>false</d2p1:TradePlate>
      <d2p1:VehClassId>0</d2p1:VehClassId>
      <d2p1:VehicleColour>String</d2p1:VehicleColour>
      <d2p1:VehicleMakeId>0</d2p1:VehicleMakeId>
      <d2p1:VehicleModel>String</d2p1:VehicleModel>
      <d2p1:VehicleYear>String</d2p1:VehicleYear>
      <d2p1:WheelPlan>String</d2p1:WheelPlan>
    </d2p1:VehicleVM>
  </NewVehicles>
  <PayAsPrimaryPaymentMethod>false</PayAsPrimaryPaymentMethod>
  <PayFromCurrentBalance>false</PayFromCurrentBalance>
  <PaymentMethod xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:Address>
      <d2p1:AddressLine1>STRING</d2p1:AddressLine1>
      <d2p1:AddressLine2>STRING</d2p1:AddressLine2>
      <d2p1:City>STRING</d2p1:City>
      <d2p1:CountryCode>STRING</d2p1:CountryCode>
      <d2p1:CountyCode>STRING</d2p1:CountyCode>
      <d2p1:PostalCode>STRING</d2p1:PostalCode>
      <d2p1:PtcAbsCode>STRING</d2p1:PtcAbsCode>
    </d2p1:Address>
    <d2p1:CardNumber>String</d2p1:CardNumber>
    <d2p1:CardType>0</d2p1:CardType>
    <d2p1:ExpirationMonth>String</d2p1:ExpirationMonth>
    <d2p1:ExpirationYear>String</d2p1:ExpirationYear>
    <d2p1:IsSameAddress>false</d2p1:IsSameAddress>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:SecurityCode>String</d2p1:SecurityCode>
  </PaymentMethod>
  <TotalAmount>0</TotalAmount>
</CreateVehicles>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateVehiclesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Vehicles xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:VehicleResponse>
      <d2p1:ApprovalDocIsInvalid>false</d2p1:ApprovalDocIsInvalid>
      <d2p1:AxleCount>0</d2p1:AxleCount>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:BodyCode>String</d2p1:BodyCode>
      <d2p1:CategoryId>0</d2p1:CategoryId>
      <d2p1:EffectiveDate>0001-01-01T00:00:00</d2p1:EffectiveDate>
      <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
      <d2p1:GroupName>String</d2p1:GroupName>
      <d2p1:IsLUDSAutoRenewal>false</d2p1:IsLUDSAutoRenewal>
      <d2p1:IsMonthlyPassAutoRenewal>false</d2p1:IsMonthlyPassAutoRenewal>
      <d2p1:IsTransponderRequested>false</d2p1:IsTransponderRequested>
      <d2p1:Make>String</d2p1:Make>
      <d2p1:MakeCode>String</d2p1:MakeCode>
      <d2p1:MakeId>0</d2p1:MakeId>
      <d2p1:Message>String</d2p1:Message>
      <d2p1:MissingDocType xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:MissingDocType>
      <d2p1:MissingDocTypeDesc xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MissingDocTypeDesc>
      <d2p1:Model>String</d2p1:Model>
      <d2p1:NeedManualRenewal>false</d2p1:NeedManualRenewal>
      <d2p1:NeedManualRenewalLUDS>false</d2p1:NeedManualRenewalLUDS>
      <d2p1:PlateCountry>String</d2p1:PlateCountry>
      <d2p1:PlateNumber>String</d2p1:PlateNumber>
      <d2p1:PlatePlanId>0</d2p1:PlatePlanId>
      <d2p1:PlatePlanName>String</d2p1:PlatePlanName>
      <d2p1:PlatePlanStatusDescription>String</d2p1:PlatePlanStatusDescription>
      <d2p1:PlatePlanStatusId>0</d2p1:PlatePlanStatusId>
      <d2p1:PlateStateRegion>String</d2p1:PlateStateRegion>
      <d2p1:RegType>String</d2p1:RegType>
      <d2p1:SeatingCapacity>0</d2p1:SeatingCapacity>
      <d2p1:SetupFee>0</d2p1:SetupFee>
      <d2p1:StartDateTime>0001-01-01T00:00:00</d2p1:StartDateTime>
      <d2p1:TagId>0</d2p1:TagId>
      <d2p1:TagSerial>String</d2p1:TagSerial>
      <d2p1:TagStatus>String</d2p1:TagStatus>
      <d2p1:TagStatusId>0</d2p1:TagStatusId>
      <d2p1:TagTypeId>0</d2p1:TagTypeId>
      <d2p1:TaxClassCode>String</d2p1:TaxClassCode>
      <d2p1:TaxClassCodeDescription>String</d2p1:TaxClassCodeDescription>
      <d2p1:VehicleClass>0</d2p1:VehicleClass>
      <d2p1:VehicleColor>String</d2p1:VehicleColor>
      <d2p1:VehicleColorCode>String</d2p1:VehicleColorCode>
      <d2p1:VehicleId>0</d2p1:VehicleId>
      <d2p1:WheelPlan>String</d2p1:WheelPlan>
      <d2p1:WheelPlanCode>String</d2p1:WheelPlanCode>
      <d2p1:Year>0</d2p1:Year>
    </d2p1:VehicleResponse>
  </Vehicles>
  <VehiclesNotAdded xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:VehicleVM>
      <d2p1:BodyCode>String</d2p1:BodyCode>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:GroupName>String</d2p1:GroupName>
      <d2p1:IsMonthlyPassAutoRenewal>false</d2p1:IsMonthlyPassAutoRenewal>
      <d2p1:LicPlateNo>String</d2p1:LicPlateNo>
      <d2p1:OrderTag>false</d2p1:OrderTag>
      <d2p1:PlatePlan>0</d2p1:PlatePlan>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:SeatCapacity>0</d2p1:SeatCapacity>
      <d2p1:TaxClassId>0</d2p1:TaxClassId>
      <d2p1:TradePlate>false</d2p1:TradePlate>
      <d2p1:VehClassId>0</d2p1:VehClassId>
      <d2p1:VehicleColour>String</d2p1:VehicleColour>
      <d2p1:VehicleMakeId>0</d2p1:VehicleMakeId>
      <d2p1:VehicleModel>String</d2p1:VehicleModel>
      <d2p1:VehicleYear>String</d2p1:VehicleYear>
      <d2p1:WheelPlan>String</d2p1:WheelPlan>
    </d2p1:VehicleVM>
  </VehiclesNotAdded>
</CreateVehiclesResponse>