TMW Web-API Schnittstelle

Version: 2.5.3

Server: SQL01.TMW.AC.AT\TMW

Adlib 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

Media - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a one-time token for downloading a media without authentication GET --- --- --- String https://webapi.tmw.at/adlib/get-token
Get a media without authentication passing an one-time token GET id Int Primary-Key of Media Content-Type: application/octet-stream https://webapi.tmw.at/adlib/media-download?id=663608&token=
https://webapi.tmw.at/adlib/media-download?id=596930&token=
token String One-time token generated by the GetToken function
Get a media GET id Int Primary-Key of Media Content-Type: application/octet-stream https://webapi.tmw.at/adlib/media-download?id=663608
https://webapi.tmw.at/adlib/media-download?id=596930

Coordinates
Property Type Description
X Double X-Coordinate
Y Double Y-Coordinate
Z Double Z-Coordinate
Collect - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of collection object primary keys for all highlight-objects GET --- --- --- List[Int] https://webapi.tmw.at/adlib/collect-highlights
Get the indoor coordinates of a collect object GET priref Int Primary-Key of the collect object Coordinates https://webapi.tmw.at/adlib/collect-coordinates?priref=311810
Get the indoor coordinates of a collect object by it's inventory number GET object_number String Inventory number of collect object Coordinates https://webapi.tmw.at/adlib/collect-coordinates?object_number=66987/8
Set the indoor coordinates of a collect object POST priref Int Primary-Key of the collect object HttpResponseMessage https://webapi.tmw.at/adlib/collect-coordinates?priref=311810&x=404.79&y=402.08&z=793.46
x Double X-Coordinate of the collect object
y Double Y-Coordinate of the collect object
z Double Z-Coordinate of the collect object
Set the indoor coordinates of a collect object by it's inventory number POST object_number String Inventory number of collect object HttpResponseMessage https://webapi.tmw.at/adlib/collect-coordinates?object_number=66987/8&x=404.79&y=402.08&z=793.46
x Double X-Coordinate of the collect object
y Double Y-Coordinate of the collect object
z Double Z-Coordinate of the collect object
Set the location and the indoor coordinates of a collect object POST priref Int Primary-Key of the collect object HttpResponseMessage https://webapi.tmw.at/adlib/collect-location?priref=311810&location_priref=45194&x=404.79&y=402.08&z=793.46
locattion_priref Int Primary-Key of location
x Double X-Coordinate of the collect object
(can be omitted)
y Double Y-Coordinate of the collect object
(can be omitted)
z Double Z-Coordinate of the collect object
(can be omitted)
Set the location and the indoor coordinates of a collect object by it's inventory number POST object_number String Inventory number of collect object HttpResponseMessage https://webapi.tmw.at/adlib/collect-location?object_number=66987/8&location_priref=45194&x=404.79&y=402.08&z=793.46
locattion_priref Int Primary-Key of location
x Double X-Coordinate of the collect object
(can be omitted)
y Double Y-Coordinate of the collect object
(can be omitted)
z Double Z-Coordinate of the collect object
(can be omitted)

Location
Property Type Description
PriRef Int Primary-Key of the location
LocationName String Name of the location
ParentPriRef Int Primary-Key of the parent location
ParentLocationName String Name of the parent location
LocationType String Type of the location
X_Min Double Minimum X-Coordinate
Y_Min Double Minimum Y-Coordinate
Z_Min Double Minimum Z-Coordinate
X_Max Double Maximum X-Coordinate
Y_Max Double Maximum Y-Coordinate
Z_Max Double Maximum Z-Coordinate
X_Default Double Default X-Coordinate
Y_Default Double Default Y-Coordinate
Z_Default Double Default Z-Coordinate
Location - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a location by it's primary-key GET priref Int Primary-Key of the location Location https://webapi.tmw.at/adlib/location?priref=45194
Set the coordinates of a location POST priref Int Primary-Key of the location Location https://webapi.tmw.at/adlib/location-coordinates?priref=45194&x_min=2172.56&y_min=2750&z_min=1548.36&x_max=7443.95&y_max=9919.21&z_max=5003.88
x_min Double Minimum x-coordinate of the location
y_min Double Minimum y-coordinate of the location
z_min Double Minimum z-coordinate of the location
x_max Double Minimum x-coordinate of the location
y_max Double Minimum y-coordinate of the location
z_max Double Minimum z-coordinate of the location
Set the default coordinates of a location POST priref Int Primary-Key of the location Location https://webapi.tmw.at/adlib/location-default-coordinates?priref=45194&x=5502.76&y=3478.52&z=2855.16
x_min Double Default x-coordinate of the location
y_min Double Default y-coordinate of the location
z_min Double Default z-coordinate of the location

Sponsorship
Property Type Description
PriRef Int Primary-Key of the collect object
Value Double Subscription fee
TerminationDate DateTime Termination date of sponsorship
Sponsorship - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get the sponsorship data of a single object GET priref Int Primary-Key of the collect object Sponsorship https://webapi.tmw.at/adlib/collect-sponsorship?priref=167721
Add a sponsorship to a collect object by starting date and returns the computed termination date POST priref Int Primary-Key of the collect object DateTime https://webapi.tmw.at/adlib/collect-sponsorship?priref=#SECRET#&starting_date=2024-11-21
sponsor (NULL) String Name of the sponsor. If ommited, it's treated as reservation
starting_date Date Date when the sponsorship starts. Termination date will be computed automatically.
Update a sponsorship to a collect object. Only possible for sponsorship reservation with empty sponsor name. POST priref Int Primary-Key of the collect object HttpResponseMessage https://webapi.tmw.at/adlib/collect-sponsorship?priref=#SECRET#&sponsor=Fadawiro Sapiz&termination_date=2027-02-17
sponsor String Name of the sponsor
termination_date Date Termination date of sponsorship
Delte a sponsorship reservation to a collect object. Can only be executed if the sponsor is empty DELETE priref Int Primary-Key of the collect object HttpResponseMessage https://webapi.tmw.at/adlib/collect-sponsorship?priref=#SECRET#&termination_date=2027-02-17
termination_date Date Termination date of sponsorship
Get the hole list of sponsorship objects order by sponsorship terminating date GET --- --- --- List[Sponsorship] https://webapi.tmw.at/adlib/collect-sponsorship
Get all highlight object prirefs of an exhibition GET priref Int Primary-Key of exhibition List[Int] https://webapi.tmw.at/adlib/exhibition-highlight?priref=2140
Get a list of scopes from sponsorship objects GET --- --- --- List[Scope] https://webapi.tmw.at/adlib/collect-sponsorship-scope

Sponsor
Property Type Description
SponsorName String Name of the sponsor
StartingDate DateTime (NULL) Starting date of the sponsorship
TerminationDate DateTime (NULL) Termination date of sponsorship
Sponsor - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a list of all sponsors from a collect object GET priref Int Primary-Key of collection object List[Sponsor] https://webapi.tmw.at/adlib/collect-sponsor?priref=167721

Scope
Property Type Description
ScopeName String Name of the collection scope
Scope_ID Int Primary-Key of the collection scope
InternalName String Internal Name of the collection scope (sortable)
Count Int Number of found sponsorship objects in this scope

TourItem
Property Type Description
PriRef Int32 Primary-Key of the tour
Title String Displayable Title of the tour
AlternativeTitle String Internal title of the tour (sortable)
Online Boolean Online-Flag of the tour
Description String Description text of the tour
Location_PriRef Int (NULL) Primary-Key of location
Location String Name of location
Objects List[ObjectItemInfo] List of the related objects
PartOf TourItemInfo Summary of the parent tour item
Parts List[TourItemInfo] Summary of the child tour items
Media List[MediaItem] List of the related media items
TourItemInfo
Property Type Description
PriRef Int32 Primary-Key of the tour
Title String Displayable Title of the tour
AlternativeTitle String Internal title of the tour (sortable)
Online Boolean Online-Flag of the tour
ObjectItemInfo
Property Type Description
PriRef Int32 Primary-Key of the object
Number String Inventory number of the object
Name String Name of the object
Title Boolean Title of the object
MediaItem
Property Type Description
PriRef Int32 Primary-Key of the media
Title String Title of the media
FilePath String Path to the media file
AudioFlag Boolean Flag for audio files
FrontpageFlag Boolean Flag for file to display st the frontpage
Tour - Functions
Purpose Method Parameter Return-Value Example
Name Type Description
Get a tour item by it's primary key GET priref Int Primary-Key of tour TourItem https://webapi.tmw.at/adlib/app-tour?priref=100
Get a language list GET --- --- --- List[TourLanguage] https://webapi.tmw.at/adlib/app-tour-languages
Get a group list GET language_priref Int (NULL) Primary-Key of TourLanguage List[TourGroup] https://webapi.tmw.at/adlib/app-tour-groups
https://webapi.tmw.at/adlib/app-tour-groups?language_priref=61662
Get a record-type list GET --- --- --- List[String] https://webapi.tmw.at/adlib/app-tour-record-types
Get a subjet list GET language_priref Int (NULL) Primary-Key of TourLanguage List[TourSubject] https://webapi.tmw.at/adlib/app-tour-subjects
https://webapi.tmw.at/adlib/app-tour-subjects?language_priref=61662
Get all Tour properties in a list GET --- --- --- List[dynamic] https://webapi.tmw.at/adlib/app-tour-list
Find Tours and Sections by parameter GET online Boolean (NULL) online flag List[int] https://webapi.tmw.at/adlib/app-tour-priref-list?subject_priref=61623
has_sections Boolean (NULL) indicator of sections
record_type String (NULL) name of record-type
language_priref Int (NULL) Primary-Key of language
group_priref Int (NULL) Primary-Key of group