Quercus Live Link Developer’s Guide<>

Live Link XML data format

XML structure — example XML document

All XML documents returned by Live Link queries are instances of a standard XML data model. The document returned by the query

https://demo.campusit.net/pls/demo/solar.qll_web.common?instanceCode=SCIENCE2010

is shown below:

<?xml version="1.0" encoding="UTF-8"?>
<QuercusLiveLink version="8.0.2">
<response timestamp="2011-02-24T05:26:09.587222-08:00">
<status>SUCCESS</status>
</response>
<instances>
<courseInstance id="15167263" instanceCode="SCIENCE2010" courseCode="ELECTIVE" courseDescription="Elective Course" courseYear="1" startDate="2009-12-12" session="2010" modeOfStudyCode="FULL_TIME" modeOfStudyDescription="Full Time" locationCode="PRAGUE" locationDescription="Prague">
<service cis="15188809" 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:15167263&quot; target=&quot;_blank&quot;"></service>
<service cis="29150886" 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:15167263&quot; target=&quot;_blank&quot;"></service>
</courseInstance>
<courseInstance id="16473205" instanceCode="SCIENCE2010" courseCode="SCIENCE_2" courseDescription="Science 2 (copy)" courseYear="1" startDate="2009-12-12" session="2010" modeOfStudyCode="FULL_TIME" modeOfStudyDescription="Full Time" locationCode="PRAGUE" locationDescription="Prague">
<service cis="16742211" 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:16473205&quot; target=&quot;_blank&quot;"></service>
<service cis="29151172" 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:16473205&quot; target=&quot;_blank&quot;"></service>
<service cis="38659459" serviceCode="COURSE_BROWSE" serviceName="Browse Course" startDate="2011-02-11" active="1"></service>
</courseInstance>
</instances>
</QuercusLiveLink> 

Structure of the example document

The structure of the above example in graphical form:

We can see that the document has a simple structure with the payload taking the form of repeating courseInstance elements contained within an instances wrapper element.

Each courseInstance element contains a collection of attributes containing course information.

Each courseInstance element contains one or more service elements.

Each service element contains a collection of attributes containing service information. This includes a link to the service itself in the url attribute.

In addition to the payload content, the document contains a reponse element which contains a timestamp and can be used to display status messages in the event of record retrieval failures. For example:

<QuercusLiveLink version="8.0.2">
<response timestamp="2011-02-25T08:06:09.910238-08:00">
<status>WARNING</status>
<message>Warning: Student not found.</message>
</response>
</QuercusLiveLink>

The full data model is attached as a XSD schema definition in Appendix 1 — Live Link XSD schema.

Attribute values — origin of data

When you run a Live Link query you trigger a database SQL query which returns the information from the database. The origin of the data returned as attribute values in the XML is shown below.

element

attribute

data origin

courseInstance

id

quercus COURSE_INSTANCE_TABLE table — OBJECT_ID column

instanceCode

quercus COURSE_INSTANCE_TABLE table — INSTANCE_CODE column

courseCode

quercus COURSE table — COURSE column

courseDescription

quercus COURSE table — DESCRIPTION column

courseYear

quercus COURSE_INSTANCE_TABLE table — COURSE_YEAR column

startDate

quercus COURSE_INSTANCE_TABLE table — START_DATE column

endDate

quercus COURSE_INSTANCE_TABLE table — END_DATE column

session

quercus COURSE_INSTANCE_TABLE table — ACADEMIC_YEAR column

modeOfStudyCode

quercus MODE_OF_STUDY table — MODE_OF_STUDY column

modeOfStudyDescription

quercus MODE_OF_STUDY table — DESCRIPTION column

locationCode

quercus LOCATION table — LOCATION column

locationDescription

quercus LOCATION table — DECSRIPTION column

service

cis

solar COURSE_INSTANCE_SERVICE table — OBJECT_ID column

serviceCode

solar SERVICE table — SERVICE column

serviceName

solar SERVICE table — DESCRIPTION column

startDate

solar COURSE_INSTANCE_SERVICE table — START_DATE column

active

solar SERVICE table — ENABLED column

url

solar SERVICE table — URL column

The url attribute value

The url attribute value is passed from the solar SERVICE table URL column. This value is maintained through the Control Centre Set-up > Service Adminstration option: