RESTful Service for a DDI Repository (draft 2013-10)

This service is REST-based.

WADL Specification

Software

Server Generation

Client Generation


Resources

/DDIURN/{ddiurn}

resource-wide template parameters
parameter value description

ddiurn

string

Valid DDI URN.

Methods

GET

request query parameters
parameter value description

typeOfObject

string

Type of object which is queried.

filter

string

Filter objet of the query.

filterProperty

string

Property of the filter object.

filterValue

string

Value of the filter object.

resolutionDepth

int

Default: 0

Indicates the maximum number of levels at the resolution of references.

timeout

int

Default: 5

Sets the maximum number of seconds to wait while trying to establish a connection before terminating the attempt and generating an error.

request header parameters
parameter value description

Accept

One of:

  • application/vnd.ddi+xml;version=3.2
  • text/html;version=3.2
  • text/html;format=summary,version=3.2
  • application/rdf+xml;version=3.2

application/vnd.ddi+xml;format=[format],version=[version], where [format] should be replaced with the desired format (i.e.: summary) and [version] should be replaced with one of the versions of the DDI standard, starting with DDI 3.1.

Accept-Language

lang

Default: en-US

Restricts the set of natural languages that are preferred as a response to the request.

available response representations:

available response representations:

Representations

application/vnd.ddi+xml;version=3.2 (ddi:FragmentInstance)

XML Schema

Source:

application/vnd.ddi+xml;format=summary,version=3.2 (ddi:FragmentInstance)

XML Schema

Source:

text/html;version=3.2 (ddi:FragmentInstance)

XML Schema

Source:

text/html;format=summary,version=3.2 (ddi:FragmentInstance)

XML Schema

Source:

application/rdf+xml;version=3.2 (rdf:RDF)

XML Schema

Source:

application/rdf+xml;format=summary,version=3.2 (rdf:RDF)

XML Schema

Source:

application/xml