Skip to content

Linking to external timetables

Bert Pareyn edited this page May 27, 2015 · 2 revisions

Linking to external timetables

When a timetable is published outside of the Timetable app, a link can be provided from within the UI to guide the users to it. No UI has been put in place for this, but the task can be easily achieved through the Swagger UI. Login in the the tenant as an application administrator and select the part you want to provide a link for to easily grab the ID of the part from the URL.

Grab the part's ID from the URL

Once you copied the ID of the part, navigate to the Swagger UI orgunit section and open up the Update an organisational unit method. Paste the copied part ID into the id field. The next step is to add a metadata body with a link to the published timetable. Copy and paste {"external": "http://www.google.co.uk"} into the metadata field and update the link before hitting the 'try it out!' button at the bottom of the form.

If you are authenticated as an administrator, you provided a valid part ID and the JSON provided in the metadata field is valid, you will get a successful response back from the server as your part has been updated to provide a link to the external resource. You will recognise a successful response by reading the response code field (200 is an OK). After a successful update, when you access the part through the Timetable UI, you will see a link to the external timetable.

External link for a part