API Resources

Author - Live Course Session Registrations API

This API allows authors to list, create, destroy registrants and take attendance.

Interfaces

List registrations for a live course session

GET /api/author/live_course_sessions/:live_course_session_id/registrations

Note: the deleted_at element in the returned object is present only if deleted records were requested.

Response Codes

  • 200 OK
  • 400 Bad Request

Parameters

  • live_course_sessions_id Integer Required

    Path parameter. Live course session id.

  • updated_after DateTime

    Returns records updated after a given date and time

  • created_after DateTime

    Returns records created after a given date and time

  • deleted_after DateTime

    Returns records deleted after a given date and time

  • updated_before DateTime

    Returns records updated before a given date and time

  • created_before DateTime

    Returns records created before a given date and time

  • deleted_before DateTime

    Returns records deleted before a given date and time

  • only_deleted Boolean

    Filters list to only include deleted registrations.

  • with_deleted Boolean

    Filters list to also include deleted registrations.

Example Request

/api/author/live_course_sessions/5/registrations
/api/author/live_course_sessions/5/registrations?with_deleted&updated_after=2015-07-05T12:27:55Z

Example Response

{
  "meta": {},
  "registrations": [
    {
      "id": "3",
      "live_course_session_id": "1",
      "name": "John Doo",
      "avatar_url": null,
      "marked_complete_at": "2015-07-16T14:49:00.762-06:00",
      "start_at": "2015-07-16T14:30:00.546-06:00",
      "created_at": "2015-06-01T01:12:56Z",
      "updated_at": "2015-07-04T23:57:00Z",
      "deleted_at": null
    }
  ]
}

Create a new registration

POST /api/author/live_course_sessions/:live_course_session_id/registrations

Response Codes

  • 204 No Content
  • 400 Bad Request

Parameters

  • live_course_session_id Integer Required

    Path parameter. Live course session id.

  • user_id Integer Required

    Body parameter. The ID of the learner to register for the session.

  • from_waitlist Boolean

    Body parameter. Default false.

Example Request

JSON cURL 
{
  "user_id": 42
}
curl \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"user_id":42}' \
  http://<bridge>/api/author/live_course_sessions/:live_course_session_id/registrations

Update the registration

PATCH /api/author/live_course_sessions/:live_course_session_id/registrations/:id
PUT /api/author/live_course_sessions/:live_course_session_id/registrations/:id

Response Codes

  • 200 OK
  • 400 Bad Request

Parameters

  • live_course_session_id Integer Required

    Path parameter. Live course session id.

  • id Integer Required

    Path parameter. Registration id.

  • live_course_session_registration[marked_complete_at] DateTime Required

    Body parameter. DateTime of check in at live course session or null if not present.

Example Request

JSON cURL 
{
  "live_course_session_registration": {
    "marked_complete_at": null
  }
}
curl \
  -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"live_course_session_registration":{"marked_complete_at":null}}' \
  http://<bridge>/api/author/live_course_sessions/:live_course_session_id/registrations/:id

Example Response

{
  "meta": {},
  "registrations": []
}