Quercus Live Link Developer’s Guide<>

URL construction – services

URL syntax

You can retrieve data from the Live Link service by sending a HTTP GET request with the URL part of the request constructed as follows:

solar.qll_web.[service-category]?serviceCode=[service code]&instanceCode=[instance code]&modeOfStudyCode=[mode-of-study code]&locationCode=[location code]

The solar.qll_web component will be preceded by the URL path appropriate to your organisation (this will be determined in consultation with CampusIT).

The URL components shown [like this] must be replaced by the parameter values you wish to pass to the query. You can combine parameters as necessary, for example:

https://demo.campusit.net/pls/demo/solar.qll_web.common?modeOfStudyCode=FULL_TIME
&locationCode=GALWAY

would retrieve information about public-facing (.common) services enabled for full-time courses in Galway.

Service category

There are three categories of service you can query. You distinguish these in the URL by the service-category modifier which follows the solar.qll_web namespace:

Service category

service-category modifier

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

solar.qll_web.common?

services available to a specific student

solar.qll_web.student?

services available to all staff members

solar.qll_web.staff?

Examples

https://demo.campusit.net/pls/demo/solar.qll_web.common?locationCode=GALWAY

would retrieve information about public-facing (.common) services enabled in Galway.

https://demo.campusit.net/pls/demo/solar.qll_web.staff?locationCode=GALWAY

would retrieve information about staff (.staff) services enabled in Galway.

URL query parameters

List of parameters

You can append the following query parameters to the Live Link URL.

Service Category

Parameter

Purpose

Example

student only

guid

Provide global unique identifier of the student/person (also known as LDAP_ID)

qll_web.student?guid=51

Returned response when student is not found

qll_web.student?guid=6546768721

student only

id

Provide ID number of the student/person

qll_web.student?id=113158

all

serviceCode

Restrict results to specified service

qll_web.common?serviceCode=ONLINE_APP

all

instanceCode

Restrict results to specified course instances

qll_web.common?instanceCode=SCIENCE2010

all

modeOfStudyCode

Restrict results to specified mode of study

qll_web.common?modeOfStudyCode=EVENING

all

locationCode

Restrict results to specified service

qll_web.common?locationCode=GALWAY

all

auth

Provide an authorization key

qll_web.common?serviceCode=ONLINE_APP&auth=97ad50e6f1bc8da6b5d509c41d91c34f4a4d56d2

guid or id is mandatory for the student service category

When you send a request in the student service category you must append either the student’s guid or id.

So …

https://demo.campusit.net/pls/demo/solar.qll_web.student?guid=51&serviceCode=ONLINE_APP

… will work, whereas …

https://demo.campusit.net/pls/demo/solar.qll_web.student?serviceCode=ONLINE_APP

… will not

Only one parameter of a given type allowed

You can append only one parameter of each type, so …

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

… will not work as intended. The first instanceCode parameter will be evaluated, subsequent instanceCode parameters will be ignored

Names of parameters same as attribute names in the XML

The names of the query parameters are the same as the corresponding attributes in the courseInstance elements in the returned XML, e.g.

this URL …

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

… returns this courseInstance element

<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">

auth parameter

» For information about this parameter see Live Link security.