Package org.mycore.restapi.v1

Class MCRRestAPIClassifications

java.lang.Object

org.mycore.restapi.v1.MCRRestAPIClassifications

@Path("/classifications")
public class MCRRestAPIClassifications
extends Object

REST API for classification objects.

Version:

$Revision: $ $Date: $

Author:

Robert Stephan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORMAT_JSON
static final String	FORMAT_XML

Constructor Summary

Constructors

Constructor	Description
MCRRestAPIClassifications()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	listClassifications(jakarta.ws.rs.core.UriInfo info, String format)	lists all available classifications as XML or JSON
jakarta.ws.rs.core.Response	showObject(String classID, String format, String filter, String style, String callback)	returns a single classification object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FORMAT_JSON

public static final String FORMAT_JSON

See Also:

• Constant Field Values

FORMAT_XML

public static final String FORMAT_XML

See Also:

• Constant Field Values

Constructor Details

MCRRestAPIClassifications

public MCRRestAPIClassifications()

Method Details

listClassifications

@GET
@Produces({"text/xml;charset=UTF-8","application/json;charset=UTF-8"})
public jakarta.ws.rs.core.Response listClassifications(@Context
 jakarta.ws.rs.core.UriInfo info,
 @QueryParam("format") @DefaultValue("json")
 String format)

lists all available classifications as XML or JSON

Parameters:

info - - the URIInfo object

format - - the output format ('xml' or 'json)

Returns:

a Jersey Response Object

showObject

@GET
@Path("/{classID}")
@Produces({"text/xml;charset=UTF-8","application/json;charset=UTF-8"})
public jakarta.ws.rs.core.Response showObject(@PathParam("classID")
 String classID,
 @QueryParam("format") @DefaultValue("xml")
 String format,
 @QueryParam("filter") @DefaultValue("")
 String filter,
 @QueryParam("style") @DefaultValue("")
 String style,
 @QueryParam("callback") @DefaultValue("")
 String callback)

returns a single classification object

Parameters:

classID - - the classfication id

format - Possible values are: json | xml (required)

filter - a ';'-separated list of ':'-separated key-value pairs, possible keys are: - lang - the language of the returned labels, if ommited all labels in all languages will be returned - root - an id for a category which will be used as root - nonempty - hide empty categories

style - a ';'-separated list of values, possible keys are: - 'checkboxtree' - create a json syntax which can be used as input for a dojo checkboxtree; - 'checked' - (together with 'checkboxtree') all checkboxed will be checked - 'jstree' - create a json syntax which can be used as input for a jsTree - 'opened' - (together with 'jstree') - all nodes will be opened - 'disabled' - (together with 'jstree') - all nodes will be disabled - 'selected' - (together with 'jstree') - all nodes will be selected

callback - - used in JSONP to wrap json result into a Javascript function named by callback parameter

Returns:

a Jersey Response object