TMW Web-API Schnittstelle

Version: 2.5.5

Server: TSQLCL01.TMW.AC.AT\TMW

KFZ-Funktionen

Home

Rätsel-Rallye Funktionen

Adlib-Funktionen

Kundenkonto-Funktionen

KFZ-Funktionen

Versionsgeschichte

Allgemeine Funktionen

Event Funktionen

---

Swagger

Allgemein
Headers Values
Authorization Basic
Content-Type application/json

State
Property Type Description
State String Name of the State
Count Int Number of dispossessed vehicles
State - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of all States GET --- --- --- List[State] https://webapi.tmw.at/kfz/state
Get the State of a district GET district String Name of the disctrict List[State] https://webapi.tmw.at/kfz/state?district=Linz
Get all States where the defined vehicle type was dispossessed. GET type_id Int Primary-Key of the vehicle type List[State] https://webapi.tmw.at/kfz/state?type_id=21849
Get the State of a district where the defined vehicle type was dispossessed. GET type_id Int Primary-Key of the vehicle type List[State] https://webapi.tmw.at/kfz/state?district=Linz&type_id=21849
district String Name of the district

District
Property Type Description
District String Key-Field
DistrictName String Name to display
Count Int Number of dispossessed vehicles
District - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of all districts GET --- --- --- List[District] https://webapi.tmw.at/kfz/district
Get all districts of a State GET state String Name of State List[District] https://webapi.tmw.at/kfz/district?state=Oberösterreich
Get all districts where the defined vehicle type was dispossessed. GET type_id Int Primary-Key of vehicle type List[District] https://webapi.tmw.at/kfz/district?type_id=21849
Get all districts of a State where the defined vehicle type was dispossessed. GET state String Name of the State List[District] https://webapi.tmw.at/kfz/district?state=Oberösterreich&type_id=21849
type_id Int Primary-Key of the vehicle type

Type
Property Type Description
Type_ID String Key-Field
Type String Value-Field
Count Int Number of dispossessed vehicles
Type - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of all dispossessed vehicle types GET --- --- --- List[Type] https://webapi.tmw.at/kfz/type
Get all dispossessed vehicel types of a State GET state String Name of State List[Type] https://webapi.tmw.at/kfz/type?state=Oberösterreich
Get all dispossessed vehicel types of a State GET district String Name of district List[Type] https://webapi.tmw.at/kfz/type?district=Linz
Get a list of all dispossessed vehicle types on a defined State and district. GET state String Name of the State List[Type] https://webapi.tmw.at/kfz/type?state=Oberösterreich&district=Linz
district String Name of district

LicensePlate
Property Type Description
Type_ID String Key-Field
Type String Value-Field
Count Int Number of dispossessed vehicles
LicensePlate - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of all dispossessed vehicle with a license plate number by a search string GET licenseplate String Search string with wildcard % allowed List[ResultSetItem] https://webapi.tmw.at/kfz/licenseplate?licenseplate=a2%

Person
Property Type Description
Person_ID Int Primary-Key of Person
Count Int Number of dispossessed vehicles
Person - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get all Persons GET --- --- --- List[Person] https://webapi.tmw.at/kfz/person
Get a Person by it's primary key GET id Int Primary_key of Person Person https://webapi.tmw.at/kfz/person?id=2701637
Get all Persons for an Entry GET entry_id Int Primary_Key of Entry List[Person] https://webapi.tmw.at/kfz/person?entry_id=133924

SearchResult
Property Type Description
Count Int Total number of records found.
Start Int Offset, where the resutl-set starts
Limit Int Maximum number of records returned in the result-set
SearchResultItemList List [SearchResultItem] List of SearchResultItems
SearchResultItem
Property Type Description
Entry_ID Int PrimaryKey of the SearchResultItem
Person_ID Int Primary-Key of person or company
FirstName String Firstname of the person
LastName String Lastname of the person
AcademicTtitle String Academic ttitle of the person
Profession String Profession of the person
CompanyName String Company name
CompanySector String Company sector
Street String Address of person or company
City String City of person or company
District String District of person or company
State String State of person or company
Country String Country of person or company
Type_ID Int (NULL) Primary-Key of the vehicle-type
Type String Type of vehicle
LicensePlate String LicensePlate of vehicle
EngineCode String LicensePlate of vehicle
ChassisNumber String LicensePlate of vehicle
SearchResult - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of search results of all dispossessed vehicles filterd by the defined parameters.
GET start Int Startvalue for paging results SearchResult https://webapi.tmw.at/kfz/search?start=0&limit=0&company_name=*nationalbank*
limit Int Number of returned records
(0 = return all record starting at offset "start")
first_name String Search string for the first name of a person
last_name String Search string for the last name of a person
company_name String Search string for the name of a company
profession String Search string for the profession of a person
street String Name of a street
city String Name of a city
district String Name of a district
country String name of a country
state String Name of a state https://webapi.tmw.at/kfz/search?start=15&limit=10&district=11
type_id Int Primary-Key of vehicle type
type Int Search string for vehicle type
license_plate String Search string for a license plate number
engine_code String Search string for an engine code
chassis_number String Search string for a chassis number
comment String Search string for a comment
dispossession Bool Search of dispossession

Media - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of all MediaStorage IDs of an Entry GET entry_id Int Primary Key of Entry List[Int] https://webapi.tmw.at/kfz/media?entry_id=133924
Get MediaStorage Thumbnail by it's primary key GET id Int Primary Key of MediaStorage List[Int] https://webapi.tmw.at/media-storage/thumbnail?id=517031

Details - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get the Details of an Entry GET entry_id Int Primary Key of Entry Detail https://webapi.tmw.at/kfz/details?entry_id=133924