Skip to content
This repository was archived by the owner on Feb 17, 2020. It is now read-only.

API models schema

Sebastiano Poggi edited this page Feb 17, 2017 · 11 revisions

The API models that are served by the Firebase RTDB must follow this schema:

{
    "events": [
        {
            "id": "0",
            "name": "This is the event title",
            "type": "[registration|talk|keynote|coffee_break|lunch|social|other]",        // Optional (assume other)
            "short_description": "This is the event short description, such as the abstract. Some HTML allowed.",
            "description": "A longer description. Some HTML allowed.",        // Optional, assume none
            "start_time": 1234567890,
            "end_time": 1234567891,
            "day_id": "1",
            "track_id": "0",        // Optional, assume no track
            "experience_level": "[beginner|intermediate|advanced]",                // Optional, assume none
            "place_id": "0",        // Optional, assume no place
            "speaker_ids": [
                "123", "876"
            ],        // Optional, assume no speakers
            "links": {
                "streaming": "http://example.com/stream/0",        // Optional, assume no streaming link
                "vod": "http://example.com/vod/0",        // Optional, assume no VOD link
                "slides": "http://example.com/decks/0"        // Optional, assume no deck link
            }
        } 
    ],
    "days": [
        {
            "id": "1",
            "position": 0, 
            "date": "07-04-2017"
        }
    ],
    "places": [
        {
            "id": "0",
            "floor": "Ground floor",         // Optional, assume no floor
            "name": "Keynote room"
        }
    ],
    "tracks": [
        {
            "id": "0",
            "accent_color": "#RRGGBB",
            "text_color": "#RRGGBB",
            "name": "Android",
            "icon_url": "http://example.com/tracks/0"         // Optional, assume no icon (vectors if possible)
        }
    ],
    "speakers": [
        {
            "id": "123",
            "name": "Rick Sanchez",
            "company_name": "Gazorpazorp",        // Optional, assume none
            "company_url": "http://gazorpazo.rp",        // Optional, assume none
            "personal_url": "http://rick.sanch.ez",        // Optional, assume none
            "bio": "The speaker's bio. Some HTML allowed.",
            "twitter_username": "@squanchy",        // Optional, assume none
            "photo_url": "gs://conf-app-id.appspot.com/speakers/123_Rick_Sanchez.jpg"        // Optional, assume none
        }
    ],
    "venue": {
        "name": "Centro congressi Rincotto",
        "address": "123 stocazzo rd, Trollino, Italy",
        "lat": 45.9680213,
        "lon": 12.9463144,
        "description": "Whatever you might want to say. Accepts some HTML"
    }
}

Clone this wiki locally