Catalog Webservice: Interface Definition

Catalog Webservice V1.
3
Interface Definition Apr 2008
Confidental
Catalog
Webservice
-
Interface Definition
Version: V1.3
Date: Apr 2008
Status: accepted by customer
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page I
Catalog Webservice V1.3
Confidental
Prologue A : History of changes
Version Date Author Comment

0.1 Dec 2006 AF Initial release
0.2 Apr 2007 AF Corrections, additions
0.3 Apr 2007 TW Review, corrections
0.5 May 2007 AF Additions
0.6 June 2007 AF Additions
Switch to optimized Database. Compatibility functions
1.0a July 2007 AF, TW marked as "(deprecated)" are likely to disappear in the
final version.
1.0b Aug 2007 AE, TW Additions
1.0 Aug 2007 AF, TW Deprecated functions are deleted, final Review
1.1a Sep 2007 AF Additions
1.1a Oct 2007 AF Additions
1.1a Nov 2007 AF Additions
1.1a Dec 2007 AF Additions
1.1b Dec 2007 AF Additions
1.1b Jan 2008 AF Additions
1.1 Jan 2008 TW, AF Additions, Final Review
1.2 Jan 2008 AF Additions
1.3a Feb 2008 AF Additions
1.3a Apr 2008 AF Review, Corrections
1.3b Apr 2008 AF, TW Review, Corrections
1.3b May 2008 AF Review, Corrections
Persons:
AW Alexander Wegner (TecDoc)
TW Thomas Wendt (TecDoc)
AF Andreas Feldewert (TecDoc)
MP Mehdi Parvaresh (TecDoc)
Version: Version of the software
Prologue B : Abbreviations and terms
Term Description
URL Uniform Resource Locator
SOAP Simple Object Access Protocol
WSDL Web Service Description Language
Page II
Confidental
Table of contents
Prologue A : History of changes ................................................................................. II
Prologue B : Abbreviations and terms ........................................................................ II
1 Introduction .....................................................................................................13
1.1 Request Parameter ...................................................................................... 13
1.2 Result ............................................................................................................ 13
1.3 Access Control............................................................................................. 13
1.4 Linkage to other databases......................................................................... 14
1.5 Known compatibility problems................................................................... 14
1.5.1 .net ...........................................................................................................14
1.5.2 PHP ..........................................................................................................14
2 Standard request functions............................................................................15
2.1 Get key table values..................................................................................... 15
2.2 Get TecDoc country groups........................................................................ 16
2.3 Get criteria (deprecated).............................................................................. 16
2.3.1 Get criteria (new) ....................................................................................17
2.4 Get brands .................................................................................................... 18
2.5 Get vehicle manufacturer (simplified or standard) ................................... 19
2.6 Get vehicle models (simplified or standard selection) ............................. 20
2.7 Get vehicle by ID Code system (deprecated) ............................................ 21
2.8 Get vehicle by ID Code system ................................................................... 22
2.9 Get vehicle.................................................................................................... 23
2.9.1 Get vehicle (simplified selection) ..........................................................23
2.9.2 Get vehicle (simplified selection) with motor codes ...........................25
2.9.2.1 Get motor code ...................................................................................27
2.9.3 Get vehicle by model ID (advanced selection) .....................................27
2.9.4 Get vehicle details by model ID (advanced selection).........................29
2.9.5 Get vehicle by model description (advanced selection) .....................31
2.9.6 Get vehicle by motor ID..........................................................................32
2.9.7 Get construction types...........................................................................33
2.9.8 Get axis configurations..........................................................................34
Page 3-160
Confidental
2.9.9 Get fuel types ..........................................................................................34

2.9.10 Get vehicle details (construction year, power, capacity …) ...............35
2.9.11 Get vehicle details (terms) .....................................................................36
2.9.12 Get vehicle details (Passenger car details) ..........................................37
2.9.13 Get all vehicle details by a list ...............................................................39
2.9.14 Get all vehicle details by a list of string id’s ........................................40
2.10 Get body types ............................................................................................. 41
2.10.1 Get body types by body type ID ............................................................41
2.10.2 Get vehicles by body type ID .................................................................42
2.10.3 Get body type by ID ................................................................................43
2.10.4 Get vehicle ID’s by body type ................................................................44
2.11 Get motors.................................................................................................... 45
2.11.1 Get motor manufacturers.......................................................................46
2.11.2 Get motor details ....................................................................................47
2.11.3 Get motor details by a list......................................................................47
2.11.4 Get motor details by a list of string id’s ...............................................48
2.11.5 Get motors by motorcode (advanced selection)..................................49
2.12 Get axles ....................................................................................................... 50
2.12.1 Get axle manufacturers..........................................................................51
2.12.2 Get axle models ......................................................................................52
2.12.3 Get brake sizes .......................................................................................52
2.12.4 Get axle types .........................................................................................54
2.12.5 Get axle styles.........................................................................................55
2.12.6 Get axle details .......................................................................................55
2.12.7 Get axle details by a list .........................................................................56
2.12.8 Get axle details by a list of string id’s...................................................57
2.13 Get assembly groups................................................................................... 58
2.13.1 Get shortcuts for assembly groups ......................................................58
2.13.2 Get linked shortcuts for assembly groups ...........................................59
2.13.3 Get assembly groups by shortcut.........................................................59
2.13.4 Get linked assembly groups by shortcut..............................................61
2.13.5 Get assembly groups .............................................................................62
2.13.6 Get linked assembly groups ..................................................................63
2.14 Get articles (direct search).......................................................................... 64
Page 4-160
Confidental
2.14.1 Get articles ..............................................................................................64

2.14.2 Get articles by brandno and generic articleid ......................................66
2.14.3 Get article basic information (deprecated)...........................................67
2.14.4 Get article basic information (new) .......................................................68
2.14.5 Get all article detail information by article list (deprecated)...............70
2.14.6 Get all article detail information by article string list (deprecated)....72
2.14.7 Get all article detail information by single article (deprecated)..........74
2.14.8 Get all article detail information by article list (new)...........................76
2.14.9 Get all article detail information by article string list (new) ................77
2.14.10 Get all article detail information by single article (new)......................77
2.15 Get generic articles and brands ................................................................. 78
2.15.1 Get generic articles and brands by an assembly group .....................78
2.15.2 Get generic articles and brands by list.................................................80
2.15.3 Get generic articles and brands by string list ......................................81
2.15.4 Get distinct generic articles and brands by list ...................................83
2.15.5 Get distinct generic articles and brands by string list ........................85
2.16 Get articles (search tree) ............................................................................. 86
2.16.1 Get articles by generic article (product group) (deprecated) .............86
2.16.2 Get articles by brand number (deprecated) .........................................88
2.16.3 Get articles by brand number and generic article list (deprecated)...90
2.16.4 Get articles by brand number and generic article string list
(deprecated).........................................................................................................92
2.16.5 Get articles by brand number and generic article single (deprecated)93
2.16.6 Get articles by brand number and generic article list .........................95
2.16.7 Get articles by brand number and generic article string list ..............96
2.16.8 Get articles by brand number and generic article single ....................98
2.16.9 Get article basic information (deprecated)...........................................99
2.16.10 Get article basic information (new) .....................................................101
2.16.11 Get all article detail information by article list (deprecated).............103
2.16.12 Get all article detail information by single article (deprecated)........106
2.16.13 Get all article detail information by article list (new).........................109
2.16.14 Get all article detail information by single article (new)....................110
2.17 Get articles by criteria ................................................................................110
2.17.1 Get required Attributs (Criteria) ..........................................................111
2.17.2 Get attribute values of articles ............................................................112
Page 5-160
Confidental
2.17.3 Get attribute values of articles stringlist ............................................113

2.17.4 Get articles filtered by attribute string values....................................113
2.17.5 Get articles filtered by attribute string values stringlist....................114
2.17.6 Get articles filtered by attribute numeric values................................115
2.17.7 Get articles filtered by attribute numeric values stringlist................116
2.17.8 Get articles filtered by attribute interval values.................................117
2.17.9 Get articles filtered by attribute interval values stringlist.................118
2.18 Get article main information ......................................................................120
2.18.1 Get article main attributes ...................................................................120
2.18.2 Get article main information ................................................................121
2.18.3 Get article standard price ....................................................................122
2.19 Get article information................................................................................123
2.19.1 Get article EAN number .......................................................................123
2.19.2 Get article trade number ......................................................................123
2.19.3 Get article replacement number ..........................................................124
2.19.4 Get URL of extended article information ............................................125
2.19.5 Get article attribute values...................................................................126
2.19.6 Get article information .........................................................................127
2.19.7 Get main articles...................................................................................128
2.20 Get article documents ................................................................................129
2.21 Get article thumbnail documents ..............................................................130
2.22 Get article context sensitive document ....................................................131
2.22.1 Get coordinates by article document..................................................131
2.22.2 Get article context sensitive document data (deprecated) ...............133
2.22.3 Get article context sensitive document data (new) ...........................134
2.23 Get article document data ..........................................................................135
2.24 Get article catalog prices ...........................................................................135
2.25 Get article OE numbers ..............................................................................136
2.26 Get manufacturer addresses .....................................................................137
2.27 Get linked vehicles, motors, axles of an article .......................................138
2.27.1 Get linked vehicles, motors, axles of an article by manufacturer ....140
2.27.2 Get linked vehicle, motor, axle manufacturers of an article .............141
2.27.3 Get article main attributes of a linked article .....................................142
2.27.4 Get linked axle details ..........................................................................143
Page 6-160
Confidental
2.27.5 Get linked motor details.......................................................................143

2.27.6 Get linked vehicle details.....................................................................144
2.27.7 Get linked vehicle, motor, axle details of an article and a list of
linking targets (deprecated) .............................................................................145
2.27.8 Get linked vehicle, motor, axle details of an article and a list of
linking targets (new) .........................................................................................147
2.28 Get article accessory list............................................................................148
2.28.1 Get article accessory list (deprecated) ...............................................148
2.28.2 Get article accessory list (new) ...........................................................150
2.28.3 Get article accessory list with attributes (deprecated)......................152
2.28.4 Get article accessory list with attributes (new)..................................152
2.28.5 Get article accessory list existing information ..................................153
2.28.6 Get article main attribute of an accessory article ..............................154
2.29 Get article part list (deprecated) ................................................................155
2.29.1 Get article part list (new)......................................................................157
2.30 Version info .................................................................................................159
2.31 Add dynamic address.................................................................................160
Page 7-160
Confidental
Table of Functions
—A—
addDynamicAddress ...............................................................................................161
—G—
getArticleAccessoryImmediateAttributs ...................................................................155
getArticleAccessoryList............................................................................................149
getArticleAccessoryList2..........................................................................................153
getArticleDirectSearchAllNumbers ........................................................................... 65
getArticleDirectSearchAllNumbers2 ......................................................................... 66
getArticleDirectSearchById....................................................................................... 68
getArticleDirectSearchById2..................................................................................... 69
getArticleDocuments ...............................................................................................130
getArticleDocumentsByDocId ..................................................................................136
getArticleExtUrlById.................................................................................................127
getArticleHasAccessoryList .....................................................................................154
getArticleIds.............................................................................................................. 91
getArticleIds2............................................................................................................ 96
getArticleIds2Single .................................................................................................. 99
getArticleIds2StringList ............................................................................................. 97
getArticleIdsByGenericArticle ................................................................................... 87
getArticleIdsByPartManufacturer .............................................................................. 89
getArticleIdsSingle.................................................................................................... 94
getArticleIdsStringList ............................................................................................... 93
getArticleLinkedAllLinkingTarget .............................................................................140
getArticleLinkedAllLinkingTarget2 ...........................................................................141
getArticleLinkedAllLinkingTargetManufacturer ........................................................142
getArticleLinkedAllLinkingTargetsByIds...................................................................147
getArticleLinkedAllLinkingTargetsByIds2.................................................................148
getArticleLinkedMotorsById .....................................................................................144
getArticleLinkedVehiclesById ..................................................................................145
Page 8-160
Confidental
getArticleOENumbers ..............................................................................................138
getArticlePartList .....................................................................................................156
getArticlePartList2 ...................................................................................................158
getArticlePrices........................................................................................................136
getArticlePricesNormalAustausch ...........................................................................123
getAssignedArticleAttributs......................................................................................127
getAssignedArticleById............................................................................................100
getAssignedArticleById2..........................................................................................102
getAssignedArticleInfos ...........................................................................................129
getAssignedArticlesByIds ........................................................................................104
getAssignedArticlesByIds2 ......................................................................................110
getAssignedArticlesByIds2Single ............................................................................111
getAssignedArticlesByIdsSingle ..............................................................................107
getAxisConfigurations............................................................................................... 34
getAxleBrakeSizes ................................................................................................... 53
getAxleById .............................................................................................................. 55
getAxleByIds............................................................................................................. 57
getAxleByIdsStringList.............................................................................................. 57
getAxleIdByTypeManCriteria2 .................................................................................. 50
getAxleModels .......................................................................................................... 52
getAxlesManufacturers2 ........................................................................................... 51
getAxleStyles............................................................................................................ 55
getAxleTypes............................................................................................................ 54
getBrandsForAssortment.......................................................................................... 19
getChildNodesAllLinkingTarget2 .............................................................................. 62
getChildNodesAllLinkingTargetShortCut2 ................................................................ 60
getConstructionTypes............................................................................................... 33
getCoordinatesByArticleDocument ..........................................................................133
getCountryGroups .................................................................................................... 16
getCriteria ................................................................................................................. 16
getCriteria2 ............................................................................................................... 17
getCriteriaAttributesByCriteriaArticles .....................................................................113
Page 9-160
Confidental
getCriteriaAttributesByCriteriaArticlesStringList.......................................................114
getCriteriaFilterArticlesByValues .............................................................................114
getCriteriaFilterArticlesByValuesInterval..........................................................112, 118
getCriteriaFilterArticlesByValuesIntervalStringList...................................................120
getCriteriaFilterArticlesByValuesNumeric ................................................................116
getCriteriaFilterArticlesByValuesNumericStringList .................................................117
getCriteriaFilterArticlesByValuesStringList ..............................................................116
getCsgDocumentsByArticleId ..........................................................................132, 134
getCsgDocumentsByArticleId2 ................................................................................135
getDirectArticlesByIds .............................................................................................. 71
getDirectArticlesByIds2............................................................................................. 77
getDirectArticlesByIds2Single................................................................................... 78
getDirectArticlesByIds2StringList.............................................................................. 78
getDirectArticlesByIdsSingle..................................................................................... 75
getDirectArticlesByIdsStringList................................................................................ 73
getEanNumbers.......................................................................................................124
getFuelTypes............................................................................................................ 35
getGenericArticlesByManufacturer2 ......................................................................... 79
getGenericArticlesByManufacturer3StringList .......................................................... 83
getGenericArticlesByManufacturer4StringList .......................................................... 86
getImmediateAttributs..............................................................................................121
getImmediateAttributsLinkedElements ....................................................................143
getImmediateInfos ...................................................................................................122
getKeyValuesForTradersMode................................................................................. 15
getLinkedChildNodesAllLinkingTarget ...................................................................... 63
getLinkedChildNodesAllLinkingTargetShortCut ........................................................ 61
getLinkedShortCuts .................................................................................................. 59
getMainArticles ........................................................................................................130
getManufacturerInfosById .......................................................................................138
getMarkById ............................................................................................................. 43
Page 10-160
Confidental
getMotorById ............................................................................................................ 47
getMotorByIds .......................................................................................................... 48
getMotorByIdsStringList ........................................................................................... 48
getMotorCodesByCarId ............................................................................................ 27
getMotorIdsByManuIdCriteria ................................................................................... 45
getMotorManufacturers2 .......................................................................................... 46
getMotorsByCarTypeManuIdTerm ........................................................................... 49
getPassengerCarDetails........................................................................................... 37
getPegasusVersionInfo............................................................................................160
getReplacedByNumbers..........................................................................................126
getReplacedNumbers ..............................................................................................125
getRequiredAttributes ..............................................................................................112
getShortCuts2........................................................................................................... 58
getThumbnailByArticleId..........................................................................................131
getUsageNumbers...................................................................................................125
getVehicleById.......................................................................................................... 35
getVehicleByIds........................................................................................................ 39
getVehicleByIdsStringList ......................................................................................... 40
getVehicleByIdWithTerm .......................................................................................... 36
getVehicleIdsByCarTypeManuIdModelIdCriteria2 .................................................... 27
getVehicleIdsByCarTypeManuIdTerm ...................................................................... 31
getVehicleIdsByKeyNumberPlates2 ......................................................................... 21
getVehicleIdsByKeyNumberPlates3 ......................................................................... 23
getVehicleIdsByMark ................................................................................................ 44
getVehicleIdsByMotor............................................................................................... 32
getVehicleIdsByVendorId ......................................................................................... 42
getVehicleManufacturers2 ........................................................................................ 19
getVehicleModels2 ................................................................................................... 20
getVehiclesByCarTypeManuIdModelIdCriteria2 ....................................................... 29
getVehicleSimplifiedSelection2................................................................................. 23
getVehicleSimplifiedSelection3................................................................................. 25
getVendorIds ............................................................................................................ 41
Page 11-160
Confidental
Page 12-160
Confidental
1 Introduction
For the TecDoc online catalog a flexible and modular request system in form of web
services exists. External data users can access the volume of data of the online
catalog using standard requests. The present version of the catalog is 6.1.
1.1 Request Parameter

The request parameters of each request function are passed in a special request
object. As parameter the types integer, long, boolean and the special types String,
StringList and LongList are available. An unused optional parameter must be passed
as null. Mandatory parameters are marked with bold and lowercase (integer) types.
An optional parameter has an uppercase (Integer) type.
1.2 Result
The result is returned in a container object. This contains different information: A
status code of the type integer and an optional status text of the type string. The state
must be evaluated at the client, since exceptions at the server are not passed to the
Client, but are visible as status code. The search results are returned as list of data
records or as tree structure. For the data in the data record objects are used, in order
to be able to represent empty results as null.
State codes:
State Description
200 OK
400 Invalid request (e.g. invalid parameter value)
401 Request not authorized
405 Method not allowed
413 Too many results found
500 Internal error
1.3 Access Control

In each request function there is a parameter provider of type integer. TecDoc
assigns this number to each mandator. It is evaluated to authenticate the mandator
and authorize the request together with the ip address of the request. The static ip
address or addresses of the mandator are configured by TecDoc based on the
information provided by the mandator.
The request parameter provider is implicitly contained in all functions and not
described in the list of input parameters for each function.
Page 13-160
Confidental
1.4 Linkage to other databases

The TecDoc data might be linked to other databases on basis of the articleNo and
brandId in the case of articles. The technical keys like articleId or articleLinkId may
change with every new version of data.
Other keys needed to identify articles (like vehicle manufacturer, model, generic
article) remain constant over time and just get extended by new data.
1.5 Known compatibility problems
1.5.1 .net
In .net the older RPC/Encoded style of SOAP does not work. In order to work around
this, there is also an implementation of the Wrapped/Literal style with synthetic
wrapper classes. The wrapper classes do not exist, so there is no way to link it to
correct namespaces at the server. Currently one needs to work around this by
adjusting the namespaces at the client. If one fails to do, only empty results get
returned, because the generated code at client side is not able to parse the SOAP
returned by the server.
If processing arrays fails, one needs to check if there are naming conflicts. In this
case the client side generator does not take the names given in WSDL.
1.5.2 PHP
PHP does not implement different integer data types. Depending on the operating
system an integer contains 32 or 64 bit. Therefore an automatic implicit mapping
from int (32 bit) to long (64 bit) is done on discrete parameters which take a 64 bit
value. However, this does not work with arrays, so there functions having arrays of
strings containing the numeric values have to be used.
Page 14-160
Confidental
2 Standard request functions

Following standard request functions are available for the volume of data of the
online catalog version 6.1.
2.1 Get key table values

In the results of the request functions references of keytables are returned (KT xxx).
The assigned entries are found by calling this function if needed. The language
specific texts of these references should get cached and added to the search result
as required.
XML Template:
KeyValuesForTraderModeConfig.xml
Function:
getKeyValuesForTradersMode()
Result:
Column Type Description
keyTableId Integer Key table ID
keyId String Key ID
keyValue String Key value
Request Parameter:
Name Type States Description
lang string Language according to Language
ISO 639
keyTableId integer Key table ID Key table ID
Comment:
The result could get cached per language.
Page 15-160
Confidental
2.2 Get TecDoc country groups

Get available TecDoc country groups like "Europe".
XML Template:
CountryGroupsConfig.xml
Function:
getCountryGroups()
Result:
tecdocCode String TecDoc code
countryName String Country name
Request Parameter:
lang string Language code according Language
to ISO 639
Comment:
2.3 Get criteria (deprecated)

In the results of the request functions references of criterion are returned. The
assigned entries are found by calling this function if needed. The language specific
texts of these references should get cached and added to the search result as
required.
XML Template:
CriteriaConfig.xml
Function:
getCriteria()
Page 16-160
Confidental
Result:
criteriaId Integer Criterion ID
criteriaName String Criterion name
criteriaShortName String Short name
criteriaUnit String Unit
criteriaType String Type:
A: Alphanumeric
N:Numeric
D:Date
K:Key
V:No Value
Request Parameter:
to ISO 639
Comment:
2.3.1 Get criteria (new)

In the results of the request functions references of criterion are returned. The
assigned entries are found by calling this function if needed. The language specific
texts of these references should get cached and added to the search result as
required.
XML Template:
Criteria2Config.xml
Function:
getCriteria2()
Page 17-160
Confidental
Result:
criteriaId Integer Criterion ID
criteriaName String Criterion name
criteriaShortName String Short name
criteriaUnit String Unit
criteriaType String Type:
A: Alphanumeric
N:Numeric
D:Date
K:Key
V:No Value
isInterval Boolean Flag:
true: criterium has interval
false: criterium has no
interval
successorId Integer Successor ID
Request Parameter:
Identical structure as function getCriteria () (see:2.3).
Comment:
2.4 Get brands

Find all currently available brands for this mandator.
XML Template:
BrandsForAssortmentConfig.xml
Function:
Page 18-160
Confidental
getBrandsForAssortment ()
Result:
brandNo Integer Brand no
brandName String Brand name
Request Parameter:
2.5 Get vehicle manufacturer (simplified or standard)

Find vehicle manufacturers.
XML Template:
VehicleManufacturers2Config.xml
Function:
getVehicleManufacturers2()
Result:
manuId Long Manufacturer ID
manuName String Manufacturer name
Request Parameter:
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
evalFavor boolean true, if simplified vehicle Flag: simplified vehicle
selection else false selection
Page 19-160
Confidental

favouredList Integer If simplified vehicle selection: Favoured list for
favoured list: 1: first list else simplified vehicle
null selection
Others tbd
lang String Language code according to Language
ISO 639
countryGrou boolean true, if country group selection, Flag: country group
pFlag else false selection
countriesCa string Country code according to ISO Country for vehicle
rSelection 3166 or TecDoc country selection
group code
Comment:
The result may get cached.
2.6 Get vehicle models (simplified or standard selection)

Find vehicle models.
XML Template:
VehicleModels2Config.xml
Function:
getVehicleModels2()
Result:
modelId Long Model ID
modelname String Model name
yearOfConstrFrom Integer From construction year
[YYYYMM]
yearOfConstrTo Integer To construction year
[YYYYMM]
Page 20-160
Confidental
Request Parameter:
manuId long Result of vehicle Manufacturer ID
manufacturer selection
1: Passenger car
3: Both
evalFavor boolean true, if simplified vehicle Flag: simplified
selection, else false model selection
favouredList Integer If simplified vehicle Favoured list for
selection: favoured list: 1: simplified model
first list else null selection
Others tbd
lang string Language code Language
according to ISO 639
countryGroupFlag boolean true, if country group Flag: country
selection else false group selection
countriesCarSelection string Country code according Country for model
to ISO 3166 or TecDoc selection
country group code
2.7 Get vehicle by ID Code system (deprecated)

Find vehicles by an ID Code system.
XML Template:
VehicleIdsByKeyNumberPlates2Config.xml
Function:
getVehicleIdsByKeyNumberPlates2()
Result:
carId Long Vehicle ID
Page 21-160
Confidental
carName String Vehicle name

firstCountry String First country code (according
to ISO 3166)
Request Parameter:
keySystemNumber string Key system number ID Code
keySystemType integer Key system type: ID Code system
1: Dutch NumberPlate
2: French TypeMine
3: Swedish NumberPlate
4: Swiss Typenumber
5: Danish NumberPlate
6: Austrian NatCodes
20: German KBA Number
Others tbd.
Lang string Language code according Language
to ISO 639
countryUserSetting String If vehicle selection with Country for article
article assignments: assignments
country code according to
ISO 3166, else null
countryGroupFlag boolean true, if country group Flag: country group
countriesCarSelect string Country code according to Country for vehicle
ion ISO 3166 or TecDoc selection
country group code
2.8 Get vehicle by ID Code system

Find vehicles by an ID Code system with model and manufacturer.
XML Template:
VehicleIdsByKeyNumberPlates3Config.xml
Page 22-160
Confidental
Function:
getVehicleIdsByKeyNumberPlates3()
Result:
to ISO 3166)
Request Parameter:
Identical structure as function getVehicleIdsByKeyNumberPlates2 () (see:2.7).
2.9 Get vehicle
2.9.1 Get vehicle (simplified selection)

Find vehicles for simplified selection.
XML Template:
VehicleSimplifiedSelection2Config.xml
Function:
getVehicleSimplifiedSelection2()
Result:
linked Integer Number of article
assignments
Page 23-160
Confidental

to ISO 3166)
[YYYYMM]
[YYYYMM]
powerKwFrom Integer From power / KW
powerKwTo Integer To power / KW
powerHpFrom Integer From power / HP
powerHpTo Integer To power / HP
cylinderCapacity Integer Capacity / ccm
Request Parameter:
manuId Long If standard selection: Manufacturer ID
result of vehicle
manufacturer selection,
else null
modId Long If standard selection: Model ID
result of model
selection, else null
favouredList Integer If not standard selection: Favoured list for
favoured list: 1: first list simplified selection
else null; others tbd
1: Passenger car
3: Both
linked boolean false: all, true: only Flag: selection with /
linked articles without article
assignments
countryUserSetting String If model selection with Country for article
country code according
Page 24-160
Confidental

to ISO 3166 else null
countriesCarSelectio string Country code according Country for Vehicle
n to ISO 3166 or TecDoc selection
country group code
2.9.2 Get vehicle (simplified selection) with motor codes

Find vehicles for simplified selection with motor codes.
XML Template:
VehicleSimplifiedSelection3Config.xml
Function:
getVehicleSimplifiedSelection3()
Result:
Records Description Records
CarDetails Result of Car details
vehicle
selection (see
2.9.1
MotorCodes Result of Motor codes
motor code
selection
(see:2.9.2.1)
Page 25-160
Confidental
Request Parameter:
manuId Long If standard selection: Manufacturer ID
result of vehicle
manufacturer selection,
else null
modId Long If standard selection: Model ID
result of model
selection, else null
favouredList Integer If not standard selection: Favoured list for
favoured list: 1: first list simplified selection
else null; others tbd
1: Passenger car
3: Both
assignments
countryUserSetting String If model selection with Country for article
country code according
to ISO 3166 else null
country group code
Page 26-160
Confidental
2.9.2.1 Get motor code

Find motor code for a vehicle.
XML Template:
MotorCodesByCarIdConfig.xml
Function:
getMotorCodesByCarId()
Result:
motorCode String Motor code
Request Parameter:
carId long Result of vehicle Vehicle ID
selection
countriesCarSelection string Country code according Country of vehicle
to ISO 3166 or TecDoc selection
country group code
2.9.3 Get vehicle by model ID (advanced selection)

Find vehicles by advanced selection.
XML Template:
VehicleIdsByCarTypeManuIdModelIdCriteria2Config.xml
Function:
getVehicleIdsByCarTypeManuIdModelIdCriteria2()
Page 27-160
Confidental
Result:
to ISO 3166)
Request Parameter:
modId long Result of vehicle model Model ID
selection
1: Passenger car
3: Both
yearOfConstruction Integer Construction year [YYYY] Construction year
fuelTypeId Long Result of fuel type Fuel type ID
selection
constructionTypeId Long Result of construction Construction type
type selection ID
axisConfigurationId Long Result of configuration Configuration ID
selection
cylinderCapacityFrom Integer Capacity / ccm From capacity
cylinderCapacityTo Integer Capacity / ccm To capacity
powerHpType Boolean true: HP false: KW Flag: power type
powerFrom Integer Power / HP or power / KW From power
powerTo Integer Power / HP or power / KW To power
tonnageFrom Integer Tonnage / T From Tonnage
tonnageTo Integer Tonnage / T To Tonnage
to ISO 639
Page 28-160
Confidental

selection, else false group selection
countriesCarSelectio string Country code according to Country of vehicle
n ISO 3166 or TecDoc selection
country group code
2.9.4 Get vehicle details by model ID (advanced selection)

XML Template:
VehiclesByCarTypeManuIdModelIdCriteria2Config.xml
Function:
getVehiclesByCarTypeManuIdModelIdCriteria2()
Result:
Records Description
vehicle Vehicle info (see

2.9.3)
vehicleDetails Vehicle detail info
(see 2.9.10)
Page 29-160
Confidental
Request Parameter:
modId long Result of vehicle model Model ID
selection
1: Passenger car
3: Both
selection
type selection ID
selection
to ISO 639
country group code
Page 30-160
Confidental
2.9.5 Get vehicle by model description (advanced selection)

XML Template:
VehicleIdsByCarTypeManuIdTermConfig.xml
Function:
getVehicleIdsByCarTypeManuIdTerm()
Result:
to ISO 3166)
Request Parameter:
modelDescription String Result of vehicle model Model description
selection
1: Passenger car
3: Both
selection
type selection ID
selection
Page 31-160
Confidental

to ISO 639
country group code
2.9.6 Get vehicle by motor ID

Find vehicles by motor ID.
XML Template:
VehicleIdsByMotorConfig.xml
Function:
getVehicleIdsByMotor()
Result:
to ISO 3166)
Page 32-160
Confidental
Request Parameter:
motorId long Result of motor selection Motor ID
1: Passenger car
3: Both
to ISO 639
country group code
2.9.7 Get construction types

Return available construction types.
XML Template:
ConstructionTypesConfig.xml
Function:
getConstructionTypes()
Result:
constrTypeID Long Construction type ID
constrTypeName String Construction type name
Request Parameter:
to ISO 639
Page 33-160
Confidental
Comment:
The result may get cached per language.
2.9.8 Get axis configurations

Return available axis configurations.
XML Template:
AxisConfigurationsConfig.xml
Function:
getAxisConfigurations()
Result:
axisConfigID Long Axis configuration ID
axisConfigName String Axis configuration name
Request Parameter:
to ISO 639
Comment:
2.9.9 Get fuel types

Return available fuel types.
XML Template:
FuelTypesConfig.xml
Page 34-160
Confidental
Function:
getFuelTypes()
Result:
fuelTypeID Long Fuel type ID
fuelTypeName String Fuel type name
Request Parameter:
to ISO 639
Comment:
2.9.10 Get vehicle details (construction year, power, capacity …)

Find vehicle detail information.
XML Template:
VehicleByIdConfig.xml
Function:
getVehicleById()
Result:
axisConfiguration String Axis configuration name
constructionType String Construction type name
[YYYYMM]
Page 35-160
Confidental

[YYYYMM]
powerKwTo Integer To power / KW
powerHpFrom Integer From power / HP
powerHpTo Integer To power / HP
ccmTech Integer Capacity / ccm
tonnage Integer Tonnage / T
modId Long Model ID
Request Parameter:
carId long Result of vehicle selection Vehicle
lang string Language code according to Language
ISO 639
Country string Country code according to Country
ISO 3166
2.9.11 Get vehicle details (terms)

Find vehicle terms.
XML Template:
VehicleByIdWithTermConfig.xml
Function:
getVehicleByIdWithTerm()
Result:
Page 36-160
Confidental

modId Long Model ID
carType String Vehicle type
modelName String Model name
Request Parameter:
carId long Result of vehicle selection Vehicle ID
ISO 639
country string Country code according to Country
ISO 3166
countryUserSetting string Country code according to Country of article
ISO 3166 assignments
2.9.12 Get vehicle details (Passenger car details)

Find vehicle details.
XML Template:
PassengerCarDetailsConfig.xml
Function:
getPassengerCarDetails()
Result:
manuName String Manufacturer
typeName String Type name
constructionType String Construction type
Page 37-160
Confidental

fuelType String Fuel type
impulsionType String Impulsion Type
brakeSystem String Brake system
motorType String Motor type
yearOfConstructionFrom Integer From construction year
[YYYYMM]
yearOfConstructionTo Integer To construction year
[YYYYMM]
powerKW Integer Power / KW
powerHP Integer Power / HP
cylinderCapacityCcm Integer Cylinder capacity / CCM
cylinderCapacityLiter Integer Cylinder capacity / Liter
cylinder Integer Cylinder
typeNumber Integer Type number
valves Integer Valves
fuelTypeProcess String Fuel type process
Request Parameter:
ISO 639
ISO 3166
Page 38-160
Confidental
2.9.13 Get all vehicle details by a list

Find vehicle detail information by a list of ID´s.
XML Template:
VehicleByIdsConfig.xml
Function:
getVehicleByIds()
Result:
Records Description
VehicleDetails Vehicle Details (see
2.9.10)
VehicleTerms Vehicle Terms (see
2.9.11)
PassengerCarDetails Passenger Car details
(see 2.9.12)
MotorCodes Motor Codes (see
2.9.2.1)
Request Parameter:
carIds longList Result of vehicle selection List of Vehicle ID’s
(max 25)
Lang string Language code according to Language
ISO 639
ISO 3166
countryUserSettin string Country code according to Country of article
g ISO 3166 assignments
vehicleTerms boolean If true, get vehicle terms Vehicle terms
passengerCarDet boolean If true, get passenger car Passenger car
ails details details
motorCodes boolean If true, get motor codes Motor Codes
Page 39-160
Confidental
2.9.14 Get all vehicle details by a list of string id’s

Find vehicle detail information by a list of string id’s. It is only needed for compatibility
to environments missing the "long" data type (like php). If possible do not call this
function, instead call the original function (with an array of long).
XML Template:
VehicleByIdsStringListConfig.xml
Function:
getVehicleByIdsStringList()
Result:
Records Description
VehicleDetails Vehicle Details (see
2.9.10)
VehicleTerms Vehicle Terms (see
2.9.11)
PassengerCarDetails Passenger Car details
(see 2.9.12)
MotorCodes Motor Codes (see
2.9.2.1)
Request Parameter:
carIds stringList Result of vehicle selection List of Vehicle ID’s
(max 25)
ISO 639
ISO 3166
countryUserSettin string Country code according to Country of article
g ISO 3166 assignments
vehicleTerms boolean If true, get vehicle terms Vehicle terms
passengerCarDet boolean If true, get passenger car Passenger car
Page 40-160
Confidental

ails details details
motorCodes boolean If true, get motor codes Motor Codes
2.10 Get body types

Find body types.
2.10.1 Get body types by body type ID

Find body types by their body type ID.
XML Template:
VendorIdsConfig.xml
Function:
getVendorIds()
Result:
vendorName String Body type name
markId Long Body type ID
linkedCars Integer Count of car assignments
linkedArticles Integer Count of article assignments
direct to the body type
Page 41-160
Confidental
Request Parameter:
1: Passenger car
3: Both
countryUserSetting string Country code according Country for article
to ISO 3166 assignments
country group code
searchPattern string Search pattern Search pattern for
body type like ‘4B’
searchExact boolean true: exact search Flag: exact search
false: no exact search
2.10.2 Get vehicles by body type ID

Find vehicles by their body type ID.
XML Template:
VehicleIdsByVendorIdConfig.xml
Function:
getVehicleIdsByVendorId()
Result:
carId Long Car ID
to ISO 3166)
Page 42-160
Confidental
term String Short vehicle description
Request Parameter:
1: Passenger car
3: Both
manuId long Manufacturer ID Id of the vehicle
manufacturer like ‘55’
for ‘IVECO’
vendorName string Vendor name Body type name like
‚E3MPC1A1’
country group code
2.10.3 Get body type by ID

Find a body type by its ID.
XML Template:
MarkByIdConfig.xml
Function:
getMarkById()
Result:
markId Long Body type ID
markName String Body type name
Page 43-160
Confidental
manuName String Name of vehicle

manufacturer
linkedCars Integer Count of linked cars
Request Parameter:
markId long Body type ID Body type ID
assignments
lang string Language nach ISO 639 Language
country string Country code according Country
to ISO 3166
2.10.4 Get vehicle ID’s by body type

Find vehicle ID’s by body type.
XML Template:
VehicleIdsByMarkConfig.xml
Function:
getVehicleIdsByMark()
Result:
carId Long Vehicle Id
term String Short vehicle description
Request Parameter:
markId long Body type ID Body type ID
Page 44-160
Confidental

countryUserSetting string Country code according Country for article
to ISO 3166 assignments
country group code
2.11 Get motors

Find motors.
XML Template:
MotorIdsByManuIdCriteriaConfig.xml
Function:
getMotorIdsByManuIdCriteria()
Result:
motorId Long Motor ID
Request Parameter:
manuId long Result of motor Manufacturer ID
1: Passenger car
3: Both
selection
Page 45-160
Confidental

powerHpType Boolean true: HP false: KW Power type
powerFrom Integer Power / HP or Power / HP From Power
or null
powerTo Integer Power / HP or Power / To Power
KW or null
sellsTerm String Sales description Sales description
motorCode String Motor code Motor code
to ISO 639
ISO 3166
2.11.1 Get motor manufacturers

Find motor manufacturers.
XML Template:
MotorManufacturers2Config.xml
Function:
getMotorManufacturers2()
Result:
Request Parameter:
lang string Language code according to ISO Language
639
Page 46-160
Confidental

country string Country code according to ISO Country
3166
2.11.2 Get motor details

Find motor details.
XML Template:
MotorByIdConfig.xml
Function:
getMotorById()
Result:
manuId Long Motor manufacturer ID
manuText String Manufacturer name
cylinder Integer Number of cylinder
sellsTerm String Sales description
Request Parameter:
Lang string Language nach ISO 639 Language
ISO 3166
2.11.3 Get motor details by a list
Page 47-160
Confidental
Find motor details by a list of long id's.
XML Template:
MotorByIdsConfig.xml
Function:
getMotorByIds()
Result:
Records Description
MotorDetails Motor Details (see 2.11.2)
Request Parameter:
motorIds longList Result of motor selection Motor ID’s (max
25)
ISO 3166
2.11.4 Get motor details by a list of string id’s

Find motor details by a list of string id's. It is only needed for compatibility to
environments missing the "long" data type (like php). If possible do not call this
XML Template:
MotorByIdsStringListConfig.xml
Function:
getMotorByIdsStringList()
Page 48-160
Confidental
Result:
Records Description
MotorDetails Motor Details (see 2.11.2)
Request Parameter:
motorIds stringLis Result of motor selection Motor ID’s (max
t 25)
ISO 3166
2.11.5 Get motors by motorcode (advanced selection)

Find motors by motor code.
XML Template:
MotorsByCarTypeManuIdTermConfig.xml
Function:
getMotorsByCarTypeManuIdTerm()
Result:
manuId Long Motor manufacturer ID
manuText String Manufacturer name
cylinder Integer Number of cylinder
sellsTerm String Sales description
Page 49-160
Confidental
Request Parameter:
1: Passenger car
3: Both
motorCode String Motor code Motor code like
‚AEL’
countriesCarSelectio string Country code according to Country for Vehicle
country group code
2.12 Get axles

Find axles.
XML Template:
AxleIdByTypeManCriteria2Config.xml
Function:
getAxleIdByTypeManCriteria2()
Result:
axleId Long Axle ID
Page 50-160
Confidental
Request Parameter:
manuId long Result of axle manufacturer Manufacturer ID
selection
modelId Long Result of axle model Axle model ID
selection
axleDescription String Axle name Axle name
axleTypeId Long Result of axle type selection Axle type ID
axleStyleId Long Result of axle style selection Axle style ID
brakeSizeId Long Result of brake size Brake size ID
selection
ISO 639
2.12.1 Get axle manufacturers

Return all axle manufacturers.
XML Template:
AxlesManufacturers2Config.xml
Function:
getAxlesManufacturers2()
Result:
Request Parameter:
Lang String Language code according to ISO Language
Page 51-160
Confidental

639
Comment:
2.12.2 Get axle models

Find axle models.
XML Template:
AxleModelsConfig.xml
Function:
getAxleModels()
Result:
modelId Long Modell ID
[YYYYMM]
[YYYYMM]
Request Parameter:
manuId long Result of axle manufacturer Manufacturer ID
selection
Lang string Language code according to ISO Language
639
3166
2.12.3 Get brake sizes
Page 52-160
Confidental
Return all available brake sizes.
XML Template:
AxleBrakeSizesConfig.xml
Function:
getAxleBrakeSizes()
Result:
brakeSizeId Long Brake size ID
brakeSize String Brake size
brakeSizeName String Brake size name
Request Parameter:
639
Comment:
Page 53-160
Confidental
2.12.4 Get axle types

Return all available axle types.
XML Template:
AxleTypesConfig.xml
Function:
getAxleTypes()
Result:
axleTypeId Long Axle type ID
axleTypeName String Axle type name
Request Parameter:
639
Comment:
Page 54-160
Confidental
2.12.5 Get axle styles

Return all available axle styles.
XML Template:
AxleStylesConfig.xml
Function:
getAxleStyles()
Result:
axleStyleId Long Axle style ID
axleStyleName String Axle style name
Request Parameter:
639
Comment:
2.12.6 Get axle details

Find axle details.
XML Template:
AxleByIdConfig.xml
Function:
getAxleById()
Page 55-160
Confidental
Result:
axleId Long Axle ID
axleDescription String Axle description
manuShortName String Manufacturer short name
modelId Long Axle model ID
axleTypeId Long Axle type ID
[YYYYMM]
[YYYYMM]
axleLoadFrom Integer From axle load/kg
axleLoadUpto Integer To axle load/kg
Request Parameter:
axleId long Result of axle selection Axle ID
639
3166
2.12.7 Get axle details by a list

Find axle details by a list of long id’s.
XML Template:
AxleByIdsConfig.xml
Page 56-160
Confidental
Function:
getAxleByIds()
Result:
Records Description
AxleDetails AxleDetails (see 2.12.6)
Request Parameter:
axleIds longList Result of axle selection Axle ID (max 25)
639
3166
2.12.8 Get axle details by a list of string id’s

Find axle details by a list of string id’s. It is only needed for compatibility to
environments missing the "long" data type (like php). If possible do not call this
XML Template:
AxleByIdsStringListConfig.xml
Function:
getAxleByIdsStringList()
Result:
Records Description
AxleDetails AxleDetails (see 2.12.6)
Request Parameter:
axleIds stringList Result of axle selection Axle ID's (max 25)
Page 57-160
Confidental

639
3166
2.13 Get assembly groups

Find aasembly groups.
2.13.1 Get shortcuts for assembly groups

Find shortcuts for assembly groups.
XML Template:
ShortCuts2Config.xml
Function:
getShortCuts2()
Result:
shortCutId Long Shortcut ID
shortCutName String Shortcut name
Request Parameter:
linkingTargetType string Linking target type: Linking target type
C: Vehicle
M: Motor
A: Axles
K: Body Type
U: Universal
ISO 639
Page 58-160
Confidental
2.13.2 Get linked shortcuts for assembly groups

Find shortcuts for assembly groups, if any articles are linked to it.
XML Template:
LinkedShortCutsConfig.xml
Function:
getLinkedShortCuts()
Result:
Identical structure as function getShortCuts2() (see 2.13.1)
Request Parameter:
C: Vehicle
M: Motor
A: Axles
K: Body Type
U: Universal
linkingTargetId Long Linking target ID according to Linking target ID
the linking target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body Type ID
U: null
ISO 639
country string Country code according to ISO Country for article
3166 assignments
2.13.3 Get assembly groups by shortcut
Page 59-160
Confidental
Find vehicle, motor, axle or universal assembly groups by a shortcut for the search
tree.
XML Template:
ChildNodesAllLinkingTargetShortCut2SpecialConfig.xml
Function:
getChildNodesAllLinkingTargetShortCut2()
Result:
assemblyGroupNodeId Long Assembly group node ID
parentNodeId Long Parent node ID, null = root
node
assemblyGroupName String Assembly group name
hasChilds Boolean true, has child nodes, else false
Request Parameter:
C: Vehicle
M: Motor
A: Axle
K: Body Type
U: Universal
parentNodeId Long Parent node ID or null, if root Parent node ID
node
shortCutId long Result of shortcut selection Shortcut ID
ISO 639
childNodes boolean true, if child nodes of Flag: child nodes
assembly group should be selection
selected too else false
Page 60-160
Confidental
2.13.4 Get linked assembly groups by shortcut

Find vehicle, motor, axle or universal assembly groups by a shortcut for the search
tree, if any articles are linked to it.
XML Template:
LinkedChildNodesAllLinkingTargetShortCutSpecialConfig.xml
Function:
getLinkedChildNodesAllLinkingTargetShortCut()
Result:
Identical structure as function getChildNodesAllLinkingTargetShortCut() (see 2.13.3)
Request Parameter:
C: Vehicle
M: Motor
A: Axle
K: Body Type
U: Universal
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body Type ID
U: null
parentNodeId Long Parent node ID or null, if root Parent node ID
node
shortCutId long Result of shortcut selection Shortcut ID
Page 61-160
Confidental

ISO 639
country string Country code according to Country for article
childNodes boolean true, if child nodes of Flag: child nodes
2.13.5 Get assembly groups

Find vehicle, axle, motor or universal assembly groups for the search tree.
XML Template:
ChildNodesAllLinkingTarget2SpecialConfig.xml
Function:
getChildNodesAllLinkingTarget2()
Result:
parentNodeId Long Parent node ID, null = root node
assemblyGroupName String Assembly group name
hasChilds Boolean True if result has child nodes else
false
Request Parameter:
C: Vehicle
M: Motor
A: Axle
K: Body Type
U: Universal
Page 62-160
Confidental

parentNodeId Long Parent node ID or null in Parent node ID
case of root node
to ISO 639
childNodes boolean True if child nodes of Flag: child nodes
(has no effect on the
selection of the root node)
2.13.6 Get linked assembly groups

Find vehicle, axle, motor or universal assembly groups for the search tree, if any
articles are linked to it.
XML Template:
LinkedChildNodesAllLinkingTargetSpecialConfig.xml
Function:
getLinkedChildNodesAllLinkingTarget()
Result:
Identical structure as function getChildNodesAllLinkingTarget() (see 2.13.5)
Request Parameter:
C: Vehicle
M: Motor
A: Axle
K: Body Type
U: Universal
linkingTargetId Long Linking target ID according Linking target ID
to the linking target type:
Page 63-160
Confidental

C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body Type ID
U: null
parentNodeId Long Parent node ID or null in Parent node ID
case of root node
to ISO 639
country string Country code according to Country for article
childNodes boolean True if child nodes of Flag: child nodes
(has no effect on the
selection of the root node)
2.14 Get articles (direct search)

Find article by all number types.
2.14.1 Get articles

Find articles by all number types.
XML Template:
ArticleDirectSearchAllNumbersSpecialConfig.xml
Function:
getArticleDirectSearchAllNumbers()
Result:
articleId Long Article ID
articleNo String Article number
Page 64-160
Confidental

articleName String Article name
articleSearchNo String Article search number
brandNo Integer Brand number
genericArticleId Long Generic Article number
numberType Integer TecDoc number type:
0: Article number
1: OE number
2: Trade number
3: Comparable number
4: Replacement number
If the count of found articles exceeds 2000, the function returns an error 413 instead
of the article list.
Request Parameter:
numberType integer 0: Article number Number type
1: OE number
2: Trade number
10: Any number
11: Seller number
Others tbd
articleNumber string Article number (will be Article number
converted in the search process
in a simplified article number)
searchExact boolean true: exact search Search mode
false: similar search
sortType integer 1: Brand Sort mode
2: Product group
Others tbd
ISO 639
Page 65-160
Confidental

3166
2.14.2 Get articles by brandno and generic articleid

Find article by all number types and brandno and generic articleId.
XML Template:
ArticleDirectSearchAllNumbers2SpecialConfig.xml
Function:
getArticleDirectSearchAllNumbers2()
Result:
Identical structure as function getArticleDirectSearchAllNumbers() (see:2.14.1).
Request Parameter:
numberType integer 0: Article number Number type
1: OE number
2: Trade number
10: Any number
11: Seller number
Others tbd
articleNumber string Article number (will be Article number
converted in the search process
in a simplified article number)
searchExact boolean true: exact search Search mode
false: similar search
sortType integer 1: Brand Sort mode
2: Product group
Others tbd
ISO 639
Page 66-160
Confidental

3166
brandno Long Result of brand selection Brand number
genericArticleId Long Result of generic article Generic article ID
selection
2.14.3 Get article basic information (deprecated)

Find basic information of an article.
XML Template:
ArticleDirectSearchByIdConfig.xml
Function:
getArticleDirectSearchById()
Result:
articleAddName String Article add name
articleState Integer Article state (KT 073)
articleStateName String Article state name (KT 073)
genericArticleId Long Generic article ID
packingUnit Integer Packing Unit
quantityPerPackingUnit Integer Quantity per packing unit
hasPrices Boolean true if prices are available else
false
hasDocuments Boolean true if documents are available
Page 67-160
Confidental

else false
hasSecurityInfo Boolean true if security info is available
else false
hasPartList Boolean true if a part list is available else
false
hasOEN Boolean true if OE numbers are available
else false
hasUsage Boolean true if trade numbers are
available else false
hasVehicleLink Boolean true if vehicle links are available
else false
hasMotorLink Boolean true if motor links are available
else false
hasAxleLink Boolean true if axle links are available
else false
hasCsGraphics Boolean true if context sensitive graphics
are available else false
hasAppendage Boolean true if appendages are available
else false
hasLessDiscount Boolean true if less discount is available
else false
Request Parameter:
articleId long Result of article selection Article ID
priceDate Integer Price date [YYYYMMDD] Price date
Null = current date
3166
ISO 639
2.14.4 Get article basic information (new)

Find basic information of an article (with body type info).
Page 68-160
Confidental
XML Template:
ArticleDirectSearchById2Config.xml
Function:
getArticleDirectSearchById2()
Result:
false
else false
else false
false
else false
Page 69-160
Confidental

else false
else false
else false
else false
else false
hasMarkLink Boolean true if body type links are
Request Parameter:
Identical structure as function getArticleDirectSearchById() (see 2.14.3)
2.14.5 Get all article detail information by article list (deprecated)

Find all detail information of a list of articles.
XML Template:
DirectArticlesByIdsConfig.xml
Function:
getDirectArticlesByIds()
Result:
Records Description
directArticle Article basic information (see 2.14.3)
assignedArticle Not used
immediateAttributs Article main attributes (see 2.18.1)
immediateInfo Article main info (see 2.18.2)
Page 70-160
Confidental
normalAustauschPrice Normal price (see 2.18.3)

eanNumber EAN number (see 2.19.1)
usageNumbers Trade numbers (see 2.19.2)
replacedNumber Replacement number (see 2.19.3)
replacedByNumber Replaced by numbers (see 2.19.3)
articleAttributes Article attributes (see 2.19.5)
articleInfo Article information (see 2.19.6)
mainArticle Main articles of part articles (see 2.19.7)
articleDocuments Documentdescription (see 2.20)
documentData Documentdata (see 2.23)
articlePrices Article catalog prices (see 2.24)
oenNumbers OE numbers (see 2.25)
Request Parameter:
articleId LongList Results of article List of Article ID’s (max. 25
selection entries)
priceDate Integer Price date Price date
[YYYYMMDD]
Null = current date
country string Country code Country
according to ISO
3166
according to ISO
639
immediateAttrib boolean If true, get Article main attributes
uts immediate attributes
(see 2.18.1) else
false
immediateInfo boolean If true, get Article main info
immediate info (see
2.18.2) else false
normalAustausc boolean If true, get normal Normal price
hPrice price (see 2.18.3)
Page 71-160
Confidental

else false
eanNumbers boolean If true, get EAN EAN number
number (see 2.19.1)
else false
usageNumbers boolean If true, get trade Trade numbers
number (see 2.19.2)
else false
replacedNumbe boolean If true, get replace- Replacement number
rs ment number (see
2.19.3) else false
replacedByNum boolean If true, get replaced Replaced by numbers
bers by numbers (see
2.19.3) else false
attributs boolean if true, get article Article attributs
attributes (see
2.19.5) else false
info boolean If true, get article Article information
information (see
2.19.6) else false
mainArticles boolean If true, get main Main articles of part articles
articles (see 2.19.7)
else false
documents boolean If true, get Document description
documents (see
2.20) else false
documentsData boolean If true, get Documentdata
documents data
(see 2.23) else false
prices boolean If true, get article Article catalog prices
catalog prices (see
2.24) else false
oeNumbers boolean If true, get OE OE numbers
numbers (see 2.25)
else false
2.14.6 Get all article detail information by article string list (deprecated)
Page 72-160
Confidental
Find all detail information of a list of articles.
XML Template:
DirectArticlesByIdsStringListConfig.xml
Function:
getDirectArticlesByIdsStringList()
Result:
Identical structure as function getDirectArticlesByIds() (see: 2.14.5).
Request Parameter:
articleId StringList Results of article List of Article ID’s (max. 25
selection entries)
[YYYYMMDD]
Null = current date
according to ISO
3166
according to ISO
639
(see 2.18.1) else
false
immediate info (see
2.18.2) else false
else false
number (see 2.19.1)
Page 73-160
Confidental

else false
number (see 2.19.2)
else false
rs ment number (see
2.19.3) else false
2.19.3) else false
attributes (see
2.19.5) else false
information (see
2.19.6) else false
articles (see 2.19.7)
else false
document (see 2.20)
else false
documentdata (see
2.23) else false
catalog prices (see
2.24) else false
numbers (see 2.25)
else false
2.14.7 Get all article detail information by single article (deprecated)

Find all detail information of a single article.
XML Template:
DirectArticlesByIdsSingleConfig.xml
Page 74-160
Confidental
Function:
getDirectArticlesByIdsSingle()
Result:
Request Parameter:
articleId long Results of article Article ID
selection
[YYYYMMDD]
Null = current date
according to ISO
3166
according to ISO
639
(see 2.18.1) else
false
immediate info (see
2.18.2) else false
else false
number (see 2.19.1)
else false
number (see 2.19.2)
else false
Page 75-160
Confidental

rs ment number (see
2.19.3) else false
2.19.3) else false
attributes (see
2.19.5) else false
information (see
2.19.6) else false
articles (see 2.19.7) (see 2.19.7)
else false
document (see 2.20)
else false
documentdata (see
2.23) else false
catalog prices (see
2.24) else false
numbers (see 2.25)
else false
2.14.8 Get all article detail information by article list (new)

Find all detail information of a list of articles (with body type info).
XML Template:
DirectArticlesByIds2Config.xml
Function:
getDirectArticlesByIds2()
Page 76-160
Confidental
Result:
Exception: The result has a new basic record (see: 2.14.4)
Request Parameter:
2.14.9 Get all article detail information by article string list (new)
Find all detail information of a list of articles (with body type info).
XML Template:
DirectArticlesByIds2StringListConfig.xml
Function:
getDirectArticlesByIds2StringList()
Result:
Request Parameter:
Identical structure as function getDirectArticlesByIdsStringList() (see: 2.14.6).
2.14.10 Get all article detail information by single article (new)

Find all detail information of a single article (with body type info).
XML Template:
DirectArticlesByIds2SingleConfig.xml
Function:
getDirectArticlesByIds2Single()
Page 77-160
Confidental
Result:
Request Parameter:
Identical structure as function getDirectArticlesByIdsSingle() (see: 2.14.7).
2.15 Get generic articles and brands

Find generic articles
2.15.1 Get generic articles and brands by an assembly group

Find generic articles by an assembly group.
XML Template:
GenericArticlesByManufacturer2Config.xml
Function:
getGenericArticlesByManufacturer2()
Result:
Column Typ Description
parentNodeId Long Parent node ID of assembly
group node
articleNormName String Article standard name
Page 78-160
Confidental
Request Parameter:
linkingTargetType string Linking target type: Linking target
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Other tbd
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
assemblyGroupNodeI long Result of assembly group Assembly group
d selection node ID
childNodes boolean false:Standard Flag: child
nodes selection
true:show detail information
of all child nodes of the
assembly group
brandNo Integer In case of limitation to brand Brand number
number else null
genericArticleId Long In case of limitation to Generic article
generic article number else number
null
sortMode integer Sort mode: Sort mode
1: Brand name
2: Article norm name
Others tbd
ISO 639
Page 79-160
Confidental

ISO 3166
2.15.2 Get generic articles and brands by list

XML Template:
Function:
Result:
group node
Request Parameter:
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Other tbd
Page 80-160
Confidental

C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
d selection node ID
nodes selection
assembly group
brandNo LongList In case of limitation to brand List of Brand
numbers else null numbers
genericArticleId LongList In case of limitation to List of Generic
generic article numbers else article numbers
null
1: Brand name
Others tbd
ISO 639
ISO 3166
2.15.3 Get generic articles and brands by string list
Page 81-160
Confidental
XML Template:
GenericArticlesByManufacturer3StringListConfig.xml
Function:
getGenericArticlesByManufacturer3StringList()
Result:
Identical structure as function getGenericArticlesByManufacturer3() (see:2.15.2).
Request Parameter:
type
C: Vehicle
M: Motor
A: Axle
U: Universal
Other tbd
C: Vehicle ID
M: Motor ID
A: Axle ID
U: null
d selection node ID
nodes selection
assembly group
brandNo StringList In case of limitation to brand List of Brand
Page 82-160
Confidental

genericArticleId StringList In case of limitation to List of Generic
null
1: Brand name
Others tbd
ISO 639
ISO 3166
2.15.4 Get distinct generic articles and brands by list

Find generic articles by an assembly group with distinct result.
XML Template:
Function:
Result:
Request Parameter:
type
C: Vehicle
Page 83-160
Confidental

M: Motor
A: Axle
K: Body type
U: Universal
Other tbd
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
resultMode Integer 1:Distinct brand numbers Result mode
2:Distinct generic articles
3:Both (standard)
Null:Standard choose
(=Both)
d selection node ID
brandNo LongList In case of limitation to brand List of Brand
genericArticleId LongList In case of limitation to List of Generic
null
1: Brand name
Others tbd
ISO 639
ISO 3166
Page 84-160
Confidental
2.15.5 Get distinct generic articles and brands by string list

Find generic articles by an assembly group with distinct result.
XML Template:
GenericArticlesByManufacturer4StringListConfig.xml
Function:
getGenericArticlesByManufacturer4StringList()
Result:
Identical structure as function getGenericArticlesByManufacturer4() (see:2.15.4).
Request Parameter:
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Other tbd
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
resultMode Integer 1:Distinct brand numbers Result mode
2:Distinct generic articles
3:Both (standard)
Null:Standard choose
Page 85-160
Confidental

(=Both)
d selection node ID
brandNo StringList In case of limitation to brand List of Brand
genericArticleId StringList In case of limitation to List of Generic
null
1: Brand name
Others tbd
ISO 639
ISO 3166
2.16 Get articles (search tree)
2.16.1 Get articles by generic article (product group) (deprecated)

Find articles by generic article (product group) and assembly group.
XML Template:
ArticleIdsByGenericArticleConfig.xml
Function:
getArticleIdsByGenericArticle()
Result:
assemblyGroupNodeId Long Assembly group node
group node
Page 86-160
Confidental

articleLinkId Long Article link ID
sortNo Integer Sort number
Request Parameter:
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
assemblyGroupNo long Result of assembly group Search node ID
deId selection
childNodes boolean false:Standard Flag: child nodes
selection
assembly group
brandNo Integer In case of limitation to brand Brand number
Page 87-160
Confidental

number else null
genericArticleId long Generic article number Generic article
(product group) number
ISO 3166
2.16.2 Get articles by brand number (deprecated)

Find articles by brand number and assembly group.
XML Template:
ArticleIdsByPartManufacturerConfig.xml
Function:
getArticleIdsByPartManufacturer()
Result:
group node
genericArticleName String Generic article name
Request Parameter:
linkingTargetType string C: Vehicle Linking target
Page 88-160
Confidental

M: Motor type
A: Axle
K: Body type
U: Universal
Others tbd
linkingTargetId Long Linking target ID Linking target ID
according to the linking
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
assemblyGroupNodeId long Result of assembly group Assembly group
selection node ID
selection
true:show detail
information of all child
nodes of the assembly
group
brandNo integer Brand number Brand number
generic article number number
else null
to ISO 639
to ISO 3166
Page 89-160
Confidental
2.16.3 Get articles by brand number and generic article list (deprecated)
Find articles by brand number and generic article and assembly group.
XML Template:
ArticleIdsConfig.xml
Function:
getArticleIds()
Result:
group node
Request Parameter:
type
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
Page 90-160
Confidental

target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
selection node ID
selection
true:show detail
group
brandNo LongList In case of limitation to Brand number
Brand number else null
genericArticleId LongList In case of limitation to Generic article
else null
to ISO 639
to ISO 3166
Sort integer 1: Sort by brandNo Sorting field
2: sort by
genericArticleName
Page 91-160
Confidental
2.16.4 Get articles by brand number and generic article string list (deprecated)
XML Template:
ArticleIdsStringListConfig.xml
Function:
getArticleIdsStringList()
Result:
Identical structure as function getArticleIds() (see: 2.16.3).
Request Parameter:
type
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
selection node ID
selection
true:show detail
Page 92-160
Confidental

group
brandNo StringList In case of limitation to Brand number
genericArticleId StringList In case of limitation to Generic article
else null
to ISO 639
to ISO 3166
sort integer 1: Sort by brandNo Sorting field
2: sort by
genericArticleName
2.16.5 Get articles by brand number and generic article single (deprecated)
XML Template:
ArticleIdsSingleConfig.xml
Function:
getArticleIdsSingle()
Result:
Identical structure as function getArticleIds() (see:2.16.3).
Request Parameter:
type
M: Motor
A: Axle
K: Body type
Page 93-160
Confidental

U: Universal
Others tbd
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
selection node ID
selection
true:show detail
group
brandNo Integer In case of limitation to Brand number
else null
to ISO 639
to ISO 3166
2: sort by
genericArticleName
Page 94-160
Confidental
2.16.6 Get articles by brand number and generic article list

XML Template:
ArticleIds2Config.xml
Function:
getArticleIds2()
Result:
Request Parameter:
type
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
target type:
C: Vehicle ID
Page 95-160
Confidental

M: Motor ID
A: Axle ID
K: Body type ID
U: null
selection node ID
brandNo LongList In case of limitation to Brand number
genericArticleId LongList In case of limitation to Generic article
else null
to ISO 639
to ISO 3166
Sort integer 1: Sort by brandNo Sorting field
2: sort by
genericArticleName
2.16.7 Get articles by brand number and generic article string list
XML Template:
ArticleIds2StringListConfig.xml
Function:
getArticleIds2StringList()
Result:
Identical structure as function getArticleIds2() (see:2.16.6).
Page 96-160
Confidental
Request Parameter:
type
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
selection node ID
brandNo StringList In case of limitation to Brand number
genericArticleId StringList In case of limitation to Generic article
else null
to ISO 639
to ISO 3166
2: sort by
genericArticleName
Page 97-160
Confidental
2.16.8 Get articles by brand number and generic article single

XML Template:
ArticleIds2SingleConfig.xml
Function:
getArticleIds2Single()
Result:
Identical structure as function getArticleIds2() (see: 2.16.6).
Request Parameter:
type
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
U: null
selection node ID
brandNo Integer In case of limitation to Brand number
Page 98-160
Confidental

else null
to ISO 639
to ISO 3166
2: sort by
genericArticleName
2.16.9 Get article basic information (deprecated)

Find article basic information, which is assigned to an assembly group.
XML Template:
AssignedArticleByIdConfig.xml
Function:
getAssignedArticleById()
Result:
articleLinkId Long Article link Id
articleAddName String Article additional name
quantityPerPackingUnit Integer Quantiy per packing Unit
false
Page 99-160
Confidental

else false
hasSecurityInfo Boolean true if security information is
hasPartList Boolean true if part list is available else
false
else false
else false
else false
else false
else false
else false
Request Parameter:
articleLinkId long Result of article Article link ID
selection
articleId long Result of article Article ID
selection
linkingTargetTy string Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
U: Universal
Page 100-160
Confidental

according to linking
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
U: null
manuId Long Result of vehicle Manufacturer ID
if linking target type is:
Vehicle, Motor or Axle
else null
modId Long Result of vehicle model Model ID
selection if linking
targte type is: Vehicle,
Motor or Axle else null
[YYYYMMDD]
Null = current date
2.16.10 Get article basic information (new)

Find article basic information, which is assigned to an assembly group (with body
type info).
XML Template:
AssignedArticleById2Config.xml
Function:
getAssignedArticleById2()
Page 101-160
Confidental
Result:
articleLinkId Long Article link Id
articleAddName String Article additional name
quantityPerPackingUnit Integer Quantiy per packing Unit
false
else false
hasPartList Boolean true if part list is available else
false
else false
else false
else false
else false
else false
Page 102-160
Confidental

else false
Request Parameter:
Identical structure as function getAssignedArticleById() (see 2.16.9)
2.16.11 Get all article detail information by article list (deprecated)

Find all article detail information, which is assigned to an assembly group.
XML Template:
AssignedArticlesByIdsConfig.xml
Function:
getAssignedArticlesByIds()
Result:
Records Description
directArticle Not used
assignedArticle Article basic information (see:2.16.9)
immediateAttributs Article main attributes (see 2.18.1)
immediateInfo Article main info (see 2.18.2)
normalAustauschPrice Normal price (see 2.18.3)
eanNumber EAN number (see 2.19.1)
usageNumbers Trade numbers (see 2.19.2)
replacedNumber Replacement number (see 2.19.3)
replacedByNumber Replaced by numbers (see 2.19.3)
articleAttributes Article attributes (see 2.19.5)
articleInfo Article information (see 2.19.6)
mainArticle Main articles of part articles (see 2.19.7)
Page 103-160
Confidental
articleDocuments Documentdescription (see 2.20)

documentData Documentdata (see 2.23)
articlePrices Article catalog prices (see 2.24)
oenNumbers OE numbers (see 2.25)
Request Parameter:
articleIdPairs ArticleIdPairSeq Result of article List of article ID pairs
selection (articleId with max. 25 entries.
and articleLinkId) (see comment below)
linkingTargetTy String Linking target type: Linking target type
pe
C: Vehicle
M: Motor
A: Axle
U: Universal
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
U: null
manufacturer
target type is:
Vehicle, Motor or
Axle else null
modId Long Result of vehicle Model ID
model selection if
linking targte type
is: Vehicle, Motor
or Axle else null
[YYYYMMDD]
Page 104-160
Confidental

Null = current date
according to ISO
3166
according to ISO
639
uts immediate
attributes (see
2.18.1) else false
immediate info
(see 2.18.2) else
false
else false
number (see
2.19.1) else false
number (see
2.19.2) else false
replacedNumbe boolean If true, get Replacement number
rs replacement
number (see
2.19.3) else false
replacedByNum boolean If true, get Replaced by numbers
bers replaced by
numbers (see
2.19.3) else false
attributes (see
2.19.5) else false
information (see
2.19.6) else false
Page 105-160
Confidental

mainArticles boolean If true, get main Main articles of part
articles (see articles (see 2.19.7)
2.19.7) else false
documents (see
2.20) else false
documents data
(see 2.23) else
false
catalog prices (see
2.24) else false
numbers (see
2.25) else false
Comment:
ArticleIdPairSeq is a Sequence of ArticleIdPair, which has two fields:
articleId (long) and articleLinkId (long).
2.16.12 Get all article detail information by single article (deprecated)

Find all article detail information, which is assigned to an assembly group.
XML Template:
AssignedArticlesByIdsSingleConfig.xml
Function:
getAssignedArticlesByIdsSingle()
Result:
Page 106-160
Confidental
Identical Structure as function getAssignedArticlesByIds() (see 2.16.11)
Request Parameter:
articleId long Result of article Article ID
selection
articleLinkId long Result of article Articlelink ID
selection
linkingTargetTy String Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
U: Universal
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
U: null
manufacturer
target type is:
Vehicle, Motor or
Axle else null
modId Long Result of vehicle Model ID
model selection if
linking targte type
is: Vehicle, Motor
or Axle else null
[YYYYMMDD]
Null = current date
according to ISO
Page 107-160
Confidental

3166
according to ISO
639
uts immediate
attributes (see
2.18.1) else false
immediate info
(see 2.18.2) else
false
else false
number (see
2.19.1) else false
number (see
2.19.2) else false
replacedNumbe boolean If true, get Replacement number
rs replacement
number (see
2.19.3) else false
replacedByNum boolean If true, get Replaced by numbers
bers replaced by
numbers (see
2.19.3) else false
attributes (see
2.19.5) else false
information (see
2.19.6) else false
mainArticles boolean If true, get main Main articles of part
articles (see articles
2.19.7) else false
Page 108-160
Confidental

documents (see
2.20) else false
documents data
(see 2.23) else
false
catalog prices (see
2.24) else false
numbers (see
2.25) else false
2.16.13 Get all article detail information by article list (new)

Find all article detail information, which is assigned to an assembly group (with body
type info).
XML Template:
AssignedArticlesByIds2Config.xml
Function:
getAssignedArticlesByIds2()
Result:
Identical structure as function getAssignedArticlesByIds() (see: 2.16.11)
Exception: The result has a new basic record (see 2.16.10).
Request Parameter:
Identical structure as function getAssignedArticlesByIds() (see: 2.16.11)
Exception: There is a new linkingTarget type ‘K’ for body type info.
Page 109-160
Confidental
2.16.14 Get all article detail information by single article (new)

Find all article detail information, which is assigned to an assembly group (with body
type info).
XML Template:
AssignedArticlesByIds2SingleConfig.xml
Function:
getAssignedArticlesByIds2Single()
Result:
Identical structure as function getAssignedArticlesByIdsSingle() (see: 2.16.12)
Exception: The result has a new basic record (see 2.16.10).
Request Parameter:
Identical structure as function getAssignedArticlesByIdsSingle() (see: 2.16.12)
Exception: There is a new linkingTarget type ‘K’ for body type info.
2.17 Get articles by criteria

Find articles by criteria.
These functions are used to filter a list of articles.
There are two important restrictions:

1. Articles to be filtered must be assigned to a car, axle, motor or assembly
group. Articles found by a direct search can not be filtered.
2. Articles to be filtered must belong to the same generic article.
Use the following program flow to filter the articles:

1. Get all filter criteria with function getCritera2() and cache them. The ‘criteria
type’ specifies the filter function (see step 5). If ‘dutyFlag’ is set, more than one
attribute value of one criterion can be used to specify one article. In this case
each attribute value is chooseable and needs to get transfered into the filter
function. If the ‘dutyFlag’ is not set, there is only one attribute value choosable
and needs to get transfered into the filter function. In the case of no filtering
Page 110-160
Confidental
jump over to the next criterion. If ‘IsInterval’ equals true, the interval filter
getCriteriaFilterArticlesByValuesInterval() is usable with two criteria (upper and
lower value) to specify one article. The ‘SuccessorId’ is used in the filter
function (see step 5).
2. Get the ArticleIds (articleIds and articleLinkIds) by calling function
getArticleIds2() for exactly one generic article.
3. Get the possible filter criteria for the requested generic article as response of
getRequiredAttributes().
4. Get the filter values for the first (next) criterion and the first (next) article list
with function getCriteraAttributesByCriteriaArticles()
5. Filter the article list by the attribute values with the following functions:
A. Use function getCriteriaFilterArticlesByValues(), if the criterion is
alphanumeric (see step 1).
B. Use function getCriteriaFilterArticlesByValuesNumeric(), if the criterion
is numeric (see step 1).
C. You may use function getCriteriaFilterArticlesByValuesInterval(), if the
criterion is interval (see step 1).
6. Go further with step 4 until all filter criteria are used.
2.17.1 Get required Attributs (Criteria)

Find required criterias of a generic article.
XML Template:
RequiredAttributesConfig.xml
Function:
getRequiredAttributes()
Result:
criteriaId Long Criteria ID
dutyFlag Boolean Duty flag
Page 111-160
Confidental
Request Parameter:
genericArticleId long Result of generic article Generic article number
selection
2.17.2 Get attribute values of articles

Find attribute values of articles.
XML Template:
CriteriaAttributesByCriteriaArticlesConfig.xml
Function:
getCriteriaAttributesByCriteriaArticles()
Result:
criteriaId Long Criteria ID
attributeValue String Attribute value
Request Parameter:
criteriaId long Criteria ID Criteria ID
articleIds longLis Result of article List of article ID’s
t selection
articleLinkIds LongList Result of article List of articlelink ID’s
selection
Page 112-160
Confidental
2.17.3 Get attribute values of articles stringlist

Find attribute values of articles stringlist.
XML Template:
CriteriaAttributesByCriteriaArticlesStringListConfig.xml
Function:
getCriteriaAttributesByCriteriaArticlesStringList()
Result:
Identical structure as function getCriteriaAttributesByCriteriaArticles (see: 2.17.2)
Request Parameter:
articleIds stringLi Result of article List of article ID’s
st selection
articleLinkIds StringLi Result of article List of articlelink ID’s
st selection
2.17.4 Get articles filtered by attribute string values

Find articles by attribute values.
XML Template:
CriteriaFilterArticlesByValuesConfig.xml
Function:
getCriteriaFilterArticlesByValues()
Page 113-160
Confidental
Result:
articleLinkId Long Articlelink ID
Request Parameter:
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
t selection
selection
attributeValues stringLi List of attribute values List of attribute values
st
2.17.5 Get articles filtered by attribute string values stringlist

Find articles by attribute values stringlist.
XML Template:
CriteriaFilterArticlesByValuesStringListConfig.xml
Function:
Page 114-160
Confidental
getCriteriaFilterArticlesByValuesStringList()
Result:
Identical structure as function getCriteriaFilterArticlesByValues (see: 2.17.4)
Request Parameter:
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
st selection
st selection
st
2.17.6 Get articles filtered by attribute numeric values

Find articles by attribute numeric values.
XML Template:
CriteriaFilterArticlesByValuesNumericConfig.xml
Function:
getCriteriaFilterArticlesByValuesNumeric()
Page 115-160
Confidental
Result:
Request Parameter:
pe C: Vehicle
M: Motor
A: Axle
U: Universal
t selection
selection
st
2.17.7 Get articles filtered by attribute numeric values stringlist

Find articles by attribute numeric values stringlist.
XML Template:
CriteriaFilterArticlesByValuesNumericStringListConfig.xml
Function:
getCriteriaFilterArticlesByValuesNumericStringList()
Page 116-160
Confidental
Result:
Identical structure as function getCriteriaFilterArticlesByValuesNumeric()
(see:2.17.6).
Request Parameter:
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
st selection
st selection
st
2.17.8 Get articles filtered by attribute interval values

Find articles by attribute interval values.
XML Template:
CriteriaFilterArticlesByValuesIntervalConfig.xml
Function:
getCriteriaFilterArticlesByValuesInterval()
Page 117-160
Confidental
Result:
Request Parameter:
criteriaId Long Criteria ID Criteria ID
criteriaId2 Long Successor criteria ID Successor criteria ID
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
t selection
selection
value1 String Interval value 1 Interval value 1
flagDate boolea true:value is date Flag: Is Date
n false:value is not date
2.17.9 Get articles filtered by attribute interval values stringlist

Find articles by attribute interval values stringlist.
XML Template:
Page 118-160
Confidental
CriteriaFilterArticlesByValuesIntervalStringListConfig.xml
Function:
getCriteriaFilterArticlesByValuesIntervalStringList()
Result:
Identical structure as function getCriteriaFilterArticlesByValuesInterval() (see: 2.17.8 )
Request Parameter:
criteriaId Long Criteria ID Criteria ID
criteriaId2 Long Successor criteria ID Successor criteria ID
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
st selection
st selection
flagDate boolea true:value is date Flag: Is Date
n false:value is not date
Page 119-160
Confidental
2.18 Get article main information

Find article main information.
2.18.1 Get article main attributes

Find article main attributes.
XML Template:
ImmediateAttributsConfig.xml
Function:
getImmediateAttributs()
Result:
attrValueId Long Attribute value ID
attrId Long Attribute ID
attrValue String Attribute value
attrType String Attribute type:
A: Alphanumeric
N: Numeric
D: Date
K: Key
V: Without value
Others tbd
attrName String Attribute name
attrShortName String Attribute short name
attrUnit String Attribute unit
attrSuccessorId Long Successory ID
attrIsInterval Boolean Flag: Is Interval
Page 120-160
Confidental
Request Parameter:
articleLinkId Long In case of assembly group Article link ID
selection article link ID of
article selection else (article
direct search) null
ISO 3166
ISO 639
2.18.2 Get article main information

Find article main information.
XML Template:
ImmediateInfosConfig.xml
Function:
getImmediateInfos()
Result:
infoId Long Information ID
infoText String Information text
infoTypeId Integer Information type (KT 072)
infoTypeName String Information type name (KT 072)
Request Parameter:
Page 121-160
Confidental

selection article link ID of article
selection else (article direct
search) null
3166
ISO 639
2.18.3 Get article standard price

Find article standard price.
XML Template:
ArticlePricesNormalAustauschConfig.xml
Function:
getArticlePricesNormalAustausch()
Result:
price Integer Price with 2 decimal spaces
priceTypeId Integer Price type (KT 074)
priceTypeName String Price type name (KT 074)
currency String Currency
validDateFrom Integer From date valid [YYYYMMDD]
validDateTo Integer To date valid [YYYYMMDD]
priceUnitId Integer Price unit ID (KT 070)
priceUnitName String Price unit name (KT 070)
quantityUnitId String Quantity unit ID (KT 071, e.g.
Piece)
quantityUnitName String Quantity unit name (KT 071, e.g.
Piece)
hasLessDiscount Boolean true, if less discount available,
else false
Page 122-160
Confidental
Request Parameter:
Null = current date
3166
ISO 639
2.19 Get article information
2.19.1 Get article EAN number

Find article EAN number.
XML Template:
EanNumbersConfig.xml
Function:
getEanNumbers()
Result:
eanNumber String EAN number
Request Parameter:
3166
2.19.2 Get article trade number
Page 123-160
Confidental
Find article trade number.
XML Template:
UsageNumbersConfig.xml
Function:
getUsageNumbers()
Result:
usageNumber String Trade number
Request Parameter:
ISO 3166
2.19.3 Get article replacement number

First flavour: Find article and replacement number which replaces an article.
XML Template:
ReplacedNumbersConfig.xml
Function:
getReplacedNumbers()
Result:
replaceArticleId Long Replacement article ID
replaceNumber String Replacement article number
Page 124-160
Confidental
Request Parameter:
3166
Second flavour: Find articles and replacement number which are replaced by an
article.
XML Template:
ReplacedByNumbersConfig.xml
Function:
getReplacedByNumbers()
Result:
replaceArticleId Long Replacement article ID
replaceNumber String Replacement article number
Request Parameter:
3166
2.19.4 Get URL of extended article information
Page 125-160
Confidental
Find URL of extended article information.
XML Template:
ArticleExtUrlByIdConfig.xml
Function:
getArticleExtUrlById()
Result:
extInfoURL String URL of extended article
information
Request Parameter:
genericArticleId long Result of article selection Generic article ID
brandNo integer Brand number Brand number
3166
ISO 639
2.19.5 Get article attribute values

Find article attribute values.
XML Template:
AssignedArticleAttributsConfig.xml
Function:
getAssignedArticleAttributs()
Page 126-160
Confidental
Result:
attrValueId Long Attribute value ID
A: Alphanumeric
N: Numeric
D: Date
K: Key
V: Without value
Others tbd
Request Parameter:
articleLinkId Long If assembly group selection: Article link ID
article link ID of article
selection, if article direct search:
null
3166
ISO 639
2.19.6 Get article information
Page 127-160
Confidental
Find article information.
XML Template:
AssignedArticleInfosConfig.xml
Function:
getAssignedArticleInfos()
Result:
infoId Long Information ID
infoText String Information text
infoType Integer Information type (KT 072)
infoTypeName String Information type name (KT 072)
Request Parameter:
search) null
3166
ISO 639
2.19.7 Get main articles

Find main articles of a part article.
XML Template:
MainArticlesConfig.xml
Page 128-160
Confidental
Function:
getMainArticles()
Result:
articleNumber String Article number
Request Parameter:
partArticleId long Result of article selection Part article ID
3166
ISO 639
2.20 Get article documents

Find document descriptions to an article.
XML Template:
ArticleDocumentsConfig.xml
Function:
getArticleDocuments()
Result:
docId Long Document ID
docLinkId Long Document link ID
docTypeName String Document type name (KT 141)
Page 129-160
Confidental

docTypeId Integer Document type Id
docFileName String File name
docFileTypeName String File type name (e.g. Bitmap)
docText String Document description
Request Parameter:
search) null
docTypeId Integer Document type (KT 141) Document type
3166
ISO 639
2.21 Get article thumbnail documents

Find article thumbnail documents.
XML Template:
ThumbnailByArticleIdConfig.xml
Function:
getThumbnailByArticleId()
Result:
thumbDocId Long Document ID
thumbTypeId Integer Document type Id
Page 130-160
Confidental

thumbFileName String File name
Request Parameter:
2.22 Get article context sensitive document

Find context sensitive graphics of an article.
XML Template:
CsgDocumentsByArticleIdConfig.xml
Function:
getCsgDocumentsByArticleId()
Result:
csgId Long Context sensitive graphic ID
csgDocId Long Document ID
csgFileName String File name
Request Parameter:
3166
ISO 639
2.22.1 Get coordinates by article document

Find coordinates by article document. The coordinate system is starting with X=0,
Y=0 at the top left of the document.
Page 131-160
Confidental
XML Template:
CoordinatesByArticleDocumentConfig.xml
Function:
getCoordinatesByArticleDocument()
Result:
number Integer Coordinate number
subNumber Integer Coordinate sub number
Type Integer Coordinate type:
0=circle, 1=rectangle
x1Value Long X value of upper left corner or
center
y1Value Long Y value of upper left corner or
center
x2Value Long X value of lower right corner or
radius
y2Value Long Y value of lower right corner
partArticleLinkId Long Part article link ID
partArticleId Long Part article Id
Request Parameter:
csgId long Context sensitive graphic ID Context sensitive
graphic ID
Page 132-160
Confidental
2.22.2 Get article context sensitive document data (deprecated)

Find article context sensitive document data.
XML Template:
CsgDocumentDataByArticleIdConfig.xml
Function:
getCsgDocumentDataByArticleId()
Result:
Records Description
DocumentData Document data (see
2.23)
ArticePartList Article part list (see
2.29)
ContextGraphicCoordinates Coordinates for
context graphic (see
2.22.1)
Request Parameter:
articleLinkId Long Result of article selection Article link Id
linkingTargetType String Linking target type: Linking target type
C: Vehicle
M: Motor
A: Axle
U: Universal
C: Vehicle ID
M: Motor ID
A: Axle ID
Page 133-160
Confidental

U: null
articlePartList boolean If true, get article part list, else Flag: Article Part
false List
3166
ISO 639
2.22.3 Get article context sensitive document data (new)

Find article context sensitive document data (with body type info).
XML Template:
CsgDocumentDataByArticleId2Config.xml
Function:
getCsgDocumentDataByArticleId2()
Result:
Records Description
DocumentData Document data (see
2.23)
ArticePartList Article part list (see
2.29.1)
ContextGraphicCoordinates Coordinates for
context graphic (see
2.22.1)
Request Parameter:
Identical structure as function getCsgDocumentDataByArticleId() (see: 2.22.2)
Page 134-160
Confidental
2.23 Get article document data

Find document data.
XML Template:
ArticleDocumentsByDocIdConfig.xml
Function:
getArticleDocumentsByDocId()
Result:
docData Byte[] The binary representation of the
document.
docFileType String File type (MIME-Types: e.g.
application/pdf, image/gif,
image/jpeg)
docId Long Document ID
Request Parameter:
docId long Document ID Document ID
thumbFlag boolean Thumb Flag Thumb flag
2.24 Get article catalog prices

Find article catalog prices. This are the recommended prices by the manufacturer.
XML Template:
ArticlePricesConfig.xml
Function:
getArticlePrices()
Page 135-160
Confidental
Result:
price Integer Price
priceTypeId Integer Price type (KT 074)
priceTypeName String Price type name (KT 074)
currency String Currency
validDateFrom Integer From date valid [YYYYMMDD]
validDateTo Integer To date valid [YYYYMMDD]
priceUnitId Integer Price unit ID (KT 070)
priceUnitName String Price unit name (KT 070)
quantityUnitId String Quantity unit ID (KT 071, e.g.
Piece)
quantityUnitName String Quantity unit name (KT 071, e.g.
Piece)
discount String Discount
else false
Request Parameter:
Null = current date
3166
ISO 639
2.25 Get article OE numbers

Find article OE numbers.
XML Template:
Page 136-160
Confidental
ArticleOENumbersConfig.xml
Function:
getArticleOENumbers()
Result:
oeNumber String OE number
brandName String Manufacturer name
blockNumber Integer Block number
sortNumber Integer Sort number
Request Parameter:
3166
ISO 639
2.26 Get manufacturer addresses

Find manufacturer addresses.
XML Template:
ManufacturerInfosByIdConfig.xml
Function:
getManufacturerInfosById()
Result:
addressType Integer Address type (KT 059)
Page 137-160
Confidental

addressName String Address name
name String Name
name2 String Name2
street String Street
street2 String Street 2
mailbox String Mailbox
zipCountryCode String Country code for zip
zip String Zip
zipSpecial String Zip special
zipMailbox String Zip mailbox
city String City
city2 String City 2
phone String Phone
fax String Fax
email String Email
wwwURL String URL
logoDocId Long Document ID for logo
Request Parameter:
brandNo integer Result of brand selection Brand number
3166
ISO 639
2.27 Get linked vehicles, motors, axles of an article

Find vehicles, motors and axles which are linked to an article.
XML Template:
ArticleLinkedAllLinkingTargetSpecialConfig.xml
Page 138-160
Confidental
Function:
getArticleLinkedAllLinkingTarget()
Result:
linkingTargetType String Linking target type:
C: Vehicle
M: Motor
A: Axle
K: Body type
linkingTargetId Long Linking target ID according to
linking target type,
C: Vehicle ID
M: Motor ID
A: Axle ID
K: Body type ID
Request Parameter:
C: Vehicle
M: Motor
A: Axle
K: Body type
linkingTargetId Long Selection of linking target ID Linking target ID
according to the linking target
type, which is excluded
C: Vehicle ID
M: Motor ID
A: Axle ID
Page 139-160
Confidental

K: Body type ID
3166
ISO 639
2.27.1 Get linked vehicles, motors, axles of an article by manufacturer

Find vehicles, motors and axles of a manufacturer, which are linked to an article.
XML Template:
ArticleLinkedAllLinkingTarget2SpecialConfig.xml
Function:
getArticleLinkedAllLinkingTarget2()
Result:
Identical structure as function getArticleLinkedAllLinkingTarget () (see:2.27).
Request Parameter:
type
C: Vehicle
M: Motor
A: Axle
K: Body type
linkingTargetId Long Selection of linking target ID Linking target ID
target type, which is
excluded
C: Vehicle ID
M: Motor ID
Page 140-160
Confidental

A: Axle ID
K: Body type ID
linkingTargetManuId Long Selection of linking target Linking target
manufacturer ID according manufacturer ID
C: Vehicle manufacturer ID’s
M: Motor manufacturer ID’s
A: Axle manufacturer ID’s
K: Body type manufacturer
ID’s
ISO 3166
ISO 639
2.27.2 Get linked vehicle, motor, axle manufacturers of an article

Find vehicle, motor and axle manufacturers, which are linked to an article.
XML Template:
ArticleLinkedAllLinkingTargetManufacturerSpecialConfig.xml
Function:
getArticleLinkedAllLinkingTargetManufacturer()
Result:
manuName String Manufacturer short name
manuId Integer Manufacturer ID
Request Parameter:
Page 141-160
Confidental

C: Vehicle
M: Motor
A: Axle
K: Body type
3166
2.27.3 Get article main attributes of a linked article

Find article main attributes of a linked article.
XML Template:
ImmediateAttributsLinkedElementsConfig.xml
Function:
getImmediateAttributsLinkedElements()
Result:
A: Alphanumeric
N: Numeric
D: Date
K: Key
V: Without value
Others tbd
Page 142-160
Confidental

Request Parameter:
articleLinkId long Result of article selection Article ID
3166
ISO 639
2.27.4 Get linked axle details

Find linked axle details of an article.
See basic function: 2.12.6 Get Axle detail
2.27.5 Get linked motor details

Find linked motor details of an article.
XML Template:
ArticleLinkedMotorsByIdConfig.xml
Function:
getArticleLinkedMotorsById()
Result:
manuDesc String Manufacturer name
powerKw Integer Power / KW
Page 143-160
Confidental

powerHp Integer From power / HP
cylinder Integer Cylinder
assembledFrom String From assembled date
assembledTo String To assembled date
Request Parameter:
ISO 639
ISO 3166
2.27.6 Get linked vehicle details

Find linked vehicle details of an article.
XML Template:
ArticleLinkedVehiclesByIdConfig.xml
Function:
getArticleLinkedVehiclesById()
Result:
carDesc String Vehicle name
manuDesc String Manufacturer name
Page 144-160
Confidental

modelDesc String Model name
axisConfiguration String Axis configuration name
constructionType String Construction type name
yearOfConstructionFrom Integer From construction year
[YYYYMM]
yearOfConstructionTo Integer To construction year
[YYYYMM]
powerKwTo Integer To Power / KW
powerHpFrom Integer From Power / HP
powerHpTo Integer To Power / HP
tonnage Integer Tonnage / T
assembledFrom String From assembled date
assembledTo String To assembled date
Request Parameter:
ISO 639
ISO 3166
2.27.7 Get linked vehicle, motor, axle details of an article and a list of linking
targets (deprecated)
Find linked vehicle, motor, axle details of an article and a list of linking targets.
XML Template:
ArticleLinkedAllLinkingTargetsByIdsSpecialConfig.xml
Page 145-160
Confidental
Function:
getArticleLinkedAllLinkingTargetsByIds()
Result:
Records Description
linkedArticleImmediateAttributs Main attributes of the linked article
(see 2.27.3)
linkedAxles Linked axles (see 2.27.4)
linkedMotors Linked motors (see 2.27.5)
linkedVehicles Linked vehicles (see 2.27.6)
articleLinkId (long) Article link ID
linkingTargetId (long) Linking target ID
Request Parameter:
C: Vehicle
M: Motor
A: Axles
linkedArticlePairs LinkedArticle Result of linked article List of linked
PairSeq selection (see 2.27) article
to ISO 3166
Comment:
LinkedArticlePairSeq is a Sequence of LinkedArticlePair, which has two fields:
linkingTargetId (long) and articleLinkId (long).
Page 146-160
Confidental
2.27.8 Get linked vehicle, motor, axle details of an article and a list of linking
targets (new)
Find linked vehicle, motor, axle, body type details of an article and a list of linking
targets (with body type info).
XML Template:
ArticleLinkedAllLinkingTargetsByIds2SpecialConfig.xml
Function:
getArticleLinkedAllLinkingTargetsByIds2()
Result:
Records Description
linkedArticleImmediateAttributs Main attributes of the linked article
(see 2.27.3)
linkedAxles Linked axles (see 2.27.4)
linkedMotors Linked motors (see 2.27.5)
linkedVehicles Linked vehicles (see 2.27.6)
linkedMarks Linked body types (see 2.10.3)
articleLinkId (long) Article link ID
linkingTargetId (long) Linking target ID
Request Parameter:
C: Vehicle
M: Motor
A: Axles
K: Body type
linkedArticlePairs LinkedArticle Result of linked article List of linked
PairSeq selection (see 2.27) article
Page 147-160
Confidental

to ISO 3166
immediateAttribut boolean If true, select immediate Select immediate
s attributes, else false attributs
Comment:
LinkedArticlePairSeq is a Sequence of LinkedArticlePair, which has two fields:
linkingTargetId (long) and articleLinkId (long).
2.28 Get article accessory list

Find accessory list.
2.28.1 Get article accessory list (deprecated)

Find accessory list of an article.
XML Template:
ArticleAccessoryListConfig.xml
Function:
getArticleAccessoryList()
Result:
accessoryLinkId Long Accessory link ID
articleListNo Integer Article list number
accessoryArticleId Long Accessory article ID
accessoryArticleName String Accessory article name
Page 148-160
Confidental

quantity Integer Quantity
false
hasDocuments Boolean true if documents are
else false
hasPartList Boolean true if a part list is available
else false
hasOEN Boolean true if OE numbers are
hasVehicleLink Boolean true if vehicle links are
else false
else false
Request Parameter:
articleLinkId Long Result of article selection Article link ID
Page 149-160
Confidental

C: Vehicle
M: Motor
A: Axle
U: Universal
linking target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
U: null
manuId Long Result of vehicle manufacturer Manufacturer ID
selection if linking target type
is: Vehicle, Motor or Axle else
null
modId Long Result of vehicle model Model ID
selection if linking targte type
is: Vehicle, Motor or Axle else
null
Null = current date
Country string Country code according to ISO Country
3166
ISO 639
2.28.2 Get article accessory list (new)

Find accessory list of an article (with body type info).
XML Template:
ArticleAccessoryList3Config.xml
Function:
getArticleAccessoryList3()
Page 150-160
Confidental
Result:
accessoryLinkId Long Accessory link ID
articleListNo Integer Article list number
accessoryArticleId Long Accessory article ID
accessoryArticleName String Accessory article name
false
hasDocuments Boolean true if documents are
else false
hasPartList Boolean true if a part list is available
else false
hasOEN Boolean true if OE numbers are
hasVehicleLink Boolean true if vehicle links are
else false
Page 151-160
Confidental

else false
Request Parameter:
Identical structure as function getArticleAccessoryList2() (see 2.28.1)
Exception: There is a new linkingTargetType ‘K’ for body type info
2.28.3 Get article accessory list with attributes (deprecated)

Find accessory list of an article with attributs.
XML Template:
Function:
Result:
Records Description
AccessoryDetails Accessory Details (see: 2.28.1)
AccessoryAttributs Accessory Attributs (see:2.28.6)
Request Parameter:
Identical structure as function getArticleAccessoryList() (see: 2.28.1).
2.28.4 Get article accessory list with attributes (new)

Find accessory list of an article with attributes (with body type info).
XML Template:
Page 152-160
Confidental
Function:
Result:
Records Description
AccessoryDetails Accessory Details (see: 2.28.2)
AccessoryAttributs Accessory Attributs (see:2.28.6)
Request Parameter:
Identical structure as function getArticleAccessoryList3() (see: 2.28.2).
2.28.5 Get article accessory list existing information

Find information, if accessory list of an article exists.
XML Template:
ArticleHasAccessoryListConfig.xml
Function:
getArticleHasAccessoryList()
Result:
articleAccessoryId Long Article accessory ID
Page 153-160
Confidental
Request Parameter:
universalFlag boolean true if universal article else Flag: universal
false article selection
manuId Long Result of manufacturer Manufacturer ID
selection if not an universal
article
modelId Long Result of model selection if Model ID
not an universal article
carId Long Result of vehicle selection if Vehicle ID
motorId Long Result of motor slection if Motor ID
ISO 3166
2.28.6 Get article main attribute of an accessory article

Find article main attributes of an accessory article.
XML Template:
ArticleAccessoryImmediateAttributsConfig.xml
Function:
getArticleAccessoryImmediateAttributs()
Result:
isAccessoryAttr Boolean true if accessory attribute
else false
A: Alphanumeric
N: Numeric
Page 154-160
Confidental

D: Date
K: Key
V: Without value
Others tbd
Request Parameter:
articleAccessoryId long Result of article accessory Article accessory
selection ID
ISO 639
ISO 3166
2.29 Get article part list (deprecated)

Find part list of an article.
XML Template:
ArticlePartListConfig.xml
Function:
getArticlePartList()
Page 155-160
Confidental
Result:
partId Long Part article link ID
partArticleId Long Part article ID
genericArticleName String Generic article number
packingUnit Integer Packing unit
false
else false
false
else false
else false
else false
else false
Page 156-160
Confidental
Request Parameter:
carId Long Result of car selection Car ID
axleID Long Result of axle selection Axle ID
motorId Long Result of motor selection Motor ID
Null = current date
3166
lang String Language code according to Language
ISO 639
2.29.1 Get article part list (new)

Find part list of an article (with body type info).
XML Template:
ArticlePartList2Config.xml
Function:
getArticlePartList2()
Result:
partId Long Part article link ID
partArticleId Long Part article ID
Page 157-160
Confidental

genericArticleName String Generic article number
packingUnit Integer Packing unit
false
else false
false
else false
else false
else false
else false
Request Parameter:
carId Long Result of car selection Car ID
Page 158-160
Confidental

axleId Long Result of axle selection Axle ID
motorId Long Result of motor selection Motor ID
markId Long Result of body type selection Body type ID
Null = current date
3166
ISO 639
2.30 Version info

Get version info about the currently running service.
Function:
getPegasusVersionInfo()
Result:
major integer Incremented at major changes which are not
expected to be compatible to a previous
version.
minor integer Incremented at minor changes or
enhancements and expected to be
compatible to a previous version.
build integer Number incremented at each build.
revision integer Distinguishes otherwise identically builds.
date String Timestamp of current build.
Page 159-160
Confidental
Request Parameter:
2.31 Add dynamic address

Permit access to the webservice to the specified address for a limited time. This
function is allowed to be called only from existant static addresses.
Function:
addDynamicAddress()
Result:
validityHours integer Calculated time/hours the access is granted
to the given address. Might be a large
positive number if access to an existant
static address is requested.
Request Parameter:
address string aaa.bbb.ccc.ddd Address like 127.0.0.1
validityHours integer 1 … 24 Time to permit access
counted in hours.
Adjusted automatically if
not in range.
Page 160-160

Catalog Webservice: Interface Definition

Caricato da

Informazioni sul documento

Descrizione originale:

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Catalog Webservice: Interface Definition

Caricato da

Copyright:

Formati disponibili

Catalog Webservice V1.

Prologue A : History of changes

Version Date Author Comment

Version: Version of the software

Prologue B : Abbreviations and terms

2.9.9 Get fuel types ..........................................................................................34

2.14.1 Get articles ..............................................................................................64

2.17.3 Get attribute values of articles stringlist ............................................113

2.27.5 Get linked motor details.......................................................................143

1.1 Request Parameter

1.3 Access Control

1.4 Linkage to other databases

1.5 Known compatibility problems

2 Standard request functions

2.1 Get key table values

2.2 Get TecDoc country groups

2.3 Get criteria (deprecated)

2.3.1 Get criteria (new)

2.4 Get brands

2.5 Get vehicle manufacturer (simplified or standard)

Name Type States Description

2.6 Get vehicle models (simplified or standard selection)

2.7 Get vehicle by ID Code system (deprecated)

carName String Vehicle name

2.8 Get vehicle by ID Code system

2.9 Get vehicle

2.9.1 Get vehicle (simplified selection)

firstCountry String First country code (according

Name Type States Description

2.9.2 Get vehicle (simplified selection) with motor codes

2.9.2.1 Get motor code

2.9.3 Get vehicle by model ID (advanced selection)

Name Type States Description

2.9.4 Get vehicle details by model ID (advanced selection)

vehicle Vehicle info (see

2.9.5 Get vehicle by model description (advanced selection)

Name Type States Description

2.9.6 Get vehicle by motor ID

2.9.7 Get construction types

2.9.8 Get axis configurations

2.9.9 Get fuel types

2.9.10 Get vehicle details (construction year, power, capacity …)

Column Type Description

2.9.11 Get vehicle details (terms)

Column Type Description

2.9.12 Get vehicle details (Passenger car details)

Column Type Description

2.9.13 Get all vehicle details by a list

2.9.14 Get all vehicle details by a list of string id’s

Name Type States Description

2.10 Get body types

2.10.1 Get body types by body type ID

2.10.2 Get vehicles by body type ID

term String Short vehicle description

2.10.3 Get body type by ID

manuName String Name of vehicle

2.10.4 Get vehicle ID’s by body type

Name Type States Description

2.11 Get motors

Name Type States Description

2.11.1 Get motor manufacturers

Name Type States Description