apiary.apib

HOST: http://api.babelroom.com/api/v1/

--- BabelRoom API ---
---
Welcome to the our API documentation.

All comments can be written in (support [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax)

Refer to the introduction on the [http://code.google.com/p/babelroom/wiki/RESTAPI wiki]
---

Retrieve user data associated with active cookie session. The empty set is returned if there is no valid active cookie session.
GET login
< 200
< Content-Type: application/json; charset=utf-8
{}
+++++
< 200
< Content-Type: application/json; charset=utf-8
{"user": {"id":3, "email_address":"apitest@example.com", "email":"apitest@example.com", "name":"API", "last_name":"Test"}}

Login. If successful set a new cookie session.
POST login
> Content-Type: application/json; charset=utf-8
{"login":"apitest@example.com", "password":"default"}
< 200
< Content-Type: application/json; charset=utf-8
{"user": {"id":3, "email_address":"apitest@example.com", "email":"apitest@example.com", "name":"API", "last_name":"Test"}}
+++++
< 200
< Content-Type: application/json; charset=utf-8
{}

Logout. Destroy the currently active cookie session
DELETE login
< 200
< Content-Type: application/json; charset=utf-8
{}

Logout. Synonymous with DELETE login
POST logout
< 200
< Content-Type: application/json; charset=utf-8
{}

Retrieve the superset of context for the currently logged in user, the specified conference and any associated invitation.
The conference uri is appended to the end of the REST resource path /api/v1/invitation
GET invitation/apitest
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
< 200
< Content-Type: application/json; charset=utf-8
{"data": {
    "user_id":3,
    "email_address":"apitest@example.com",
    "email":"apitest@example.com",
    "first_name":"API",
    "last_name":"Test",
    "origin_id":"37",
    "conference_id":3,
    "conference_name":"API Test Conference",
    "conference_config":"<internal data>",
    "conference_introduction":"API Test Conference",
    "conference_uri":"apitest",
    "conference_access_config":null,
    "conference_skin_id":1,
    "invitation_id":2,
    "pin":"444444",
    "myAccessInfo":"<internal data>",
    "connection_salt":"<internal>",
    "user_name":"API Test",
    "is_host":true,
    "is_live":false,
    "conference_estream_id":"<internal>"
    }
}

Add the current user as a conference participant
The conference uri is appended to the end of the REST resource path /api/v1/add_self
POST add_self/apitest
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
> Content-Type: application/json; charset=utf-8
{
    "user": {
        "name" => "API",
        "last_name" => "Test",
        "email" => "apitest@example.com",
        "origin_data" => "Origin System Name",
        "origin_id" => 37,
        "phone" => "650.555.1212",
        },
    "invitation": {
        },
    "avatar_url": "http://example.com/path/to/my/avatar"
}
< 200
< Content-Type: application/json; charset=utf-8
{}

Add another user as a conference participant
The conference uri is appended to the end of the REST resource path /api/v1/add_participant
POST add_participant/apitest
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
> Content-Type: application/json; charset=utf-8
{
    "user": {
        "name" => "API",
        "last_name" => "Test",
        "email" => "apitest@example.com",
        "origin_data" => "Origin System Name",
        "origin_id" => 37,
        "phone" => "650.555.1212",
        },
    "invitation": {
        "role":"Host",
        },
    "avatar_url": "http://example.com/path/to/my/avatar",
    "return_token":true
}
< 200
< Content-Type: application/json; charset=utf-8
{}

--
Server
APIs for server version and status.
--
Server status. This is mainly for use by automated server monitoring tools.
GET status
< 200
< Content-Type: application/json; charset=utf-8
{
  "status": "OK"
}

Server version. 
GET version
< 200
< Content-Type: application/json; charset=utf-8
{
  "major": "2",
  "minor": "37",
  "commit": "201",
  "stamp": "2.37.201"
}

Remove files
DELETE files
< 200
< Content-Type: application/json; charset=utf-8
{}

--
General Purpose Resources
These resources are automatically generated from
[https://github.com/babelroom/clouds/blob/master/gen/schema/main.sch](https://github.com/babelroom/clouds/blob/master/gen/schema/main.sch)
--

Get user data

Retrieve specified columns only by appending query string 'c' parameter, e.g. ?c=name,email_address,last_name,company,email,origin_data,origin_id

Access required to execute this API will be documented shortly.
GET users/3
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
< 200
< Content-Type: application/json; charset=utf-8
{"name": "First","email_address": "mail@example.com","last_name": "Last","company": "Fastbuck, Inc.","email": "mail@example.com","origin_data": "Origin System (optional)","origin_id": 37}
+++++
< 401
< Content-Type: application/json; charset=utf-8
{"error":{"code": 401,"text": "HTTP Basic Auth or Cookie Session Required" }}
+++++
< 403
< Content-Type: application/json; charset=utf-8
{"error":{"code":403,"text":"Access Denied"}}

Get conference data

Retrieve specified columns only by appending query string 'c' parameter, e.g. ?c=name,uri,introduction,access_config,origin_data,origin_id

Access required to execute this API will be documented shortly.
GET conferences/3
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
< 200
< Content-Type: application/json; charset=utf-8
{"name": "My Conference","uri": "myuri","introduction": "My summary, introduction or description","access_config": "{}","origin_data": "Origin data (optional)","origin_id": 37}
+++++
< 401
< Content-Type: application/json; charset=utf-8
{"error":{"code": 401,"text": "HTTP Basic Auth or Cookie Session Required" }}
+++++
< 403
< Content-Type: application/json; charset=utf-8
{"error":{"code":403,"text":"Access Denied"}}

Create a new conference

Access required to execute this API will be documented shortly.
POST conferences
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
> Content-Type: application/json; charset=utf-8
{"name": "My Conference","introduction": "My summary, introduction or description","access_config": "{}","origin_data": "Origin data (optional)","origin_id": 37}
< 201
< Content-Type: application/json; charset=utf-8
{}
+++++
< 401
< Content-Type: application/json; charset=utf-8
{"error":{"code": 401,"text": "HTTP Basic Auth or Cookie Session Required" }}
+++++
< 403
< Content-Type: application/json; charset=utf-8
{"error":{"code":403,"text":"Access Denied"}}

Update an existing conference

Access required to execute this API will be documented shortly.
PUT /conferences/3
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
> Content-Type: application/json; charset=utf-8
{"name": "My Conference","introduction": "My summary, introduction or description","access_config": "{}","origin_data": "Origin data (optional)","origin_id": 37}
< 200
< Content-Type: application/json; charset=utf-8
{}
+++++
< 401
< Content-Type: application/json; charset=utf-8
{"error":{"code": 401,"text": "HTTP Basic Auth or Cookie Session Required" }}
+++++
< 403
< Content-Type: application/json; charset=utf-8
{"error":{"code":403,"text":"Access Denied"}}

Delete a conference

Access required to execute this API will be documented shortly.
DELETE conferences/3
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
< 200
< Content-Type: application/json; charset=utf-8
{}
+++++
< 401
< Content-Type: application/json; charset=utf-8
{"error":{"code": 401,"text": "HTTP Basic Auth or Cookie Session Required" }}
+++++
< 403
< Content-Type: application/json; charset=utf-8
{"error":{"code":403,"text":"Access Denied"}}

Create a new avatar for the current user

Access required to execute this API will be documented shortly.
POST /avatar
> Authorization: Basic N2NiNTI0ZmI2NGViNGUyNmQxYjIzM2QyZjI5M2QxMGM6
> Content-Type: application/json; charset=utf-8
{"upload_url": "http://files.example.com/file/my_master_avatar.png"}
< 201
< Content-Type: application/json; charset=utf-8
{}
+++++
< 401
< Content-Type: application/json; charset=utf-8
{"error":{"code": 401,"text": "HTTP Basic Auth or Cookie Session Required" }}
+++++
< 403
< Content-Type: application/json; charset=utf-8
{"error":{"code":403,"text":"Access Denied"}}