Académique Documents
Professionnel Documents
Culture Documents
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
Interface Definition Apr 2008
Confidental
Term Description
URL Uniform Resource Locator
SOAP Simple Object Access Protocol
WSDL Web Service Description Language
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page II
Catalog Webservice V1.3
Interface Definition Apr 2008
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 3-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 4-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 5-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 6-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 7-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Table of Functions
—A—
addDynamicAddress ...............................................................................................161
—G—
getArticleAccessoryImmediateAttributs ...................................................................155
getArticleAccessoryList............................................................................................149
getArticleAccessoryList2..........................................................................................153
getArticleAccessoryList3..........................................................................................151
getArticleAccessoryList4..........................................................................................154
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 8-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 9-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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
getGenericArticlesByManufacturer3 ......................................................................... 81
getGenericArticlesByManufacturer3StringList .......................................................... 83
getGenericArticlesByManufacturer4 ......................................................................... 84
getGenericArticlesByManufacturer4StringList .......................................................... 86
getImmediateAttributs..............................................................................................121
getImmediateAttributsLinkedElements ....................................................................143
getImmediateInfos ...................................................................................................122
getKeyValuesForTradersMode................................................................................. 15
getLinkedChildNodesAllLinkingTarget ...................................................................... 63
getLinkedChildNodesAllLinkingTargetShortCut ........................................................ 61
getLinkedShortCuts .................................................................................................. 59
getMainArticles ........................................................................................................130
getManufacturerInfosById .......................................................................................138
getMarkById ............................................................................................................. 43
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 10-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 11-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 12-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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.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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 13-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 14-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 15-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
CountryGroupsConfig.xml
Function:
getCountryGroups()
Result:
Column Type Description
tecdocCode String TecDoc code
countryName String Country name
Request Parameter:
Name Type States Description
lang string Language code according Language
to ISO 639
Comment:
The result could get cached per language.
XML Template:
CriteriaConfig.xml
Function:
getCriteria()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 16-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
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:
Name Type States Description
lang string Language code according Language
to ISO 639
Comment:
The result could get cached per language.
XML Template:
Criteria2Config.xml
Function:
getCriteria2()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 17-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
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:
The result could get cached per language.
XML Template:
BrandsForAssortmentConfig.xml
Function:
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 18-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
getBrandsForAssortment ()
Result:
Column Type Description
brandNo Integer Brand no
brandName String Brand name
Request Parameter:
Name Type States Description
XML Template:
VehicleManufacturers2Config.xml
Function:
getVehicleManufacturers2()
Result:
Column Type Description
manuId Long Manufacturer ID
manuName String Manufacturer name
Request Parameter:
Name Type States Description
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 19-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Comment:
The result may get cached.
XML Template:
VehicleModels2Config.xml
Function:
getVehicleModels2()
Result:
Column Type Description
modelId Long Model ID
modelname String Model name
yearOfConstrFrom Integer From construction year
[YYYYMM]
yearOfConstrTo Integer To construction year
[YYYYMM]
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 20-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
manuId long Result of vehicle Manufacturer ID
manufacturer selection
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
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
XML Template:
VehicleIdsByKeyNumberPlates2Config.xml
Function:
getVehicleIdsByKeyNumberPlates2()
Result:
Column Type Description
carId Long Vehicle ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 21-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
selection else false selection
countriesCarSelect string Country code according to Country for vehicle
ion ISO 3166 or TecDoc selection
country group code
XML Template:
VehicleIdsByKeyNumberPlates3Config.xml
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 22-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getVehicleIdsByKeyNumberPlates3()
Result:
Column Type Description
carId Long Vehicle ID
manuId Long Manufacturer ID
modelId Long Model ID
carName String Vehicle name
firstCountry String First country code (according
to ISO 3166)
Request Parameter:
Identical structure as function getVehicleIdsByKeyNumberPlates2 () (see:2.7).
XML Template:
VehicleSimplifiedSelection2Config.xml
Function:
getVehicleSimplifiedSelection2()
Result:
Column Type Description
carId Long Vehicle ID
carName String Vehicle name
linked Integer Number of article
assignments
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 23-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
linked boolean false: all, true: only Flag: selection with /
linked articles without article
assignments
lang string Language code Language
according to ISO 639
countryUserSetting String If model selection with Country for article
article assignments: assignments
country code according
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 24-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 25-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
linked boolean false: all, true: only Flag: selection with /
linked articles without article
assignments
lang string Language code Language
according to ISO 639
countryUserSetting String If model 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
selection else false selection
countriesCarSelectio string Country code according Country for Vehicle
n to ISO 3166 or TecDoc selection
country group code
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 26-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
MotorCodesByCarIdConfig.xml
Function:
getMotorCodesByCarId()
Result:
Column Type Description
motorCode String Motor code
Request Parameter:
Name Type States Description
carId long Result of vehicle Vehicle ID
selection
countryGroupFlag boolean true, if country group Flag: country
selection else false group selection
countriesCarSelection string Country code according Country of vehicle
to ISO 3166 or TecDoc selection
country group code
XML Template:
VehicleIdsByCarTypeManuIdModelIdCriteria2Config.xml
Function:
getVehicleIdsByCarTypeManuIdModelIdCriteria2()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 27-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
carId Long Vehicle ID
carName String Vehicle name
firstCountry String First country code (according
to ISO 3166)
Request Parameter:
Name Type States Description
manuId long Result of vehicle Manufacturer ID
manufacturer selection
modId long Result of vehicle model Model ID
selection
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
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
lang string Language code according Language
to ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 28-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
VehiclesByCarTypeManuIdModelIdCriteria2Config.xml
Function:
getVehiclesByCarTypeManuIdModelIdCriteria2()
Result:
Records Description
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 29-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
manuId long Result of vehicle Manufacturer ID
manufacturer selection
modId long Result of vehicle model Model ID
selection
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
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
lang string Language code according Language
to ISO 639
countryGroupFlag boolean true, if country group Flag: country
selection, else false group selection
countriesCarSelectio string Country code according to Country of vehicle
n ISO 3166 or TecDoc selection
country group code
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 30-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
VehicleIdsByCarTypeManuIdTermConfig.xml
Function:
getVehicleIdsByCarTypeManuIdTerm()
Result:
Column Type Description
carId Long Vehicle ID
carName String Vehicle name
firstCountry String First country code (according
to ISO 3166)
Request Parameter:
Name Type States Description
manuId long Result of vehicle Manufacturer ID
manufacturer selection
modelDescription String Result of vehicle model Model description
selection
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 31-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
VehicleIdsByMotorConfig.xml
Function:
getVehicleIdsByMotor()
Result:
Column Type Description
carId Long Vehicle ID
carName String Vehicle name
firstCountry String First country code (according
to ISO 3166)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 32-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
motorId long Result of motor selection Motor ID
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
lang string Language code according Language
to ISO 639
countryGroupFlag boolean true, if country group Flag: country
selection, else false group selection
countriesCarSelectio string Country code according to Country of vehicle
n ISO 3166 or TecDoc selection
country group code
XML Template:
ConstructionTypesConfig.xml
Function:
getConstructionTypes()
Result:
Column Type Description
constrTypeID Long Construction type ID
constrTypeName String Construction type name
Request Parameter:
Name Type States Description
lang string Language code according Language
to ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 33-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Comment:
The result may get cached per language.
XML Template:
AxisConfigurationsConfig.xml
Function:
getAxisConfigurations()
Result:
Column Type Description
axisConfigID Long Axis configuration ID
axisConfigName String Axis configuration name
Request Parameter:
Name Type States Description
lang string Language code according Language
to ISO 639
Comment:
The result may get cached per language.
XML Template:
FuelTypesConfig.xml
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 34-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getFuelTypes()
Result:
Column Type Description
fuelTypeID Long Fuel type ID
fuelTypeName String Fuel type name
Request Parameter:
Name Type States Description
Lang string Language code according Language
to ISO 639
Comment:
The result may get cached per language.
XML Template:
VehicleByIdConfig.xml
Function:
getVehicleById()
Result:
Column Type Description
carId Long Vehicle ID
axisConfiguration String Axis configuration name
constructionType String Construction type name
yearOfConstrFrom Integer From construction year
[YYYYMM]
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 35-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
XML Template:
VehicleByIdWithTermConfig.xml
Function:
getVehicleByIdWithTerm()
Result:
Column Type Description
carId Long Vehicle ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 36-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
carId long Result of vehicle selection Vehicle ID
lang string Language code according to Language
ISO 639
country string Country code according to Country
ISO 3166
countryUserSetting string Country code according to Country of article
ISO 3166 assignments
XML Template:
PassengerCarDetailsConfig.xml
Function:
getPassengerCarDetails()
Result:
Column Type Description
manuName String Manufacturer
modelName String Model name
typeName String Type name
constructionType String Construction type
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 37-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
carId long Result of vehicle selection Vehicle ID
lang string Language code according to Language
ISO 639
country string Country code according to Country
ISO 3166
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 38-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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:
Name Type States Description
carIds longList Result of vehicle selection List of Vehicle ID’s
(max 25)
Lang string Language code according to Language
ISO 639
Country string Country code according to Country
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 39-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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:
Name Type States Description
carIds stringList Result of vehicle selection List of Vehicle ID’s
(max 25)
lang string Language code according to Language
ISO 639
country string Country code according to Country
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 40-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
VendorIdsConfig.xml
Function:
getVendorIds()
Result:
Column Type Description
vendorName String Body type name
manuName String Manufacturer name
manuId Long Manufacturer ID
markId Long Body type ID
linkedCars Integer Count of car assignments
linkedArticles Integer Count of article assignments
direct to the body type
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 41-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
lang string Language code Language
according to ISO 639
countryUserSetting string Country code according Country for article
to ISO 3166 assignments
countryGroupFlag boolean true, if country group Flag: country group
selection else false selection
countriesCarSelectio string Country code according Country for Vehicle
n to ISO 3166 or TecDoc selection
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
XML Template:
VehicleIdsByVendorIdConfig.xml
Function:
getVehicleIdsByVendorId()
Result:
Column Type Description
carId Long Car ID
firstCountry String First country code (according
to ISO 3166)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 42-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
manuId long Manufacturer ID Id of the vehicle
manufacturer like ‘55’
for ‘IVECO’
vendorName string Vendor name Body type name like
‚E3MPC1A1’
countryGroupFlag boolean true, if country group Flag: country group
selection else false selection
countriesCarSelectio string Country code according Country for Vehicle
n to ISO 3166 or TecDoc selection
country group code
lang string Language code Language
according to ISO 639
XML Template:
MarkByIdConfig.xml
Function:
getMarkById()
Result:
Column Type Description
markId Long Body type ID
markName String Body type name
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 43-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
markId long Body type ID Body type ID
linked boolean false: all, true: only Flag: selection with /
linked articles without article
assignments
lang string Language nach ISO 639 Language
country string Country code according Country
to ISO 3166
XML Template:
VehicleIdsByMarkConfig.xml
Function:
getVehicleIdsByMark()
Result:
Column Type Description
carId Long Vehicle Id
term String Short vehicle description
Request Parameter:
Name Type States Description
markId long Body type ID Body type ID
lang string Language code Language
according to ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 44-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
MotorIdsByManuIdCriteriaConfig.xml
Function:
getMotorIdsByManuIdCriteria()
Result:
Column Type Description
motorId Long Motor ID
Request Parameter:
Name Type States Description
manuId long Result of motor Manufacturer ID
manufacturer selection
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
yearOfConstruction Integer Construction year [YYYY] Construction year
fuelTypeId Long Result of fuel type Fuel type ID
selection
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 45-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
MotorManufacturers2Config.xml
Function:
getMotorManufacturers2()
Result:
Column Type Description
manuId Long Manufacturer ID
manuName String Manufacturer name
Request Parameter:
Name Type States Description
lang string Language code according to ISO Language
639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 46-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
MotorByIdConfig.xml
Function:
getMotorById()
Result:
Column Type Description
motorId Long Motor ID
manuId Long Motor manufacturer ID
manuText String Manufacturer name
cylinderCapacity Integer Capacity / ccm
cylinder Integer Number of cylinder
powerKW Integer Power / KW
powerHP Integer Power / HP
sellsTerm String Sales description
motorCode String Motor code
Request Parameter:
Name Type States Description
motorId long Result of motor selection Motor ID
Lang string Language nach ISO 639 Language
Country string Country code according to Country
ISO 3166
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 47-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
MotorByIdsConfig.xml
Function:
getMotorByIds()
Result:
Records Description
MotorDetails Motor Details (see 2.11.2)
Request Parameter:
Name Type States Description
motorIds longList Result of motor selection Motor ID’s (max
25)
lang string Language nach ISO 639 Language
country string Country code according to Country
ISO 3166
XML Template:
MotorByIdsStringListConfig.xml
Function:
getMotorByIdsStringList()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 48-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Records Description
MotorDetails Motor Details (see 2.11.2)
Request Parameter:
Name Type States Description
motorIds stringLis Result of motor selection Motor ID’s (max
t 25)
lang string Language nach ISO 639 Language
country string Country code according to Country
ISO 3166
XML Template:
MotorsByCarTypeManuIdTermConfig.xml
Function:
getMotorsByCarTypeManuIdTerm()
Result:
Column Type Description
motorId Long Motor ID
manuId Long Motor manufacturer ID
manuText String Manufacturer name
cylinderCapacity Integer Capacity / ccm
cylinder Integer Number of cylinder
powerKW Integer Power / KW
powerHP Integer Power / HP
sellsTerm String Sales description
motorCode String Motor code
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 49-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
manuId long Result of vehicle Manufacturer ID
manufacturer selection
carType integer Vehicle type: Vehicle type
1: Passenger car
2: Commercial vehicle
3: Both
motorCode String Motor code Motor code like
‚AEL’
lang string Language nach ISO 639 Language
countryGroupFlag boolean true, if country group Flag: country
selection else false group selection
countriesCarSelectio string Country code according to Country for Vehicle
n ISO 3166 or TecDoc selection
country group code
XML Template:
AxleIdByTypeManCriteria2Config.xml
Function:
getAxleIdByTypeManCriteria2()
Result:
Column Type Description
axleId Long Axle ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 50-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
yearOfConstruction Integer Construction year [YYYY] Construction year
lang string Language code according to Language
ISO 639
XML Template:
AxlesManufacturers2Config.xml
Function:
getAxlesManufacturers2()
Result:
Column Type Description
manuId Long Manufacturer ID
manuName String Manufacturer name
Request Parameter:
Name Type States Description
Lang String Language code according to ISO Language
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 51-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Comment:
The result could get cached per language.
XML Template:
AxleModelsConfig.xml
Function:
getAxleModels()
Result:
Column Type Description
modelId Long Modell ID
modelName String Model name
yearOfConstrFrom Integer From construction year
[YYYYMM]
yearOfConstrTo Integer To construction year
[YYYYMM]
Request Parameter:
Name Type States Description
manuId long Result of axle manufacturer Manufacturer ID
selection
Lang string Language code according to ISO Language
639
country string Country code according to ISO Country
3166
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 52-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
AxleBrakeSizesConfig.xml
Function:
getAxleBrakeSizes()
Result:
Column Type Description
brakeSizeId Long Brake size ID
brakeSize String Brake size
brakeSizeName String Brake size name
Request Parameter:
Name Type States Description
Lang string Language code according to ISO Language
639
Comment:
The result may get cached per language.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 53-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
AxleTypesConfig.xml
Function:
getAxleTypes()
Result:
Column Type Description
axleTypeId Long Axle type ID
axleTypeName String Axle type name
Request Parameter:
Name Type States Description
lang string Language code according to ISO Language
639
Comment:
The result could get cached per language.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 54-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
AxleStylesConfig.xml
Function:
getAxleStyles()
Result:
Column Type Description
axleStyleId Long Axle style ID
axleStyleName String Axle style name
Request Parameter:
Name Type States Description
lang string Language code according to ISO Language
639
Comment:
The result could get cached per language.
XML Template:
AxleByIdConfig.xml
Function:
getAxleById()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 55-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
axleId Long Axle ID
axleDescription String Axle description
manuId Long Manufacturer ID
manuName String Manufacturer name
manuShortName String Manufacturer short name
modelId Long Axle model ID
modelName String Model name
axleTypeId Long Axle type ID
yearOfConstrFrom Integer From construction year
[YYYYMM]
yearOfConstrTo Integer To construction year
[YYYYMM]
axleLoadFrom Integer From axle load/kg
axleLoadUpto Integer To axle load/kg
Request Parameter:
Name Type States Description
axleId long Result of axle selection Axle ID
lang string Language code according to ISO Language
639
country string Country code according to ISO Country
3166
XML Template:
AxleByIdsConfig.xml
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 56-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getAxleByIds()
Result:
Records Description
AxleDetails AxleDetails (see 2.12.6)
Request Parameter:
Name Type States Description
axleIds longList Result of axle selection Axle ID (max 25)
lang string Language code according to ISO Language
639
country string Country code according to ISO Country
3166
XML Template:
AxleByIdsStringListConfig.xml
Function:
getAxleByIdsStringList()
Result:
Records Description
AxleDetails AxleDetails (see 2.12.6)
Request Parameter:
Name Type States Description
axleIds stringList Result of axle selection Axle ID's (max 25)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 57-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ShortCuts2Config.xml
Function:
getShortCuts2()
Result:
Column Type Description
shortCutId Long Shortcut ID
shortCutName String Shortcut name
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target type
C: Vehicle
M: Motor
A: Axles
K: Body Type
U: Universal
lang string Language code according to Language
ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 58-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
LinkedShortCutsConfig.xml
Function:
getLinkedShortCuts()
Result:
Identical structure as function getShortCuts2() (see 2.13.1)
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target type
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
lang string Language code according to Language
ISO 639
country string Country code according to ISO Country for article
3166 assignments
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 59-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Find vehicle, motor, axle or universal assembly groups by a shortcut for the search
tree.
XML Template:
ChildNodesAllLinkingTargetShortCut2SpecialConfig.xml
Function:
getChildNodesAllLinkingTargetShortCut2()
Result:
Column Type Description
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:
Name Type States Description
linkingTargetType string Linking target type: Linking target type
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
lang string Language code according to Language
ISO 639
childNodes boolean true, if child nodes of Flag: child nodes
assembly group should be selection
selected too else false
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 60-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
LinkedChildNodesAllLinkingTargetShortCutSpecialConfig.xml
Function:
getLinkedChildNodesAllLinkingTargetShortCut()
Result:
Identical structure as function getChildNodesAllLinkingTargetShortCut() (see 2.13.3)
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target type
C: Vehicle
M: Motor
A: Axle
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
parentNodeId Long Parent node ID or null, if root Parent node ID
node
shortCutId long Result of shortcut selection Shortcut ID
lang string Language code according to Language
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 61-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ChildNodesAllLinkingTarget2SpecialConfig.xml
Function:
getChildNodesAllLinkingTarget2()
Result:
Column Type Description
assemblyGroupNodeId Long Assembly group node ID
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:
Name Type States Description
linkingTargetType string Linking target type: Linking target type
C: Vehicle
M: Motor
A: Axle
K: Body Type
U: Universal
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 62-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
LinkedChildNodesAllLinkingTargetSpecialConfig.xml
Function:
getLinkedChildNodesAllLinkingTarget()
Result:
Identical structure as function getChildNodesAllLinkingTarget() (see 2.13.5)
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target type
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:
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 63-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleDirectSearchAllNumbersSpecialConfig.xml
Function:
getArticleDirectSearchAllNumbers()
Result:
Column Type Description
articleId Long Article ID
articleNo String Article number
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 64-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
numberType integer 0: Article number Number type
1: OE number
2: Trade number
3: Comparable 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
lang string Language code according to Language
ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 65-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleDirectSearchAllNumbers2SpecialConfig.xml
Function:
getArticleDirectSearchAllNumbers2()
Result:
Identical structure as function getArticleDirectSearchAllNumbers() (see:2.14.1).
Request Parameter:
Name Type States Description
numberType integer 0: Article number Number type
1: OE number
2: Trade number
3: Comparable 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
lang string Language code according to Language
ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 66-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleDirectSearchByIdConfig.xml
Function:
getArticleDirectSearchById()
Result:
Column Type Description
articleId Long Article ID
articleNo String Article number
articleName String Article name
articleAddName String Article add name
articleState Integer Article state (KT 073)
articleStateName String Article state name (KT 073)
genericArticleId Long Generic article ID
brandName String Brand name
brandNo Integer Brand number
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 67-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
priceDate Integer Price date [YYYYMMDD] Price date
Null = current date
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 68-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleDirectSearchById2Config.xml
Function:
getArticleDirectSearchById2()
Result:
Column Type Description
articleId Long Article ID
articleNo String Article number
articleName String Article name
articleAddName String Article add name
articleState Integer Article state (KT 073)
articleStateName String Article state name (KT 073)
genericArticleId Long Generic article ID
brandName String Brand name
brandNo Integer Brand number
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
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 69-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Identical structure as function getArticleDirectSearchById() (see 2.14.3)
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)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 70-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
lang string Language code Language
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)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 71-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
2.14.6 Get all article detail information by article string list (deprecated)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 72-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
DirectArticlesByIdsStringListConfig.xml
Function:
getDirectArticlesByIdsStringList()
Result:
Identical structure as function getDirectArticlesByIds() (see: 2.14.5).
Request Parameter:
Name Type States Description
articleId StringList 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
lang string Language code Language
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)
else false
eanNumbers boolean If true, get EAN EAN number
number (see 2.19.1)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 73-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
DirectArticlesByIdsSingleConfig.xml
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 74-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getDirectArticlesByIdsSingle()
Result:
Identical structure as function getDirectArticlesByIds() (see: 2.14.5).
Request Parameter:
Name Type States Description
articleId long Results of article Article ID
selection
priceDate Integer Price date Price date
[YYYYMMDD]
Null = current date
country string Country code Country
according to ISO
3166
lang string Language code Language
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)
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 75-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
DirectArticlesByIds2Config.xml
Function:
getDirectArticlesByIds2()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 76-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Identical structure as function getDirectArticlesByIds() (see: 2.14.5).
Exception: The result has a new basic record (see: 2.14.4)
Request Parameter:
Identical structure as function getDirectArticlesByIds() (see: 2.14.5).
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:
Identical structure as function getDirectArticlesByIds() (see: 2.14.5).
Exception: The result has a new basic record (see: 2.14.4)
Request Parameter:
Identical structure as function getDirectArticlesByIdsStringList() (see: 2.14.6).
XML Template:
DirectArticlesByIds2SingleConfig.xml
Function:
getDirectArticlesByIds2Single()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 77-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Identical structure as function getDirectArticlesByIds() (see: 2.14.5).
Exception: The result has a new basic record (see: 2.14.4)
Request Parameter:
Identical structure as function getDirectArticlesByIdsSingle() (see: 2.14.7).
XML Template:
GenericArticlesByManufacturer2Config.xml
Function:
getGenericArticlesByManufacturer2()
Result:
Column Typ Description
assemblyGroupNodeId Long Assembly group node ID
parentNodeId Long Parent node ID of assembly
group node
genericArticleId Long Generic article ID
articleNormName String Article standard name
brandNo Integer Brand number
brandName String Brand name
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 78-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Other tbd
linkingTargetId Long Linking target ID according Linking target ID
to the linking target type:
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
lang string Language code according to Language
ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 79-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
GenericArticlesByManufacturer3Config.xml
Function:
getGenericArticlesByManufacturer3()
Result:
Column Typ Description
assemblyGroupNodeId Long Assembly group node ID
parentNodeId Long Parent node ID of assembly
group node
genericArticleId Long Generic article ID
articleNormName String Article standard name
brandNo Integer Brand number
brandName String Brand name
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Other tbd
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 80-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 81-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
GenericArticlesByManufacturer3StringListConfig.xml
Function:
getGenericArticlesByManufacturer3StringList()
Result:
Identical structure as function getGenericArticlesByManufacturer3() (see:2.15.2).
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target
type
C: Vehicle
M: Motor
A: Axle
U: Universal
Other tbd
linkingTargetId Long Linking target ID according Linking target ID
to the linking target type:
C: Vehicle ID
M: Motor ID
A: Axle 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 StringList In case of limitation to brand List of Brand
numbers else null numbers
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 82-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
GenericArticlesByManufacturer4Config.xml
Function:
getGenericArticlesByManufacturer4()
Result:
Column Typ Description
genericArticleId Long Generic article ID
articleNormName String Article standard name
brandNo Integer Brand number
brandName String Brand name
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target
type
C: Vehicle
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 83-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 84-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
GenericArticlesByManufacturer4StringListConfig.xml
Function:
getGenericArticlesByManufacturer4StringList()
Result:
Identical structure as function getGenericArticlesByManufacturer4() (see:2.15.4).
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Other tbd
linkingTargetId Long Linking target ID according Linking target ID
to the linking target type:
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 85-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleIdsByGenericArticleConfig.xml
Function:
getArticleIdsByGenericArticle()
Result:
Column Type Description
assemblyGroupNodeId Long Assembly group node
parentNodeId Long Parent node ID of assembly
group node
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 86-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
linkingTargetType string Linking target type: Linking target
type
C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
linkingTargetId Long Linking target ID according Linking target ID
to the linking target type:
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
true:show detail information
of all child nodes of the
assembly group
brandNo Integer In case of limitation to brand Brand number
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 87-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleIdsByPartManufacturerConfig.xml
Function:
getArticleIdsByPartManufacturer()
Result:
Column Type Description
assemblyGroupNodeId Long Assembly group node ID
parentNodeId Long Parent node ID of assembly
group node
articleLinkId Long Article link ID
articleId Long Article ID
articleNo String Article number
genericArticleId Long Generic article ID
genericArticleName String Generic article name
brandNo Integer Brand number
sortNo Integer Sort number
Request Parameter:
Name Type States Description
linkingTargetType string C: Vehicle Linking target
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 88-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 89-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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:
Column Type Description
assemblyGroupNodeId Long Assembly group node ID
parentNodeId Long Parent node ID of assembly
group node
articleLinkId Long Article link ID
articleId Long Article ID
articleNo String Article number
genericArticleId Long Generic article ID
genericArticleName String Generic article name
brandNo Integer Brand number
brandName String Brand name
sortNo Integer Sort number
Request Parameter:
Name Type States Description
linkingTargetType string C: Vehicle Linking target
type
M: Motor
A: Axle
K: Body type
U: Universal
Others tbd
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 90-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 91-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
2.16.4 Get articles by brand number and generic article string list (deprecated)
Find articles by brand number and generic article and assembly group.
XML Template:
ArticleIdsStringListConfig.xml
Function:
getArticleIdsStringList()
Result:
Identical structure as function getArticleIds() (see: 2.16.3).
Request Parameter:
Name Type States Description
linkingTargetType string C: Vehicle Linking target
type
M: Motor
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
childNodes boolean false:Standard Flag: child nodes
selection
true:show detail
information of all child
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 92-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
2.16.5 Get articles by brand number and generic article single (deprecated)
Find articles by brand number and generic article and assembly group.
XML Template:
ArticleIdsSingleConfig.xml
Function:
getArticleIdsSingle()
Result:
Identical structure as function getArticleIds() (see:2.16.3).
Request Parameter:
Name Type States Description
linkingTargetType string C: Vehicle Linking target
type
M: Motor
A: Axle
K: Body type
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 93-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 94-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleIds2Config.xml
Function:
getArticleIds2()
Result:
Column Type Description
articleLinkId Long Article link ID
articleId Long Article ID
articleNo String Article number
genericArticleId Long Generic article ID
genericArticleName String Generic article name
brandNo Integer Brand number
brandName String Brand name
sortNo Integer Sort number
Request Parameter:
Name Type States Description
linkingTargetType string C: Vehicle Linking target
type
M: Motor
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 95-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
2.16.7 Get articles by brand number and generic article string list
Find articles by brand number and generic article and assembly group.
XML Template:
ArticleIds2StringListConfig.xml
Function:
getArticleIds2StringList()
Result:
Identical structure as function getArticleIds2() (see:2.16.6).
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 96-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
linkingTargetType string C: Vehicle Linking target
type
M: Motor
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
brandNo StringList In case of limitation to Brand number
Brand number else null
genericArticleId StringList In case of limitation to Generic article
generic article number number
else null
lang string Language code according Language
to ISO 639
country string Country code according Country
to ISO 3166
sort integer 1: Sort by brandNo Sorting field
2: sort by
genericArticleName
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 97-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleIds2SingleConfig.xml
Function:
getArticleIds2Single()
Result:
Identical structure as function getArticleIds2() (see: 2.16.6).
Request Parameter:
Name Type States Description
linkingTargetType string C: Vehicle Linking target
type
M: Motor
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
brandNo Integer In case of limitation to Brand number
Brand number else null
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 98-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
AssignedArticleByIdConfig.xml
Function:
getAssignedArticleById()
Result:
Column Type Description
articleId Long Article ID
articleLinkId Long Article link Id
articleNo String Article number
articleAddName String Article additional name
articleState Integer Article state (KT 73)
articleStateName String Article state name (KT 73)
packingUnit Integer Packing Unit
quantityPerPackingUnit Integer Quantiy per packing Unit
hasPrices Boolean true if prices are available else
false
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 99-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 100-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
AssignedArticleById2Config.xml
Function:
getAssignedArticleById2()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 101-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
articleId Long Article ID
articleLinkId Long Article link Id
articleNo String Article number
articleAddName String Article additional name
articleState Integer Article state (KT 73)
articleStateName String Article state name (KT 73)
packingUnit Integer Packing Unit
quantityPerPackingUnit Integer Quantiy per packing Unit
hasPrices Boolean true if prices are available else
false
hasDocuments Boolean true if documents are available
else false
hasSecurityInfo Boolean true if security information is
available else false
hasPartList Boolean true if 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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 102-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Identical structure as function getAssignedArticleById() (see 2.16.9)
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)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 103-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
linkingTargetId Long Linking target ID Linking target ID
according to linking
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
U: null
manuId Long Result of vehicle Manufacturer ID
manufacturer
selection if linking
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
priceDate Integer Price date Price date
[YYYYMMDD]
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 104-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 105-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Comment:
ArticleIdPairSeq is a Sequence of ArticleIdPair, which has two fields:
articleId (long) and articleLinkId (long).
XML Template:
AssignedArticlesByIdsSingleConfig.xml
Function:
getAssignedArticlesByIdsSingle()
Result:
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 106-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
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
linkingTargetId Long Linking target ID Linking target ID
according to linking
target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
U: null
manuId Long Result of vehicle Manufacturer ID
manufacturer
selection if linking
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
priceDate Integer Price date Price date
[YYYYMMDD]
Null = current date
country string Country code Country
according to ISO
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 107-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 108-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 109-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 110-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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.
XML Template:
RequiredAttributesConfig.xml
Function:
getRequiredAttributes()
Result:
Column Type Description
criteriaId Long Criteria ID
dutyFlag Boolean Duty flag
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 111-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
genericArticleId long Result of generic article Generic article number
selection
country string Country code Country
according to ISO 3166
XML Template:
CriteriaAttributesByCriteriaArticlesConfig.xml
Function:
getCriteriaAttributesByCriteriaArticles()
Result:
Column Type Description
criteriaId Long Criteria ID
attributeValue String Attribute value
Request Parameter:
Name Type States Description
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
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 112-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
CriteriaAttributesByCriteriaArticlesStringListConfig.xml
Function:
getCriteriaAttributesByCriteriaArticlesStringList()
Result:
Identical structure as function getCriteriaAttributesByCriteriaArticles (see: 2.17.2)
Request Parameter:
Name Type States Description
criteriaId long Criteria ID Criteria ID
articleIds stringLi Result of article List of article ID’s
st selection
articleLinkIds StringLi Result of article List of articlelink ID’s
st selection
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
XML Template:
CriteriaFilterArticlesByValuesConfig.xml
Function:
getCriteriaFilterArticlesByValues()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 113-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
articleId Long Article ID
articleLinkId Long Articlelink ID
Request Parameter:
Name Type States Description
criteriaId long Criteria ID Criteria ID
linkingTargetTy string Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
articleIds longLis Result of article List of article ID’s
t selection
articleLinkIds LongList Result of article List of articlelink ID’s
selection
attributeValues stringLi List of attribute values List of attribute values
st
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
XML Template:
CriteriaFilterArticlesByValuesStringListConfig.xml
Function:
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 114-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
getCriteriaFilterArticlesByValuesStringList()
Result:
Identical structure as function getCriteriaFilterArticlesByValues (see: 2.17.4)
Request Parameter:
Name Type States Description
criteriaId long Criteria ID Criteria ID
linkingTargetTy string Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
articleIds stringLi Result of article List of article ID’s
st selection
articleLinkIds StringLi Result of article List of articlelink ID’s
st selection
attributeValues stringLi List of attribute values List of attribute values
st
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
XML Template:
CriteriaFilterArticlesByValuesNumericConfig.xml
Function:
getCriteriaFilterArticlesByValuesNumeric()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 115-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
articleId Long Article ID
articleLinkId Long Articlelink ID
Request Parameter:
Name Type States Description
criteriaId long Criteria ID Criteria ID
linkingTargetTy string Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
U: Universal
articleIds longLis Result of article List of article ID’s
t selection
articleLinkIds LongList Result of article List of articlelink ID’s
selection
attributeValues stringLi List of attribute values List of attribute values
st
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
XML Template:
CriteriaFilterArticlesByValuesNumericStringListConfig.xml
Function:
getCriteriaFilterArticlesByValuesNumericStringList()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 116-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Identical structure as function getCriteriaFilterArticlesByValuesNumeric()
(see:2.17.6).
Request Parameter:
Name Type States Description
criteriaId long Criteria ID Criteria ID
linkingTargetTy string Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
articleIds stringLi Result of article List of article ID’s
st selection
articleLinkIds StringLi Result of article List of articlelink ID’s
st selection
attributeValues stringLi List of attribute values List of attribute values
st
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
XML Template:
CriteriaFilterArticlesByValuesIntervalConfig.xml
Function:
getCriteriaFilterArticlesByValuesInterval()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 117-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
articleId Long Article ID
articleLinkId Long Articlelink ID
Request Parameter:
Name Type States Description
criteriaId Long Criteria ID Criteria ID
criteriaId2 Long Successor criteria ID Successor criteria ID
linkingTargetTy string Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
articleIds longLis Result of article List of article ID’s
t selection
articleLinkIds LongList Result of article List of articlelink ID’s
selection
value1 String Interval value 1 Interval value 1
value2 String Interval value 2 Interval value 2
flagDate boolea true:value is date Flag: Is Date
n false:value is not date
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
XML Template:
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 118-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
CriteriaFilterArticlesByValuesIntervalStringListConfig.xml
Function:
getCriteriaFilterArticlesByValuesIntervalStringList()
Result:
Identical structure as function getCriteriaFilterArticlesByValuesInterval() (see: 2.17.8 )
Request Parameter:
Name Type States Description
criteriaId Long Criteria ID Criteria ID
criteriaId2 Long Successor criteria ID Successor criteria ID
linkingTargetTy string Linking target type: Linking target type
pe C: Vehicle
M: Motor
A: Axle
K: Body type
U: Universal
articleIds stringLi Result of article List of article ID’s
st selection
articleLinkIds StringLi Result of article List of articlelink ID’s
st selection
value1 String Interval value 1 Interval value 1
value2 String Interval value 2 Interval value 2
flagDate boolea true:value is date Flag: Is Date
n false:value is not date
country string Country code Country
according to ISO 3166
lang string Language code Language
according to ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 119-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ImmediateAttributsConfig.xml
Function:
getImmediateAttributs()
Result:
Column Type Description
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 120-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleLinkId Long In case of assembly group Article link ID
selection article link ID of
article selection else (article
direct search) null
country string Country code according to Country
ISO 3166
lang string Language code according to Language
ISO 639
XML Template:
ImmediateInfosConfig.xml
Function:
getImmediateInfos()
Result:
Column Type Description
infoId Long Information ID
infoText String Information text
infoTypeId Integer Information type (KT 072)
infoTypeName String Information type name (KT 072)
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleLinkId Long In case of assembly group Article link ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 121-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticlePricesNormalAustauschConfig.xml
Function:
getArticlePricesNormalAustausch()
Result:
Column Type Description
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 122-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
priceDate Integer Price date [YYYYMMDD] Price date
Null = current date
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
EanNumbersConfig.xml
Function:
getEanNumbers()
Result:
Column Type Description
eanNumber String EAN number
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
country string Country code according to ISO Country
3166
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 123-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
UsageNumbersConfig.xml
Function:
getUsageNumbers()
Result:
Column Type Description
usageNumber String Trade number
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
country string Country code according to Country
ISO 3166
XML Template:
ReplacedNumbersConfig.xml
Function:
getReplacedNumbers()
Result:
Column Type Description
replaceArticleId Long Replacement article ID
replaceNumber String Replacement article number
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 124-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
country string Country code according to ISO Country
3166
Second flavour: Find articles and replacement number which are replaced by an
article.
XML Template:
ReplacedByNumbersConfig.xml
Function:
getReplacedByNumbers()
Result:
Column Type Description
replaceArticleId Long Replacement article ID
replaceNumber String Replacement article number
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
country string Country code according to ISO Country
3166
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 125-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleExtUrlByIdConfig.xml
Function:
getArticleExtUrlById()
Result:
Column Type Description
extInfoURL String URL of extended article
information
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
genericArticleId long Result of article selection Generic article ID
brandNo integer Brand number Brand number
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
AssignedArticleAttributsConfig.xml
Function:
getAssignedArticleAttributs()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 126-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
attrValueId Long Attribute value ID
attrValue String Attribute value
attrName String Attribute name
attrType String Attribute type:
A: Alphanumeric
N: Numeric
D: Date
K: Key
V: Without value
Others tbd
attrId Long Attribute ID
attrShortName String Attribute short name
attrUnit String Attribute unit
attrSuccessorId Long Successory ID
attrIsInterval Boolean Flag: Is Interval
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleLinkId Long If assembly group selection: Article link ID
article link ID of article
selection, if article direct search:
null
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 127-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
AssignedArticleInfosConfig.xml
Function:
getAssignedArticleInfos()
Result:
Column Type Description
infoId Long Information ID
infoText String Information text
infoType Integer Information type (KT 072)
infoTypeName String Information type name (KT 072)
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleLinkId Long In case of assembly group Article link ID
selection article link ID of article
selection else (article direct
search) null
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
MainArticlesConfig.xml
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 128-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getMainArticles()
Result:
Column Type Description
articleId Long Article ID
articleNumber String Article number
articleName String Article name
articleAddName String Article add name
Request Parameter:
Name Type States Description
partArticleId long Result of article selection Part article ID
country string Country code according to ISO Country
3166
Lang string Language code according to Language
ISO 639
XML Template:
ArticleDocumentsConfig.xml
Function:
getArticleDocuments()
Result:
Column Type Description
docId Long Document ID
docLinkId Long Document link ID
docTypeName String Document type name (KT 141)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 129-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleLinkId Long In case of assembly group Article link ID
selection article link ID of article
selection else (article direct
search) null
docTypeId Integer Document type (KT 141) Document type
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
ThumbnailByArticleIdConfig.xml
Function:
getThumbnailByArticleId()
Result:
Column Type Description
thumbDocId Long Document ID
thumbTypeId Integer Document type Id
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 130-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
XML Template:
CsgDocumentsByArticleIdConfig.xml
Function:
getCsgDocumentsByArticleId()
Result:
Column Type Description
csgId Long Context sensitive graphic ID
csgDocId Long Document ID
csgFileName String File name
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 131-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
CoordinatesByArticleDocumentConfig.xml
Function:
getCoordinatesByArticleDocument()
Result:
Column Type Description
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:
Name Type States Description
csgId long Context sensitive graphic ID Context sensitive
graphic ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 132-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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:
Name Type States Description
articleId long Result of article selection Article ID
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
linkingTargetId Long Linking target ID according to Linking target ID
the linking target type:
C: Vehicle ID
M: Motor ID
A: Axle ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 133-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
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)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 134-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleDocumentsByDocIdConfig.xml
Function:
getArticleDocumentsByDocId()
Result:
Column Type Description
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:
Name Type States Description
docId long Document ID Document ID
thumbFlag boolean Thumb Flag Thumb flag
XML Template:
ArticlePricesConfig.xml
Function:
getArticlePrices()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 135-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
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
hasLessDiscount Boolean true if less discount is available
else false
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
priceDate Integer Price date [YYYYMMDD] Price date
Null = current date
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 136-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
ArticleOENumbersConfig.xml
Function:
getArticleOENumbers()
Result:
Column Type Description
oeNumber String OE number
brandName String Manufacturer name
blockNumber Integer Block number
sortNumber Integer Sort number
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
ManufacturerInfosByIdConfig.xml
Function:
getManufacturerInfosById()
Result:
Column Type Description
addressType Integer Address type (KT 059)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 137-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
brandNo integer Result of brand selection Brand number
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
ArticleLinkedAllLinkingTargetSpecialConfig.xml
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 138-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getArticleLinkedAllLinkingTarget()
Result:
Column Type Description
articleLinkId Long Article link ID
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:
Name Type States Description
articleId long Result of article selection Article ID
linkingTargetType string Linking target type: Linking target type
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 139-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleLinkedAllLinkingTarget2SpecialConfig.xml
Function:
getArticleLinkedAllLinkingTarget2()
Result:
Identical structure as function getArticleLinkedAllLinkingTarget () (see:2.27).
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
linkingTargetType string Linking target type: Linking target
type
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 140-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleLinkedAllLinkingTargetManufacturerSpecialConfig.xml
Function:
getArticleLinkedAllLinkingTargetManufacturer()
Result:
Column Type Description
manuName String Manufacturer short name
manuId Integer Manufacturer ID
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 141-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ImmediateAttributsLinkedElementsConfig.xml
Function:
getImmediateAttributsLinkedElements()
Result:
Column Type Description
attrId Long Attribute ID
attrValue String Attribute value
attrName String Attribute name
attrType String Attribute type:
A: Alphanumeric
N: Numeric
D: Date
K: Key
V: Without value
Others tbd
attrShortName String Attribute short name
attrUnit String Attribute unit
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 142-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleLinkId long Result of article selection Article ID
country string Country code according to ISO Country
3166
lang string Language code according to Language
ISO 639
XML Template:
ArticleLinkedMotorsByIdConfig.xml
Function:
getArticleLinkedMotorsById()
Result:
Column Type Description
motorId Long Motor ID
motorCode String Motor code
manuId Long Manufacturer ID
manuDesc String Manufacturer name
powerKw Integer Power / KW
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 143-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
motorId long Result of motor selection Motor ID
lang string Language code according to Language
ISO 639
country string Country code according to Country
ISO 3166
XML Template:
ArticleLinkedVehiclesByIdConfig.xml
Function:
getArticleLinkedVehiclesById()
Result:
Column Type Description
carId Long Vehicle ID
carDesc String Vehicle name
manuId Long Manufacturer ID
manuDesc String Manufacturer name
modelId Long Model ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 144-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
carId long Result of vehicle selection Vehicle ID
lang string Language code according to Language
ISO 639
country string Country code according to Country
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 145-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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:
Name Type States Description
articleId long Result of article selection Article ID
linkingTargetType string Linking target type: Linking target type
C: Vehicle
M: Motor
A: Axles
linkedArticlePairs LinkedArticle Result of linked article List of linked
PairSeq selection (see 2.27) article
lang string Language code Language
according to ISO 639
country string Country code according Country
to ISO 3166
Comment:
LinkedArticlePairSeq is a Sequence of LinkedArticlePair, which has two fields:
linkingTargetId (long) and articleLinkId (long).
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 146-160
Catalog Webservice V1.3
Interface Definition Apr 2008
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:
Name Type States Description
articleId long Result of article selection Article ID
linkingTargetType string Linking target type: Linking target type
C: Vehicle
M: Motor
A: Axles
K: Body type
linkedArticlePairs LinkedArticle Result of linked article List of linked
PairSeq selection (see 2.27) article
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 147-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Comment:
LinkedArticlePairSeq is a Sequence of LinkedArticlePair, which has two fields:
linkingTargetId (long) and articleLinkId (long).
XML Template:
ArticleAccessoryListConfig.xml
Function:
getArticleAccessoryList()
Result:
Column Type Description
accessoryLinkId Long Accessory link ID
articleListNo Integer Article list number
accessoryArticleId Long Accessory article ID
accessoryArticleName String Accessory article name
articleNo String Article number
articleName String Article name
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 148-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleLinkId Long Result of article selection Article link ID
articleId long Result of article selection Article ID
linkingTargetType string Linking target type: Linking target type
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 149-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
XML Template:
ArticleAccessoryList3Config.xml
Function:
getArticleAccessoryList3()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 150-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
accessoryLinkId Long Accessory link ID
articleListNo Integer Article list number
accessoryArticleId Long Accessory article ID
accessoryArticleName String Accessory article name
articleNo String Article number
articleName String Article name
articleAddName String Article add name
articleState Integer Article state (KT 073)
articleStateName String Article state name (KT 073)
genericArticleId Long Generic article ID
genericArticleName String Generic article name
brandName String Brand name
brandNo Integer Brand number
packingUnit Integer Packing Unit
quantityPerPackingUnit Integer Quantity per packing unit
quantity Integer Quantity
hasPrices Boolean true if prices are available else
false
hasDocuments Boolean true if documents are
available 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
hasVehicleLink Boolean true if vehicle links are
available else false
hasMotorLink Boolean true if motor links are available
else false
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 151-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Identical structure as function getArticleAccessoryList2() (see 2.28.1)
Exception: There is a new linkingTargetType ‘K’ for body type info
XML Template:
ArticleAccessoryList2Config.xml
Function:
getArticleAccessoryList2()
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).
XML Template:
ArticleAccessoryList4Config.xml
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 152-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getArticleAccessoryList4()
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).
XML Template:
ArticleHasAccessoryListConfig.xml
Function:
getArticleHasAccessoryList()
Result:
Column Type Description
articleAccessoryId Long Article accessory ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 153-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
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
not an universal article
motorId Long Result of motor slection if Motor ID
not an universal article
country string Country code according to Country
ISO 3166
XML Template:
ArticleAccessoryImmediateAttributsConfig.xml
Function:
getArticleAccessoryImmediateAttributs()
Result:
Column Type Description
isAccessoryAttr Boolean true if accessory attribute
else false
attrId Long Attribute ID
attrType String Attribute type:
A: Alphanumeric
N: Numeric
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 154-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleAccessoryId long Result of article accessory Article accessory
selection ID
lang string Language code according to Language
ISO 639
country string Country code according to Country
ISO 3166
XML Template:
ArticlePartListConfig.xml
Function:
getArticlePartList()
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 155-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Result:
Column Type Description
partId Long Part article link ID
partArticleId Long Part article ID
articleNo String Article number
articleName String Article name
articleAddName String Article add name
articleState Integer Article state (KT 073)
articleStateName String Article state name (KT 073)
genericArticleId Long Generic article ID
genericArticleName String Generic article number
brandName String Brand name
brandNo Integer Brand number
packingUnit Integer Packing unit
quantityPerPackingUnit Integer Quantity per packing unit
quantity Integer Quantity
hasPrices Boolean true if prices are available else
false
hasDocuments Boolean true if documents are available
else false
hasSecurityInfo Boolean true if security information 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
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
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 156-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleLinkId Long Result of article selection Article link ID
carId Long Result of car selection Car ID
axleID Long Result of axle selection Axle ID
motorId Long Result of motor selection Motor ID
priceDate Integer Price date [YYYYMMDD] Price date
Null = current date
country string Country code according to ISO Country
3166
lang String Language code according to Language
ISO 639
XML Template:
ArticlePartList2Config.xml
Function:
getArticlePartList2()
Result:
Column Type Description
partId Long Part article link ID
partArticleId Long Part article ID
articleNo String Article number
articleName String Article name
articleAddName String Article add name
articleState Integer Article state (KT 073)
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 157-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Name Type States Description
articleId long Result of article selection Article ID
articleLinkId Long Result of article selection Article link ID
carId Long Result of car selection Car ID
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 158-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Function:
getPegasusVersionInfo()
Result:
Column Type Description
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.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 159-160
Catalog Webservice V1.3
Interface Definition Apr 2008
Confidental
Request Parameter:
Column Type Description
Function:
addDynamicAddress()
Result:
Column Type Description
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:
Name Type States Description
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.
The publication of this document, or parts of it, in arbitrary form requires the written agreement of the TecDoc
Informations System GmbH.
Page 160-160