autoscout24 xml schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26autoscout24...

47
AutoScout24 XML Schema Technical Documentation

Upload: ngoanh

Post on 02-May-2018

273 views

Category:

Documents


11 download

TRANSCRIPT

Page 1: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML Schema

Technical Documentation

Page 2: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 2 of 47

Contents

Introduction ............................................................................................. 5

About this document ................................................................................. 5

About STX3 ............................................................................................. 5

Schema .................................................................................................... 6

Overview ................................................................................................. 6

XML elements ........................................................................................ 11

STX3 .................................................................................................. 11

Vehicle Data ....................................................................................... 11

Vehicles ............................................................................................. 12

Vehicle ............................................................................................... 12

Fuel Types .......................................................................................... 18

Consumption....................................................................................... 19

Liquid ................................................................................................. 19

Gas .................................................................................................... 20

Electric ............................................................................................... 21

Emission............................................................................................. 21

Service ............................................................................................... 22

Prices ................................................................................................. 23

Price .................................................................................................. 23

Financing ............................................................................................ 24

Page 3: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 3 of 47

Initial Payment .................................................................................... 25

Rate .................................................................................................. 26

Ending Rate ........................................................................................ 26

Gross Credit Amount ............................................................................ 27

Service Fee ......................................................................................... 27

Rate Insurance .................................................................................... 28

Net Credit Amount ............................................................................... 28

Delivery ............................................................................................. 29

Equipments ........................................................................................ 29

Equipment .......................................................................................... 30

Seals ................................................................................................. 31

Seal ................................................................................................... 31

Media ................................................................................................. 32

Images .............................................................................................. 32

Image ................................................................................................ 33

Videos ................................................................................................ 33

Video ................................................................................................. 34

Product Bookings ................................................................................. 34

Product .............................................................................................. 35

Previous Owner ................................................................................... 35

Notes .................................................................................................... 36

XSD ...................................................................................................... 38

Page 4: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 4 of 47

XML example ......................................................................................... 38

History ................................................................................................... 44

Contact .................................................................................................. 47

Page 5: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 5 of 47

Introduction

About this document

The AutoScout24 XML schema is used to transmit vehicle data and images to Au-

toScout24.

In this document the definition of the AutoScout24 XML schema and individual

functionalities are described in addition to the “autoscout24_xml.xsd” file.

The AutoScout24 XML schema is a real subset of the STX3 schema, so that Au-

toScout24 XML files can be validated through the STX3 XML schema definition.

About STX3

STX3 is an incorporated society, whose members are car portals, data service

providers and other industry organizations in the automotive field. STX3’s primary

aim is the interface standardization in automobile sales. The society provides the

STX3 interface for all IT systems in the automotive field free of cost.

Page 6: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 6 of 47

Schema

Overview

This section enables a quick overview of the parent nodes (gray) and their child

elements (white). You may find additional information in the chapter “XML ele-

ments”.

stx3

(NODE) vehicle_data

(NODE) vehicles

(NODE) vehicle

(NODE) dealer_id

ownersvehicle_id

status

visibility

vin

country_version

type

category

body

brand

model

version

title

body_color

body_colorgroup

body_painting

interior_color

Page 7: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 7 of 47

covering

doors

gear_type

gears

fuel_type

fuel_types

(NODE) primary_fuel_type

fuel_type

transmission

capacity

kilowatt

cylinder

consumption

(NODE) liquid

(NODE) urban

extra_urban

combined

gas

(NODE) urban

extra_urban

combined

electric

(NODE) combined

emission

(NODE) class

sticker

co2_liquid

Page 8: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 8 of 47

co2_gas

co2_electric

efficiency_class

mileage

service

(NODE) last_technical_service

last_change_cam_belt

hsn

tsn

schwacke_code

initial_registration

general_inspection

licence_number1

notes

prices

(NODE) price

(NODE) type

vat_type

currency

negotiable

value

financing

(NODE) initial_payment

(NODE) value

rate

1 Only Netherlands

Page 9: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 9 of 47

(NODE) value

duration

eff_rate_of_interest

ending_rate

(NODE) value

bank_name

gross_credit_amount

(NODE) value

service_fee

(NODE) value

rate_insurance

(NODE) value

debit_interest_rate

debit_interest_type

net_credit_amount

(NODE) value

warranty_duration

delivery

(NODE) delivery_time

delivery_date

equipments

(NODE) equipment

(NODE) text

seals

(NODE) seal

(NODE) name

status

Page 10: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 10 of 47

media

(NODE) images

(NODE) image

(NODE) local

videos

(NODE) video

(NODE) uri

product_bookings

(NODE) product

(NODE) name

status

previous_owner

(NODE) count

accident_free

kerb_weight

alloy_wheels_size

seats

Page 11: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 11 of 47

XML elements

STX3

The “stx3” node is the root node of all other elements, and opens and closes the

AutoScout24 XML files.

Element name Occurrence Type / Values Mandatory field

<stx3> 1 Root Node yes

<vehicle_data> 1 Node yes

XPath: stx3

Vehicle Data

The “vehicle_data” node contains the “vehicles” node.

Element name Occurrence Type / Values Mandatory field

<vehicle_data> 1 Node Yes

<vehicles> 1 Node Yes

XPath: stx3/vehicle_data/

Page 12: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 12 of 47

Vehicles

The “vehicles” node contains all “vehicle” nodes of all vehicles.

Element name Occurrence Type / Values Mandatory field

<vehicles> 1 Node Yes

<vehicle> 1 - n Node Yes

XPath: stx3/vehicle_data/vehicles

Vehicle

The “vehicle” node contains all data of a vehicle.

Element name Occur-

rence

Type / Values Mandatory

field

<vehicle> 1-n Node yes

<dealer_id> 1 Int yes

<ownersvehicle_id> 0-1 String no

<status> 0-1 String

[active;inactive]

no

<visibility> 0-1 String

[public;dealer]

no

Page 13: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 13 of 47

Element name Occur-

rence

Type / Values Mandatory

field

<vin> 0-1 String no

<type> 1 String

[bike;car]

yes

<category> 1 String

[classic; demonstration;

employee; new;

pre_registered;

used]

yes

<body> 1 String

[cars: bus_van;compact;

convertible; coupe; off_road; other_car;

sedan; station_wagon; transporter;

bikes: chopper_cruiser;

enduro;sidecar;

kids_motorcycle; tourer;

moped;motocross;

naked_bike;

other_bike;quad_atv;rally;

travel_enduro; rac-

ing;scooter;street_figher;

super_moto; supersport;

sporttourer;trial;trike]

yes

<brand> 1 String yes

<model> 1 String yes

<version> 0-1 String no

<title> 0-1 String no

Page 14: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 14 of 47

Element name Occur-

rence

Type / Values Mandatory

field

<body_color> 0-1 String no

<body_colorgroup> 1 String

[beige;black;blue;bronze;

brown;green;grey;orange;

red;silver;violet;white;yellow]

yes

<body_painting> 0-1 String

[metallic;uni]

no

<interior_color> 0-1 String

[beige;black;brown;

grey;other]

no

<covering> 0-1 String

[alcantara;cloth;full_leather;

part_leather;

velour;other]

no

<doors> 0-1 Int no

<gear_type> 0-1 String

[automatic;semi-automatic;

manual]

no

<gears> 0-1 Int no

<fuel_type> 1 String

[diesel; 2T gasoline; gasoline;

electric_gasoline; electric_diesel; electric;

ethanol; hydrogen; lpg; cng; other]

yes

Page 15: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 15 of 47

Element name Occur-

rence

Type / Values Mandatory

field

<fuel_types> 0-1 Node no

<transmission> 0-1 String

[front;rear;4wd]

no

<capacity> 0-1 Int no

<kilowatt> 0-1 Int no

<cylinder> 0-1 Int no

<consumption> 0-1 Node no

<emission> 0-1 Node no

<mileage> 0-1 Int yes

<service> 0-1 Node no

<hsn> 0-1 Int no

<tsn> 0-1 String no

Page 16: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 16 of 47

Element name Occur-

rence

Type / Values Mandatory

field

<schwacke_code> 0-1 Int no

<initial_registration> 0-1 Date

[YYYY-MM-DD]

no

<general_inspection> 0-1 Date

[YYYY-MM-DD]

no

<licence_number>1 0-1 String no

<notes> 0-1 String no

<prices> 1-2 Node yes

<financing> 0-1 Node no

<warranty_duration> 0-1 Int no

<delivery> 0-1 Node no

<equipments> 0-1 Node no

<seals> 0-1 Node no

<media> 0-1 Node no

1 Only Netherlands

Page 17: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 17 of 47

Element name Occur-

rence

Type / Values Mandatory

field

<product_bookings> 0-1 Node no

<previous_owner> 0-1 Node no

<accident_free> 0-1 Boolean

[true;false]

no

<kerb_weight> 0-1 Int no

<alloy_wheels_size> 0-1 Int

[10;11;12;13;14;15;16;17;

18;19;20;21;22;23;24;25;26]

no

<seats> 0-1 Int no

XPath: stx3/vehicle_data/vehicles/vehicle

Page 18: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 18 of 47

Fuel Types1

The “fuel_types” node contains the element “primary_fuel_type” (fuel according to

car energy consumption labeling) and “fuel_type” (all supported fuel according to

car energy consumption labeling)).

Element name Occurrence Type / Values Mandatory field

<fuel_types> 0-1 Node no

<primary_fuel_type> 0-1 String

[biodiesel; biogas; diesel; do-

mestic gas H; domestic gas L;

electricity; ethanol; hydrogen;

liquid petroleum gas (LPG);

regular/benzine 91; regu-

lar/benzine E10 91; super 95;

super E10 95; super plus 98;

super plus E10 98; vegetable

oil]

no

<fuel_types> 0-1 String

[biodiesel; biogas; diesel; do-

mestic gas H; domestic gas L;

electricity; ethanol; hydrogen;

liquid petroleum gas (LPG);

regular/benzine 91; regu-

lar/benzine E10 91; super 95;

super E10 95; super plus 98;

super plus E10 98; vegetable

oil]

no

XPath: stx3/vehicle_data/vehicles/vehicle/fuel_types

1 Only Germany

Page 19: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 19 of 47

Consumption

The “consumption” node contains the “liquid” node.

Element name Occurrence Type / Values Mandatory field

<consumption> 0-1 Node no

<liquid> 0-1 Node no

<gas> 0-1 Node no

<electric> 0-1 Node no

XPath: stx3/vehicle_data/vehicles/vehicle/consumption

Liquid

The “liquid” node contains all fuel consumption elements.

Element name Occurrence Type / Values Mandatory field

<liquid> 0-1 Node no

<fuel_type>1 0-1 String

[biodiesel; diesel; ethanol;

hydrogen; regular/benzine

91; regular/benzine E10

91; super 95; super E10

95; super plus 98; super

plus E10 98; vegetable oil]

no

1 Only Germany

Page 20: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 20 of 47

Element name Occurrence Type / Values Mandatory field

<urban> 0-1 Decimal no

<extra_urban> 0-1 Decimal no

<combined> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/consumption/liquid/

Gas

The “gas” node contains all fuel consumption elements for fuel type gas.

Element name Occurrence Type / Values Mandatory field

<gas> 0-1 Node no

<fuel_type>1 0-1 String [biogas; domestic gas H;

domestic gas L; liquid pe-

troleum gas (LPG)]

no

<urban> 0-1 Decimal no

<extra_urban> 0-1 Decimal no

<combined> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/consumption/gas/

1 Only Germany

Page 21: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 21 of 47

Electric

The “electric” node contains all fuel consumption elements for fuel type electric.

Element name Occurrence Type / Values Mandatory field

<electric> 0-1 Node no

<fuel_type>1 0-1 String

[electricity]

no

<combined> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/consumption/electric/

Emission

The “emission” node contains all exhaust gas emission elements.

Element name Occurrence Type / Values Mandatory

field

<emission> 0-1 Node no

<class> 0-1 String

[euro1;euro2;euro3;

euro4;euro5;euro6]

no

<sticker>1 0-1 String [green;yel-

low;red;none]

no

1 Only Germany

Page 22: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 22 of 47

Element name Occurrence Type / Values Mandatory

field

<co2_liquid> 0-1 Decimal no

<co2_gas> 0-1 Decimal no

<co2_electric> 0-1 Decimal no

<efficiency_class>1 0-1 String

[a+;a;b;c;d;e;f;g]

no

XPath: stx3/vehicle_data/vehicles/vehicle/emission

Service

The “service” node contains information about the most recent services the vehi-

cle has got.

Element name Occurrence Type/ Values Mandatory field

<service> 0-1 Node no

<last_technical_service> 0-1 Date

[YYYY-MM-DD]

no

<last_change_cam_belt> 0-1 Date

[YYYY-MM-DD]

no

XPath: stx3/vehicle_data/vehicles/vehicle/service

Page 23: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 23 of 47

Prices

The “prices” node contains the “price” node.

Element name Occurrence Type / Values Mandatory field

<prices> 1 Node yes

<price> 1-2 Node yes

XPath: stx3/vehicle_data/vehicles/vehicle/prices

Price

The “price” node contains all price information.

Element name Occurrence Type / Values Mandatory field

<price> 1-2 Node yes

<type> 1 String

[public; dealer; ex-

port1]

yes

<vat_type> 0-1 String

[reclaimable;

non_reclaimable]

no

<currency> 1 String

[eur]

yes

1 Only Austria

Page 24: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 24 of 47

Element name Occurrence Type / Values Mandatory field

<negotiable> 0-1 Boolean

[true;false]

no

<value> 1 Int yes

XPath: stx3/vehicle_data/vehicles/vehicle/prices/price

Financing1

The “financing” node contains all financing information.

Element name Occurrence Type / Values Mandatory

field

<financing> 0-1 Node no

<initial_payment> 0-1 Node no

<rate> 0-1 Decimal no

<duration> 0-1 Int no

<eff_rate_of_interest> 0-1 Decimal no

<ending_rate> 0-1 Decimal no

<bankname> 0-1 String no

1 Only Germany

Page 25: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 25 of 47

Element name Occurrence Type / Values Mandatory

field

<gross_credit_amount> 0-1 Node no

<service_fee> 0-1 Decimal no

<rate_insurance> 0-1 Decimal no

<debit_interest_rate> 0-1 Decimal no

<debit_interest_type> 0-1 String [combined; changeable;

fixed] no

<net_credit_amount> 0-1 Node no

XPath: stx3/vehicle_data/vehicles/vehicle/financing

Initial Payment1

The “initial_payment” node contains the element “value”.

Element name Occurence Type / Values Mandatory

field

<initial_payment> 0-1 Node no

<value> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/financing/initial_payment

1 Only Germany

Page 26: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 26 of 47

Rate1

The “rate” node contains the element “value”.

Element name Occurence Type / Values Mandatory field

<rate> 0-1 Node no

<value> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/financing/rate

Ending Rate1

The “ending rate” node contains the element “value”.

Element name Occurence Type / Values Mandatory field

<ending_rate> 0-1 Node no

<value> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/financing/ending_rate

1 Only Germany

Page 27: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 27 of 47

Gross Credit Amount1

The “gross_credit_amount” node contains the element “value”.

Element name Occurence Type / Values Mandatory field

<gross_credit_amount> 0-1 Node no

<value> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/financing/gross_credit_amount

Service Fee1

The “service_fee” node contains the element “value”.

Element name Occurence Type / Values Mandatory field

<service_fee> 0-1 Node no

<value> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/financing/service_fee

1 Only Germany

Page 28: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 28 of 47

Rate Insurance1

The “rate_insurance” node contains the element “value”.

Element name Occurence Type / Values Mandatory field

<rate_insurance> 0-1 Node no

<value> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/financing/rate_insurance

Net Credit Amount1

The “net_credit_amount” node contains the element “value”.

Element name Occurence Type / Values Mandatory field

<net_credit_amount> 0-1 Node no

<value> 0-1 Decimal no

XPath: stx3/vehicle_data/vehicles/vehicle/financing/net_credit_amount

1 Only Germany

Page 29: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 29 of 47

Delivery

The “delivery” node contains details regarding the availability of vehicles.

Element name Occurence Type / Values Mandatory field

<delivery> 0-1 Node no

<delivery_time> 0-1 Int no

<delivery_date> 0-1 Date

[YYYY-MM-DD]

no

XPath: stx3/vehicle_data/vehicles/vehicle/delivery

Equipments

The “equipments” node contains all “equipment” nodes of a vehicle.

Element name Occurrence Type / Values Mandatory field

<equipments> 0-1 Node no

<equipment> 0-n Node no

XPath: stx3/vehicle_data/vehicles/vehicle/equipments

Page 30: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 30 of 47

Equipment

The “equipment” node contains the equipment description.

Element name Occur-

rence

Type / Values Mandatory

field

<equipment> 0-n Node no

<text> 0-1 String

[cars: abs;air_conditioning;airbag; alarm;al-

loy_wheels;auxiliary_heating; fog_lights;esp;light

sensor;

bending_light;cab_or_rented_car;

central_door_lock;climate_control; cruise_con-

trol;daytime_running_light; electrical_adjusta-

ble_seats; full_service_history;handicapped_ena-

bled;heated_seats; roof_rack; immobilizer;inspec-

tions_new; multifunctional_wheel; naviga-

tion_system; radio; mp3; cd;

nonsmoking_vehicle;ski_bag; electrical rear-view

mirrors;bluetooth;

particulate_filter;onboard_computer;

park_distance_control; used_car_warranty;rain

sensor;

panoramic_roof;passenger_airbag; side_air-

bags;isofix;head-up display;

hands-free equipment; power_steer-

ing;power_windows;parking assistance system

sensors front; parking assistance system sensors

rear, parking assistance system camera; parking

assistance system self-steering;sport_seats;

sport_suspension; traction_control;sport_pack-

age;start_stop_automatic; sunroof; towing_hook;

xenon_lights;

bikes (excl.): heated_bar;topcase;

wind_shield;roll_bar;fairing;

electric_starter; kick_starter; catalyzer]

no

XPath: stx3/vehicle_data/vehicles/vehicle/equipments/equipment

Page 31: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 31 of 47

Seals

The “seals” node contains all manufacturer’s seals, warranty and quality seals of

a vehicle.

Element name Occurrence Type / Values Mandatory field

<seals> 0-1 Node no

<seal> 0-n Node no

XPath: stx3/vehicle_data/vehicles/vehicle/seals

Seal

The “seal” node contains the name of the seal and status.

Element name Occurrence Type / Values Mandatory field

<seal> 0-n Node no

<name> 0-1 String no

<status> 0-1 String

[active;inactive]

no

XPath: stx3/vehicle_data/vehicles/vehicle/seals/seal

Page 32: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 32 of 47

Media

The “media” node contains the “images” and the “videos” node.

Element name Occurrence Type / Values Mandatory field

<media> 0-n Node no

<images> 0-1 Node no

<videos> 0-1 Node no

XPath: stx3/vehicle_data/vehicles/vehicle/media

Images

The “images” node contains all images of a vehicle.

Element name Occurrence Type / Values Mandatory field

<images> 0-1 Node no

<image> 0-15 Node no

XPath: stx3/vehicle_data/vehicles/vehicle/media/images

Page 33: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 33 of 47

Image

The “image” node contains the image name or link of the provided image.

Element name Occurrence Type / Values Mandatory field

<image> 0-15 Node no

<local> 0-1 String No

<uri> 0-1 String no

XPath: stx3/vehicle_data/vehicles/vehicle/media/images/image

Videos

The “videos” node contains all videos of a vehicle.

Element Name Occurence Type / Values Mandatory Field

<videos> 0-1 Node no

<video> 0-1 Node no

XPath: stx3/vehicle_data/vehicles/vehicle/media/videos

Page 34: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 34 of 47

Video

The “video” node contains the link to the video at Youtube.

Element Name Occurence Type / Values Mandatory Field

<video> 0-1 Node no

<uri> 0-1 String no

XPath: stx3/vehicle_data/vehicles/vehicle/media/videos/video

Product Bookings

The “product_bookings” node contains all dealer promotional items of a vehicle.

Element name Occurrence Type / Values Mandatory field

<product_bookings> 0-1 Node no

<product> 0-n String no

XPath: stx3/vehicle_data/vehicles/vehicle/product_bookings

Page 35: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 35 of 47

Product1,2

The “product” node contains product name and status.

Element name Occurrence Type / Values Mandatory field

<product> 0-n Node no

<name> 0-1 String

[top_insertion; fea-

tured_ad; homep-

age_ad]

no

<status> 0-1 String

[active;inactive]

no

XPath: stx3/vehicle_data/vehicles/vehicle/product_bookings/product

Previous Owner

The “previous_owner” node contains the number of previous owners.

Element name Occurrence Type / Values Mandatory field

<previous_owner> 0-1 Node no

<count> 0-1 Node no

XPath: stx3/vehicle_data/vehicles/vehicle/previous_owner

1 Booking this product is subject to a fee. You may find further details in the product information at: http://ww2.autoscout24.de/as24-b2b-products-online-activation.aspx („top_insertion“ = AS24 top ad, „fea-tured_ad“ = AS24 ad presentation, “homepage_ad” = AS24 ad placement on the homepage) 2 If <visibility> is set to ‚dealer‘, the products are ignored

Page 36: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 36 of 47

Notes

The free text describing a vehicle (Field notes) can be formatted using certain

formatting elements. Please find the list of formatting elements that are sup-

ported by AutoScout24 in accordance with wikicreole.org (http://www.wikicre-

ole.org/wiki/Elements).

Supported Creole For-

matting Element

Supported Creole For-

matting Syntax

Result HTML Equivalent Comments

Line break \\

<br> Line breaks are only sup-

ported using this Creole for-

matting element.

Horizontal line ---- _____________ <hr> A horizontal line is always ac-

companied by an automatic

line break.

Bold **lorem ipsum** lorem ipsum <b>lorem ipsum</b> Bold text items must start and

end with two **.

List * List item 1\\

* List item 2\\

List item 1

List item 2

<ul>

<li> List item 1</li>

<li> List item 2</li>

</ul>

Inserting one * leads to a bul-

let point. After each bullet

point a line break needs to be

inserted.

This example illustrates the formatting result when using all of these formatting

elements.

Example: Content

vehicle description

field

„Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et

dolore magna aliqua.\\----*lorem\\*ipsum\\*dolor\\\\Ut enim ad minim veniam, quis nostrud exerci-

tation ullamco laboris nisi ut aliquid ex ea commodi consequat.“

Page 37: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 37 of 47

Example: Result

Page 38: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 38 of 47

XSD

By using the “autoscout24_xml.xsd” file, XML files can be validated with the Au-

toScout24 XML schema definition to ensure that valid AutoScout24 XML files are

generated.

XML example

<?xml version="1.0" encoding="UTF-8"?>

<stx3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<vehicle_data>

<vehicles>

<vehicle>

<dealer_id>1234567890</dealer_id>

<ownersvehicle_id>102030</ownersvehicle_id>

<status>active</status>

<visibility>dealer</visibility>

<vin>12345678901234567</vin>

<type>car</type>

<category>used</category>

<body>convertible</body>

<brand>Mini</brand>

<model>Cooper</model>

<version>Cabrio</version>

<title>top condition, garage car</title>

<body_color>Pure Silver</body_color>

<body_colorgroup>silver</body_colorgroup>

<body_painting>metallic</body_painting>

<interior_color>black</interior_color>

<covering>full_leather</covering>

<doors>2</doors>

<gear_type>manual</gear_type>

<gears>6</gears>

<fuel_type>gasoline</fuel_type>

<fuel_types>

Page 39: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 39 of 47

<primary_fuel_type>super</primary_fuel_type>

<fuel_type>super</fuel_type>

<fuel_type>super e10</fuel_type>

<transmission>front</transmission>

<capacity>1598</capacity>

<kilowatt>128</kilowatt>

<cylinder>4</cylinder>

<consumption>

<liquid>

<fuel_type>super</fuel_type>

<urban>7.9</urban>

<extra_urban>5.2</extra_urban>

<combined>6.2</combined>

</liquid>

</consumption>

<emission>

<class>euro_5</class>

<sticker>green</sticker>

<co2_liquid>149</co2_liquid>

<efficiency_class>b</efficiency_class>

</emission>

<mileage>100</mileage>

<service>

<last_technical_service>2011-07-01</last_technical_service>

<last_change_cam_belt>2011-07-01</last_change_cam_belt>

</service>

<hsn>0005</hsn>

<tsn>801</tsn>

<schwacke_code>10630510</schwacke_code>

<initial_registration>2008-01-31</initial_registration>

<general_inspection>2011-07-01</general_inspection>

<licence_number>SZGN95</licence_number>

<notes>great car, please ask for more details</notes>

<prices>

Page 40: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 40 of 47

<price>

<type>public</type>

<vat_type>reclaimable</vat_type>

<currency>eur</currency>

<negotiable>true</negotiable>

<value>3000</value>

</price>

<price>

<type>dealer</type>

<value>2900</value>

</price>

</prices>

<financing>

<initial_payment>

<value>1000</value>

</initial_payment>

<rate>

<value>100</value>

</rate>

<duration>36</duration>

<eff_rate_of_interest>3.99</eff_rate_of_interest>

<ending_rate>

<value>50</value>

</ending_rate>

<bankname>Test Bank</bankname>

<gross_credit_amount>

<value>4000</value>

</gross_credit_amount>

<service_fee>

<value>120</value>

</service_fee>

<rate_insurance>

<value>80</value>

</rate_insurance>

Page 41: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 41 of 47

<debit_interest_rate>4.57</debit_interest_rate>

<debit_interest_type>combined</debit_interest_type>

<net_credit_amount>

<value>3000</value>

</net_credit_amount>

</financing>

<warranty_duration>12</warranty_duration>

<equipments>

<equipment>

<text>abs</text>

</equipment>

<equipment>

<text>alloy_wheels</text>

</equipment>

<equipment>

<text>climate_control</text>

</equipment>

</equipments>

<seals>

<seal>

<name>bmw_premium_selection</name>

<status>active</status>

</seal>

<seal>

<name>dekra</name>

<status>active</status>

</seal>

</seals>

<media>

<images>

<image>

<local>60_1.jpg</local>

</image>

<image>

Page 42: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 42 of 47

<local>60_2.jpg</local>

</image>

<image>

<local>60_3.jpg</local>

</image>

<image>

<local>60_4.jpg</local>

</image>

<image>

<local>60_5.jpg</local>

</image>

</images>

<videos>

<video>

<uri>www.youtube.com/watch?v=hR10_vBZtjM</uri>

</video>

</videos>

</media>

<product_bookings>

<product>

<name>top_insertion</name>

<status>active</status>

</product>

<product>

<name>featured_ad</name>

<status>active</status>

</product>

</product_bookings>

<previous_owner>

<count>3</count>

</previous_owner>

<accident_free>true</accident_free>

<kerb_weight>1500</kerb_weight>

<alloy_wheels_size>17</alloy_wheels_size>

Page 43: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 43 of 47

<seats>4</seats>

</vehicle>

</vehicles>

</vehicle_data>

</stx3>

Page 44: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 44 of 47

History

DATE DESCRIPTION

15.01.2015 - Changed Formatting options for “notes”

- inserted Footnote for licence_plate

05.06.2014 - Remove “leasing” elements

30.04.2014 - Layout changes for the whole document

03.04.2014 - Formatting options for “notes” are available

10.02.2014 - New element in node “financing”: net_credit_amount

05.09.2013 - Changed value “radio/cd” in “radio” (node “equipment”).

- New values for car equipment items (node “equipment”):

“electrical rear-view mirrors”; ”bluetooth”; “head-up display”;

“hands-free equipment”; “mp3”; “isofix”; “light sensor”; “rain sensor”;

“parking assistance system sensors front”; “parking assistance system sen-

sors rear”; “parking assistance system camera”; “parking assistance system

self-steering”; “cd”

- New value for the upload of payed dealer ad products (node “product”):

“homepage_ad”

07.08.2013 - New value for element “type” (node “price”): export

22.05.2013 - New value to display the vehicles country of origin (node “vehicle”):

“country_version”. The value has to be in ISO-3166-1 alpha -2 format.

05.11.2012 - Changes for some elements (node “financing” and “leasing”) to type/values:

“decimal”

10.08.2012 - New value for car equipment item (node “equipment“): “panoramic_roof”

Page 45: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 45 of 47

10.05.2012 - New elements, especially for the exchange of equipment and service infor-

mation:

Last technical service:

stx3/vehicle_data/vehicles/vehicle/service/last_technical_service

Last cam belt change:

stx3/vehicle_data/vehicles/vehicle/service/last_change_cam_belt

Interior material:

stx3/vehicle_data/vehicles/vehicle/covering

Interior color:

stx3/vehicle_data/vehicles/vehicle/interior_color

Transmission type:

stx3/vehicle_data/vehicles/vehicle/transmission

Alloy wheels size:

stx3/vehicle_data/vehicles/vehicle/alloy_wheels_size

Price negotiable:

stx3/vehicle_data/vehicles/vehicle/price/negotiable

Video Link:

stx3/vehicle_data/vehicles/vehicle/media/videos/video/uri

- Deleted values for car equipment items (node “equipment“):

„4wd”, “leather_seats”, “radio”, “tuned_car”

- New values for car equipment items (node “equipment“):

„nonsmoking_vehicle“, „cab_or_rented_car”, “sport_package”, “start_stop_au-

tomatic”, “multi_functional_wheel”, “daytime_running_light”, “sport_suspen-

sion”, “sport_seats”, “bending_light”, “ski_bag”, “inspections_new”

- New value for the gearing type (node „gear_type“): „semi-automatic“

02.02.2012 - New elements for the availability of vehicles (node “delivery“):

Deliverable from (delivery date):

stx3/vehicle_data/vehicles/vehicle/delivery/delivery_date

Available after the order in (delivery time):

stx3/vehicle_data/vehicles/vehicle/delivery/delivery_time

- Changed body type values for cars (node “body“):

Old New

2/3_doors compact

4/5_doors sedan

station_wagon station_wagon

Page 46: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 46 of 47

off_road off_road

convertible convertible

coupe coupe

Van

bus van_bus

transporter transporter

2011-09-26 New element for the support of image downloads (node “image” (p. 20)).

2011-03-03 New elements for the upload of payed dealer ad products (nodes ”prod-

uct_bookings“ and “product“ (p.31)).

2011-02-16 First version of AutoScout24 XML schema description.

Page 47: AutoScout24 XML Schemaww2.autoscout24.it/interface_description.pdf ·  · 2018-03-26AutoScout24 XML Page 5 of 47 Introduction About this document The AutoScout24 XML schema is used

AutoScout24 XML

Page 47 of 47

Contact

If you have any queries or need further information, just contact us.

We are happy to help you!

AutoScout24 customer support interfaces

We are available: Monday to Friday from 8 am to 6 pm

Phone: +49-(0)89 444 56-1000

Email: [email protected]