API v1.1 Documentation

Upgrade notes

  • Verified Learning has been renamed World Continuing Education Alliance, all branding and terminology has been changed to reflect that.

  • The API now supports HTTPS, so please change your URL endpoints.

  • Terminology change Training is now E-learning, all references to training have been changed to reflect that. Response property names have also been changed to reflect that.

  • Terminology change Micro Portals are now Additional Portals, all references have been changed to reflect that.

  • Additional fields E-learning reports (previously training reports) now contain five additional fields:
    • time_restriction : Number of days training is available after purchase
    • accreditation : List of Accreditors for this E-learning
    • participant_score_breakdown : Exam score breakdown
    • participant_score_breakdown_pdf : Link to a PDF displaying exam score breakdown
    • participant_per_answer_pdf : Link to a PDF displaying participants per exam answer

  • New Search criteria E-learning activity reports (previously Training Activity Reports) can now be searched using a user_id. This means, you can now fetch all training activity for a particular user.

  • Additional fields E-learning activity reports (previously Training Activity Reports) now contain four additional fields:
    • exam_attempts
    • date_expiry : Date on which this E-learning will not be available to this user anymore
    • date_modified
    • member_email

  • Additional fields User reports now contain additional fields:
    • street
    • zip
    • number_of_times_logged_in : Number of times the user has logged into this portal
    • all_ce_requires_accreditation : Does all CE Need to be accredited?
    • accreditors : Accreditors which must accredit CE (comma separated list)
    • ce_minimum_duration : Minimum duration to qualify for CE
    • ce_start_date : CE Cycle Start Date
    • ce_end_date : CE Cycle End Date
    • ce_declaration_date : Next CE Declaration Date
    • referrer_url : The url where the user came from before registration
    • utm_source : The source of the user registration

  • New Field All user related endpoints now have a field called licensing_region which defaults to the region if not provided, it's available in both Get and Set operations.

  • New Field All user related endpoints now have a field called member_id which allows you to attach a custom identifier to each user, it's available in both Get and Set operations.

  • New Primary Field All user related endpoints now accept member_id as a url parameter in addition to the current id and email fields. This means you can now fetch users by their member_id. See Get user for more info.

  • New Endpoints See Accreditor and User - Accreditor.

  • New Endpoints See User - External Education.

Endpoint URL changes

Old URL New URL
/user/{id}/trainingProfile /user/{id}/elearningProfile
/microportal /additionalportal
/microportal/{id} /additionalportal/{id}
/training /elearning
/training/{id} /elearning/{id}
/report/training /report/elearning
/report/trainingActivity /report/elearningActivity
/report/trainingActivity/{id} /report/elearningActivity/{id}

Parameter changes

  1. When getting authenticated links (SSO) direct to a particular training, the context parameter now needs a value of e-learning. Previously it used to accept training as a parameter. See E-learning - Link to e-learning
  2. The payment endpoint now accepts e-learning as the parameter name instead of training. See Payment - Create new payment