Content Invocation protocols

From PAWS Lab
Revision as of 00:30, 21 January 2025 by Peterb (talk | contribs) (Why Content Invocation)
Jump to: navigation, search

This page describes the content invocation protocols supported by ADAPT2

Why Content Invocation

A content invocation protocol allows two online learning systems to work together in supporting learners. With this protocol, a host system, such as a learning portal, a learning management system, or a personalized learning interface) can activate an independent client system while also passing a range of important parameters to it, most importantly, information about the user and group who will work with the client system, and the user target. The target might indicate a specific activity that the client system will need to launch for the user, while the information about the user and group enables the client system to customize its interaction with the user. The information about the user and the target are also important to log the information about the user interaction with the tool.

= ADAPT2 protocol for user authentication and activity invocation

ADAPT2 content invocation protocol is the "native" protocol of ADAPT2 infrastructure. This protocol is adopted by all ADAPT2 tools developed by our teams and by many content servers developers by our collaborators. It regulates how user and resource identities is transferred from application to application via the following HTTP parameters

  • usr - user identifier, usually login (mandatory)
  • grp - group identifier (mandatory), just like a user identifier, but for a group of users (class, research team)
  • sid - session identifier (optional), usually 5 character string each application makes a choice whether and how to come up with this parameter (e.g. truncate | Apache Tomcat session id to last 5 characters)
  • act - id of the resource (mandatory), each application maintains its own vocabulary of resource ids
  • sub - if a resource is a collection of multiple resources/steps, then a sub-resource id is supplied to call a specific sub-resource or step (optional)

Other Standard authentication and content invocation protocols supported by ADAPT2

  • LTI protocol
  • SPLICE protocol