E-learning activity report

Returns a report on all user activity on a particular piece of e-learning in authenticated organization.

Request

  • HTTP Verb: GET
  • URI: /report/elearningActivity/{id}

Query Parameters

  • id: e-learning id.

Please Note: {id} is optional in the above request, if no {id} is provided, the report contains all user activity on all e-learning in the organization.

Searchable Fields

user_id Example:

(user_id[eq]:123456)

display activity report on e-learning taken by user with user_id = 123456

custom_member_id Example:

(custom_member_id[eq]:M123456)

display activity report on e-learning taken by user with custom_member_id = M123456

wcea_organization_uid Example:

(wcea_organiation_uid[eq]:M123456)

display activity report on e-learning taken by user with wcea_organization_uid = M123456

report_mobile Example:

(report_mobile[eq]:onlyMobile)

display activity report on e-learning taken in the mobile app. Can have 3 values:

'': Report only Education portal data

onlyMobile: Report only Mobile App data

all: Report Education Portal and Mobile App data

start_date Example:

(start_date[eq]:2020-08-21 11_45_00)

Datetime from which the report has to get the data. Notice the time part of the datetime have to replace the ':' by '_'

end_date Example:

(end_date[eq]:2020-08-21 11_46_00)

Datetime until which the report has to get the data. Notice the time part of the datetime have to replace the ':' by '_'

See Advanced queries for details on how to use Searchable Fields.

Request example

curl -H "Request-Time: Wed, 11 Dec 2013 13:15:04 +0000" \
     -H "Api-Key: 78b47a40f93378a6a487919edea6e92c" \
     -H "Signature: 0a035961fbf7d2ffdc5ca8780e0a33cb3d6c3a5f8fb0623e886c9933377d3e1e" \
     http://wceaapi.org/v1.1/report/elearningActivity/1234

Output Example

{
  "_meta": {
   ...
  },
  "records": [
    {
      "portal": "ABBREV",
      "e-learning_reference": 1234,
      "e-learning_name": "A e-learning name",
      "cost": "FREE"
      "e-learning_description": "lorem ipsum",
      "e-learning_duration": "02:15:00",
      "e-learning_language": "English",
      "member\custommemberid:" "A74426",
      "member_id" => 2345,
      "member_title": "Mr",
      "member_name": "John",
      "member_surname": "Doe",
      "member_suffix" => "PhD",
      "member_email" => "user@domain.com",
      "e-learning_status": "Active",
      "date_started": "2014-03-02",
      "date_completed": "2014-03-02",
      "date_modified": "2014-03-02 00:00:01",
      "date_expiry": "2014-11-02 00:00:01",
      "accreditation": "5 Credits",
      "exam": "Passed",
      "exam_result": "75%",
      "exam_attempts": "2",
      "evaluation_statement_link": "link_to_eval_statement",
      "certificate_link": "link_to_eval_certificate",
      "eval_question_1": "answer_to_this_question",
      "eval_question_2": "answer_to_this_question",
      "eval_question_3": "answer_to_this_question",
      //... more evaluation statement questions and answers
    },
    {
      "portal": "ABBREV",
      "e-learning_reference": 1234,
      "e-learning_name": "A e-learning name",
      "cost": "FREE"
      "e-learning_description": "lorem ipsum",
      "e-learning_duration": "02:15:00",
      "e-learning_language": "English",
      "member\custommemberid:" "A74426",
      "member_id" => 123456,
      "member_title": "Miss",
      "member_name": "Adrianne",
      "member_surname": "Victor",
      "member_suffix" => "MBBS",
      "member_email" => "user@domain.com",
      "e-learning_status": "Active",
      "date_started": "2014-01-28",
      "date_completed": "2014-02-09",
      "date_modified": "2014-02-09 00:00:01",
      "date_expiry": false,
      "accreditation": "5 Credits",
      "exam": "Self-Verified",
      "exam_result": "",
      "exam_attempts": "",
      "evaluation_statement_link": "link_to_eval_statement",
      "certificate_link": "link_to_eval_certificate",
      "eval_question_1": "answer_to_this_question",
      "eval_question_2": "answer_to_this_question",
      "eval_question_3": "answer_to_this_question",
      //... more evaluation statement questions and answers
    },
    ...
  ]
}