RootIO Web API

The RootIO Web API is the primary means of communication between the cloud server and the phone client.

Methods and URLs

HTTP is the default means of communication, but fallbacks to SMS may be provided for low-bandwidth situations where some latency is acceptable. All requests should follow standard HTTP verbs (GET, PUT, PATCH, DELETE), and all responses are standard HTTP error codes with JSON messages. Do not include trailing slashes in your URLs.

CRUD routes are provided by Flask-Restless, which uses JSON syntax to provide pagination and search.

Dates are ISO formatted, times without timezone are assumed to be UTC.

Authentication

Calls must be identified either with a 10-digit station API key, or basic HTTP authentication provided by Flask. The API key is preferred for station to server communication. The API should implement SSL, although this is currently TBD.

Examples

/api/person/1

{
additionalcontact: "",
email: "[email protected]",
firstname: "John",
gender_code: 1,
id: 1,
languages: [
{
    id: 1,
    iso639_1: "en",
    iso639_2: "eng",
    locale_code: "en_US",
    name: "English"
},
{
    id: 2,
    iso639_1: "de",
    iso639_2: "deu",
    locale_code: "de_CH",
    name: "German"
},
],
lastname: "Jacob",
middlename: "Jingleheimer-Schmidt",
phone: {
    carrier: null,
    countrycode: "41",
    id: 1,
    number: "0123456789",
    number_type: "1",
    raw_number: "0123456789"
},
phone_id: 1,
privacy_code: null,
role: [ ],
title: "Mr."
}

/api/station/1