Skip to content
Pietro Liuzzo edited this page Dec 15, 2016 · 3 revisions

Public API

Description

REST API providing access to data

Notes

this should export formats for other users

Implementation

at the moment the RESTXQ module is based on the example by syriaca.org it serves tei records, it searches the data based on a url encoded query it returns lists of files with minimal information it returns text based on a dts like style. This beeing not yet ready, is at the moment a draft only for developing other parts. the url for this has at this time this format http://betamasaheft.aai.uni-hamburg.de/api/dts/{WorkID}/{book}/{chapter}/{linesRange} and returns JSON data with text and references to previous, next, container, subparts.

to do

the dts text query should have this format and ignore the number of div levels and their names, also adding the optional possibility to request the translation of such text.

http://betamasaheft.aai.uni-hamburg.de/api/dts/{language}/{WorkID}/{maindivlevel}/{firstDIVsublevel}/{secondDIVsublevel}?/{thirdDIVsublevel}?/{linesRange}

the text should be returned TRANSFORMED as it will contain markup, or as XML. back to list

Clone this wiki locally