API v1.1 Documentation

List all

Returns all external education attached to the given user's profile.

Request

  • HTTP Verb: GET
  • URI: /user/{id}/externalEducation

Query Parameters

  • id: user identifier. It could be either user id, user email or custom member_id.

Searchable Fields

name Example:

(name[lk]:Awesome, has_exam[eq]:1)

Find all external education whose:

  • name contains Awesome
  • And has_exam is TRUE
date_completion
has_exam
cpd_hours
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/user/1234/externalEducation

Output Example

{
  "_meta": {
   ...
  },
  "records": [
    {
      "id" : 1,
      "name" : "Awesome education on APIs",
      "date_completion" : "2017-05-12",
      "duration" : "02:15",
      "cpd_hours" : "2.25",
      "certificate_url" : "",
      "has_exam" : 0,
      "exam_score" : "",
      "exam_score_out_of" : "",
      "exam_attempts" : "0"
    },
    {
      "id" : 2,
      "name" : "Awesome education on WCEA",
      "date_completion" : "2017-07-13",
      "duration" : "01:15",
      "cpd_hours" : "1.25",
      "certificate_url" : "http://example.com/certificate.pdf",
      "has_exam" : 1,
      "exam_score" : 9,
      "exam_score_out_of" : 10,
      "exam_attempts" : 1
    },
    ...
  ]
}