interface cat service

Catalog Webservice V1.3 Interface Definition

Confidental

Apr 2008

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

-

Interface Definition

Version: V1.3 Date: Apr 2008 Status: accepted by customer


Confidental

Apr 2008


Page II

Prologue A : History of changes

Version Date Author Comment 0.1 Dec 2006 AF Initial release 0.2 Apr 2007 AF Corrections, additions 0.3 Apr 2007 TW Review, corrections 0.5 May 2007 AF Additions 0.6 June 2007 AF Additions

1.0a July 2007 AF, TW Switch to optimized Database. Compatibility functions marked as "(deprecated)" are likely to disappear in the final version.

1.0b Aug 2007 AE, TW Additions 1.0 Aug 2007 AF, TW Deprecated functions are deleted, final Review

1.1a Sep 2007 AF Additions 1.1a Oct 2007 AF Additions 1.1a Nov 2007 AF Additions 1.1a Dec 2007 AF Additions 1.1b Dec 2007 AF Additions 1.1b Jan 2008 AF Additions 1.1 Jan 2008 TW, AF Additions, Final Review 1.2 Jan 2008 AF Additions

1.3a Feb 2008 AF Additions 1.3a Apr 2008 AF Review, Corrections 1.3b Apr 2008 AF, TW Review, Corrections 1.3b May 2008 AF Review, Corrections

Persons: AW Alexander Wegner (TecDoc) TW Thomas Wendt (TecDoc) AF Andreas Feldewert (TecDoc) MP Mehdi Parvaresh (TecDoc) Version: Version of the software

Prologue B : Abbreviations and terms

Term Description URL Uniform Resource Locator SOAP Simple Object Access Protocol WSDL Web Service Description Language


Confidental

Apr 2008


-160

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


Confidental

Apr 2008


-160

2.9.9 Get fuel types..........................................................................................34 2.9.10 Get vehicle details (construction year, power, capacity …) ...............35 2.9.11 Get vehicle details (terms) .....................................................................36 2.9.12 Get vehicle details (Passenger car details) ..........................................37 2.9.13 Get all vehicle details by a list ...............................................................39 2.9.14 Get all vehicle details by a list of string id’s ........................................40

2.10 Get body types ............................................................................................. 41 2.10.1 Get body types by body type ID ............................................................41 2.10.2 Get vehicles by body type ID .................................................................42 2.10.3 Get body type by ID ................................................................................43 2.10.4 Get vehicle ID’s by body type ................................................................44

2.11 Get motors.................................................................................................... 45 2.11.1 Get motor manufacturers.......................................................................46 2.11.2 Get motor details ....................................................................................47 2.11.3 Get motor details by a list......................................................................47 2.11.4 Get motor details by a list of string id’s ...............................................48 2.11.5 Get motors by motorcode (advanced selection)..................................49

2.12 Get axles ....................................................................................................... 50 2.12.1 Get axle manufacturers..........................................................................51 2.12.2 Get axle models ......................................................................................52 2.12.3 Get brake sizes .......................................................................................52 2.12.4 Get axle types .........................................................................................54 2.12.5 Get axle styles.........................................................................................55 2.12.6 Get axle details .......................................................................................55 2.12.7 Get axle details by a list .........................................................................56 2.12.8 Get axle details by a list of string id’s...................................................57

2.13 Get assembly groups................................................................................... 58 2.13.1 Get shortcuts for assembly groups ......................................................58 2.13.2 Get linked shortcuts for assembly groups...........................................59 2.13.3 Get assembly groups by shortcut.........................................................59 2.13.4 Get linked assembly groups by shortcut..............................................61 2.13.5 Get assembly groups .............................................................................62 2.13.6 Get linked assembly groups..................................................................63

2.14 Get articles (direct search).......................................................................... 64


Confidental

Apr 2008


-160

2.14.1 Get articles ..............................................................................................64 2.14.2 Get articles by brandno and generic articleid......................................66 2.14.3 Get article basic information (deprecated)...........................................67 2.14.4 Get article basic information (new).......................................................68 2.14.5 Get all article detail information by article list (deprecated)...............70 2.14.6 Get all article detail information by article string list (deprecated)....72 2.14.7 Get all article detail information by single article (deprecated)..........74 2.14.8 Get all article detail information by article list (new)...........................76 2.14.9 Get all article detail information by article string list (new)................77 2.14.10 Get all article detail information by single article (new)......................77

2.15 Get generic articles and brands ................................................................. 78 2.15.1 Get generic articles and brands by an assembly group .....................78 2.15.2 Get generic articles and brands by list.................................................80 2.15.3 Get generic articles and brands by string list ......................................81 2.15.4 Get distinct generic articles and brands by list ...................................83 2.15.5 Get distinct generic articles and brands by string list ........................85

2.16 Get articles (search tree) ............................................................................. 86 2.16.1 Get articles by generic article (product group) (deprecated) .............86 2.16.2 Get articles by brand number (deprecated) .........................................88 2.16.3 Get articles by brand number and generic article list (deprecated)...90 2.16.4 Get articles by brand number and generic article string list (deprecated).........................................................................................................92 2.16.5 Get articles by brand number and generic article single (deprecated)93 2.16.6 Get articles by brand number and generic article list .........................95 2.16.7 Get articles by brand number and generic article string list ..............96 2.16.8 Get articles by brand number and generic article single ....................98 2.16.9 Get article basic information (deprecated)...........................................99 2.16.10 Get article basic information (new).....................................................101 2.16.11 Get all article detail information by article list (deprecated).............103 2.16.12 Get all article detail information by single article (deprecated)........106 2.16.13 Get all article detail information by article list (new).........................109 2.16.14 Get all article detail information by single article (new)....................110

2.17 Get articles by criteria ................................................................................110 2.17.1 Get required Attributs (Criteria) ..........................................................111 2.17.2 Get attribute values of articles ............................................................112


Confidental

Apr 2008


-160

2.17.3 Get attribute values of articles stringlist ............................................113 2.17.4 Get articles filtered by attribute string values....................................113 2.17.5 Get articles filtered by attribute string values stringlist....................114 2.17.6 Get articles filtered by attribute numeric values................................115 2.17.7 Get articles filtered by attribute numeric values stringlist................116 2.17.8 Get articles filtered by attribute interval values.................................117 2.17.9 Get articles filtered by attribute interval values stringlist.................118

2.18 Get article main information ......................................................................120 2.18.1 Get article main attributes ...................................................................120 2.18.2 Get article main information ................................................................121 2.18.3 Get article standard price ....................................................................122

2.19 Get article information................................................................................123 2.19.1 Get article EAN number .......................................................................123 2.19.2 Get article trade number ......................................................................123 2.19.3 Get article replacement number..........................................................124 2.19.4 Get URL of extended article information ............................................125 2.19.5 Get article attribute values...................................................................126 2.19.6 Get article information .........................................................................127 2.19.7 Get main articles...................................................................................128

2.20 Get article documents ................................................................................129

2.21 Get article thumbnail documents ..............................................................130

2.22 Get article context sensitive document ....................................................131 2.22.1 Get coordinates by article document..................................................131 2.22.2 Get article context sensitive document data (deprecated) ...............133 2.22.3 Get article context sensitive document data (new) ...........................134

2.23 Get article document data ..........................................................................135

2.24 Get article catalog prices ...........................................................................135

2.25 Get article OE numbers ..............................................................................136

2.26 Get manufacturer addresses .....................................................................137

2.27 Get linked vehicles, motors, axles of an article .......................................138 2.27.1 Get linked vehicles, motors, axles of an article by manufacturer ....140 2.27.2 Get linked vehicle, motor, axle manufacturers of an article .............141 2.27.3 Get article main attributes of a linked article .....................................142 2.27.4 Get linked axle details ..........................................................................143


Confidental

Apr 2008


-160

2.27.5 Get linked motor details.......................................................................143 2.27.6 Get linked vehicle details.....................................................................144 2.27.7 Get linked vehicle, motor, axle details of an article and a list of linking targets (deprecated) .............................................................................145 2.27.8 Get linked vehicle, motor, axle details of an article and a list of linking targets (new) .........................................................................................147

2.28 Get article accessory list............................................................................148 2.28.1 Get article accessory list (deprecated) ...............................................148 2.28.2 Get article accessory list (new) ...........................................................150 2.28.3 Get article accessory list with attributes (deprecated)......................152 2.28.4 Get article accessory list with attributes (new)..................................152 2.28.5 Get article accessory list existing information ..................................153 2.28.6 Get article main attribute of an accessory article..............................154

2.29 Get article part list (deprecated) ................................................................155 2.29.1 Get article part list (new)......................................................................157

2.30 Version info .................................................................................................159

2.31 Add dynamic address.................................................................................160


Confidental

Apr 2008


-160

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


Confidental

Apr 2008


-160

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


Confidental

Apr 2008


-160

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


Confidental

Apr 2008


-160

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


Confidental

Apr 2008


-160


Confidental

Apr 2008


-160

1 Introduction For the TecDoc online catalog a flexible and modular request system in form of web services exists. External data users can access the volume of data of the online catalog using standard requests. The present version of the catalog is 6.1.

1.1 Request Parameter The request parameters of each request function are passed in a special request object. As parameter the types integer, long, boolean and the special types String, StringList and LongList are available. An unused optional parameter must be passed as null. Mandatory parameters are marked with bold and lowercase (integer) types. An optional parameter has an uppercase (Integer) type.

1.2 Result The result is returned in a container object. This contains different information: A status code of the type integer and an optional status text of the type string. The state must be evaluated at the client, since exceptions at the server are not passed to the Client, but are visible as status code. The search results are returned as list of data records or as tree structure. For the data in the data record objects are used, in order to be able to represent empty results as null. State codes:

State Description 200 OK

400 Invalid request (e.g. invalid parameter value)

401 Request not authorized

405 Method not allowed

413 Too many results found

500 Internal error

1.3 Access Control In each request function there is a parameter provider of type integer. TecDoc assigns this number to each mandator. It is evaluated to authenticate the mandator and authorize the request together with the ip address of the request. The static ip address or addresses of the mandator are configured by TecDoc based on the information provided by the mandator.

The request parameter provider is implicitly contained in all functions and not described in the list of input parameters for each function.


Confidental

Apr 2008


-160

1.4 Linkage to other databases The TecDoc data might be linked to other databases on basis of the articleNo and brandId in the case of articles. The technical keys like articleId or articleLinkId may change with every new version of data. Other keys needed to identify articles (like vehicle manufacturer, model, generic article) remain constant over time and just get extended by new data.

1.5 Known compatibility problems

1.5.1 .net In .net the older RPC/Encoded style of SOAP does not work. In order to work around this, there is also an implementation of the Wrapped/Literal style with synthetic wrapper classes. The wrapper classes do not exist, so there is no way to link it to correct namespaces at the server. Currently one needs to work around this by adjusting the namespaces at the client. If one fails to do, only empty results get returned, because the generated code at client side is not able to parse the SOAP returned by the server. If processing arrays fails, one needs to check if there are naming conflicts. In this case the client side generator does not take the names given in WSDL.

1.5.2 PHP PHP does not implement different integer data types. Depending on the operating system an integer contains 32 or 64 bit. Therefore an automatic implicit mapping from int (32 bit) to long (64 bit) is done on discrete parameters which take a 64 bit value. However, this does not work with arrays, so there functions having arrays of strings containing the numeric values have to be used.


Confidental

Apr 2008


-160

2 Standard request functions Following standard request functions are available for the volume of data of the online catalog version 6.1.

2.1 Get key table values In the results of the request functions references of keytables are returned (KT xxx). The assigned entries are found by calling this function if needed. The language specific texts of these references should get cached and added to the search result as required.

XML Template: KeyValuesForTraderModeConfig.xml

Function: getKeyValuesForTradersMode()

Result: Column Type Description keyTableId Integer Key table ID

keyId String Key ID

keyValue String Key value

Request Parameter: Name Type States Description lang string Language according to

ISO 639 Language

keyTableId integer Key table ID Key table ID

Comment: The result could get cached per language.


Confidental

Apr 2008


-160

2.2 Get TecDoc country groups Get available TecDoc country groups like "Europe".

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

to ISO 639 Language


2.3 Get criteria (deprecated) In the results of the request functions references of criterion are returned. The assigned entries are found by calling this function if needed. The language specific texts of these references should get cached and added to the search result as required.

XML Template: CriteriaConfig.xml

Function: getCriteria()


Confidental

Apr 2008


-160

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


to ISO 639 Language


2.3.1 Get criteria (new) In the results of the request functions references of criterion are returned. The assigned entries are found by calling this function if needed. The language specific texts of these references should get cached and added to the search result as required.

XML Template: Criteria2Config.xml

Function: getCriteria2()


Confidental

Apr 2008


-160

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).


2.4 Get brands Find all currently available brands for this mandator.

XML Template: BrandsForAssortmentConfig.xml

Function:


Confidental

Apr 2008


-160

getBrandsForAssortment ()

Result: Column Type Description brandNo Integer Brand no

brandName String Brand name

Request Parameter: Name Type States Description

2.5 Get vehicle manufacturer (simplified or standard) Find vehicle manufacturers.

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:

1: Passenger car 2: Commercial vehicle 3: Both

Vehicle type

evalFavor boolean true, if simplified vehicle selection else false

Flag: simplified vehicle selection


Confidental

Apr 2008


-160

Name Type States Description favouredList Integer If simplified vehicle selection:

favoured list: 1: first list else null Others tbd

Favoured list for simplified vehicle selection

lang String Language code according to ISO 639

Language

countryGroupFlag

boolean true, if country group selection, else false

Flag: country group selection

countriesCarSelection

string Country code according to ISO 3166 or TecDoc country group code

Country for vehicle selection

Comment: The result may get cached.

2.6 Get vehicle models (simplified or standard selection) Find vehicle models.

XML Template: VehicleModels2Config.xml

Function: getVehicleModels2()

Result: Column Type Description modelId Long Model ID

modelname String Model name

yearOfConstrFrom Integer From construction year [YYYYMM]

yearOfConstrTo Integer To construction year [YYYYMM]


Confidental

Apr 2008


-160

Request Parameter: Name Type States Description manuId long Result of vehicle

manufacturer selection Manufacturer ID

carType integer Vehicle type: 1: Passenger car 2: Commercial vehicle 3: Both

Vehicle type

evalFavor boolean true, if simplified vehicle selection, else false

Flag: simplified model selection

favouredList Integer If simplified vehicle selection: favoured list: 1: first list else null Others tbd

Favoured list for simplified model selection

lang string Language code according to ISO 639

Language

countryGroupFlag boolean true, if country group selection else false


countriesCarSelection string Country code according to ISO 3166 or TecDoc country group code

Country for model selection

2.7 Get vehicle by ID Code system (deprecated) Find vehicles by an ID Code system.

XML Template: VehicleIdsByKeyNumberPlates2Config.xml

Function: getVehicleIdsByKeyNumberPlates2()

Result: Column Type Description carId Long Vehicle ID


Confidental

Apr 2008


-160

carName String Vehicle name

firstCountry String First country code (according to ISO 3166)

Request Parameter: Name Type States Description keySystemNumber string Key system number ID Code

keySystemType integer Key system type: 1: Dutch NumberPlate 2: French TypeMine 3: Swedish NumberPlate 4: Swiss Typenumber 5: Danish NumberPlate 6: Austrian NatCodes 20: German KBA Number Others tbd.

ID Code system

Lang string Language code according to ISO 639

Language

countryUserSetting String If vehicle selection with article assignments: country code according to ISO 3166, else null

Country for article assignments





Country for vehicle selection

2.8 Get vehicle by ID Code system Find vehicles by an ID Code system with model and manufacturer.

XML Template: VehicleIdsByKeyNumberPlates3Config.xml


Confidental

Apr 2008


-160

Function: getVehicleIdsByKeyNumberPlates3()


manuId Long Manufacturer ID

modelId Long Model ID



Request Parameter: Identical structure as function getVehicleIdsByKeyNumberPlates2 () (see:2.7).

2.9 Get vehicle

2.9.1 Get vehicle (simplified selection) Find vehicles for simplified selection.

XML Template: VehicleSimplifiedSelection2Config.xml

Function: getVehicleSimplifiedSelection2()



linked Integer Number of article assignments


Confidental

Apr 2008


-160




powerKwFrom Integer From power / KW

powerKwTo Integer To power / KW

powerHpFrom Integer From power / HP

powerHpTo Integer To power / HP

cylinderCapacity Integer Capacity / ccm

Request Parameter: Name Type States Description manuId Long If standard selection:

result of vehicle manufacturer selection, else null

Manufacturer ID

modId Long If standard selection: result of model selection, else null

Model ID

favouredList Integer If not standard selection: favoured list: 1: first list else null; others tbd

Favoured list for simplified selection


Vehicle type

linked boolean false: all, true: only linked articles

Flag: selection with / without article assignments


Language

countryUserSetting String If model selection with article assignments: country code according



Confidental

Apr 2008


-160

Name Type States Description to ISO 3166 else null





Country for Vehicle selection

2.9.2 Get vehicle (simplified selection) with motor codes Find vehicles for simplified selection with motor codes.

XML Template: VehicleSimplifiedSelection3Config.xml

Function: getVehicleSimplifiedSelection3()

Result: Records Description Records CarDetails Result of

vehicle selection (see 2.9.1

Car details

MotorCodes Result of motor code selection (see:2.9.2.1)

Motor codes


Confidental

Apr 2008


-160

Request Parameter: Name Type States Description manuId Long If standard selection:

result of vehicle manufacturer selection, else null

Manufacturer ID

modId Long If standard selection: result of model selection, else null

Model ID

favouredList Integer If not standard selection: favoured list: 1: first list else null; others tbd

Favoured list for simplified selection


Vehicle type




Language

countryUserSetting String If model selection with article assignments: country code according to ISO 3166 else null








Confidental

Apr 2008


-160

2.9.2.1 Get motor code Find motor code for a vehicle.

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

selection Vehicle ID



countriesCarSelection string Country code according to ISO 3166 or TecDoc country group code

Country of vehicle selection

2.9.3 Get vehicle by model ID (advanced selection) Find vehicles by advanced selection.

XML Template: VehicleIdsByCarTypeManuIdModelIdCriteria2Config.xml

Function: getVehicleIdsByCarTypeManuIdModelIdCriteria2()


Confidental

Apr 2008


-160






modId long Result of vehicle model selection

Model ID


Vehicle type

yearOfConstruction Integer Construction year [YYYY] Construction year

fuelTypeId Long Result of fuel type selection

Fuel type ID

constructionTypeId Long Result of construction type selection

Construction type ID

axisConfigurationId Long Result of configuration selection

Configuration ID

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


Language


Confidental

Apr 2008


-160

Name Type States Description countryGroupFlag boolean true, if country group

selection, else false Flag: country group selection




2.9.4 Get vehicle details by model ID (advanced selection) Find vehicles by advanced selection.

XML Template: VehiclesByCarTypeManuIdModelIdCriteria2Config.xml

Function: getVehiclesByCarTypeManuIdModelIdCriteria2()

Result: Records Description

vehicle Vehicle info (see 2.9.3)

vehicleDetails Vehicle detail info (see 2.9.10)


Confidental

Apr 2008


-160



modId long Result of vehicle model selection

Model ID


Vehicle type



Fuel type ID




Configuration ID

cylinderCapacityFrom Integer Capacity / ccm From capacity








Language

countryGroupFlag boolean true, if country group selection, else false






Confidental

Apr 2008


-160

2.9.5 Get vehicle by model description (advanced selection) Find vehicles by advanced selection.

XML Template: VehicleIdsByCarTypeManuIdTermConfig.xml

Function: getVehicleIdsByCarTypeManuIdTerm()






modelDescription String Result of vehicle model selection

Model description


Vehicle type



Fuel type ID




Configuration ID


Confidental

Apr 2008


-160

Name Type States Description cylinderCapacityFrom Integer Capacity / ccm From capacity








Language






2.9.6 Get vehicle by motor ID Find vehicles by motor ID.

XML Template: VehicleIdsByMotorConfig.xml

Function: getVehicleIdsByMotor()





Confidental

Apr 2008


-160

Request Parameter: Name Type States Description motorId long Result of motor selection Motor ID


Vehicle type


Language






2.9.7 Get construction types Return available construction types.

XML Template: ConstructionTypesConfig.xml

Function: getConstructionTypes()

Result: Column Type Description constrTypeID Long Construction type ID

constrTypeName String Construction type name


to ISO 639 Language


Confidental

Apr 2008


-160

Comment: The result may get cached per language.

2.9.8 Get axis configurations Return available axis configurations.

XML Template: AxisConfigurationsConfig.xml

Function: getAxisConfigurations()

Result: Column Type Description axisConfigID Long Axis configuration ID

axisConfigName String Axis configuration name


to ISO 639 Language


2.9.9 Get fuel types Return available fuel types.

XML Template: FuelTypesConfig.xml


Confidental

Apr 2008


-160

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

to ISO 639 Language


2.9.10 Get vehicle details (construction year, power, capacity …) Find vehicle detail information.

XML Template: VehicleByIdConfig.xml

Function: getVehicleById()


axisConfiguration String Axis configuration name

constructionType String Construction type name



Confidental

Apr 2008


-160

Column Type Description yearOfConstrTo Integer To construction year

[YYYYMM]


powerKwTo Integer To power / KW

powerHpFrom Integer From power / HP

powerHpTo Integer To power / HP

ccmTech Integer Capacity / ccm

tonnage Integer Tonnage / T

modId Long Model ID


Request Parameter: Name Type States Description carId long Result of vehicle selection Vehicle


Language

Country string Country code according to ISO 3166

Country

2.9.11 Get vehicle details (terms) Find vehicle terms.

XML Template: VehicleByIdWithTermConfig.xml

Function: getVehicleByIdWithTerm()



Confidental

Apr 2008


-160

Column Type Description modId Long Model ID


carType String Vehicle type


modelName String Model name

Request Parameter: Name Type States Description carId long Result of vehicle selection Vehicle ID


Language

country string Country code according to ISO 3166

Country

countryUserSetting string Country code according to ISO 3166

Country of article assignments

2.9.12 Get vehicle details (Passenger car details) Find vehicle details.

XML Template: PassengerCarDetailsConfig.xml

Function: getPassengerCarDetails()

Result: Column Type Description manuName String Manufacturer


typeName String Type name

constructionType String Construction type


Confidental

Apr 2008


-160

Column Type Description fuelType String Fuel type

impulsionType String Impulsion Type

brakeSystem String Brake system

motorType String Motor type

yearOfConstructionFrom Integer From construction year [YYYYMM]

yearOfConstructionTo Integer To construction year [YYYYMM]

powerKW Integer Power / KW

powerHP Integer Power / HP

cylinderCapacityCcm Integer Cylinder capacity / CCM

cylinderCapacityLiter Integer Cylinder capacity / Liter

cylinder Integer Cylinder

typeNumber Integer Type number

valves Integer Valves

fuelTypeProcess String Fuel type process

Request Parameter: Name Type States Description carId long Result of vehicle selection Vehicle ID


Language


Country


Confidental

Apr 2008


-160

2.9.13 Get all vehicle details by a list Find vehicle detail information by a list of ID´s.

XML Template: VehicleByIdsConfig.xml

Function: getVehicleByIds()

Result: Records Description VehicleDetails Vehicle Details (see

2.9.10)

VehicleTerms Vehicle Terms (see 2.9.11)

PassengerCarDetails Passenger Car details (see 2.9.12)

MotorCodes Motor Codes (see 2.9.2.1)

Request Parameter: Name Type States Description carIds longList Result of vehicle selection List of Vehicle ID’s

(max 25)


Language


Country

countryUserSetting

string Country code according to ISO 3166


vehicleTerms boolean If true, get vehicle terms Vehicle terms

passengerCarDetails

boolean If true, get passenger car details

Passenger car details

motorCodes boolean If true, get motor codes Motor Codes


Confidental

Apr 2008


-160

2.9.14 Get all vehicle details by a list of string id’s Find vehicle detail information by a list of string id’s. It is only needed for compatibility to environments missing the "long" data type (like php). If possible do not call this function, instead call the original function (with an array of long).

XML Template: VehicleByIdsStringListConfig.xml

Function: getVehicleByIdsStringList()

Result: Records Description VehicleDetails Vehicle Details (see

2.9.10)

VehicleTerms Vehicle Terms (see 2.9.11)

PassengerCarDetails Passenger Car details (see 2.9.12)

MotorCodes Motor Codes (see 2.9.2.1)

Request Parameter: Name Type States Description carIds stringList Result of vehicle selection List of Vehicle ID’s

(max 25)


Language


Country

countryUserSetting

string Country code according to ISO 3166


vehicleTerms boolean If true, get vehicle terms Vehicle terms

passengerCarDet boolean If true, get passenger car Passenger car


Confidental

Apr 2008


-160

Name Type States Description ails details details

motorCodes boolean If true, get motor codes Motor Codes

2.10 Get body types Find body types.

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

XML Template: VendorIdsConfig.xml

Function: getVendorIds()

Result: Column Type Description vendorName String Body type name



markId Long Body type ID

linkedCars Integer Count of car assignments

linkedArticles Integer Count of article assignments direct to the body type


Confidental

Apr 2008


-160



Vehicle type


Language

countryUserSetting string Country code according to ISO 3166







searchPattern string Search pattern Search pattern for body type like ‘4B’

searchExact boolean true: exact search false: no exact search

Flag: exact search

2.10.2 Get vehicles by body type ID Find vehicles by their body type ID.

XML Template: VehicleIdsByVendorIdConfig.xml

Function: getVehicleIdsByVendorId()

Result: Column Type Description carId Long Car ID



Confidental

Apr 2008


-160

term String Short vehicle description



Vehicle type

manuId long Manufacturer ID Id of the vehicle manufacturer like ‘55’ for ‘IVECO’

vendorName string Vendor name Body type name like ‚E3MPC1A1’







Language

2.10.3 Get body type by ID Find a body type by its ID.

XML Template: MarkByIdConfig.xml

Function: getMarkById()

Result: Column Type Description markId Long Body type ID

markName String Body type name


Confidental

Apr 2008


-160

manuName String Name of vehicle manufacturer

linkedCars Integer Count of linked cars

Request Parameter: Name Type States Description markId long Body type ID Body type ID



lang string Language nach ISO 639 Language


Country

2.10.4 Get vehicle ID’s by body type Find vehicle ID’s by body type.

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


Language


Confidental

Apr 2008


-160

Name Type States Description countryUserSetting string Country code according

to ISO 3166 Country for article assignments






2.11 Get motors Find motors.

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



Vehicle type



Fuel type ID


Confidental

Apr 2008


-160

Name Type States Description cylinderCapacityFrom Integer Capacity / ccm From capacity


powerHpType Boolean true: HP false: KW Power type

powerFrom Integer Power / HP or Power / HP or null

From Power

powerTo Integer Power / HP or Power / KW or null

To Power

sellsTerm String Sales description Sales description

motorCode String Motor code Motor code


Language


Country

2.11.1 Get motor manufacturers Find motor manufacturers.

XML Template: MotorManufacturers2Config.xml

Function: getMotorManufacturers2()



Request Parameter: Name Type States Description lang string Language code according to ISO

639 Language


Confidental

Apr 2008


-160

Name Type States Description country string Country code according to ISO

3166 Country

2.11.2 Get motor details Find motor details.

XML Template: MotorByIdConfig.xml

Function: getMotorById()


manuId Long Motor manufacturer ID

manuText String Manufacturer name


cylinder Integer Number of cylinder



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

2.11.3 Get motor details by a list


Confidental

Apr 2008


-160

Find motor details by a list of long id's.

XML Template: MotorByIdsConfig.xml

Function: getMotorByIds()

Result: Records Description MotorDetails Motor Details (see 2.11.2)

Request Parameter: Name Type States Description motorIds longList Result of motor selection Motor ID’s (max

25)



Country

2.11.4 Get motor details by a list of string id’s Find motor details by a list of string id's. It is only needed for compatibility to environments missing the "long" data type (like php). If possible do not call this function, instead call the original function (with an array of long).

XML Template: MotorByIdsStringListConfig.xml

Function: getMotorByIdsStringList()


Confidental

Apr 2008


-160

Result: Records Description MotorDetails Motor Details (see 2.11.2)

Request Parameter: Name Type States Description motorIds stringLis

t Result of motor selection Motor ID’s (max

25)



Country

2.11.5 Get motors by motorcode (advanced selection) Find motors by motor code.

XML Template: MotorsByCarTypeManuIdTermConfig.xml

Function: getMotorsByCarTypeManuIdTerm()


manuId Long Motor manufacturer ID

manuText String Manufacturer name


cylinder Integer Number of cylinder



sellsTerm String Sales description



Confidental

Apr 2008


-160




Vehicle type

motorCode String Motor code Motor code like ‚AEL’







2.12 Get axles Find axles.

XML Template: AxleIdByTypeManCriteria2Config.xml

Function: getAxleIdByTypeManCriteria2()

Result: Column Type Description axleId Long Axle ID


Confidental

Apr 2008


-160

Request Parameter: Name Type States Description manuId long Result of axle manufacturer

selection Manufacturer ID

modelId Long Result of axle model selection

Axle model ID

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 selection

Brake size ID



Language

2.12.1 Get axle manufacturers Return all axle manufacturers.

XML Template: AxlesManufacturers2Config.xml

Function: getAxlesManufacturers2()



Request Parameter: Name Type States Description Lang String Language code according to ISO Language


Confidental

Apr 2008


-160

Name Type States Description 639


2.12.2 Get axle models Find axle models.

XML Template: AxleModelsConfig.xml

Function: getAxleModels()

Result: Column Type Description modelId Long Modell ID




Request Parameter: Name Type States Description manuId long Result of axle manufacturer

selection Manufacturer ID


Language


Country

2.12.3 Get brake sizes


Confidental

Apr 2008


-160

Return all available brake sizes.

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

639 Language



Confidental

Apr 2008


-160

2.12.4 Get axle types Return all available axle types.

XML Template: AxleTypesConfig.xml

Function: getAxleTypes()

Result: Column Type Description axleTypeId Long Axle type ID

axleTypeName String Axle type name


639 Language



Confidental

Apr 2008


-160

2.12.5 Get axle styles Return all available axle styles.

XML Template: AxleStylesConfig.xml

Function: getAxleStyles()

Result: Column Type Description axleStyleId Long Axle style ID

axleStyleName String Axle style name


639 Language


2.12.6 Get axle details Find axle details.

XML Template: AxleByIdConfig.xml

Function: getAxleById()


Confidental

Apr 2008


-160

Result: Column Type Description axleId Long Axle ID

axleDescription String Axle description



manuShortName String Manufacturer short name

modelId Long Axle model ID


axleTypeId Long Axle type ID



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


Language


Country

2.12.7 Get axle details by a list Find axle details by a list of long id’s.

XML Template: AxleByIdsConfig.xml


Confidental

Apr 2008


-160

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)


Language


Country

2.12.8 Get axle details by a list of string id’s Find axle details by a list of string id’s. It is only needed for compatibility to environments missing the "long" data type (like php). If possible do not call this function, instead call the original function (with an array of long).

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)


Confidental

Apr 2008


-160

Name Type States Description Lang string Language code according to ISO

639 Language


Country

2.13 Get assembly groups Find aasembly groups.

2.13.1 Get shortcuts for assembly groups Find shortcuts for assembly groups.

XML Template: ShortCuts2Config.xml Function: getShortCuts2() Result: Column Type Description shortCutId Long Shortcut ID

shortCutName String Shortcut name

Request Parameter: Name Type States Description linkingTargetType string Linking target type:

C: Vehicle M: Motor A: Axles K: Body Type U: Universal

Linking target type


Language


Confidental

Apr 2008


-160

2.13.2 Get linked shortcuts for assembly groups Find shortcuts for assembly groups, if any articles are linked to it.

XML Template: LinkedShortCutsConfig.xml Function: getLinkedShortCuts() Result: Identical structure as function getShortCuts2() (see 2.13.1)


C: Vehicle M: Motor A: Axles K: Body Type U: Universal

Linking target type

linkingTargetId Long Linking target ID according to the linking target type: C: Vehicle ID M: Motor ID A: Axle ID K: Body Type ID U: null

Linking target ID


Language



2.13.3 Get assembly groups by shortcut


Confidental

Apr 2008


-160

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


C: Vehicle M: Motor A: Axle K: Body Type U: Universal

Linking target type

parentNodeId Long Parent node ID or null, if root node

Parent node ID

shortCutId long Result of shortcut selection Shortcut ID


Language

childNodes boolean true, if child nodes of assembly group should be selected too else false

Flag: child nodes selection


Confidental

Apr 2008


-160

2.13.4 Get linked assembly groups by shortcut Find vehicle, motor, axle or universal assembly groups by a shortcut for the search tree, if any articles are linked to it.

XML Template: LinkedChildNodesAllLinkingTargetShortCutSpecialConfig.xml Function: getLinkedChildNodesAllLinkingTargetShortCut() Result: Identical structure as function getChildNodesAllLinkingTargetShortCut() (see 2.13.3) Request Parameter: Name Type States Description linkingTargetType string Linking target type:


Linking target type

linkingTargetId Long Linking target ID according to the linking target type: C: Vehicle ID M: Motor ID A: Axle ID K: Body Type ID U: null

Linking target ID

parentNodeId Long Parent node ID or null, if root node

Parent node ID

shortCutId long Result of shortcut selection Shortcut ID

lang string Language code according to Language


Confidental

Apr 2008


-160

Name Type States Description ISO 639



childNodes boolean true, if child nodes of assembly group should be selected too else false


2.13.5 Get assembly groups Find vehicle, axle, motor or universal assembly groups for the search tree.

XML Template: ChildNodesAllLinkingTarget2SpecialConfig.xml

Function: getChildNodesAllLinkingTarget2()

Result: 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



Linking target type


Confidental

Apr 2008


-160

Name Type States Description parentNodeId Long Parent node ID or null in

case of root node Parent node ID


Language

childNodes boolean True if child nodes of assembly group should be selected too else false (has no effect on the selection of the root node)


2.13.6 Get linked assembly groups Find vehicle, axle, motor or universal assembly groups for the search tree, if any articles are linked to it.

XML Template: LinkedChildNodesAllLinkingTargetSpecialConfig.xml

Function: getLinkedChildNodesAllLinkingTarget()

Result: Identical structure as function getChildNodesAllLinkingTarget() (see 2.13.5)



Linking target type

linkingTargetId Long Linking target ID according to the linking target type:

Linking target ID


Confidental

Apr 2008


-160

Name Type States Description C: Vehicle ID M: Motor ID A: Axle ID K: Body Type ID U: null

parentNodeId Long Parent node ID or null in case of root node

Parent node ID


Language



childNodes boolean True if child nodes of assembly group should be selected too else false (has no effect on the selection of the root node)


2.14 Get articles (direct search) Find article by all number types.

2.14.1 Get articles Find articles by all number types.

XML Template: ArticleDirectSearchAllNumbersSpecialConfig.xml

Function: getArticleDirectSearchAllNumbers() Result: Column Type Description articleId Long Article ID

articleNo String Article number


Confidental

Apr 2008


-160

Column Type Description articleName String Article name

articleSearchNo String Article search number

brandNo Integer Brand number


genericArticleId Long Generic Article number

numberType Integer TecDoc number type: 0: Article number 1: OE number 2: Trade number 3: Comparable number 4: Replacement number

If the count of found articles exceeds 2000, the function returns an error 413 instead of the article list.

Request Parameter: Name Type States Description numberType integer 0: Article number

1: OE number 2: Trade number 3: Comparable number 10: Any number 11: Seller number Others tbd

Number type

articleNumber string Article number (will be converted in the search process in a simplified article number)

Article number

searchExact boolean true: exact search false: similar search

Search mode

sortType integer 1: Brand 2: Product group Others tbd

Sort mode


Language


Confidental

Apr 2008


-160


3166 Country

2.14.2 Get articles by brandno and generic articleid Find article by all number types and brandno and generic articleId.

XML Template: ArticleDirectSearchAllNumbers2SpecialConfig.xml

Function: getArticleDirectSearchAllNumbers2() Result: Identical structure as function getArticleDirectSearchAllNumbers() (see:2.14.1).

Request Parameter: Name Type States Description numberType integer 0: Article number

1: OE number 2: Trade number 3: Comparable number 10: Any number 11: Seller number Others tbd

Number type

articleNumber string Article number (will be converted in the search process in a simplified article number)

Article number

searchExact boolean true: exact search false: similar search

Search mode

sortType integer 1: Brand 2: Product group Others tbd

Sort mode


Language


Confidental

Apr 2008


-160


3166 Country

brandno Long Result of brand selection Brand number

genericArticleId Long Result of generic article selection

Generic article ID

2.14.3 Get article basic information (deprecated) Find basic information of an article.

XML Template: ArticleDirectSearchByIdConfig.xml

Function: getArticleDirectSearchById()

Result: Column Type Description articleId Long Article ID


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



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


Confidental

Apr 2008


-160

Column Type Description else false

hasSecurityInfo Boolean true if security info is available else false

hasPartList Boolean true if a part list is available else false

hasOEN Boolean true if OE numbers are available else false

hasUsage Boolean true if trade numbers are available else false

hasVehicleLink Boolean true if vehicle links are available else false

hasMotorLink Boolean true if motor links are available else false

hasAxleLink Boolean true if axle links are available else false

hasCsGraphics Boolean true if context sensitive graphics are available else false

hasAppendage Boolean true if appendages are available else false

hasLessDiscount Boolean true if less discount is available else false

Request Parameter: Name Type States Description articleId long Result of article selection Article ID

priceDate Integer Price date [YYYYMMDD] Null = current date

Price date


Country


Language

2.14.4 Get article basic information (new) Find basic information of an article (with body type info).


Confidental

Apr 2008


-160

XML Template: ArticleDirectSearchById2Config.xml

Function: getArticleDirectSearchById2()













hasDocuments Boolean true if documents are available else false





hasVehicleLink Boolean true if vehicle links are available


Confidental

Apr 2008


-160







hasMarkLink Boolean true if body type links are available else false

Request Parameter: Identical structure as function getArticleDirectSearchById() (see 2.14.3)

2.14.5 Get all article detail information by article list (deprecated) Find all detail information of a list of articles.

XML Template: DirectArticlesByIdsConfig.xml

Function: getDirectArticlesByIds()

Result: Records Description directArticle Article basic information (see 2.14.3)

assignedArticle Not used

immediateAttributs Article main attributes (see 2.18.1)

immediateInfo Article main info (see 2.18.2)


Confidental

Apr 2008


-160

normalAustauschPrice Normal price (see 2.18.3)

eanNumber EAN number (see 2.19.1)

usageNumbers Trade numbers (see 2.19.2)

replacedNumber Replacement number (see 2.19.3)

replacedByNumber Replaced by numbers (see 2.19.3)

articleAttributes Article attributes (see 2.19.5)

articleInfo Article information (see 2.19.6)

mainArticle Main articles of part articles (see 2.19.7)

articleDocuments Documentdescription (see 2.20)

documentData Documentdata (see 2.23)

articlePrices Article catalog prices (see 2.24)

oenNumbers OE numbers (see 2.25)

Request Parameter: Name Type States Description articleId LongList Results of article

selection List of Article ID’s (max. 25 entries)


Price date


Country


Language

immediateAttributs

boolean If true, get immediate attributes (see 2.18.1) else false

Article main attributes

immediateInfo boolean If true, get immediate info (see 2.18.2) else false

Article main info

normalAustauschPrice

boolean If true, get normal price (see 2.18.3)

Normal price


Confidental

Apr 2008


-160

Name Type States Description else false

eanNumbers boolean If true, get EAN number (see 2.19.1) else false

EAN number

usageNumbers boolean If true, get trade number (see 2.19.2) else false

Trade numbers

replacedNumbers

boolean If true, get replace-ment number (see 2.19.3) else false

Replacement number

replacedByNumbers

boolean If true, get replaced by numbers (see 2.19.3) else false

Replaced by numbers

attributs boolean if true, get article attributes (see 2.19.5) else false

Article attributs

info boolean If true, get article information (see 2.19.6) else false

Article information

mainArticles boolean If true, get main articles (see 2.19.7) else false

Main articles of part articles

documents boolean If true, get documents (see 2.20) else false

Document description

documentsData boolean If true, get documents data (see 2.23) else false

Documentdata

prices boolean If true, get article catalog prices (see 2.24) else false

Article catalog prices

oeNumbers boolean If true, get OE numbers (see 2.25) else false

OE numbers

2.14.6 Get all article detail information by article string list (deprecated)


Confidental

Apr 2008


-160

Find all detail information of a list of articles.

XML Template: DirectArticlesByIdsStringListConfig.xml

Function: getDirectArticlesByIdsStringList()

Result: Identical structure as function getDirectArticlesByIds() (see: 2.14.5).

Request Parameter: Name Type States Description articleId StringList Results of article

selection List of Article ID’s (max. 25 entries)


Price date


Country


Language

immediateAttributs




Article main info


boolean If true, get normal price (see 2.18.3) else false

Normal price

eanNumbers boolean If true, get EAN number (see 2.19.1)

EAN number


Confidental

Apr 2008


-160

Name Type States Description else false


Trade numbers

replacedNumbers


Replacement number

replacedByNumbers


Replaced by numbers


Article attributs


Article information



documents boolean If true, get document (see 2.20) else false


documentsData boolean If true, get documentdata (see 2.23) else false

Documentdata




OE numbers

2.14.7 Get all article detail information by single article (deprecated) Find all detail information of a single article.

XML Template: DirectArticlesByIdsSingleConfig.xml


Confidental

Apr 2008


-160

Function: getDirectArticlesByIdsSingle()

Result: Identical structure as function getDirectArticlesByIds() (see: 2.14.5).

Request Parameter: Name Type States Description articleId long Results of article

selection Article ID


Price date


Country


Language

immediateAttributs




Article main info



Normal price


EAN number


Trade numbers


Confidental

Apr 2008


-160

Name Type States Description replacedNumbers


Replacement number

replacedByNumbers


Replaced by numbers


Article attributs


Article information


Main articles of part articles (see 2.19.7)

documents boolean If true, get document (see 2.20) else false


documentsData boolean If true, get documentdata (see 2.23) else false

Documentdata




OE numbers

2.14.8 Get all article detail information by article list (new) Find all detail information of a list of articles (with body type info).

XML Template: DirectArticlesByIds2Config.xml

Function: getDirectArticlesByIds2()


Confidental

Apr 2008


-160

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()


Request Parameter: Identical structure as function getDirectArticlesByIdsStringList() (see: 2.14.6).

2.14.10 Get all article detail information by single article (new) Find all detail information of a single article (with body type info).

XML Template: DirectArticlesByIds2SingleConfig.xml

Function: getDirectArticlesByIds2Single()


Confidental

Apr 2008


-160


Request Parameter: Identical structure as function getDirectArticlesByIdsSingle() (see: 2.14.7).

2.15 Get generic articles and brands Find generic articles

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

XML Template: GenericArticlesByManufacturer2Config.xml

Function: getGenericArticlesByManufacturer2()

Result: Column Typ Description assemblyGroupNodeId Long Assembly group node ID

parentNodeId Long Parent node ID of assembly group node


articleNormName String Article standard name




Confidental

Apr 2008


-160


C: Vehicle M: Motor A: Axle K: Body type U: Universal Other tbd

Linking target type

linkingTargetId Long Linking target ID according to the linking target type: C: Vehicle ID M: Motor ID A: Axle ID K: Body type ID U: null

Linking target ID

assemblyGroupNodeId

long Result of assembly group selection

Assembly group node ID

childNodes boolean false:Standard true:show detail information of all child nodes of the assembly group


brandNo Integer In case of limitation to brand number else null

Brand number

genericArticleId Long In case of limitation to generic article number else null

Generic article number

sortMode integer Sort mode: 1: Brand name 2: Article norm name Others tbd

Sort mode


Language


Confidental

Apr 2008


-160

Name Type States Description country string Country code according to

ISO 3166 Country

2.15.2 Get generic articles and brands by list Find generic articles by an assembly group.



Result: Column Typ Description assemblyGroupNodeId Long Assembly group node ID








Linking target type


Confidental

Apr 2008


-160

Name Type States Description linkingTargetId Long Linking target ID according

to the linking target type: C: Vehicle ID M: Motor ID A: Axle ID K: Body type ID U: null

Linking target ID

assemblyGroupNodeId





brandNo LongList In case of limitation to brand numbers else null

List of Brand numbers

genericArticleId LongList In case of limitation to generic article numbers else null

List of Generic article numbers


Sort mode


Language


Country

2.15.3 Get generic articles and brands by string list


Confidental

Apr 2008


-160

Find generic articles by an assembly group.

XML Template: GenericArticlesByManufacturer3StringListConfig.xml

Function: getGenericArticlesByManufacturer3StringList()

Result: Identical structure as function getGenericArticlesByManufacturer3() (see:2.15.2).


C: Vehicle M: Motor A: Axle U: Universal Other tbd

Linking target type

linkingTargetId Long Linking target ID according to the linking target type: C: Vehicle ID M: Motor ID A: Axle ID U: null

Linking target ID

assemblyGroupNodeId





brandNo StringList In case of limitation to brand numbers else null



Confidental

Apr 2008


-160

Name Type States Description genericArticleId StringList In case of limitation to

generic article numbers else null



Sort mode


Language


Country

2.15.4 Get distinct generic articles and brands by list Find generic articles by an assembly group with distinct result.



Result: Column Typ Description genericArticleId Long Generic article ID





C: Vehicle Linking target type


Confidental

Apr 2008


-160

Name Type States Description M: Motor A: Axle K: Body type U: Universal Other tbd


Linking target ID

resultMode Integer 1:Distinct brand numbers 2:Distinct generic articles 3:Both (standard) Null:Standard choose (=Both)

Result mode

assemblyGroupNodeId



brandNo LongList In case of limitation to brand numbers else null


genericArticleId LongList In case of limitation to generic article numbers else null



Sort mode


Language


Country


Confidental

Apr 2008


-160

2.15.5 Get distinct generic articles and brands by string list Find generic articles by an assembly group with distinct result.

XML Template: GenericArticlesByManufacturer4StringListConfig.xml

Function: getGenericArticlesByManufacturer4StringList()

Result: Identical structure as function getGenericArticlesByManufacturer4() (see:2.15.4).



Linking target type


Linking target ID

resultMode Integer 1:Distinct brand numbers 2:Distinct generic articles 3:Both (standard) Null:Standard choose

Result mode


Confidental

Apr 2008


-160

Name Type States Description (=Both)

assemblyGroupNodeId



brandNo StringList In case of limitation to brand numbers else null


genericArticleId StringList In case of limitation to generic article numbers else null



Sort mode


Language


Country

2.16 Get articles (search tree)

2.16.1 Get articles by generic article (product group) (deprecated) Find articles by generic article (product group) and assembly group.

XML Template: ArticleIdsByGenericArticleConfig.xml

Function: getArticleIdsByGenericArticle()

Result: Column Type Description assemblyGroupNodeId Long Assembly group node



Confidental

Apr 2008


-160

Column Type Description articleLinkId Long Article link ID

articleId Long Article ID





sortNo Integer Sort number


C: Vehicle M: Motor A: Axle K: Body type U: Universal Others tbd

Linking target type


Linking target ID

assemblyGroupNodeId


Search node ID



brandNo Integer In case of limitation to brand Brand number


Confidental

Apr 2008


-160

Name Type States Description number else null

genericArticleId long Generic article number (product group)



Country

2.16.2 Get articles by brand number (deprecated) Find articles by brand number and assembly group.

XML Template: ArticleIdsByPartManufacturerConfig.xml

Function: getArticleIdsByPartManufacturer()



articleLinkId Long Article link ID




genericArticleName String Generic article name



Request Parameter: Name Type States Description linkingTargetType string C: Vehicle Linking target


Confidental

Apr 2008


-160

Name Type States Description M: Motor A: Axle K: Body type U: Universal Others tbd

type


Linking target ID

assemblyGroupNodeId long Result of assembly group selection




brandNo integer Brand number Brand number




Language


Country


Confidental

Apr 2008


-160

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()



articleLinkId Long Article link ID








Request Parameter: Name Type States Description linkingTargetType string C: Vehicle

M: Motor A: Axle K: Body type U: Universal Others tbd

Linking target type


Confidental

Apr 2008


-160

Name Type States Description linkingTargetId Long Linking target ID

according to the linking target type: C: Vehicle ID M: Motor ID A: Axle ID K: Body type ID U: null

Linking target ID





brandNo LongList In case of limitation to Brand number else null

Brand number

genericArticleId LongList In case of limitation to generic article number else null



Language


Country

Sort integer 1: Sort by brandNo 2: sort by genericArticleName

Sorting field


Confidental

Apr 2008


-160

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).



Linking target type


Linking target ID



childNodes boolean false:Standard true:show detail information of all child



Confidental

Apr 2008


-160

Name Type States Description nodes of the assembly group

brandNo StringList In case of limitation to Brand number else null

Brand number

genericArticleId StringList In case of limitation to generic article number else null



Language


Country

sort integer 1: Sort by brandNo 2: sort by genericArticleName

Sorting field

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).


M: Motor A: Axle K: Body type

Linking target type


Confidental

Apr 2008


-160

Name Type States Description U: Universal Others tbd


Linking target ID





brandNo Integer In case of limitation to Brand number else null

Brand number




Language


Country


Sorting field


Confidental

Apr 2008


-160

2.16.6 Get articles by brand number and generic article list Find articles by brand number and generic article and assembly group.

XML Template: ArticleIds2Config.xml

Function: getArticleIds2()

Result: Column Type Description articleLinkId Long Article link ID










Linking target type

linkingTargetId Long Linking target ID according to the linking target type: C: Vehicle ID

Linking target ID


Confidental

Apr 2008


-160

Name Type States Description M: Motor ID A: Axle ID K: Body type ID U: null



brandNo LongList In case of limitation to Brand number else null

Brand number

genericArticleId LongList In case of limitation to generic article number else null



Language


Country

Sort integer 1: Sort by brandNo 2: sort by genericArticleName

Sorting field

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).


Confidental

Apr 2008


-160



Linking target type


Linking target ID



brandNo StringList In case of limitation to Brand number else null

Brand number

genericArticleId StringList In case of limitation to generic article number else null



Language


Country


Sorting field


Confidental

Apr 2008


-160

2.16.8 Get articles by brand number and generic article single Find articles by brand number and generic article and assembly group.

XML Template: ArticleIds2SingleConfig.xml

Function: getArticleIds2Single()

Result: Identical structure as function getArticleIds2() (see: 2.16.6).



Linking target type


Linking target ID



brandNo Integer In case of limitation to Brand number else null

Brand number


Confidental

Apr 2008


-160

Name Type States Description genericArticleId Long In case of limitation to

generic article number else null



Language


Country


Sorting field

2.16.9 Get article basic information (deprecated) Find article basic information, which is assigned to an assembly group.

XML Template: AssignedArticleByIdConfig.xml

Function: getAssignedArticleById()


articleLinkId Long Article link Id


articleAddName String Article additional name




quantityPerPackingUnit Integer Quantiy per packing Unit



Confidental

Apr 2008


-160

Column Type Description 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









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: C: Vehicle M: Motor A: Axle U: Universal

Linking target type


Confidental

Apr 2008


-160

Name Type States Description linkingTargetId Long Linking target ID

according to linking target type: C: Vehicle ID M: Motor ID A: Axle ID U: null

Linking target ID

manuId Long Result of vehicle manufacturer selection if linking target type is: Vehicle, Motor or Axle else null

Manufacturer ID

modId Long Result of vehicle model selection if linking targte type is: Vehicle, Motor or Axle else null

Model ID


Price date


Country


Language

2.16.10 Get article basic information (new) Find article basic information, which is assigned to an assembly group (with body type info).

XML Template: AssignedArticleById2Config.xml

Function: getAssignedArticleById2()


Confidental

Apr 2008


-160


articleLinkId Long Article link Id


articleAddName String Article additional name




quantityPerPackingUnit Integer Quantiy per packing Unit




hasPartList Boolean true if part list is available else false








hasLessDiscount Boolean true if less discount is available


Confidental

Apr 2008


-160



Request Parameter: Identical structure as function getAssignedArticleById() (see 2.16.9)

2.16.11 Get all article detail information by article list (deprecated) Find all article detail information, which is assigned to an assembly group.

XML Template: AssignedArticlesByIdsConfig.xml

Function: getAssignedArticlesByIds()

Result: Records Description directArticle Not used

assignedArticle Article basic information (see:2.16.9)

immediateAttributs Article main attributes (see 2.18.1)

immediateInfo Article main info (see 2.18.2)

normalAustauschPrice Normal price (see 2.18.3)

eanNumber EAN number (see 2.19.1)

usageNumbers Trade numbers (see 2.19.2)

replacedNumber Replacement number (see 2.19.3)

replacedByNumber Replaced by numbers (see 2.19.3)

articleAttributes Article attributes (see 2.19.5)

articleInfo Article information (see 2.19.6)

mainArticle Main articles of part articles (see 2.19.7)


Confidental

Apr 2008


-160

articleDocuments Documentdescription (see 2.20)

documentData Documentdata (see 2.23)

articlePrices Article catalog prices (see 2.24)

oenNumbers OE numbers (see 2.25)

Request Parameter: Name Type States Description articleIdPairs ArticleIdPairSeq Result of article

selection (articleId and articleLinkId)

List of article ID pairs with max. 25 entries. (see comment below)

linkingTargetType

String Linking target type:C: Vehicle M: Motor A: Axle U: Universal

Linking target type

linkingTargetId Long Linking target ID according to linking target type: C: Vehicle ID M: Motor ID A: Axle ID U: null

Linking target ID


Manufacturer ID


Model ID

priceDate Integer Price date [YYYYMMDD]

Price date


Confidental

Apr 2008


-160

Name Type States Description Null = current date


Country


Language

immediateAttributs




Article main info



Normal price


EAN number


Trade numbers

replacedNumbers

boolean If true, get replacement number (see 2.19.3) else false

Replacement number

replacedByNumbers


Replaced by numbers


Article attributs


Article information


Confidental

Apr 2008


-160

Name Type States Description mainArticles boolean If true, get main

articles (see 2.19.7) else false

Main articles of part articles (see 2.19.7)

documents boolean If true, get documents (see 2.20) else false



Documentdata




OE numbers

Comment: ArticleIdPairSeq is a Sequence of ArticleIdPair, which has two fields:

articleId (long) and articleLinkId (long).

2.16.12 Get all article detail information by single article (deprecated) Find all article detail information, which is assigned to an assembly group.

XML Template: AssignedArticlesByIdsSingleConfig.xml

Function: getAssignedArticlesByIdsSingle()

Result:


Confidental

Apr 2008


-160

Identical Structure as function getAssignedArticlesByIds() (see 2.16.11)

Request Parameter: Name Type States Description articleId long Result of article

selection Article ID

articleLinkId long Result of article selection

Articlelink ID

linkingTargetType

String Linking target type:C: Vehicle M: Motor A: Axle U: Universal

Linking target type


Linking target ID


Manufacturer ID


Model ID


Price date

country string Country code according to ISO

Country


Confidental

Apr 2008


-160

Name Type States Description 3166


Language

immediateAttributs




Article main info



Normal price


EAN number


Trade numbers

replacedNumbers

boolean If true, get replacement number (see 2.19.3) else false

Replacement number

replacedByNumbers


Replaced by numbers


Article attributs


Article information




Confidental

Apr 2008


-160

Name Type States Description documents boolean If true, get

documents (see 2.20) else false



Documentdata




OE numbers

2.16.13 Get all article detail information by article list (new) Find all article detail information, which is assigned to an assembly group (with body type info).

XML Template: AssignedArticlesByIds2Config.xml

Function: getAssignedArticlesByIds2()

Result: Identical structure as function getAssignedArticlesByIds() (see: 2.16.11) Exception: The result has a new basic record (see 2.16.10).

Request Parameter: Identical structure as function getAssignedArticlesByIds() (see: 2.16.11) Exception: There is a new linkingTarget type ‘K’ for body type info.


Confidental

Apr 2008


-160

2.16.14 Get all article detail information by single article (new) Find all article detail information, which is assigned to an assembly group (with body type info).

XML Template: AssignedArticlesByIds2SingleConfig.xml

Function: getAssignedArticlesByIds2Single()

Result: Identical structure as function getAssignedArticlesByIdsSingle() (see: 2.16.12) Exception: The result has a new basic record (see 2.16.10).

Request Parameter: Identical structure as function getAssignedArticlesByIdsSingle() (see: 2.16.12) Exception: There is a new linkingTarget type ‘K’ for body type info.

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

1. Articles to be filtered must be assigned to a car, axle, motor or assembly group. Articles found by a direct search can not be filtered.

2. Articles to be filtered must belong to the same generic article. Use the following program flow to filter the articles:

1. Get all filter criteria with function getCritera2() and cache them. The ‘criteria type’ specifies the filter function (see step 5). If ‘dutyFlag’ is set, more than one attribute value of one criterion can be used to specify one article. In this case each attribute value is chooseable and needs to get transfered into the filter function. If the ‘dutyFlag’ is not set, there is only one attribute value choosable and needs to get transfered into the filter function. In the case of no filtering


Confidental

Apr 2008


-160

jump over to the next criterion. If ‘IsInterval’ equals true, the interval filter getCriteriaFilterArticlesByValuesInterval() is usable with two criteria (upper and lower value) to specify one article. The ‘SuccessorId’ is used in the filter function (see step 5).

2. Get the ArticleIds (articleIds and articleLinkIds) by calling function getArticleIds2() for exactly one generic article.

3. Get the possible filter criteria for the requested generic article as response of getRequiredAttributes().

4. Get the filter values for the first (next) criterion and the first (next) article list with function getCriteraAttributesByCriteriaArticles()

5. Filter the article list by the attribute values with the following functions: A. Use function getCriteriaFilterArticlesByValues(), if the criterion is

alphanumeric (see step 1). B. Use function getCriteriaFilterArticlesByValuesNumeric(), if the criterion

is numeric (see step 1). C. You may use function getCriteriaFilterArticlesByValuesInterval(), if the

criterion is interval (see step 1). 6. Go further with step 4 until all filter criteria are used.

2.17.1 Get required Attributs (Criteria) Find required criterias of a generic article.

XML Template: RequiredAttributesConfig.xml

Function: getRequiredAttributes()

Result: Column Type Description criteriaId Long Criteria ID

dutyFlag Boolean Duty flag


Confidental

Apr 2008


-160

Request Parameter: Name Type States Description genericArticleId long Result of generic article

selection Generic article number


Country

2.17.2 Get attribute values of articles Find attribute values of articles.

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 longList

Result of article selection

List of article ID’s

articleLinkIds LongList Result of article selection

List of articlelink ID’s


Country


Language


Confidental

Apr 2008


-160

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

XML Template: CriteriaAttributesByCriteriaArticlesStringListConfig.xml

Function: getCriteriaAttributesByCriteriaArticlesStringList()

Result: Identical structure as function getCriteriaAttributesByCriteriaArticles (see: 2.17.2)


articleIds stringList



articleLinkIds StringList




Country


Language

2.17.4 Get articles filtered by attribute string values Find articles by attribute values.

XML Template: CriteriaFilterArticlesByValuesConfig.xml

Function: getCriteriaFilterArticlesByValues()


Confidental

Apr 2008


-160


articleLinkId Long Articlelink ID


linkingTargetType

string Linking target type: C: Vehicle M: Motor A: Axle K: Body type U: Universal

Linking target type

articleIds longList





attributeValues stringList

List of attribute values List of attribute values


Country


Language

2.17.5 Get articles filtered by attribute string values stringlist Find articles by attribute values stringlist.

XML Template: CriteriaFilterArticlesByValuesStringListConfig.xml

Function:


Confidental

Apr 2008


-160

getCriteriaFilterArticlesByValuesStringList()

Result: Identical structure as function getCriteriaFilterArticlesByValues (see: 2.17.4) Request Parameter: Name Type States Description criteriaId long Criteria ID Criteria ID

linkingTargetType


Linking target type










Country


Language

2.17.6 Get articles filtered by attribute numeric values Find articles by attribute numeric values.

XML Template: CriteriaFilterArticlesByValuesNumericConfig.xml

Function: getCriteriaFilterArticlesByValuesNumeric()


Confidental

Apr 2008


-160




linkingTargetType

string Linking target type: C: Vehicle M: Motor A: Axle U: Universal

Linking target type

articleIds longList








Country


Language

2.17.7 Get articles filtered by attribute numeric values stringlist Find articles by attribute numeric values stringlist.

XML Template: CriteriaFilterArticlesByValuesNumericStringListConfig.xml

Function: getCriteriaFilterArticlesByValuesNumericStringList()


Confidental

Apr 2008


-160

Result: Identical structure as function getCriteriaFilterArticlesByValuesNumeric() (see:2.17.6). Request Parameter: Name Type States Description criteriaId long Criteria ID Criteria ID

linkingTargetType


Linking target type










Country


Language

2.17.8 Get articles filtered by attribute interval values Find articles by attribute interval values.

XML Template: CriteriaFilterArticlesByValuesIntervalConfig.xml

Function: getCriteriaFilterArticlesByValuesInterval()


Confidental

Apr 2008


-160



Request Parameter: Name Type States Description criteriaId Long Criteria ID Criteria ID

criteriaId2 Long Successor criteria ID Successor criteria ID

linkingTargetType


Linking target type

articleIds longList





value1 String Interval value 1 Interval value 1


flagDate boolean

true:value is date false:value is not date

Flag: Is Date


Country


Language

2.17.9 Get articles filtered by attribute interval values stringlist Find articles by attribute interval values stringlist.

XML Template:


Confidental

Apr 2008


-160

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

linkingTargetType


Linking target type









flagDate boolean

true:value is date false:value is not date

Flag: Is Date


Country


Language


Confidental

Apr 2008


-160

2.18 Get article main information Find article main information.

2.18.1 Get article main attributes Find article main attributes.

XML Template: ImmediateAttributsConfig.xml

Function: getImmediateAttributs()

Result: 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


Confidental

Apr 2008


-160


articleLinkId Long In case of assembly group selection article link ID of article selection else (article direct search) null

Article link ID


Country


Language

2.18.2 Get article main information Find article main information.

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)


articleLinkId Long In case of assembly group Article link ID


Confidental

Apr 2008


-160

Name Type States Description selection article link ID of article selection else (article direct search) null


Country


Language

2.18.3 Get article standard price Find article standard price.

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


Confidental

Apr 2008


-160



Price date


Country


Language

2.19 Get article information

2.19.1 Get article EAN number Find article EAN number.

XML Template: EanNumbersConfig.xml

Function: getEanNumbers()

Result: Column Type Description eanNumber String EAN number



Country

2.19.2 Get article trade number


Confidental

Apr 2008


-160

Find article trade number.

XML Template: UsageNumbersConfig.xml

Function: getUsageNumbers()

Result: Column Type Description usageNumber String Trade number



Country

2.19.3 Get article replacement number First flavour: Find article and replacement number which replaces an article.

XML Template: ReplacedNumbersConfig.xml

Function: getReplacedNumbers()

Result: Column Type Description replaceArticleId Long Replacement article ID

replaceNumber String Replacement article number


Confidental

Apr 2008


-160



Country

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



Country

2.19.4 Get URL of extended article information


Confidental

Apr 2008


-160

Find URL of extended article information.

XML Template: ArticleExtUrlByIdConfig.xml

Function: getArticleExtUrlById()

Result: Column Type Description extInfoURL String URL of extended article

information


genericArticleId long Result of article selection Generic article ID

brandNo integer Brand number Brand number


Country


Language

2.19.5 Get article attribute values Find article attribute values.

XML Template: AssignedArticleAttributsConfig.xml

Function: getAssignedArticleAttributs()


Confidental

Apr 2008


-160

Result: Column Type Description attrValueId Long Attribute value ID










articleLinkId Long If assembly group selection: article link ID of article selection, if article direct search: null

Article link ID


Country


Language

2.19.6 Get article information


Confidental

Apr 2008


-160

Find article information.

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)



Article link ID


Country


Language

2.19.7 Get main articles Find main articles of a part article.

XML Template: MainArticlesConfig.xml


Confidental

Apr 2008


-160

Function: getMainArticles()


articleNumber String Article number



Request Parameter: Name Type States Description partArticleId long Result of article selection Part article ID


Country


Language

2.20 Get article documents Find document descriptions to an article.

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)


Confidental

Apr 2008


-160

Column Type Description docTypeId Integer Document type Id

docFileName String File name

docFileTypeName String File type name (e.g. Bitmap)

docText String Document description



Article link ID

docTypeId Integer Document type (KT 141) Document type


Country


Language

2.21 Get article thumbnail documents Find article thumbnail documents.

XML Template: ThumbnailByArticleIdConfig.xml

Function: getThumbnailByArticleId()

Result: Column Type Description thumbDocId Long Document ID

thumbTypeId Integer Document type Id


Confidental

Apr 2008


-160

Column Type Description thumbFileName String File name


2.22 Get article context sensitive document Find context sensitive graphics of an article.

XML Template: CsgDocumentsByArticleIdConfig.xml

Function: getCsgDocumentsByArticleId()

Result: Column Type Description csgId Long Context sensitive graphic ID

csgDocId Long Document ID

csgFileName String File name



Country


Language

2.22.1 Get coordinates by article document Find coordinates by article document. The coordinate system is starting with X=0, Y=0 at the top left of the document.


Confidental

Apr 2008


-160

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


Confidental

Apr 2008


-160

2.22.2 Get article context sensitive document data (deprecated) Find article context sensitive document data.

XML Template: CsgDocumentDataByArticleIdConfig.xml

Function: getCsgDocumentDataByArticleId()

Result: Records Description DocumentData Document data (see

2.23)

ArticePartList Article part list (see 2.29)

ContextGraphicCoordinates Coordinates for context graphic (see 2.22.1)


articleLinkId Long Result of article selection Article link Id

linkingTargetType String Linking target type: C: Vehicle M: Motor A: Axle U: Universal

Linking target type

linkingTargetId Long Linking target ID according to the linking target type: C: Vehicle ID M: Motor ID A: Axle ID

Linking target ID


Confidental

Apr 2008


-160

Name Type States Description U: null

articlePartList boolean If true, get article part list, else false

Flag: Article Part List


Country


Language

2.22.3 Get article context sensitive document data (new) Find article context sensitive document data (with body type info).

XML Template: CsgDocumentDataByArticleId2Config.xml

Function: getCsgDocumentDataByArticleId2()

Result: Records Description DocumentData Document data (see

2.23)

ArticePartList Article part list (see 2.29.1)

ContextGraphicCoordinates Coordinates for context graphic (see 2.22.1)

Request Parameter: Identical structure as function getCsgDocumentDataByArticleId() (see: 2.22.2)


Confidental

Apr 2008


-160

2.23 Get article document data Find document data.

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

2.24 Get article catalog prices Find article catalog prices. This are the recommended prices by the manufacturer.

XML Template: ArticlePricesConfig.xml

Function: getArticlePrices()


Confidental

Apr 2008


-160

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




Price date


Country


Language

2.25 Get article OE numbers Find article OE numbers.

XML Template:


Confidental

Apr 2008


-160

ArticleOENumbersConfig.xml

Function: getArticleOENumbers()

Result: Column Type Description oeNumber String OE number

brandName String Manufacturer name

blockNumber Integer Block number

sortNumber Integer Sort number



Country


Language

2.26 Get manufacturer addresses Find manufacturer addresses.

XML Template: ManufacturerInfosByIdConfig.xml

Function: getManufacturerInfosById()

Result: Column Type Description addressType Integer Address type (KT 059)


Confidental

Apr 2008


-160

Column Type Description addressName String Address name

name String Name

name2 String Name2

street String Street

street2 String Street 2

mailbox String Mailbox

zipCountryCode String Country code for zip

zip String Zip

zipSpecial String Zip special

zipMailbox String Zip mailbox

city String City

city2 String City 2

phone String Phone

fax String Fax

email String Email

wwwURL String URL

logoDocId Long Document ID for logo

Request Parameter: Name Type States Description brandNo integer Result of brand selection Brand number


Country


Language

2.27 Get linked vehicles, motors, axles of an article Find vehicles, motors and axles which are linked to an article.

XML Template: ArticleLinkedAllLinkingTargetSpecialConfig.xml


Confidental

Apr 2008


-160

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


linkingTargetType string Linking target type: C: Vehicle M: Motor A: Axle K: Body type

Linking target type

linkingTargetId Long Selection of linking target ID according to the linking target type, which is excluded C: Vehicle ID M: Motor ID A: Axle ID

Linking target ID


Confidental

Apr 2008


-160

Name Type States Description K: Body type ID


Country


Language

2.27.1 Get linked vehicles, motors, axles of an article by manufacturer Find vehicles, motors and axles of a manufacturer, which are linked to an article.

XML Template: ArticleLinkedAllLinkingTarget2SpecialConfig.xml Function: getArticleLinkedAllLinkingTarget2() Result: Identical structure as function getArticleLinkedAllLinkingTarget () (see:2.27).


linkingTargetType string Linking target type: C: Vehicle M: Motor A: Axle K: Body type

Linking target type

linkingTargetId Long Selection of linking target ID according to the linking target type, which is excluded C: Vehicle ID M: Motor ID

Linking target ID


Confidental

Apr 2008


-160

Name Type States Description A: Axle ID K: Body type ID

linkingTargetManuId Long Selection of linking target manufacturer ID according to the linking target type: C: Vehicle manufacturer ID’s M: Motor manufacturer ID’s A: Axle manufacturer ID’s K: Body type manufacturer ID’s

Linking target manufacturer ID


Country


Language

2.27.2 Get linked vehicle, motor, axle manufacturers of an article Find vehicle, motor and axle manufacturers, which are linked to an article.

XML Template: ArticleLinkedAllLinkingTargetManufacturerSpecialConfig.xml Function: getArticleLinkedAllLinkingTargetManufacturer() Result: Column Type Description manuName String Manufacturer short name

manuId Integer Manufacturer ID



Confidental

Apr 2008


-160

Name Type States Description linkingTargetType string Linking target type:

C: Vehicle M: Motor A: Axle K: Body type

Linking target type


Country

2.27.3 Get article main attributes of a linked article Find article main attributes of a linked article.

XML Template: ImmediateAttributsLinkedElementsConfig.xml Function: getImmediateAttributsLinkedElements() Result: Column Type Description attrId Long Attribute ID







Confidental

Apr 2008


-160

Column Type Description attrSuccessorId Long Successory ID


Request Parameter: Name Type States Description articleLinkId long Result of article selection Article ID


Country


Language

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

2.27.5 Get linked motor details Find linked motor details of an article.

XML Template: ArticleLinkedMotorsByIdConfig.xml

Function: getArticleLinkedMotorsById()




manuDesc String Manufacturer name

powerKw Integer Power / KW


Confidental

Apr 2008


-160

Column Type Description powerHp Integer From power / HP


cylinder Integer Cylinder

assembledFrom String From assembled date

assembledTo String To assembled date


motorId long Result of motor selection Motor ID


Language


Country

2.27.6 Get linked vehicle details Find linked vehicle details of an article.

XML Template: ArticleLinkedVehiclesByIdConfig.xml

Function: getArticleLinkedVehiclesById()


carDesc String Vehicle name


manuDesc String Manufacturer name

modelId Long Model ID


Confidental

Apr 2008


-160

Column Type Description modelDesc String Model name

axisConfiguration String Axis configuration name

constructionType String Construction type name

yearOfConstructionFrom Integer From construction year [YYYYMM]

yearOfConstructionTo Integer To construction year [YYYYMM]


powerKwTo Integer To Power / KW

powerHpFrom Integer From Power / HP

powerHpTo Integer To Power / HP


tonnage Integer Tonnage / T

assembledFrom String From assembled date

assembledTo String To assembled date


carId long Result of vehicle selection Vehicle ID


Language


Country

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


Confidental

Apr 2008


-160

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


linkingTargetType string Linking target type: C: Vehicle M: Motor A: Axles

Linking target type

linkedArticlePairs LinkedArticlePairSeq

Result of linked article selection (see 2.27)

List of linked article


Language


Country

Comment: LinkedArticlePairSeq is a Sequence of LinkedArticlePair, which has two fields:

linkingTargetId (long) and articleLinkId (long).


Confidental

Apr 2008


-160

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


linkingTargetType string Linking target type: C: Vehicle M: Motor A: Axles K: Body type

Linking target type

linkedArticlePairs LinkedArticlePairSeq

Result of linked article selection (see 2.27)

List of linked article


Confidental

Apr 2008


-160

Name Type States Description lang string Language code

according to ISO 639 Language


Country

immediateAttributs

boolean If true, select immediate attributes, else false

Select immediate attributs

Comment: LinkedArticlePairSeq is a Sequence of LinkedArticlePair, which has two fields:

linkingTargetId (long) and articleLinkId (long).

2.28 Get article accessory list Find accessory list.

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

XML Template: ArticleAccessoryListConfig.xml

Function: getArticleAccessoryList()

Result: Column Type Description accessoryLinkId Long Accessory link ID

articleListNo Integer Article list number

accessoryArticleId Long Accessory article ID

accessoryArticleName String Accessory article name




Confidental

Apr 2008


-160

Column Type Description articleAddName String Article add name









quantity Integer Quantity









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


Confidental

Apr 2008


-160

Name Type States Description C: Vehicle M: Motor A: Axle U: Universal


Linking target ID


Manufacturer ID


Model ID


Price date


Country


Language

2.28.2 Get article accessory list (new) Find accessory list of an article (with body type info).

XML Template: ArticleAccessoryList3Config.xml

Function: getArticleAccessoryList3()


Confidental

Apr 2008


-160

Result: Column Type Description accessoryLinkId Long Accessory link ID

articleListNo Integer Article list number

accessoryArticleId Long Accessory article ID

accessoryArticleName String Accessory article name





















Confidental

Apr 2008


-160

Column Type Description hasAxleLink Boolean true if axle links are available

else false


Request Parameter: Identical structure as function getArticleAccessoryList2() (see 2.28.1) Exception: There is a new linkingTargetType ‘K’ for body type info

2.28.3 Get article accessory list with attributes (deprecated) Find accessory list of an article with attributs.



Result: Records Description AccessoryDetails Accessory Details (see: 2.28.1) AccessoryAttributs Accessory Attributs (see:2.28.6)

Request Parameter: Identical structure as function getArticleAccessoryList() (see: 2.28.1).

2.28.4 Get article accessory list with attributes (new) Find accessory list of an article with attributes (with body type info).



Confidental

Apr 2008


-160


Result: Records Description AccessoryDetails Accessory Details (see: 2.28.2) AccessoryAttributs Accessory Attributs (see:2.28.6)

Request Parameter: Identical structure as function getArticleAccessoryList3() (see: 2.28.2).

2.28.5 Get article accessory list existing information Find information, if accessory list of an article exists.

XML Template: ArticleHasAccessoryListConfig.xml

Function: getArticleHasAccessoryList()

Result: Column Type Description articleAccessoryId Long Article accessory ID


Confidental

Apr 2008


-160


universalFlag boolean true if universal article else false

Flag: universal article selection

manuId Long Result of manufacturer selection if not an universal article

Manufacturer ID

modelId Long Result of model selection if not an universal article

Model ID

carId Long Result of vehicle selection if not an universal article

Vehicle ID

motorId Long Result of motor slection if not an universal article

Motor ID


Country

2.28.6 Get article main attribute of an accessory article Find article main attributes of an accessory article.

XML Template: ArticleAccessoryImmediateAttributsConfig.xml

Function: getArticleAccessoryImmediateAttributs()

Result: Column Type Description isAccessoryAttr Boolean true if accessory attribute

else false


attrType String Attribute type: A: Alphanumeric N: Numeric


Confidental

Apr 2008


-160

Column Type Description D: Date K: Key V: Without value Others tbd








articleAccessoryId long Result of article accessory selection

Article accessory ID


Language


Country

2.29 Get article part list (deprecated) Find part list of an article.

XML Template: ArticlePartListConfig.xml

Function: getArticlePartList()


Confidental

Apr 2008


-160

Result: Column Type Description partId Long Part article link ID

partArticleId Long Part article ID







genericArticleName String Generic article number



packingUnit Integer Packing unit












Confidental

Apr 2008


-160


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


Price date


Country

lang String Language code according to ISO 639

Language

2.29.1 Get article part list (new) Find part list of an article (with body type info).

XML Template: ArticlePartList2Config.xml

Function: getArticlePartList2()

Result: Column Type Description partId Long Part article link ID

partArticleId Long Part article ID






Confidental

Apr 2008


-160

Column Type Description articleStateName String Article state name (KT 073)


genericArticleName String Generic article number



packingUnit Integer Packing unit













articleLinkId Long Result of article selection Article link ID

carId Long Result of car selection Car ID


Confidental

Apr 2008


-160

Name Type States Description axleId Long Result of axle selection Axle ID

motorId Long Result of motor selection Motor ID

markId Long Result of body type selection Body type ID


Price date


Country


Language

2.30 Version info Get version info about the currently running service.

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.


Confidental

Apr 2008


-160

Request Parameter: Column Type Description

2.31 Add dynamic address Permit access to the webservice to the specified address for a limited time. This function is allowed to be called only from existant static addresses.

Function: addDynamicAddress()

Result: 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.