Float-scheduler NPM

Float Scheduler

A Node module for interacting with Float Scheduler's API.

Installation

npm install float-scheduler

Usage

var Float = require('float-scheduler');
var float = new Float({token: "my-float-api-token", user_agent: "My App <contact@myapp.com>"});

You must pass in a token and user_agent when constructing a Float object.

You get your token from the Float dashboard (of an administrator).

The user-agent string is for Float to identify who to contact in case of questions or concerns.

You may pass in a debug parameter as well, to get more console output.

If you don't need debug info but do want request logging, pass in a log_requests parameter. API request logs will be of the following format (tokens in angle brackets, all other characters literal):

<YYYY>-<MM>-<DD> <HH>:<MM>:<SS>.<mmmm> [float-scheduler] <HTTP_METHOD> <URL>

Endpoints

Endpoints are each set up to take a parameters object and a callback. Unless otherwise noted, the callback will provide an error object and a data object.

For example, list all People by calling:

float.People.list({}, function(error, response_data) {
    if (error) {
        console.log(error);
        throw new Error(error);
    }
    console.log(response_data);
});

For more detail on specific endpoints and parameters, check out the wiki page.