This endpoint allows you to get and set organisation details

Collection /organisation

GET /organisation/:id

Get details for an organisation

Apiary Demo

item value
Access system
Full url https://api.buto.tv/v2/organisation/{id}
verb GET
params string:organisation_id

GET /organisation/all

Get all active organisations

item value
Access system
Full url https://api.buto.tv/v2/organisation/all
verb GET
params none

Example usage

#set organisation details
curl -u API_KEY:x --include https://api.buto.tv/v2/organisation/all

returns

HTTP/1.1 200 OK
...
Content-Type: application/json
{
    "aaAAa": "company a",
    "bbBBb": "company b",
    "ccCCc": "company c",
    "ddDDd": "company d"
}

PUT /organisation/:id

Set details for a particular organisation

Apiary Demo

item value
Access system
Full url https://api.buto.tv/v2/organisation/{id}
verb PUT
params string:id

Collection /encodingformat

To set and get specific encoding formats for an organisation. We can't use full REST complient routes because of some technical limitations

Notes


  • These endpoints are protected with an API key, SYSTEM ONLY

GET /organisation/encodingformat/:organisation_id

Get an organisation's extra encoding formats eg wmv

item value
Access system
Full url https://api.buto.tv/v2/organisation/encodingformat/{organisation_id}
verb GET
params string:organisation_id:the organisation_id
curl -X GET -u ${api_key}:x https://api.buto.tv/v2/organisation/encodingformat/Bbgwg

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{
    "organisation_id": "Bbgwg",
    "title": "Bigbutton test",
    "1200_wmv": {
        "aspect_mode": "preserve",
        "audio_bitrate": 128,
        "audio_channels": 2,
        "audio_codec": "wmv",
        "audio_sample_rate": 44100,
        "format": "wmv",
        "keyframe_interval": 15,
        "label": 2,
        "size": "853x480",
        "speed": 2,
        "upscale": true,
        "video_bitrate": 1200,
        "video_codec": "microsoft"
    }
}

PUT /organisation/encodingformat-post/:organisation_id

Add additional encoding formats for an organisation

item value
Access system
Full url https://api.buto.tv/v2/organisation/encodingformat-post/{organisation_id}
verb PUT
params string:organisation_id: the organisation_id id int:encodingformat_id: the encodingformat_id you wish to apply
curl -X PUT -u ${api_key}:x --data-binary "encodingformat_id=12" https://api.buto.tv/v2/organisation/encodingformat-post/Bbgwg

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{
    "organisation_id": "Bbgwg",
    "title": "Bigbutton test",
    "1200_wmv": {
        "aspect_mode": "preserve",
        "audio_bitrate": 128,
        "audio_channels": 2,
        "audio_codec": "wmv",
        "audio_sample_rate": 44100,
        "format": "wmv",
        "keyframe_interval": 15,
        "label": 2,
        "size": "853x480",
        "speed": 2,
        "upscale": true,
        "video_bitrate": 1200,
        "video_codec": "microsoft"
    }
}

DELETE /organisation/encodingformat-delete/:organisationEncodingformat_id

Remove an encoding format profile from an organisation

item value
Access system
Full url https://api.buto.tv/v2/organisation/encodingformat-delete/${organisationEncodingformat_id}
verb DELETE
params int:organisationEncodingformat_id: the encodingformat/org association you wish to remove
curl -X DELETE -u ${api_key}:x https://api.buto.tv/v2/organisation/encodingformat-delete/123

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{"deleted":123}