API Resources

Author - Memberships API

This API controls group memberships.

Interfaces

Object Synopses

MembershipRequest

  • user_id Integer

    User id to add to group

Add a member to a group

POST /api/author/groups/:group_id/learners

Response Codes

  • 201 Created
  • 404 Not Found

Parameters

  • group_id Integer Required

    Path parameter. Group id.

  • users MembershipRequest[] Required

    Body parameter. An array of MembershipRequest objects

Example Request

JSON cURL 
{
  "users": [
    "{API::MembershipRequest}"
  ]
}
curl \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"users":["{API::MembershipRequest}"]}' \
  http://<bridge>/api/author/groups/:group_id/learners

Example Response

{
  "meta": {},
  "linked": {
    "groups": [
      {
        "id": "4",
        "parent_id": "",
        "name": "Rebellion",
        "type": "group",
        "users_count": 1,
        "links": {}
      }
    ]
  },
  "learners": [
    {
      "id": "2",
      "group": "4",
      "avatar": null,
      "completed_courses_count": 0,
      "email": null,
      "name": "Cem Al",
      "next_due_date": "2015-07-22T20:08:49.411Z"
    }
  ]
}

List the members of the group

GET /api/author/groups/:group_id/learners

Response Codes

  • 200 OK
  • 400 Bad Request

Parameters

  • group_id Integer Required

    Path parameter. Group id.

  • search String

    Query parameter. The value can be a firstname, lastname, username, or e-mail.

  • sort String [ name ]

    Query parameter. Returns results in ascending order. Prepending values with - will return results in descending order.

Example Response

{
  "meta": {},
  "linked": {
    "groups": [
      {
        "id": "1",
        "parent_id": "",
        "name": "All Learners",
        "type": "domain",
        "users_count": 1,
        "links": {}
      }
   ]
  },
  "learners": [
    {
      "id": "1",
      "group": "1",
      "avatar": null,
      "completed_courses_count": 1,
      "email": null,
      "name": "John Doo",
      "next_due_date": null
    }
  ]
}

Delete a member from a group

DELETE /api/author/groups/:group_id/learners/:id

Response Codes

  • 204 No Content

Parameters

  • group_id Integer Required

    Path parameter. Group id.

  • id Integer Required

    Path parameter. Learner id.