API

Private API

Video

This part of the REST API handles video listing, creation and modification.

Resource Method Description
create video POST This private request should be used to insert a video into Lemonwhale's system. In order to create a video you must include a link to the file that should be used. Lemonwhale can handle files from both FTP and HTTP.
update video POST This private request should be used to update data for an existing video.
get video GET This private request returns data for a single video.
list video on site GET Returns a list of videos for the site. By default it returns the 20 most recent videos on the site, but with the parameters you change the number of returning videos as well as the order of the list. The maximum videos that can be returned is 200.
list video for user GET Returns a list of videos for the specified user. By default it returns the 20 most recent videos on the site, but with the parameters you can change the number of returned videos as well as the order of the list. The maximum videos that can be returned is 200

Live

This part of the REST API handles liveshow listing, creation and modification.

Resource Method Description
create liveshow POST This private request lets you create a liveshow and returns data about the created liveshow.
update liveshow POST This private request lets you update an existing liveshow.
get liveshow GET This private request returns data for a single liveshow.
list liveshows on site GET Returns a list of liveshows on the site. By default it returns the 20 most recently created liveshows on the site, but with the parameters you change the number of returning liveshows as well as the order of the list. The maximum liveshows that can be returned per request is 200.

Category

This part of the REST API handles category listing, creation and modification.

Resource Method Description
create category POST Creates a category and returns data for the created category.
get category GET Returns data for a single category.
list categories on site GET Returns a list of categories for a site. Results contain maximum 200 categories. Categories are ordered in a tree structure with parent categories and subcategories and this can be used when filtering out categories on a site in this request. There are two parameters for filtering out categories; the first one is only_root which only returns categories without a parent category, the other parameter is parent, which when used only returns categories with the specified parent category.

User

This part of the REST API handles user listing, creation and modification.

Resource Method Description
get user GET Returns data for a single user.
create user POST Creates a user and returns data for the created user.
update user POST Update a user and returns the updated data.
list users on site GET Returns a list of users for a site. By default it returns the 20 most recently created users on the site, but with the parameters you change the number of returning users as well as the order of the list. The maximum users that can be returned per request is 200.