Quercus Live Link Developer’s Guide<>

Quercus Live Link and REST

What is REST?

REST is an acronym for Representational State Transfer.

Wikipedia defines REST as “a style of software architecture for distributed hypermedia systems such as the World Wide Web”. (http://en.wikipedia.org/wiki/Representational_State_Transfer).

REST in practice

In practical terms, the important feature of REST implementations is the return of machine‑parsable structured data (usually in the form of an XML document) in response to a standard HTTP GET or POST request. The data which is returned depends upon the construction of the URL sent as part of the request. Common REST addressing techniques are:

map the data to a URL and then use sub-paths of the URL to allow the retrieval of subsets of the full data set (e.g. http://mycollege.org/services/arts/2011)

map the data to a URL and then use parameters to allow the retrieval of subsets of the full data set (e.g. http://mycollege.org/services?faculty=arts&year=2011)

Quercus Live Link uses the modification-with-parameters technique as it is better suited to the relational Quercus data. An example of a Live Link URL is shown below:


What data can I access through Live Link?

Quercus services

You can retrieve details of current Quercus services. The returned XML data services are returned grouped by course instance. You can query three categories of services:

public-facing services (available on your public-facing web site)

services available to a specific student

services available to all staff members

» The XML data returned is described in Live Link XML data format.

Information about students and other persons

From version 8.3.1 onwards Live Link will be used to allow third party integrators make calls to Quercus for information in the following areas:

information about a person

information about a person on a course instance

information about notes particular to a person

information about courses or course instances

information about existing interactions

information about modules or module instances

information about course curriculum

information about student curriculum

» The XML data returned is described in Live Link XML data format.

Filter information by adding parameters to the URL of the REST call

You can filter the information returned by appending appropriate query parameters to the URL of the REST call, for example …


… results in the return of the following XML document:

<?xml version="1.0" encoding="UTF-8"?>
<QuercusLiveLink version="8.0.2">
<response timestamp="2011-02-24T02:26:22.624300-08:00">
<courseInstance id="34352412" instanceCode="AR-01" courseCode="ARCHAEOLOGY" courseDescription="Archaeology" courseYear="1" startDate="2010-09-20" endDate="2011-05-27" session="2010">
<service cis="34353845" serviceCode="ONLINE_APP" serviceName="Apply Online" startDate="2010-11-03" active="1" url="https://demo.campusit.net/pls/demo/f?p=PV_ONLINE_APP:101:::::APP_COURSE_INSTANCE:34352412&quot; target=&quot;_blank&quot;"></service>
<service cis="39126787" serviceCode="ONLINE_ENQ" serviceName="Enquire Online" startDate="2011-02-15" active="1" url="https://demo.campusit.net/pls/demo/f?p=PV_ONLINE_ENQ:101:::::APP_COURSE_INSTANCE:34352412&quot; target=&quot;_blank&quot;"></service>