ViMP API

This page describes the ways of accessing the ViMP API.

API Access is currently DISABLED. To enabled API access, contact your ViMP Administrator.

Methods

 
URL
api/getCategories
Description
Get all categories
Parameters
apikey
Optional parameters
filterbyname
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getCategory
Description
Get a specific category using ID
Parameters
apikey
categoryid
Optional parameters
language
ISO-639-1 code for category name
format
one of "xml" or "json"
 
URL
api/getCategoryMedia
Description
Get all media from a specified category
Parameters
apikey
categoryid
Optional parameters
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
 
URL
api/getChannels
Description
Get all channels
Parameters
apikey
Optional parameters
filterbyname
format
one of "xml" or "json"
 
URL
api/getChannel
Description
Get a specific channel using ID
Parameters
apikey
channelid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getChannelMedia
Description
Get all media from a specified channel
Parameters
apikey
channelid
Optional parameters
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
 
URL
api/getMedia
Description
Get all medias
Parameters
apikey
Optional parameters
filterbyname
filterbytype
id of the media type
filterbycategory
id of the category
filterbyfilter
one of "comments" "toprated" "hottest" "featured" or "newest"
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
 
URL
api/getMedium
Description
Get a specific media using ID
Parameters
apikey
mediumid
Optional parameters
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
 
URL
api/uploadMedium
Description
Upload a medium
Parameters
apikey
token
title
description
tags
categories
Ex: 5,8,9
source_url
Optional parameters
hidden
2, 1 or 0
meta_title
meta_description
meta_keywords
meta_author
meta_copyright
mediapermissions
Ex: 1,2,3
payment_withcosts
1 or 0
payment_prize
gm_location
gm_longitude
gm_latitude
gm_zoom
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/editMedium
Description
Edit a medium
Parameters
apikey
token
mediumid
Optional parameters
title
description
tags
categories
Ex: 5,8,9
thumbnail
hidden
2, 1 or 0
meta_title
meta_description
meta_keywords
meta_author
meta_copyright
mediapermissions
Ex: 1,2,3
payment_withcosts
1 or 0
payment_prize
gm_location
gm_longitude
gm_latitude
gm_zoom
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/deleteMedium
Description
Delete a medium
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/reportMedium
Description
Report innapropriate medium
Parameters
apikey
token
mediumid
reason
Optional parameters
format
one of "xml" or "json"
 
URL
api/getMediumComments
Description
Get all comments of a medium
Parameters
apikey
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addMediumComment
Description
Add comment to a medium
Parameters
apikey
token
mediumid
comment
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteMediumComment
Description
Delete a comment of a medium
Parameters
apikey
token
mediumid
commentid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addMediumRating
Description
Add rating to a specific medium
Parameters
apikey
token
mediumid
rating
1..5
Optional parameters
format
one of "xml" or "json"
 
URL
api/addMediumLike
Description
Add like to a specific medium
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteMediumLike
Description
Delete like to a specific medium
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addMediumFavorite
Description
Add a medium to user favorite
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteMediumFavorite
Description
Remove a medium from user's favorite
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getPages
Description
Get all pages
Parameters
apikey
Optional parameters
filterbyname
language
ISO-639-1 code for page content
format
one of "xml" or "json"
 
URL
api/getPage
Description
Get a specific page using ID
Parameters
apikey
pageid
Optional parameters
language
ISO-639-1 code for page content
format
one of "xml" or "json"
 
URL
api/getUsers
Description
Get all users
Parameters
apikey
Optional parameters
filterbyname
format
one of "xml" or "json"
 
URL
api/getUser
Description
Get a specific user using ID
Parameters
apikey
userid
Optional parameters
format
one of "xml" or "json"
 
URL
api/loginUser
Description
Login a specific user
Parameters
apikey
username
password
Optional parameters
format
one of "xml" or "json"
 
URL
api/logoutUser
Description
Logout a specific user
Parameters
apikey
token
Optional parameters
format
one of "xml" or "json"
 
URL
api/registerUser
Description
Register a new user
Parameters
apikey
username
email
password
Optional parameters
avatar
Url
coverpicture
Url
firstname
lastname
gender
male or female
city
country
birthday
yyyy-mm-dd
aboutme
format
one of "xml" or "json"
 
URL
api/editUser
Description
Change basic user data.
Parameters
apikey
token
userid
Optional parameters
username
password
email
avatar
Url
coverpicture
Url
firstname
lastname
gender
male or female
city
country
birthday
yyyy-mm-dd
aboutme
format
one of "xml" or "json"
 
URL
api/setNewUserPassword
Description
Reset password of a registered user. New password will be sent to the registered email address of the user.
Parameters
apikey
token
old_password
new_password
Optional parameters
userid
format
one of "xml" or "json"
 
URL
api/deleteUser
Description
Delete a user.
Parameters
apikey
token
Optional parameters
userid
format
one of "xml" or "json"
 
URL
api/reportUser
Description
Report innapropiate user
Parameters
apikey
token
userid
reason
Optional parameters
format
one of "xml" or "json"
 
URL
api/getUserComments
Description
Get a user's comments on its profile page
Parameters
apikey
userid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addUserComment
Description
Add a user comment
Parameters
apikey
token
userid
comment
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteUserComment
Description
Delete a user comment
Parameters
apikey
token
commentid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getUserFavoriteMedia
Description
Get user's favorite media
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getUserFavoriteBlogs
Description
Get user's favorite blogs
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getUserMedia
Description
Get user's media
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getUserFriends
Description
Get user's friends
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getUserAlbums
Description
Get user's albums
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getUserGroups
Description
Get user's groups
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getUserChannels
Description
Get user's channels
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getUserBlogs
Description
Get user's blogs
Parameters
apikey
userid
Optional parameters
language
ISO-639-1 code for category names
format
one of "xml" or "json"
 
URL
api/getGroups
Description
Get all groups
Parameters
apikey
Optional parameters
filterbyname
format
one of "xml" or "json"
 
URL
api/getGroup
Description
Get a specific group using ID
Parameters
apikey
groupid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getGroupUsers
Description
Get all user from a specified group
Parameters
apikey
groupid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getGroupMedia
Description
Get all media from a specified group
Parameters
apikey
groupid
Optional parameters
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
 
URL
api/getAlbums
Description
Get all albums
Parameters
apikey
Optional parameters
filterbyname
format
one of "xml" or "json"
 
URL
api/getAlbum
Description
Get a specific album using ID
Parameters
apikey
albumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getAlbumMedia
Description
Get all media from a specified album
Parameters
apikey
albumid
Optional parameters
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
 
URL
api/getLivestreams
Description
Get all livestreams
Parameters
apikey
Optional parameters
filterbyname
format
one of "xml" or "json"
 
URL
api/getLivestream
Description
Get a specific livestream using ID
Parameters
apikey
livestreamid
Optional parameters
format
one of "xml" or "json"
 
URL
api/search
Description
Search
Parameters
apikey
keyword
Optional parameters
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
 
URL
api/extendedSearch
Description
Extended search
Parameters
apikey
title
Optional parameters
description
tags
searchrange
one of "all", "video", "audio", "document", "photo" or "user" (Default: "all")
groups
channels
categories
language
ISO-639-1 code for media category names
format
one of "xml" or "json"

Data types and structures

Category
Structure Category {
  Integer cid;
  String culture;
  String name;
  String description;
  Integer categorytype;
  Integer status;
  String picture_filename;
  Integer weight;
  DateTime created_at;
  DateTime updated_at;
}  
Channel
Structure Channel {
  Integer chid;
  Integer status;
  Integer uid;
  String username;
  String picture_filename;
  String picture_menu_filename;
  String culture;
  String title;
  String description;
  DateTime created_at;
  DateTime updated_at;
}  
Media
Structure Media {
  Integer mid;
  Integer uid;
  String username;
  String mediakey;
  Integer mediatype;
  Boolean first;
  Boolean hidden;
  Integer status;
  Boolean featured;
  String culture;
  String properties;
  String title;
  String description;
  Integer duration;
  String thumbnail_filename;
  String source_filename;
  String scrambled_filename;
  String meta_title;
  String meta_description;
  String meta_keywords;
  String meta_author;
  String meta_copyright;
  String conversion_notice;
  Real sum_rating;
  Integer count_views;
  Integer count_rating;
  Integer count_favorites;
  Integer count_comments;
  Integer count_flags;
  DateTime created_at;
  DateTime updated_at;
  DateTime converted_at;
  Category[] categories;
  Tag[] tags;
}  
Page
Structure Page {
  Integer wid;
  Integer status;
  String culture;
  String title;
  String description;
  String description;
  DateTime created_at;
  DateTime updated_at;
}  
User
Structure User {
  Integer uid;
  Integer status;
  String username;
  String email;
  String avatar_filename;
  Integer gender;
  String firstname;
  String lastname;
  String city;
  String country;
  Date birthday;
  DateTime last_login_at;
  DateTime last_access_at;
  DateTime created_at;
  DateTime updated_at;
}  
Tag
Structure Tag {
  Integer tid;
  String culture;
  String name;
  DateTime created_at;
  DateTime updated_at;
}  
Group
Structure Group {
  Integer gid;
  Integer uid;
  String username;
  String groupkey;
  Boolean hidden;
  Integer status;
  Boolean featured;
  String culture;
  String title;
  String description;
  String picture_filename;
  Integer weight;
  DateTime created_at;
  DateTime updated_at;
}  
Album
Structure Album {
  Integer aid;
  Integer albumtype;
  Integer objectid;
  Integer visibility;
  String title;
  String description;
  DateTime created_at;
  DateTime updated_at;
}  
LiveStream
Structure LiveStream {
  Integer lsid;
  Integer status;
  Integer uid;
  String username;
  String picture_filename;
  String picture_menu_filename;
  String picture_cover_filename;
  String picture_placeholder_filename;
  String stream_rtmp;
  String stream_hls;
  String stream_rtp;
  String stream_hds;
  String stream_silverlight;
  String culture;
  String title;
  String description;
  DateTime created_at;
  DateTime updated_at;
}  

Video CMS powered by ViMP (Ultimate) © 2014, 2013, 2012, 2011, 2010