Reporting Attendance via API Calls

LearningBuilder allows external systems to report attendance via a series of RESTful APIs.

To do these, the external system must do the following:

1. The external system must collect an email address from the user and possible other identifying information.  The email collected must be the same email as used in LearningBuilder.

2. The external system then makes an API Request: GetMemberData (given an email address)

3. The API Response provides the uniqueId.  The external system can store this ID for future reference or can repeat this call each time.  However, repeating the call risks issues if the user changes their email address.  LearningBuilder recommends that the external system store the UniqueID for future reference once the account is linked.

4. To report attendance, the external system must know the following information in advance (given to it by the LearningBuilder admin):

   • The Name of the Learning Plan on which the attendance must be reported 

   • The Name of the Task Group under which the attendance must be reported

   • The Activity ID of the activities which was completed

   • The Action Name to report the completion 

5. It must then make the following API Requests: 

   • API/LearningPlanInstance/GetOrCreate (given a uniqueID and a learning plan name). The API Response provides a learningPlanInstanceId

   • API/LearningPlanInstance/GetOrCreate (given a learningPlanInstanceId, activity id, and task group name. Activity Number and Task Group Name would be static, can be found in the LearningBuilder system).  The API Response provides anactivityInstanceId and workflowInstanceId

   • https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/418938944 (given workflowInstanceId, attribute value, and the ‘complete’ action).  The API Response provides a success/fail