GET /api/?format=api
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/coreapi+json
Vary: Accept

{
    "_type": "document",
    "_meta": {
        "title": "Streamworld API"
    },
    "azure_channels": {
        "list": {
            "_type": "link",
            "url": "/azure_channels/",
            "action": "get",
            "description": "API endpoint that allowes AzureChannel to be viewed or edited"
        },
        "read": {
            "_type": "link",
            "url": "/azure_channels/{id}/",
            "action": "get",
            "description": "API endpoint that allowes AzureChannel to be viewed or edited",
            "fields": [
                {
                    "name": "id",
                    "required": true,
                    "location": "path"
                }
            ]
        }
    },
    "azure_programs": {
        "list": {
            "_type": "link",
            "url": "/azure_programs/",
            "action": "get",
            "description": "API endpoint that allowes AzureChannel to be viewed or edited"
        },
        "read": {
            "_type": "link",
            "url": "/azure_programs/{id}/",
            "action": "get",
            "description": "API endpoint that allowes AzureChannel to be viewed or edited",
            "fields": [
                {
                    "name": "id",
                    "required": true,
                    "location": "path"
                }
            ]
        }
    },
    "webcasts": {
        "editor_agendas": {
            "read": {
                "_type": "link",
                "url": "/webcasts/{id}/editor_agendas/",
                "action": "get",
                "description": "View to get agendas for a webcast in editors area and edit them\n:param request: the request\n:type request:  HttpRequest\n:param pk:      primary key of webcast (unused directly in view)\n:type pk:       str\n:return:        agenda data\n:rtype:         Response",
                "fields": [
                    {
                        "name": "id",
                        "required": true,
                        "location": "path"
                    }
                ]
            }
        },
        "editor_pdf": {
            "read": {
                "_type": "link",
                "url": "/webcasts/{id}/editor_pdf/",
                "action": "get",
                "description": "View to upload pdfs for a webcast in editors area\n:param request: the request\n:type request:  HttpRequest\n:param pk:      primary key of webcast (unused directly in view)\n:type pk:       str\n:return:        pdf data\n:rtype:         Response",
                "fields": [
                    {
                        "name": "id",
                        "required": true,
                        "location": "path"
                    }
                ]
            }
        },
        "editor_programs": {
            "read": {
                "_type": "link",
                "url": "/webcasts/{id}/editor_programs/",
                "action": "get",
                "description": "View to get programs for a webcast in editors area and edit them\n:param request: the request\n:type request:  HttpRequest\n:param pk:      primary key of webcast (unused directly in view)\n:type pk:       str\n:return:        program data\n:rtype:         Response",
                "fields": [
                    {
                        "name": "id",
                        "required": true,
                        "location": "path"
                    }
                ]
            }
        },
        "get_azure_vod_playlist": {
            "_type": "link",
            "url": "/webcasts/{id}/get_azure_vod_playlist/",
            "action": "get",
            "description": "View to get playlist of all azure programs in vod\n:param request: the request\n:type request:  HttpRequest\n:param pk:      primary key of webcast (unused directly in view)\n:type pk:       str\n:return:        azure vod playlist data\n:rtype:         Response",
            "fields": [
                {
                    "name": "id",
                    "required": true,
                    "location": "path"
                }
            ]
        },
        "get_consumer_agenda": {
            "_type": "link",
            "url": "/webcasts/{id}/get_consumer_agenda/{agenda_pk}/",
            "action": "get",
            "description": "View to get agendas for a webcast in consumer frontend\n:param request: the request\n:type request:  HttpRequest\n:param pk:      primary key of webcast (unused directly in view)\n:type pk:       str\n:return:        consumer agenda data\n:rtype:         Response",
            "fields": [
                {
                    "name": "id",
                    "required": true,
                    "location": "path"
                },
                {
                    "name": "agenda_pk",
                    "required": true,
                    "location": "path"
                }
            ]
        },
        "get_consumer_agendas": {
            "_type": "link",
            "url": "/webcasts/{id}/get_consumer_agendas/",
            "action": "get",
            "description": "View to get agendas for a webcast in consumer frontend\n:param request: the request\n:type request:  HttpRequest\n:param pk:      primary key of webcast (unused directly in view)\n:type pk:       str\n:return:        consumer agenda data\n:rtype:         Response",
            "fields": [
                {
                    "name": "id",
                    "required": true,
                    "location": "path"
                }
            ]
        },
        "get_consumer_pdfs": {
            "_type": "link",
            "url": "/webcasts/{id}/get_consumer_pdfs/",
            "action": "get",
            "description": "View to get pdfs for a webcast in consumer frontend\n:param request: the request\n:type request:  HttpRequest\n:param pk:      primary key of webcast (unused directly in view)\n:type pk:       str\n:return:        pdf data\n:rtype:         Response",
            "fields": [
                {
                    "name": "id",
                    "required": true,
                    "location": "path"
                }
            ]
        },
        "list": {
            "_type": "link",
            "url": "/webcasts/",
            "action": "get",
            "description": "API endpoint that allows Webcasts to be viewed or edited."
        },
        "read": {
            "_type": "link",
            "url": "/webcasts/{id}/",
            "action": "get",
            "description": "API endpoint that allows Webcasts to be viewed or edited.",
            "fields": [
                {
                    "name": "id",
                    "required": true,
                    "location": "path"
                }
            ]
        }
    }
}