Skip to content
StephanOepen edited this page Mar 25, 2016 · 27 revisions

Background

To provide a programmatic interface to the ERG on-line demonstrator, some of its functionality is available via a RESTful (HTTP-based) application programming interface (API). As of Easter 2016, this service is still under development and has not been broadly tested. The following terse sections aim to provide minimal documentation to users who might want to obtain ERG parses without creating their own installation of the DELPH-IN software stack.

A First Example

In a nutshell, the API is accessed through HTTP GET requests to the following base URI: http://erg.delph-in.net/rest/0.9/parse. There is one required parameter, named input, to provide a string for the parser to analyze. The HTTP response will be of type application/json and will contain some high-level statistics about the parsing process (e.g. the number of distinct readings and overall parsing time), as well as an array of result objects.

Parameterizing the Parser

  • nresults: integer (default: 1)

  • derivation: json (default), tsdb, or null

  • eds: json (default), native, or null

Clone this wiki locally