API Documentation

The documentation of the currently developed API version 4 can be found here: http://docs.learning-context.de

We are currently working on the API and on the documentation. If you have any suggestions for improvement, don't hesitate to contact us.

Variables

For the interfaces, some variables are pre-defined, some variables are required, some are recommended and some are used in the response to a request. The following list gives an overview of all the variables that are used in the interfaces, their meaning and their content.

Action

This variable defines if an event represents the start of something, if it is an update to a previously started event or if this event is the end of something.

START, UPDATE, END

Major Category

The major category is a first classification of an event. The set of environmental events contains every event that is not really influenced by the learner. This can be a position, the air pressure or the surrounding volume. Biological events are those which represent the biological state of the learner. Examples are if the learner is nervous, tired, motivated, or - on a lower level - what his heart rate is. The set of activity events contains elements which represent active activities by the learner. This can be a new posting in Facebook or Twitter, turning on the mobile phone, starting an application, or taking a picture.

ENVIRONMENT, BIO, ACTIVITY

Minor Category

The minor category is used to classify an event. Each category has some required entities which have to be set. Additionally, recommended optional entities are provided. We know that this list is far from finished. If you want to add a category, please let us know.

Name Required Entities Recommended Entities
POSITION lng, lat room, address, city, country
APPSTART app, package  
SCREEN screen_on  
INTENT intent mode
NETWORK type (WIFI, MOBILE, OFFLINE) ssid, bssid
PICTURE picture_base64_enc  
BROWSERHISTORY title, url  
NOISELEVEL noise_level_db  
CALENDAREVENT title, begin (unix timestamp), end (unix timestamp) description
VIDEO thumbnail_base64_enc, name video (binary)
ACCELERATION accelerationX, accelerationY, accelerationZ  
LIGHT lux  
PROXIMITY nearby (0=no, 1=yes)  
MUSIC artist, track album
LECTURE name  
QUESTION question  
TWITTERPOST source (Twitter URL of author) text
RATEPAGE url, rating mimetype
LIKE resource  
EMOTION score (0..100)  
COMMENT source, rating (1..5) comment, tags
TAGS tags, source  
COURSESUBSCRIBED cid (course ID), semester, ‚Äčtitle, description, url features (of the course)
ASSIGNMENTANNOUNCED cid (course ID), itemid, title, duedate assignmentdocuments
ASSIGNMENTSUBMITTED cid (course ID), itemid submittedby, solutiondocuments
ASSIGNMENTCORRECTION cid (course ID), itemid correctiondocuments
ASSIGNMENTPOINTS cid (course ID), itemid, obtainedpoints, totalpoints  
DISCUSSION cid (course ID), itemid, replytoid (reply to a discussion if existing) content, author

Category Type

Interests which are stored in a model can be related to private, work-related, or academic activities. If an interest is part of more than one category, it may occur more than once.

PRIVATEWORKACADEMIC

Platforms

The platform describes where an event has been captured / generated / measured. It may be on a mobile device, on a stationary PC or web-based on a website or script.

MOBILE, STATIONARY, WEBBASED

Interest Stages

Interests are ot all alike. People tend to have different stages of interests which are defined in the literature. Since there are different approaches with different naimgs, we opted for the most popular one where the first occurance of an interest is defined as situational. When the interest is important for some time, it becomes stabilized. After a longer period of time, the interest becomes a personal interest.

SITUATIONAL, STABILIZED, PERSONAL

 

The documentation of the old API versions 1-3 can be found in the archive at http://docs-old.learning-context.de. These versions won't be supported anymore. Nevertheless, old applications which rely on these version will still function.