Purefaçade

Table of contents

1   Purpose

Purefaçade is a web service to make Pure data available for the Tilburg University website.

Pure has an API (Pure Web Services) to access its data, but this API is very complicated. It returns data as huge and very complicated XML documents. None of the Pure Web Services resources returns data that can be used directly in a website.

The website uses Pure data to show publications, organisations or persons on its pages.

2   Features

3   Usage

Usage: {base-url}/rest/{resource[/path]}[?requestparameters]

3.1   {base-url}/rest/organisations/{organisation-id}/publications

Returns last added or edited 20 publications of organisation with Organisation id {organisation-id} in 'APAwithlinks' rendering as an XML document with an XSL stylesheet reference.

Optional request parameters:

  • publication-year
  • document-type
  • order-by
  • window.offset
  • window.size
  • rendering
  • encoded

See 'XML output' section below.

Example:

/rest/organisations/50000115/publications?order-by=published&window.size=5
Shows last 5 published publications of Tilburg Law School or suborganisation in 'APAwithlinks' rendering in an HTML document

3.2   {base-url}/rest/organisations/{organisation-id}/rss

Returns last added or edited 20 publications of organisation with id {organisation-id} as an RSS 2.0 feed in 'APA' rendering.

Shows publication title and publication year as the entry title. In most RSS/Atom readers this links to the publication in the Pure portal.

Optional request parameters:

  • publication-year
  • document-type
  • order-by
  • window.offset
  • window.size
  • rendering
  • feed-type

Example:

/rest/organisations/50000115/rss
Shows last last added or edited publications of Tilburg Law School in 'APA' rendering

3.3   {base-url}/rest/organisations/{organisation-id}/series

Returns all publications in specific series for a year for organisation with id {organisation-id}.

All publications ordered by descending volume number.

Required request parameters:

  • publication-year
  • document-type
  • series

Optional request parameters:

  • rendering (default = CentER)

Examples:

/rest/organisations/50000088/series?publication-year=2014&document-type=discussionpaper&series=CentER%20Discussion%20Paper
CentER discussion Papers in 2014
/rest/organisations/50000088/series?publication-year=2014&document-type=thesis%2fdoc&series=CentER%20Dissertation%20Series
CentER PhD theses in 2014
/rest/organisations/50007292/series?publication-year=2014&document-type=thesis%2fdoc&series=TiCC%20Ph.D.%20Series
PhD theses from TiCC in 2014 (organisation-id = Tilburg School of Humanities)

3.4   {base-url}/rest/persons/{person-id}/vcard

Returns very basic vCard for person with id {person-id}.

3.5   {base-url}/rest/persons/{person-id}/x-vcard

Returns very basic vCard for person with id {person-id} as XML vCard.

3.6   {base-url}/rest/persons/{person-id}/publications

Returns last added or edited 20 publications person with id {person-id} in 'APAwithlinks' rendering as an XML document with an XSL stylesheet reference.

Optional request parameters:

  • publication-year
  • order-by
  • window.offset
  • window.size
  • rendering
  • encoded

See 'XML output' section below.

Example:

/rest/persons/199788/publications
Shows last last added or edited 20 publications of Fons van de Vijver in 'APAwithlinks' rendering as an XML document with an XSL stylesheet reference.

3.7   {base-url}/rest/persons/{person-id}/rss

Returns last added or edited 20 publications of person with id {person-id} as an RSS 2.0 feed in 'APA' rendering.

Shows publication title and publication year as the entry title. In most RSS/Atom readers this links to the publication in the Pure portal.

Optional request parameters:

  • publication-year
  • order-by
  • window.offset
  • window.size
  • rendering
  • feed-type

Example:

/rest/persons/199788/rss?feed-type=atom_1.0
Shows last last added or edited publications of Fons van de Vijver in 'APA' rendering as an Atom 1.0 feed

3.8   {base-url}/rest/persons/{person-id}/ee-data

Note

Possibly not accessible

Returns XML data for a person.

Used as a data source by another system.

Example:

/rest/persons/199788/ee-data
Shows XML data of Fons van de Vijver.

3.10   {base-url}/rest/publications/rss

Returns last added or edited 20 publications matching query parameter as an RSS 2.0 feed in 'APA' rendering.

Shows publication title and publication year as the entry title. In most RSS/Atom readers this links to the publication in the Pure portal.

Optional request parameters:

  • publication-year
  • order-by
  • window.offset
  • window.size
  • rendering
  • encoded
  • feed-type

4   Matrix parameters

For vcard and x-vcard requests for a person, it's possible to replace /persons/{person-id}/ in the URL with /persons/person;id={person-id}/. So, https://purefacade.uvt.nl/rest/persons/person;id=199788/x-vcard is equivalent to https://purefacade.uvt.nl/rest/persons/199788/x-vcard.

All objects in Pure have a unique UUID. Persons too. Instead of using the person-id to reference a person in the vcard and x-vcard requests, you can also use matrix parameter uuid.

Example: /rest/persons/person;uuid=b6bdc7f6-00f9-4941-b814-1b96c95005a3/x-vcard

5   Options

5.1   document-type

Document type.

The first substring match of the provided parameter in the following list is used to select the document type:

  • /dk/atira/pure/researchoutput/researchoutputtypes/bookanthology/anthology
  • /dk/atira/pure/researchoutput/researchoutputtypes/bookanthology/book
  • /dk/atira/pure/researchoutput/researchoutputtypes/bookanthology/commissioned
  • /dk/atira/pure/researchoutput/researchoutputtypes/bookanthology/inaugural
  • /dk/atira/pure/researchoutput/researchoutputtypes/bookanthology/other
  • /dk/atira/pure/researchoutput/researchoutputtypes/bookanthology/scholarly
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontobookanthology/chapter
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontobookanthology/conference
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontobookanthology/entry
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontobookanthology/foreword
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontobookanthology/other
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontobookanthology/peerreviewedchapter
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoconference/abstract
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoconference/other
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoconference/paper
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoconference/poster
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/abstract
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/article
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/book
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/comment
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/editorial
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/letter
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/scientific
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontojournal/special
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontomemorandum/contributiontoqahearing
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontomemorandum/contributiotoacademicmemorandum
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoperiodical/article
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoperiodical/book
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoperiodical/editorial
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoperiodical/featured
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoperiodical/letter
  • /dk/atira/pure/researchoutput/researchoutputtypes/contributiontoperiodical/special
  • /dk/atira/pure/researchoutput/researchoutputtypes/memorandum/academicmemorandum
  • /dk/atira/pure/researchoutput/researchoutputtypes/memorandum/qahearing
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/artefact
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/composition
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/database
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/design
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/digitalorvisualproducts
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/exhibition
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/performance
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/software
  • /dk/atira/pure/researchoutput/researchoutputtypes/nontextual/web
  • /dk/atira/pure/researchoutput/researchoutputtypes/othercontribution/other-
  • /dk/atira/pure/researchoutput/researchoutputtypes/patent/patent
  • /dk/atira/pure/researchoutput/researchoutputtypes/thesis/doc
  • /dk/atira/pure/researchoutput/researchoutputtypes/thesis/master
  • /dk/atira/pure/researchoutput/researchoutputtypes/workingpaper/discussionpaper
  • /dk/atira/pure/researchoutput/researchoutputtypes/workingpaper/workingpaper

So &document-type=book should select document type'/dk/atira/pure/researchoutput/researchoutputtypes/bookanthology/anthology' (first line that contains string 'book'). With &document-type=thesis/master one should select on master theses only ('/dk/atira/pure/researchoutput/researchoutputtypes/thesis/master').

5.2   encoded

Only for publications as XML.

false
Present rendered reference as XML or HTML ('<div>...', default)
true
Encode rendered reference so it is a single string ('&lt;div&gt;...')

5.3   feed-type

Default=rss_2.0

  • rss_0.9
  • rss_0.91
  • rss_0.92
  • rss_0.93
  • rss_0.94
  • rss_1.0
  • rss_2.0
  • atom_0.3
  • atom_1.0

5.4   order-by

edit
Last added or edited first
published
Last publication dates first
volume
Not implemented yet

5.5   publication-year

Publication year.

Usage: &publication-year=2014

5.6   rendering

For /publications and /rss paths.

APA
APA format without links
APAwithlinks
APA with title as link to publication in portal
CentER
Simple format used by CentER for discussion papers

Use rendering={rendering}

5.7   series

Full name of series.

Usage: &series=CentER%20Discussion%20Paper

5.8   window

window.offset=
Start with this record (first record=0)
window.size=
Number of records (default=20)

6   XML output

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='/rest/pfpublications2html.xsl'?>
<pf:result xmlns:pf="http://www.tilburguniversity.edu/namespaces/purefacade">
  <pf:publications count="162" window-offset="0" window-size="20">
    <pf:publication index="1" rendering="APAwithlinks" encoded="false">...</pf:publication>