Rhythm API Description

API Description for Rhythm-Based Projects

Version 0.1

Server Endpoints

All endpoints are implemented through a Database adapter for feathers.js. This means that there is a well-documented query language for accessing endpoints made available by a Rhythm server. That query language is documented here.

In general, you may query an endpoint either through a websocket connection to a Rhythm server (recommended), or use RESTful HTTP requests to access and modify data.

In either case, the query syntax is the same. If you'd like to retrieve all meetings that started at or after 5:00PM EST on March 17th, 2016, you would do one of:

websockets (after connecting)

var io = require('feathers-socketio');
var socket = io.connect('url-to-server', {'param': 'my-param-value'});
socket.emit('meetings::find', 
  {
    query: {
      $gt: {
        'start_time': 'Thu Mar 17 2016 17:00:00 GMT-0400 (EDT)'
      }
    }
  },
  function(error, foundMeetings) {
    //... your code here
  });

REST Send a GET request to:

/meetings?$gt[start_time]=20160517T170000Z

This will set params.query on the server side to:

{
  "$gt": { "start_time": "20160517T170000Z" }
}

For more information, visit the REST readme for Feathers 2.0.0.

/meetings

All meetings recorded by the system, or a set of meetings that match the query parameters. Meetings include historical and real-time data.

Parameters

participants: Optional. List of String IDs of participants. This is a list of participants currently in the meeting. Meetings that have ended have no participants. If you're looking for data on what meeting a particular set of participants was in, see the /participant_events or /participants endpoints.

start_time: Optional. ISO Date string. Indicates the start time of this meeting.

end_time: Optional. ISO Date String. Indicates the end time of this meeting. end_time is null for meetings that have not ended yet.

meeting_id: Optional. String. Returns results whose meeting_id matches this parameter. Each meeting has a unique meeting_id.

active: Optional. Boolean. Indicates whether or not the meeting is currently active.