Skip to content

RSS feeds and data endpoints

Michael edited this page Dec 30, 2016 · 1 revision

Introduction

This article describes the URLs and parameters of RSS feeds and data endpoints, which are generated by teachPress. Since teachPress 6.0 all of this endpoints are generated with the WordPress Feed API.

RSS feeds for publications

The basic address for RSS feeds is the following:

https://<yourdomane>?feed=tp_pub_rss

As an example:

https://mywebsite.com?feed=tp_pub_rss

Parameters

id (optional)

(Integer) The ID of the WordPress user whose publications you want to show

tag (optional)

(Integer) If you want to display only publications with one determined tag, so set here the ID of this tags

Examples

https://mywebsite.com?feed=tp_pub_rss&tag=1
https://mywebsite.com?feed=tp_pub_rss&id=1

BibTeX feeds for publications

This endpoint generates a BibTeX based feed.

Parameters

id (optional)

(Integer) The ID of the WordPress user whose publications you want to show

tag (optional)

(Integer) If you want to display only publications with one determined tag, so set here the ID of this tags

use_bibtool (optional)

(String) If you want to use bibtool, you can define this here.

Examples

https://mywebsite.com?feed=tp_pub_bibtex&tag=1
https://mywebsite.com?feed=tp_pub_bibtex&id=1
https://mywebsite.com?feed=tp_pub_bibtex&id=1&use_bibtool=true

Export for single publications

This endpoint generates a single .bib file

Parameters

key

(String) The BibTeX key of the publication.

Examples

https://mywebsite.com?feed=tp_export&key=smith2016a

Export for publications (only for logged in users)

This endpoint generates a single file based on the selected format.

Parameters

user (optional)

(Integer) The ID of the WordPress user whose publications you want to export.

type (required)

(String) The type of the export. The needed value is pub

format (required)

(String) The available formats are: bib, txt, rtf, rss

Examples

https://mywebsite.com?feed=tp_export&type=pub&format=txt