...

...

The Fedora API-A-Lite interface is implemented as an HTTP service that consists of the following methods:

...

For more information on the method definitions, refer to the API descriptions located at http://www.fedora.info/definitions/1/0/api/

Client Syntax

...

...

Note
title URL encoding of parameters
Note that the LITE APIs (unlike the new REST API) do not require, and do not accept, URL-encoding of parameters within the path. Therefore PIDs should be specified as the raw PID (namespace:name) value, and should not be encoded.

describeRepository

Syntax:

http://hostname:port/fedora/describe

[?xml=BOOLEAN

]

This syntax requests information about a Fedora repository, including repository name, version, base URL, PID syntax, OAI identifier syntax, admin emails, and sample request URLs. The xml parameter determines the type of output returned. If the parameter is omitted or has a value of "false", a MIME-typed stream consisting of an HTML table is returned providing a browser-savvy means of viewing the object profile. If the value specified is "true", then a MIME-typed stream consisting of XML is returned.

• hostname – required hostname of the Fedora server.
• port – required port number on which the Fedora server is running.
• fedora – required name of the Fedora web application.
• describe – a required parameter specifying the Fedora servlet path for the describe request.
• xml – an optional parameter indicating the requested output format. A value of "true" indicates a return type of text/xml; the absence of the xml parameter or a value of "false" indicates format is to be text/html.

Example:

...

Get respository information using the describe request as XML:

http://localhost:8080/fedora/describe?xml=true

getDatastreamDissemination

Syntax:

http://hostname:port/fedora/get/PID/

DSID[/dateTime

]

This syntax requests a dissemination of the specified datastream within the specified object. The result is returned as a MIME-typed stream.

• hostname – required hostname of the Fedora server.
• port – required port number on which the Fedora server is running.
• fedora – required name of the Fedora web application.
• get – a required parameter specifying the Fedora servlet path.
• PID – required persistent identifier of the digital object.
• DSPID DSID – required identifier of the Datastream.
• dateTime – optional value indicating dissemination of a version of the digital object at the specified point in time. Proper syntax is YYYY-MM-DDTHH:MM:SS.SSSZ where HH is 24-hour clock and SSS is milliseconds.

Examples:

...

Get the Dublin Core (DC) Datastream of demo object demo:5:

http://localhost:8080/fedora/get/demo:5/DC

Get the thumbnail Datastream (DS1) of demo object demo:5:

http://localhost:8080/fedora/get/demo:5/THUMBRES_IMG

getDissemination

Syntax:

http://hostname:port/fedora/get/PID/sDefPID/methodName

[/dateTime

]

[?parmArray

]

This syntax requests a dissemination of the specified object using the specified method of the associated service definition object. The result is returned as a MIME-typed stream.

• hostname – required hostname of the Fedora server.
• port – required port number on which the Fedora server is running.
• fedora – required name of the Fedora web application.
• get – a required parameter specifying the Fedora servlet path.
• PID – required persistent identifier of the digital object.
• sDefPID – required persistent identifier of the service definition object which defines the service.
• methodName – required name of the method to be executed.
• dateTime – optional value indicating dissemination of a version of the digital object at the specified point in time. Proper syntax is YYYY-MM-DDTHH:MM:SS.SSSZ where HH is 24-hour clock and SSS is milliseconds.
• parmArray - optional array of method parameters consisting of name/value pairs in the form parm1=value1&parm2=value2...

Example:

...

Get the Dissemination for a data object with a PID of demo:5 and associated service definition object with a PID of demo:1 and methodName of getThumbnail:

http://localhost:8080/fedora/get/demo:5/demo:1/getThumbnail

getObjectHistory

Syntax:

This syntax requests the change history for the specified digital object. The change history provides a list of timestamps that indicate when components (e.g., Datastreams, etc.) in the digital object were created or modified. These timestamps can be used in a dissemination request to view the object as it existed at a specific point in time. The xml parameter determines the type of output returned. If the parameter is omitted or has a value of "false", a MIME-typed stream consisting of an html table is returned providing a browser-savvy means of viewing the object history. If the value specified is "true", then a MIME-typed stream consisting of XML is returned.

...

getObjectProfile

Syntax:

This syntax requests an object profile for the specified digital object. The xml parameter determines the type of output returned. If the parameter is omitted or has a value of "false", a MIME-typed stream consisting of an HTML table is returned providing a browser-savvy means of viewing the object profile. If the value specified is "true", then a MIME-typed stream consisting of XML is returned.

...

findObjects

Syntax:

This syntax essentially performs a search upon the objects in the repository. It finds objects that meet the criteria specified in the request. The criteria are evaluated against an index of the repository that contains unqualified Dublin Core and Fedora-specific metadata elements. The syntax provides a client with the ability to specify the search criteria as either a phrase (a simple keyword search), or as a set of name value pairs (a field-based search).

...

resumeFindObjects

Syntax:

This syntax requests the next members of a result set from a prior invocation of a findObjects request. If the findObjects request was run and there are more "hits" in the result set than the maxResults setting on the findObjects request, then the resumeFindObjects request is used to obtain the next group of items in the result set. Fields to be included as part of the result set are the same as those available for findObjects, and must be specified as part of the syntax for resumeFindObjects as well (i.e. if the parameters ?pid=true&title=true are part of the findObjects query, those same parameters should be included as part of the resumeFindObjects query.)

• hostname – required hostname of the Fedora server.
• port – required port number on which the Fedora server is running.
• fedora – required name of the Fedora web application.
• search – a required parameter specifying the Fedora servlet path for the findObjects request.
• sessionToken – the identifier of the session to which the search results are being returned.
• xml – boolean indicating whether to return the search results as xml. If this is given as true, the result will be in xml. Otherwise, the result will be provided in a simple HTML document.

listDatastreams

Syntax:

This syntax requests a list of Datastreams contained in the digital object.

...

listMethods

Syntax:

This syntax requests a list of methods available in the digital object.

...

WSDL

Anchor
wsdl wsdl

When running your own Fedora server, the API-A-LITE WSDL is available at /wsdl?api=API-A-LITE.

Example:

http://localhost:8080/fedora/wsdl?api=API-A-LITE

...

|http://localhost:8080/fedora/wsdl?api=API-A-LITE