Explore the eluxemburgensia API endpoints
eluxemburgensia offers a variety of endpoints to fetch detailed information about collections and documents.
Those APIs power the eluxemburgensia.lu website.
Digital Collections
A digital collection represents one newspaper title such as Luxemburger Wort, Revue, Tageblatt, etc.
To retrieve all digital collections:
GET : viewer.eluxemburgensia.lu/api/viewer2/cms/v2/digitalcollections
Returns all digital collections as a list, where each item has the following data:
GENERAL METADATA
○ General Metadata:
- title (Main title) and titles (Array of alternative titles)
– issn (Array of ISSN)
- printers (Array of printers) and publishers (Array of publishers)
○ Translated metadata:
- languages_code (Code of the translation)
- description (Long description of the digital collection)
- text_abstract (Short description of the digital collection)
- rights (opt – Text related to copyrights / limited rights of the digital collection)
DATE METADATA
○ startdate – enddate (opt): Availability start date – end date (present only if the newspaper title is not alive anymore)
○ startdate_digitized (opt) – enddate_digitized: Availability of digitized assets (if not the same of startdate and enddate)
○ startdate_digitalborn (opt) – enddate_digitalborn: Dates of digital-born issues
TECHNICAL METADATA
○ az_url (URL to the dedicated page on the a-z.lu catalogue)
○ paperid (unique identifier of the digital collection)
○ ark (unique identifier for long-term preservation, usable with persist.lu)
Note: Digital collections marked as “legacy” are not documented here. They have a reduced set of features.
Collection Issues
This endpoint returns all the issues for a specific collection for a given year and month.
To retrieve the issues:
GET : viewer.eluxemburgensia.lu/api/viewer2/collections/[paperid]
/calendar/[year]/[month]
Example: viewer.eluxemburgensia.lu/api/viewer2/collections/
volkfreu1869/calendar/1869/2
Requirements:
– The paperid comes from the digital collections endpoint.
– The year and month must be between the startdate and enddate of the item (if enddate is not present, set the date to today).
Month number is the same as in any date, but has no leading 0! For example, March is 3, November is 11.
This endpoint returns an array of items, each item contains the following data:
GENERAL METADATA
○ title and subtitle (opt) of the document
○ dateIssued (Date of the document, in YYYY-MM-DD format, as well as its separated day, month and year)
○ Optional fields, such as the publisher, printer and rights (related copyrights)
NEWSPAPER ISSUE METADATA
○ collection (paperId and title – related collection’s data)
○ partNumber (year and issue number)
TECHNICAL METADATA
○ pid (unique identifier of the document)
○ ark (unique identifier of the document)
○ metsType (type of the document)
○ barcode (opt – barcode of the physical document)
Document – Metadata
This endpoints returns the basic metadata of a document (book, newspaper issue, poster, …) from an ARK.
GET: viewer.eluxemburgensia.lu/api/viewer2/[ARK]
Example: viewer.eluxemburgensia.lu/api/viewer2/ark:70795/01g6w0
GENERAL METADATA
○ ark (same as the one passed in the URL)
○ title
○ dateIssued (date of the document – periodicals have the precise date and other documents might just have the year)
○ publisher (the main publisher)
○ volume (opt – number and title – metadata about the set the document is part of)
TECHNICAL METADATA
○ pid (unique identifier of the document)
○ barcode (opt – barcode of the physical document)
○ callNumber (opt)
○ numberOfFileMaps (technical indicator about the number of file arborescences – not used at the moment)
○ hasPolicy (If the document is protected with a specific policy)
○ metsType (type of the document)
○ rights (related copyrights)
Document – MARC21 record
Documents of type Monograph, Manuscript and Poster also have an associated MARC record. It can be retrieved using the ARK of the document.
GET: viewer.eluxemburgensia.lu/api/viewer2/[ARK]/marcrecord
Example: viewer.eluxemburgensia.lu/api/viewer2/ark:70795/01g6w0/marcrecord
This returns the MARC21 record of the document, in MARC-JSON format.
