Back to top

SocialEngine REST API

What is REST API? Simply, REST API is the set of functions to which the developers can perform requests and receive responses. The interaction is performed via the HTTP/HTTPS protocol. An advantage of such an approach is the wide usage of HTTP/HTTPS that’s why REST API can be used practically for any programming language.

Below are the characteristics of the SocialEngineAddOns REST API:

  • When a request is sent to the REST API server, the server will return a response that contains either the data you requested, or the status code, or both.

  • oauth_consumer_key / oauth_consumer_secret? The Consumer Key and Consumer Secret Key are used to make a connection between API client and server. These keys are also used for creating OAuth Tokens for site members to access server resources without sharing their credentials.

Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
  • oauth_token / oauth_secret? The OAuth Token and OAuth Secret are used for identifying site members.
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478

Base URL

All requests to this REST API should have the base URL: [https://example.com/api/rest/]

HTTP Verbs

In REST API, there are four verbs that are used to manage resources: GET, POST, PUT, and DELETE. You can get the contents of a data using GET, delete the data using DELETE, and create or update the data using POST/PUT.

Supported Features

Official SocialEngine Plugins

  • Blogs Plugin

  • Photo Albums Plugin

  • Classifieds Plugin

  • Groups Plugin

  • Events Plugin

  • Forums Plugin

  • Polls Plugin

  • Video Sharing Plugin

  • Music Sharing Plugin

Core SocialEngine Features

  • Search

  • Member Links

  • Member Log-in

  • Member Sign-up With Profile Fields

  • Edit Member Profile Fields

  • Activity Feeds

  • Notifications

  • Friend Requests

  • Messages

  • Member Settings

  • Likes and Comments

  • Easy Implementation of Photo Lightbox.

  • Footer Menus

SocialEngineAddOns Plugins:

  • Advanced Activity Feeds / Wall Plugin

  • Geo-Location, Geo-Tagging, Check-Ins & Proximity Search Plugin [only for Advanced Activity Feed’s location features]

Advanced Video Plugin/ Videos

These are the APIs for the SocialEngineAddOns Plugin: Advanced Video Plugin.

Video Create Form

Video Create Form
GET/advancedvideos/create

Get the Video Create form.

Example URI

GET /advancedvideos/create
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "form": [
      {
        "type": "Text",
        "name": "title",
        "label": "Channel Title",
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "channel_url",
        "description": "This will be the end of your channel URL. It should be indicative of the title and can contain alphabets, numbers, underscores and dashes only. Its length should be in the range of 3-255 characters. The complete URL of your channel will be: http://www.example.com/CHANNEL-NAME",
        "label": "Url"
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Check Availabillity"
      },
      {
        "type": "Text",
        "name": "tags",
        "label": "Tags (Keywords)",
        "description": "Separate tags with commas."
      },
      {
        "type": "Select",
        "name": "category_id",
        "allowEmpty": 0,
        "label": "Category",
        "multiOptions": {
          "0": "",
          "1": "Comedy",
          "2": "Film & Entertainment",
          "3": "Gaming",
          "4": "Beauty & Fashion",
          "5": "From TV",
          "6": "Automotive",
          "7": "Animation",
          "8": "Sports",
          "9": "Technology",
          "10": "Science & Education",
          "11": "Cooking & Health",
          "12": "News & Politics",
          "13": "Lifestyle",
          "14": "Others"
        },
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "description",
        "label": "Description",
        "hasValidator": true
      },
      {
        "type": "Select",
        "name": "auth_view",
        "label": "Privacy",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "owner": "Just Me"
        },
        "value": "everyone",
        "hasValidator": true
      },
      {
        "type": "Select",
        "name": "auth_comment",
        "label": "Comment Privacy",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "owner": "Just Me"
        },
        "value": "everyone",
        "hasValidator": true
      },
      {
        "type": "Checkbox",
        "name": "search",
        "label": "Show this video in search result",
        "value": 1
      },
      {
        "type": "File",
        "name": "filedata",
        "label": "Main Photo"
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Submit"
      }
    ],
    "subcategories": {
      "1": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "0": "",
            "15": "Comedy Night"
          }
        },
        "subsubcategories": {
          "15": {
            "type": "Select",
            "name": "subsubcategory_id",
            "label": "3rd Level Category",
            "multiOptions": {
              "0": "",
              "16": "Comedy Night With John"
            }
          }
        }
      },
},
"fields": {
  "14": [
    {
      "type": "Text",
      "name": "1_1_2_field_2",
      "label": "channel",
      "description": ""
    },

  ]
}
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Create Video

Create Video
POST/advancedvideos/create

Example URI

POST /advancedvideos/create
URI Parameters
HideShow
title
string (required) Example: title=THE TIME TRAVELERS.

title.

main_channel_id
integer (optional) Example: main_channel_id=1

main_channel_id.

category_id (required, integer, `category_id
string (required) Default: 4`) 

category_id.

tags
string (optional) Example: tags=john, Smith

tags.

description
string (required) Example: description=THE TIME TRAVELERS.

description.

location
string (optional) Example: location=New York

location.

auth_view (required, string, `auth_view
string (required) Default: everyone`) 

auth_view defualt value is everyone.

auth_comment (required, string, `auth_comment
string (required) Default: everyone`) 

auth_comment defualt value is everyone.

search
string (optional) Example: search=1

defualt set value is 1 for search else 0 .

rotation
string (optional) Example: rotation=90

rotation.

type
string (required) Example: type=1

Video type 1 for Youtube, 2 for Vimeo, 3 for My Device, 4 for dailymotion and 5 for Embed Code.

url
string (required) Example: url=www.youtube.com/xyp15x

It is required when you select You Tube, Vimeo, Dailymostion and Embed code.

filedata
file (required) Example: filedata=example.mp4

It is required when you upload video from My Device.

subcategory_id (optional, string, `subcategory_id
string (required) Default: 1`) 

subcategory_id.

subsubcategory_id (optional, string, `subsubcategory_id
string (required) Default: 19`) 

subsubcategory_id.

1_1_2_field_2
string (optional) Example: 1_1_2_field_2=Video

profile field 1_1_2_field_2 .

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
"gutterMenu": [
  {
    "label": "Delete Video",
    "name": "delete",
    "url": "advancedvideo/delete/61"
  },
  {
    "label": "Edit Video",
    "name": "delete",
    "url": "advancedvideo/edit/61"
  },
  {
    "label": "Share",
    "name": "share",
    "url": "activity/share",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  },
  {
    "label": "Suggest to friends",
    "name": "suggest",
    "url": "suggestions/suggest-to-friend",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  }
],
"menus": [
  {
    "label": "Watch Later",
    "name": "watch_later",
    "url": "advancedvideo/watch-later/61",
    "urlParams": {
      "value": 1
    }
  },
  {
    "label": "Add to Playlist",
    "name": "playlist",
    "url": "advancedvideo/add-to-playlist/61"
  },
  {
    "label": "Favourite",
    "name": "favourite",
    "url": "advancedvideo/favourite-video/61",
    "urlParams": {
      "value": 1
    }
  },
  {
    "label": "Share",
    "name": "share",
    "url": "activity/share",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  },
  {
    "label": "Subscribe",
    "name": "subscribe",
    "url": "advancedvideo/subscription/61",
    "urlParams": {
      "value": 1,
      "id": 6
    }
  }
],
"response": {
  "video_id": 61,
  "title": "THE TIME TRAVELERS",
  "description": "THE TIME TRAVELERS",
  "search": 1,
  "owner_type": "user",
  "owner_id": 1,
  "parent_type": null,
  "parent_id": null,
  "creation_date": "2017-03-27 08:02:17",
  "modified_date": "2017-03-27 08:09:31",
  "view_count": 0,
  "comment_count": 0,
  "type": 1,
  "code": "G62HrubdD6o",
  "photo_id": 420,
  "rating": 0,
  "category_id": 13,
  "status": 1,
  "file_id": 0,
  "duration": 145,
  "rotation": 0,
  "main_channel_id": 1,
  "subcategory_id": null,
  "subsubcategory_id": null,
  "profile_type": 4,
  "featured": 0,
  "favourite_count": 0,
  "sponsored": 0,
  "seao_locationid": 0,
  "location": "delhi",
  "networks_privacy": null,
  "like_count": 0,
  "synchronized": 0,
  "image": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",
  "image_normal": "http://www.example.com/public/video/a7/01/01a6_62cd.jpg?c=b28c",
  "image_profile": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",/advanceapi
  "image_icon": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",
  "content_url": "http://www.example.com/videos/1/61/old-video",
  "owner_image": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_normal": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_profile": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_icon": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
  "owner_title": "John",
  "rating_count": 0,
  "is_like": false,
  "category_tital": "Science & Technology",
  "tags": {
    "13": "John"
  },
  "auth_view": "owner",
  "auth_comment": "everyone",
  "can_edit": 1,
  "can_delete": 1,
  "can_embed": true,
  "rated": false,
  "videoEmbedded": "",
  "channel_title": "Health Flavors",
  "is_subscribe": 0,
  "video_url": "www.youtube.com/embed/G62HrubdD6o?wmode=opaque&autoplay=1",
  "ProfileInfo": {
    "channel": "Zee Tv",
  }
},
"is_password": 0
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Video Edit Form

Video Edit Form
GET/advancedvideo/edit/

Get the Video edit form.

Example URI

GET /advancedvideo/edit/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 652`) 

video_id .

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "form": [
      {
        "type": "Text",
        "name": "title",
        "label": "Channel Title",
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "channel_url",
        "description": "This will be the end of your channel URL. It should be indicative of the title and can contain alphabets, numbers, underscores and dashes only. Its length should be in the range of 3-255 characters. The complete URL of your channel will be: http://www.example.com/CHANNEL-NAME",
        "label": "Url"
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Check Availabillity"
      },
      {
        "type": "Text",
        "name": "tags",
        "label": "Tags (Keywords)",
        "description": "Separate tags with commas."
      },
      {
        "type": "Select",
        "name": "category_id",
        "allowEmpty": 0,
        "label": "Category",
        "multiOptions": {
          "0": "",
          "1": "Comedy",
          "2": "Film & Entertainment",
          "3": "Gaming",
          "4": "Beauty & Fashion",
          "5": "From TV",
          "6": "Automotive",
          "7": "Animation",
          "8": "Sports",
          "9": "Technology",
          "10": "Science & Education",
          "11": "Cooking & Health",
          "12": "News & Politics",
          "13": "Lifestyle",
          "14": "Others"
        },
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "description",
        "label": "Description",
        "hasValidator": true
      },
      {
        "type": "Select",
        "name": "auth_view",
        "label": "Privacy",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "owner": "Just Me"
        },
        "value": "everyone",
        "hasValidator": true
      },
      {
        "type": "Select",
        "name": "auth_comment",
        "label": "Comment Privacy",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "owner": "Just Me"
        },
        "value": "everyone",
        "hasValidator": true
      },
      {
        "type": "Checkbox",
        "name": "search",
        "label": "Show this video in search result",
        "value": 1
      },
      {
        "type": "File",
        "name": "filedata",
        "label": "Main Photo"
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Submit"
      }
    ],
    "subcategories": {
      "1": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "0": "",
            "15": "Comedy Night"
          }
        },
        "subsubcategories": {
          "15": {
            "type": "Select",
            "name": "subsubcategory_id",
            "label": "3rd Level Category",
            "multiOptions": {
              "0": "",
              "16": "Comedy Night With John"
            }
          }
        }
      },
},
"fields": {
  "14": [
    {
      "type": "Text",
      "name": "1_1_2_field_2",
      "label": "channel",
      "description": ""
    },

  ]
}
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Edit Video

Edit Video
POST/advancedvideo/edit/

Example URI

POST /advancedvideo/edit/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 61.`) 

video_id.

title
string (required) Example: title=THE TIME TRAVELERS.

video_id.

main_channel_id
integer (optional) Example: main_channel_id=1

main_channel_id.

category_id (required, integer, `category_id
string (required) Default: 4`) 

category_id.

tags
string (optional) Example: tags=john, Smith

tags.

description
string (required) Example: description=THE TIME TRAVELERS.

description.

location
string (optional) Example: location=New York

location.

auth_view (required, string, `auth_view
string (required) Default: everyone`) 

auth_view defualt value is everyone.

auth_comment (required, string, `auth_comment
string (required) Default: everyone`) 

auth_comment defualt value is everyone.

search
string (optional) Example: search=1

defualt set value is 1 for search else 0 .

subcategory_id (optional, string, `subcategory_id
string (required) Default: 1`) 

subcategory_id.

subsubcategory_id (optional, string, `subsubcategory_id
string (required) Default: 19`) 

subsubcategory_id.

1_1_2_field_2
string (optional) Example: 1_1_2_field_2=Video

profile field 1_1_2_field_2 .

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
"gutterMenu": [
  {
    "label": "Delete Video",
    "name": "delete",
    "url": "advancedvideo/delete/61"
  },
  {
    "label": "Edit Video",
    "name": "delete",
    "url": "advancedvideo/edit/61"
  },
  {
    "label": "Share",
    "name": "share",
    "url": "activity/share",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  },
  {
    "label": "Suggest to friends",
    "name": "suggest",
    "url": "suggestions/suggest-to-friend",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  }
],
"menus": [
  {
    "label": "Watch Later",
    "name": "watch_later",
    "url": "advancedvideo/watch-later/61",
    "urlParams": {
      "value": 1
    }
  },
  {
    "label": "Add to Playlist",
    "name": "playlist",
    "url": "advancedvideo/add-to-playlist/61"
  },
  {
    "label": "Favourite",
    "name": "favourite",
    "url": "advancedvideo/favourite-video/61",
    "urlParams": {
      "value": 1
    }
  },
  {
    "label": "Share",
    "name": "share",
    "url": "activity/share",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  },
  {
    "label": "Subscribe",
    "name": "subscribe",
    "url": "advancedvideo/subscription/61",
    "urlParams": {
      "value": 1,
      "id": 6
    }
  }
],
"response": {
  "video_id": 61,
  "title": "The Time",
  "description": "The Time",
  "search": 1,
  "owner_type": "user",
  "owner_id": 1,
  "parent_type": null,
  "parent_id": null,
  "creation_date": "2017-03-27 08:02:17",
  "modified_date": "2017-03-27 08:09:31",
  "view_count": 0,
  "comment_count": 0,
  "type": 1,
  "code": "G62HrubdD6o",
  "photo_id": 420,
  "rating": 0,
  "category_id": 13,
  "status": 1,
  "file_id": 0,
  "duration": 145,
  "rotation": 0,
  "main_channel_id": 6,
  "subcategory_id": null,
  "subsubcategory_id": null,
  "profile_type": 4,
  "featured": 0,
  "favourite_count": 0,
  "sponsored": 0,
  "seao_locationid": 0,
  "location": "delhi",
  "networks_privacy": null,
  "like_count": 0,
  "synchronized": 0,
  "image": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",
  "image_normal": "http://www.example.com/public/video/a7/01/01a6_62cd.jpg?c=b28c",
  "image_profile": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",/advanceapi
  "image_icon": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",
  "content_url": "http://www.example.com/videos/1/61/old-video",
  "owner_image": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_normal": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_profile": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_icon": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
  "owner_title": "John",
  "rating_count": 0,
  "is_like": false,
  "category_tital": "Science & Technology",
  "tags": {
    "13": "John"
  },
  "auth_view": "owner",
  "auth_comment": "everyone",
  "can_edit": 1,
  "can_delete": 1,
  "can_embed": true,
  "rated": false,
  "videoEmbedded": "",
  "channel_title": "Health Flavors",
  "is_subscribe": 0,
  "video_url": "www.youtube.com/embed/G62HrubdD6o?wmode=opaque&autoplay=1",
  "ProfileInfo": {
    "channel": "Zee Tv",
  }
},
"is_password": 0
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Password Protected Video

Password Protected Video
GET/advancedvideos/password-protection

Example URI

GET /advancedvideos/password-protection
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 61`) 

video_id.

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
"gutterMenu": [
  {
    "label": "Delete Video",
    "name": "delete",
    "url": "advancedvideo/delete/61"
  },
  {
    "label": "Edit Video",
    "name": "delete",
    "url": "advancedvideo/edit/61"
  },
  {
    "label": "Share",
    "name": "share",
    "url": "activity/share",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  },
  {
    "label": "Suggest to friends",
    "name": "suggest",
    "url": "suggestions/suggest-to-friend",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  }
],
"menus": [
  {
    "label": "Watch Later",
    "name": "watch_later",
    "url": "advancedvideo/watch-later/61",
    "urlParams": {
      "value": 1
    }
  },
  {
    "label": "Add to Playlist",
    "name": "playlist",
    "url": "advancedvideo/add-to-playlist/61"
  },
  {
    "label": "Favourite",
    "name": "favourite",
    "url": "advancedvideo/favourite-video/61",
    "urlParams": {
      "value": 1
    }
  },
  {
    "label": "Share",
    "name": "share",
    "url": "activity/share",
    "urlParams": {
      "type": "video",
      "id": 61
    }
  },
  {
    "label": "Subscribe",
    "name": "subscribe",
    "url": "advancedvideo/subscription/61",
    "urlParams": {
      "value": 1,
      "id": 6
    }
  }
],
"response": {
  "video_id": 61,
  "title": "The Time",
  "description": "The Time",
  "search": 1,
  "owner_type": "user",
  "owner_id": 1,
  "parent_type": null,
  "parent_id": null,
  "creation_date": "2017-03-27 08:02:17",
  "modified_date": "2017-03-27 08:09:31",
  "view_count": 0,
  "comment_count": 0,
  "type": 1,
  "code": "G62HrubdD6o",
  "photo_id": 420,
  "rating": 0,
  "category_id": 13,
  "status": 1,
  "file_id": 0,
  "duration": 145,
  "rotation": 0,
  "main_channel_id": 6,
  "subcategory_id": null,
  "subsubcategory_id": null,
  "profile_type": 4,
  "featured": 0,
  "favourite_count": 0,
  "sponsored": 0,
  "seao_locationid": 0,
  "location": "delhi",
  "networks_privacy": null,
  "like_count": 0,
  "synchronized": 0,
  "image": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",
  "image_normal": "http://www.example.com/public/video/a7/01/01a6_62cd.jpg?c=b28c",
  "image_profile": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",/advanceapi
  "image_icon": "http://www.example.com/public/video/a5/01/01a4_5cb2.jpg?c=336f",
  "content_url": "http://www.example.com/videos/1/61/old-video",
  "owner_image": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_normal": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_profile": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "owner_image_icon": "http://www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
  "owner_title": "john",
  "rating_count": 0,
  "is_like": false,
  "category_tital": "Science & Technology",
  "tags": {
    "13": "John"
  },
  "auth_view": "owner",
  "auth_comment": "everyone",
  "can_edit": 1,
  "can_delete": 1,
  "can_embed": true,
  "rated": false,
  "videoEmbedded": "",
  "channel_title": "Health Flavors",
  "is_subscribe": 0,
  "video_url": "www.youtube.com/embed/G62HrubdD6o?wmode=opaque&autoplay=1",
  "ProfileInfo": {
    "channel": "Zee Tv",
  }
},
"is_password": 1
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": "Parameter Validation Failure: Invalid url"
}

Video Url Validation

Video Url Validation
GET/advancedvideos/validation

Example URI

GET /advancedvideos/validation
URI Parameters
HideShow
type
integer (required) Example: type=61

type=1 for You tube, type=2 for Vimeo, type=3 for My Device, type=4 for dailymotion and type =5 for Embed Code.

url
string (required) Example: url=www.youtube.com/dcdkdj45e

url.

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
        "response": {
                    "title": "Dum Dum (Reprise) Diljit Dosanjh Version Video Song | Phillauri | Anushka Sharma | Shashwat",
                    "discription": "Presenting the video of  Dum Dum (Reprise) Diljit Dosanjh Song from the upcoming Hindi movie PHILLAURI, directed by Anshai Lal. 
                    "duration": 129
                  }
    }
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Browse Videos

Browse Videos
GET/advancedvideos/browse{?search}{&locationmiles}{&orderby}{&page}{&limit}{&1_8_37_field_98}{&location}

Get the videos. Videos can also be browsed and searched based on keywords, categories, etc.

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of videos in response and use page for the page number. [i.e: If you have 100 videos and the first request has limit=20 and page=1, then in that case the recent 20 videos will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent videos will be returned.].

Example URI

GET /advancedvideos/browse?search=search=teacher&locationmiles=locationmiles=1&orderby=orderby=creation_date&page=page=2&limit=limit=20&1_8_37_field_98=1_8_37_field_98=52&location=location=Chicago
URI Parameters
HideShow
view_view (optional, integer, `view_view
string (required) Default: 1`) 

get videos that belong to friends.

locationmiles
integer (optional) Example: locationmiles=1

get videos that belong to 1 mile.

search
string (optional) Example: search=teacher

get videos that contain this keyword in title or description.

orderby
string (optional) Example: orderby=creation_date

get videos in the order of creation_date (orderby=creation_date) or order of title (orderby=title) or order of view view_count (orderby=view_count) or order of like_count (orderby=like_ count) or order of comment_count (orderby=comment_count) or order of rating (orderby=rating) or order of favourite_ count (orderby=favourite_count) or order of featured (orderby=featured) or order of best_video (orderby=best_video) or order of sponsored (orderby=sponsored).

1_8_37_field_98
string (optional) Example: 1_8_37_field_98=52

get videos with matching value for this profile field. You can get the key name for profile field from the response of videos search form.

location
string (optional) Example: location=Chicago

get videos belong to this location.

video_state (optional, string, `video_state
string (required) Default: Chicago`) 

get videos belong to this state.

video_country (optional, string `video_country
string (required) Default: US`) 

get videos belog to this country.

video_city (optional, string, `video_city
string (required) Default: dallas`) 

get videos belong to this city.

video_street (optional, string, `video_street
string (required) Default: Green Bay`) 

get videos belong to this street.

page
integer (optional) Example: page=2

return the ‘limit’ number of videos of that page of videos.

limit
integer (optional) Example: limit=20

number of videos. Default limit is 20.

user_id (optional, integer, `user_id
string (required) Default: 1`) 

user id of profile owner. Default value is logged-in user’s ID.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
"response": [
  {
    "video_id": 1,
    "title": "NEW 2015 Peugeot 508 Sedan",
    "description": "The Peugeot 508 is a large family car launched in 2010 by French automaker Peugeot, and followed by the 508 SW, an estate version, in March 2011.It replaces the Peugeot 407, as well as the larger Peugeot 607, for which no more direct replacement is scheduled. It shares its platform and most engine options with the second-generation Citroën C5: the two cars are produced alongside one another at the companys Rennes Plant, and in Wuhan, China for sales inside China.The Peugeot 508 got several international awards like the Car of the Year 2011 in Spain (award in 2012), Next Green Car Best Large Family car 2011 for  being spacious and well equipped, also noting that it represented excellent build quality and has the best fuel economy in its class  (Peugeot 508 1.6 e-HDi 109g CO2/km) or also Auto Zeitung Best imported family car 2011",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:53:23",
    "view_count": 12,
    "comment_count": 0,
    "type": 1,
    "code": "aM6iprJa-oc",
    "photo_id": 198,
    "rating": 4,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 85,
    "rotation": 0,
    "main_channel_id": 1,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": 1,
    "featured": 1,
    "favourite_count": 2,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 0,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/c6/00c6_b197.jpg?c=992e",
    "image_normal": "http:/www.example.com/public/video/c8/00c8_7ee7.jpg?c=a43d",
    "image_profile": "http:/www.example.com/public/video/c6/00c6_b197.jpg?c=992e",
    "image_icon": "http:/www.example.com/public/video/c6/00c6_b197.jpg?c=992e",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 1,
    "video_url": "www.youtube.com/embed/aM6iprJa-oc?wmode=opaque&autoplay=1"
  },
  {
    "video_id": 2,
    "title": "The Joy of Matte Painting",
    "description": "We get old-school artsy, Corey channels his inner artiste, and we uncover matte paintings inner workings.",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:53:41",
    "view_count": 0,
    "comment_count": 1,
    "type": 2,
    "code": 153413474,
    "photo_id": 201,
    "rating": 5,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 292,
    "rotation": 0,
    "main_channel_id": 8,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 1,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/c9/00c9_1bd5.jpg?c=fbd1",
    "image_normal": "http:/www.example.com/public/video/cb/00cb_5b48.jpg?c=cc93",
    "image_profile": "http:/www.example.com/public/video/c9/00c9_1bd5.jpg?c=fbd1",
    "image_icon": "http:/www.example.com/public/video/c9/00c9_1bd5.jpg?c=fbd1",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 1,
    "video_url": "player.vimeo.com/video/153413474?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
  },
  {
    "video_id": 3,
    "title": "EAT",
    "description": "3 guys, 44 days, 11 countries, 18 flights, 38 thousand miles, an exploding volcano, 2 cameras and almost a terabyte of footage... all to turn 3 ambitious linear concepts based on movement, learning and food ....into 3 beautiful and hopefully compelling short films",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:53:44",
    "view_count": 7,
    "comment_count": 0,
    "type": 2,
    "code": 27243869,
    "photo_id": 204,
    "rating": 3,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 61,
    "rotation": 0,
    "main_channel_id": 7,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 1,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
    "image_normal": "http:/www.example.com/public/video/ce/00ce_9795.jpg?c=18a3",
    "image_profile": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
    "image_icon": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 1,
    "video_url": "player.vimeo.com/video/27243869?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
  },
  {
    "video_id": 5,
    "title": "SHARKS",
    "description": "Andy Brandy Casagrande IV aka (ABC) is an Emmy Award winning wildlife cinematographer, field producer & television presenter specializing in blue-chip wildlife documentaries around the world. From King Cobras & Killer Whales to Great Whites Sharks & Polar Bears, Andys innovative cinematography & unorthodox camera techniques are helping revolutionize the way the world sees & perceives wildlife. From super-slow motion & thermal-infrared to night-vision & remote-controlled spy-cams, Andy shoots with the most advanced camera technologies on the planet and continues to push the boundaries of wildlife filmmaking to shed new light & perspective into the hidden lives of the planets most feared & misunderstood predators.",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:53:17",
    "view_count": 2,
    "comment_count": 0,
    "type": 2,
    "code": 60475481,
    "photo_id": null,
    "rating": 0,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 32,
    "rotation": 0,
    "main_channel_id": 4,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 1,
    "synchronized": 1,
    "image": "http:/www.example.com/application/modules/Video/externals/images/nophoto_video_thumb_icon.png",
    "image_normal": "http:/www.example.com/application/modules/Video/externals/images/nophoto_video_thumb_icon.png",
    "image_profile": "http:/www.example.com/application/modules/Video/externals/images/nophoto_video_thumb_icon.png",
    "image_icon": "http:/www.example.com/application/modules/Video/externals/images/nophoto_video_thumb_icon.png",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 1,
    "video_url": "player.vimeo.com/video/60475481?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
  },
  {
    "video_id": 6,
    "title": "DIY Spider Trax Dolly Track",
    "description": "This is a track that I made for my spider trax dolly. You can attach it to a tri-pod or K-pod and it can be made with simple tools like a few wrenches and a saw.",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:54:10",
    "view_count": 3,
    "comment_count": 0,
    "type": 2,
    "code": 13949623,
    "photo_id": 210,
    "rating": 0,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 171,
    "rotation": 0,
    "main_channel_id": 5,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 1,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
    "image_normal": "http:/www.example.com/public/video/d4/00d4_40a0.jpg?c=7690",
    "image_profile": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
    "image_icon": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 0,
    "video_url": "player.vimeo.com/video/13949623?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
  },
  {
    "video_id": 7,
    "title": "How to Spatchcock a Chicken",
    "description": "This is a great way to reduce the cooking time of a regular roast chicken. It is the perfect family dinner or works well for dinner parties.",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:54:15",
    "view_count": 1,
    "comment_count": 0,
    "type": 2,
    "code": 138061328,
    "photo_id": 213,
    "rating": 0,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 83,
    "rotation": 0,
    "main_channel_id": 6,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 1,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 2,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/d5/00d5_2f8a.jpg?c=80d9",
    "image_normal": "http:/www.example.com/public/video/d7/00d7_f073.jpg?c=734a",
    "image_profile": "http:/www.example.com/public/video/d5/00d5_2f8a.jpg?c=80d9",
    "image_icon": "http:/www.example.com/public/video/d5/00d5_2f8a.jpg?c=80d9",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 0,
    "video_url": "player.vimeo.com/video/138061328?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
  },
 ],
"canCreate": 1,
"totalItemCount": 5
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

My videos

My videos
GET/advancedvideos/manage{?search}{&locationmiles}{&orderby}{&page}{&limit}{&1_5_23_field_23}{&1_8_37_field_98}{&location}

Get the videos. Videos can also be browsed and searched based on keywords, categories, etc.

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of videos in response and use page for the page number. [i.e: If you have 100 videos and the first request has limit=20 and page=1, then in that case the recent 20 videos will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent videos will be returned.]

Example URI

GET /advancedvideos/manage?search=search=teacher&locationmiles=locationmiles=1&orderby=orderby=creation_date&page=page=2&limit=limit=20&1_5_23_field_23=1_5_23_field_23=michal&1_8_37_field_98=1_8_37_field_98=52&location=location=Chicago
URI Parameters
HideShow
view_view (optional, integer, `view_view
string (required) Default: 1`) 

get videos that belong to friends.

locationmiles
integer (optional) Example: locationmiles=1

get videos that belong to 1 mile.

search
string (optional) Example: search=teacher

get videos that contain this keyword in title or description.

orderby
string (optional) Example: orderby=creation_date

get videos in the order of creation_date (orderby=creation_date) or order of title (orderby=title) or order of view view_count (orderby=view_count) or order of like_count (orderby=like_ count) or order of comment_count (orderby=comment_count) or order of rating (orderby=rating) or order of favourite_ count (orderby=favourite_count) or order of featured (orderby=featured) or order of best_video (orderby=best_video) or order of sponsored (orderby=sponsored).

1_5_23_field_23
string (optional) Example: 1_5_23_field_23=michal

get videos with matching value for this profile field. You can get the key name for profile field from the response of videos search form.

1_8_37_field_98
string (optional) Example: 1_8_37_field_98=52

get videos with matching value for this profile field. You can get the key name for profile field from the response of videos search form.

location
string (optional) Example: location=Chicago

get videos belong to this location.

user_id (optional, integer, `user_id
string (required) Default: 125`) 

user id of profile owner. Default value is logged-in user’s ID.

video_state (optional, string, `video_state
string (required) Default: Chicago`) 

get videos belong to this state.

video_country (optional, string `video_country
string (required) Default: US`) 

get videos belog to this country.

video_city (optional, string, `video_city
string (required) Default: dallas`) 

get videos belong to this city.

video_street (optional, string, `video_street
string (required) Default: Green Bay`) 

get videos belong to this street.

page
integer (optional) Example: page=2

return the ‘limit’ number of videos of that page of videos.

limit
integer (optional) Example: limit=20

number of videos. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "response": [
  {
    "video_id": 6,
    "title": "DIY Spider Trax Dolly Track",
    "description": "This is a track that I made for my spider trax dolly. You can attach it to a tri-pod or K-pod and it can be made with simple tools like a few wrenches and a saw.",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:54:10",
    "view_count": 3,
    "comment_count": 0,
    "type": 2,
    "code": 13949623,
    "photo_id": 210,
    "rating": 0,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 171,
    "rotation": 0,
    "main_channel_id": 5,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 1,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
    "image_normal": "http:/www.example.com/public/video/d4/00d4_40a0.jpg?c=7690",
    "image_profile": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
    "image_icon": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 0,
    "video_url": "player.vimeo.com/video/13949623?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1",
    "menu": [
      {
        "label": "Delete Video",
        "name": "delete",
        "url": "advancedvideo/delete/6"
      }
    ]
  },
  {
    "video_id": 7,
    "title": "How to Spatchcock a Chicken",
    "description": "This is a great way to reduce the cooking time of a regular roast chicken. It is the perfect family dinner or works well for dinner parties.",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:54:15",
    "view_count": 1,
    "comment_count": 0,
    "type": 2,
    "code": 138061328,
    "photo_id": 213,
    "rating": 0,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 83,
    "rotation": 0,
    "main_channel_id": 6,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 1,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 2,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/d5/00d5_2f8a.jpg?c=80d9",
    "image_normal": "http:/www.example.com/public/video/d7/00d7_f073.jpg?c=734a",
    "image_profile": "http:/www.example.com/public/video/d5/00d5_2f8a.jpg?c=80d9",
    "image_icon": "http:/www.example.com/public/video/d5/00d5_2f8a.jpg?c=80d9",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 0,
    "video_url": "player.vimeo.com/video/138061328?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1",
    "menu": [
      {
        "label": "Delete Video",
        "name": "delete",
        "url": "advancedvideo/delete/7"
      }
    ]
  },
  {
    "video_id": 8,
    "title": "I DON’T LIKE ANYTHING I DO",
    "description": "I made this short video to fight the feeling of frustration that comes over me when I see a work of mine finished.I thought it might be useful to exorcise the temptation to destroy everything all the time,but the result is that even this, I do not like.",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:54:20",
    "view_count": 1,
    "comment_count": 0,
    "type": 2,
    "code": 153344869,
    "photo_id": 216,
    "rating": 1,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 36,
    "rotation": 0,
    "main_channel_id": 2,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 1,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/d8/00d8_4edd.jpg?c=5b09",
    "image_normal": "http:/www.example.com/public/video/da/00da_c58a.jpg?c=800b",
    "image_profile": "http:/www.example.com/public/video/d8/00d8_4edd.jpg?c=5b09",
    "image_icon": "http:/www.example.com/public/video/d8/00d8_4edd.jpg?c=5b09",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 1,
    "rating_count": 1,
    "video_url": "player.vimeo.com/video/153344869?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1",
    "menu": [
      {
        "label": "Delete Video",
        "name": "delete",
        "url": "advancedvideo/delete/8"
      }
    ]
  },
"canCreate": 1,
"totalItemCount": 10
  }
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Video Search Form

Video Search Form
GET/advancedvideos/search-form

Get the Video search form.

Example URI

GET /advancedvideos/search-form
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "type": "Text",
      "name": "search",
      "label": "Name / Keyword"
    },
    {
      "type": "Select",
      "name": "view_view",
      "label": "View",
      "multiOptions": [
        "Everyone's Videos",
        "Only My Friends' Videos"
      ],
      "value": 0
    },
    {
      "type": "Select",
      "name": "orderby",
      "label": "Browse By",
      "multiOptions": {
        "": "",
        "creation_date": "Most Recent",
        "modified_date": "Recently Updated",
        "view_count": "Most View",
        "like_count": "Most Liked",
        "comment_count": "Most Commented",
        "rating": "Most Rated",
        "favourite_count": "Most Favourite",
        "featured": "Featured",
        "sponsored": "Sponsored",
        "title": "Alphabetical (A-Z)",
        "title_reverse": "Alphabetical (Z-A)"
      }
    },
    {
      "type": "Text",
      "name": "location",
      " label": "Location"
    },
    {
      "type": "Select",
      "name": "locationmiles",
      "label": "Within Miles",
      "multiOptions": {
        "0": "",
        "1": "1 Mile",
        "2": "2 Miles",
        "5": "5 Miles",
        "10": "10 Miles",
        "20": "20 Miles",
        "50": "50 Miles",
        "100": "100 Miles",
        "250": "250 Miles",
        "500": "500 Miles",
        "750": "750 Miles",
        "1000": "1000 Miles"
      },
      "value": 0
    },
    {
      "type": "Text",
      "name": "video_street",
      "label": "Street"
    },
    {
      "type": "Text",
      "name": "video_city",
      "label": "City"
    },
    {
      "type": "Text",
      "name": "video_state",
      "label": "State"
    },
    {
      "type": "Text",
      "name": "video_country",
      "label": "Country"
    },
    {
      "type": "Select",
      "name": "category_id",
      "allowEmpty": 0,
      "label": "Category",
      "multiOptions": {
        "0": "",
        "1": "Autos & Vehicles",
        "2": "Comedy",
        "3": "Education",
        "4": "Entertainment",
        "5": "Film & Animation",
        "6": "Gaming",
        "7": "Howto & Style",
        "8": "Music",
        "9": "News & Politics",
        "10": "Nonprofits & Activism",
        "11": "People & Blogs",
        "12": "Pets & Animals",
        "13": "Science & Technology",
        "14": "Sports",
        "15": "Travel & Events",
        "16": "Others"
      }
    },
    {
      "type": "Submit",
      "name": "submit",
      "label": "Search"
    }
  ],
  "subcategories": {
    "1": {
      "form": {
        "type": "Select",
        "name": "subcategory_id",
        "label": "Sub-Category",
        "multiOptions": {
          "0": "",
          "17": "Maruti"
        }
      },
      "subsubcategories": {
        "17": {
          "type": "Select",
          "name": "subsubcategory_id",
          "label": "3rd Level Category",
          "multiOptions": {
            "0": "",
            "17": "Swift"
          }
        }
      }
    },
    "15": {
      "form": {
        "type": "Select",
        "name": "subcategory_id",
        "label": "Sub-Category",
        "multiOptions": {
          "0": "",
          "19": "Delhi"
        }
      },
      "subsubcategories": {
        "19": {
          "type": "Select",
          "name": "subsubcategory_id",
          "label": "3rd Level Category",
          "multiOptions": {
            "0": "",
            "19": "SN Market"
          }
        }
      }
    }
  },
  "fields": {
    "1": [
      {
        "type": "Text",
        "name": "1_1_2_field_2",
        "label": "Name",
        "description": ""
      },
      {
        "type": "Radio",
        "name": "1_1_3_field_3",
        "label": "Type",
        "description": "",
        "multiOptions": {
          "2": "yes",
          "3": "no"
        }
      },
      {
        "type": "Radio",
        "name": "1_1_8_field_8",
        "label": "Radio",
        "description": "",
        "multiOptions": {
          "8": "Male",
          "9": "Female"
        }
      }
    ],
    "13": [
      {
        "type": "Text",
        "name": "1_4_5_field_5",
        "label": "Student",
        "description": ""
      },
      {
        "type": "Text",
        "name": "1_4_6_field_6",
        "label": "Teacher",
        "description": ""
      }
    ]
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

View Video

View Video
GET/advancedvideo/view/{&menu}

Get a video and its gutter menu’s (download, delete, share, suggest to friend) and menu tab’s (watch later, add to playlist, favourite, subscribe).

Example URI

GET /advancedvideo/view/&menu=menu=1 OR 0
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 878`) 

video id

gutter_menu (optional, boolean, `gutter_menu
string (required) Default: 1 OR 0`) 

get gutter menu’s array. Default valus is 1.

menu
boolean (optional) Example: menu=1 OR 0

get menu array. Default valus is 1.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "gutterMenu": [
    {
      "label": "Download Video",
      "name": "download"
    },
    {
      "label": "Delete Video",
      "name": "delete",
      "url": "advancedvideo/delete/3"
    },
    {
      "label": "Suggest to friends",
      "name": "suggest",
      "url": "suggestions/suggest-to-friend",
      "urlParams": {
        "type": "video",
        "id": 3
      }
    }
  ],
  "menus": [
    {
      "label": "Watch Later",
      "name": "watch_later",
      "url": "advancedvideo/watch-later/3",
      "urlParams": {
        "value": 1
      }
    },
    {
      "label": "Add to Playlist",
      "name": "playlist",
      "url": "advancedvideo/add-to-playlist/3"
    },
    {
      "label": "Favourite",
      "name": "favourite",
      "url": "advancedvideo/favourite-video/3",
      "urlParams": {
        "value": 1
      }
    },
    {
      "label": "Share",
      "name": "share",
      "url": "activity/share",
      "urlParams": {
        "type": "video",
        "id": 3
      }
    },
    {
      "label": "Subscribe",
      "name": "subscribe",
      "url": "advancedvideo/subscription/3",
      "urlParams": {
        "value": 1,
        "id": 7
      }
    }
  ],
  "response": {
    "video_id": 3,
    "title": "EAT",
    "description": "3 guys, 44 days, 11 countries, 18 flights, 38 thousand miles, an exploding volcano, 2 cameras and almost a terabyte of footage... all to turn 3 ambitious linear concepts based on movement, learning and food ....into 3 beautiful and hopefully compelling short films",
    "search": 1,
    "owner_type": "user",
    "owner_id": 1,
    "parent_type": null,
    "parent_id": null,
    "creation_date": "2017-02-21 06:53:17",
    "modified_date": "2017-02-21 06:53:44",
    "view_count": 7,
    "comment_count": 0,
    "type": 2,
    "code": 27243869,
    "photo_id": 204,
    "rating": 3,
    "category_id": 16,
    "status": 1,
    "file_id": 0,
    "duration": 61,
    "rotation": 0,
    "main_channel_id": 7,
    "subcategory_id": null,
    "subsubcategory_id": null,
    "profile_type": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "seao_locationid": 0,
    "location": "",
    "networks_privacy": null,
    "like_count": 1,
    "synchronized": 1,
    "image": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
    "image_normal": "http:/www.example.com/public/video/ce/00ce_9795.jpg?c=18a3",
    "image_profile": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
    "image_icon": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
    "content_url": "http:/www.example.com/videos/1/3/eat",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "rating_count": 1,
    "is_like": true,
    "category_tital": "Others",
    "tags": null,
    "can_edit": 1,
    "can_delete": 1,
    "can_embed": true,
    "rated": false,
    "videoEmbedded": "",
    "channel_title": "HGTV",
    "is_subscribe": 0,
    "video_url": "player.vimeo.com/video/27243869?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this sitevideo."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Video

Delete Video
DELETE/advancedvideo/delete/

Example URI

DELETE /advancedvideo/delete/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 878`) 

video_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Get playlist form

Get playlist form
GET/advancedvideo/add-to-playlist/

Example URI

GET /advancedvideo/add-to-playlist/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 878`) 

get playlist form.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "type": "Checkbox",
      "name": "playlist_13",
      "label": "Photo Test",
      "value": 0
    },
    {
      "type": "Checkbox",
      "name": "playlist_12",
      "label": "Final Test",
      "value": 0
    },
    {
      "type": "Checkbox",
      "name": "playlist_2",
      "label": "test2",
      "value": 0
    },
    {
      "type": "Checkbox",
      "name": "playlist_1",
      "label": "Test",
      "value": 0
    },
    {
      "type": "Label",
      "name": "create_play_description",
      "label": "You have not created any playlist yet. Get Started by creating and adding Videos."
    },
    {
      "type": "Text",
      "name": "title",
      "label": "Playlist Name"
    },
    {
      "type": "Textarea",
      "name": "description",
      "label": "Description"
    },
    {
      "type": "file",
      "name": "photo",
      "label": "Cover Photo"
    },
    {
      "type": "Select",
      "name": "privacy",
      "label": "View Privacy",
      "description": "Who may see this playlist?",
      "multiOptions": {
        "everyone": "Everyone",
        "registered": "All Registered Members",
        "owner_network": "Friends and Networks",
        "owner_member_member": "Friends of Friends",
        "owner_member": "Friends Only",
        "owner": "Just Me"
      },
      "value": "owner"
    },
    {
      "type": "Submit",
      "name": "submit",
      "label": "Save"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Add to Playlist Video

Add to Playlist
POST/advancedvideo/add-to-playlist/

Example URI

POST /advancedvideo/add-to-playlist/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 878`) 

video_id.

playlist_13 (required, integer, `playlist_13
string (required) Default: 1`) 

add video to playlist.

inplaylist_13 (required, integer, `inplaylist_13
string (required) Default: 0`) 

remove video from playlist.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Create playlist

Create Playlist
POST/advancedvideo/add-to-playlist/

Example URI

POST /advancedvideo/add-to-playlist/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 878`) 

video_id.

Title
string (required) Example: title=Nature

Title.

privacy
integer (optional) Example: privacy=owner

default owner.

description
string (optional) Example: description=nice pic

description.

photo
file (optional) 

Playlist cover photo.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Subscribe Channel

Subscribe Channel
POST/advancedvideos/subscription/

Example URI

POST /advancedvideos/subscription/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 878`) 

video_id.

id
integer (required) Example: id=7

channel id for subscription.

Value
integer (required) Example: value=0

value 0 for unsubscribe and 1 for subscribe.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Favourite Video

Favourite Video
POST/advancedvideo/favourite-video/

Example URI

POST /advancedvideo/favourite-video/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 878`) 

video_id.

Value
integer (required) Example: value=0

value 0 for unfavourite and 1 for favourite.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Suggest Video

Suggest Video
POST/suggestions/suggest-to-friend/

Example URI

POST /suggestions/suggest-to-friend/
URI Parameters
HideShow
entity_id (required, integer, `entity_id
string (required) Default: 101`) 

Here entity_id is video_id.

entity
string (required) Example: entity=sitevideo

entity type.

friends_id (required, string, `friends_id
string (required) Default: 1,2,3`) 

friend’s id where you want to suggest.

notification_type (required, string `notification_type
string (required) Default: video`) 

notification_type.

entity_title (optional, string, `entity_title
string (required) Default: Comedy`) 

entity_title.

entity_link (optional , string, `entity_link
string (required) Default: xyz@gmail.com`) 

Here you can pass email.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Watch Later

Watch Later
POST/advancedvideo/watch-later/

Example URI

POST /advancedvideo/watch-later/
URI Parameters
HideShow
video_id (required, integer, `video_id
string (required) Default: 101`) 

video_id.

value
integer (required) Example: value=0

1 for add to watch later and 0 for remove from watch later.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Video Categories

Video Categories
GET/advancedvideos/categories/

Example URI

GET /advancedvideos/categories/
URI Parameters
HideShow
category_id (optional, integer, `category_id
string (required) Default: 10`) 

category_id.

subCategory_id (optional, integer, `subCategory_id
string (required) Default: 2`) 

subCategory_id.

showAllCategories
integer (optional) Example: showAllCategories=1

default value is 1. 0 for show all category who has at least one video.

showCategories
integer (optional) Example: showCategories=1

default value is 1. 0 for show all videos belong to this category.

showVideos
integer (optional) Example: showVideos=1

default value is one . for 0 show categories only.

showCount
integer (optional) Example: showCount=1

default value is 0. for 1 show count belong to this category.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "totalItemCount": 16,
  "categories": [
    {
      "category_id": 1,
      "category_name": "Autos & Vehicles",
      "count": 1,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 2,
      "category_name": "Comedy",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 3,
      "category_name": "Education",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 4,
      "category_name": "Entertainment",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 5,
      "category_name": "Film & Animation",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 6,
      "category_name": "Gaming",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 7,
      "category_name": "Howto & Style",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 8,
      "category_name": "Music",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    }
  ],
  "subCategories": [
    {
      "sub_cat_id": 17,
      "sub_cat_name": "Maruti",
      "count": 0,
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    }
  ],
  "video": {
    "response": [
      {
        "video_id": 11,
        "title": "Comedy",
        "description": "",
        "search": 1,
        "owner_type": "user",
        "owner_id": 1,
        "parent_type": null,
        "parent_id": null,
        "creation_date": "2017-03-06 05:19:34",
        "modified_date": "2017-03-06 05:19:37",
        "view_count": 1,
        "comment_count": 0,
        "type": 2,
        "code": 168422600,
        "photo_id": 256,
        "rating": 5,
        "category_id": 1,
        "status": 1,
        "file_id": 0,
        "duration": 417,
        "rotation": 90,
        "main_channel_id": 1,
        "subcategory_id": 17,
        "subsubcategory_id": 18,
        "profile_type": 1,
        "featured": 0,
        "favourite_count": 0,
        "sponsored": 0,
        "seao_locationid": 0,
        "location": "",
        "networks_privacy": null,
        "like_count": 0,
        "synchronized": 1,
        "image": "http:/www.example.com/public/video/01/01/0100_9907.jpg?c=e22c",
        "image_normal": "http:/www.example.com/public/video/03/01/0102_3ecd.jpg?c=e7f2",
        "image_profile": "http:/www.example.com/public/video/01/01/0100_9907.jpg?c=e22c",
        "image_icon": "http:/www.example.com/public/video/01/01/0100_9907.jpg?c=e22c",
        "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "owner_title": "John",
        "allow_to_view": 1,
        "rating_count": 1,
        "video_url": "player.vimeo.com/video/168422600?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
      }
    ],
    "canCreate": 1,
    "totalItemCount": 1
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Advanced Video Plugin/Channel

These are the APIs for SocialEngine’s official.Advanced Video Plugin.

Channel Search Form

Channel Search Form
GET/advancedvideos/channel/search-form

Get the Channel search form.

Example URI

GET /advancedvideos/channel/search-form
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
"form": [
  {
    "type": "Text",
    "name": "search",
    "label": "Name / Keyword"
  },
  {
    "type": "Select",
    "name": "view_view",
    "label": "View",
    "multiOptions": [
      "Everyone's Channels",
      "Only My Friends' Channels"
    ],
    "value": 0
  },
  {
    "type": "Select",
    "name": "orderby",
    "label": "Browse By",
    "multiOptions": {
      "": "",
      "creation_date": "Most Recent",
      "modified_date": "Recently Updated",
      "view_count": "Most View",
      "like_count": "Most Liked",
      "comment_count": "Most Commented",
      "favourite_count": "Most Favourite",
      "featured": "Featured",
      "best_channel": "Best Channel",
      "videos_count": "Most Videos",
      "sponsored": "Sponsored",
      "title": "Alphabetical (A-Z)",
      "title_reverse": "Alphabetical (Z-A)",
      "rating": "Most Rated"
    }
  },
  {
    "type": "Select",
    "name": "category_id",
    "allowEmpty": 0,
    "label": "Category",
    "multiOptions": {
      "0": "",
      "1": "Comedy",
      "2": "Film & Entertainment",
      "3": "Gaming",
      "4": "Beauty & Fashion",
      "5": "From TV",
      "6": "Automotive",
      "7": "Animation",
      "8": "Sports",
      "9": "Technology",
      "10": "Science & Education",
      "11": "Cooking & Health",
      "12": "News & Politics",
      "13": "Lifestyle",
      "14": "Others"
    }
  },
  {
    "type": "Submit",
    "name": "submit",
    "label": "Submit"
  }
],
"subcategories": {
  "1": {
    "form": {
      "type": "Select",
      "name": "subcategory_id",
      "label": "Sub-Category",
      "multiOptions": {
        "0": "",
        "15": "CNWK"
      }
    },

  },
  "2": {
    "form": {
      "type": "Select",
      "name": "subcategory_id",
      "label": "Sub-Category",
      "multiOptions": {
        "0": "",
        "17": "zee tv"
      }
    }
  }
},
"fields": {
  "14": [
    {
      "type": "Text",
      "name": "1_1_2_field_2",
      "label": "channel",
      "description": ""
    },

  ]
}
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Create Channel Form

Create Channel Form
GET/advancedvideos/channel/create

Get the Create Channel form.

Example URI

GET /advancedvideos/channel/create
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "form": [
      {
        "type": "Text",
        "name": "title",
        "label": "Channel Title",
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "channel_url",
        "description": "This will be the end of your channel URL. It should be indicative of the title and can contain alphabets, numbers, underscores and dashes only. Its length should be in the range of 3-255 characters. The complete URL of your channel will be: http://www.example.com/CHANNEL-NAME",
        "label": "Url"
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Check Availabillity"
      },
      {
        "type": "Text",
        "name": "tags",
        "label": "Tags (Keywords)",
        "description": "Separate tags with commas."
      },
      {
        "type": "Select",
        "name": "category_id",
        "allowEmpty": 0,
        "label": "Category",
        "multiOptions": {
          "0": "",
          "1": "Comedy",
          "2": "Film & Entertainment",
          "3": "Gaming",
          "4": "Beauty & Fashion",
          "5": "From TV",
          "6": "Automotive",
          "7": "Animation",
          "8": "Sports",
          "9": "Technology",
          "10": "Science & Education",
          "11": "Cooking & Health",
          "12": "News & Politics",
          "13": "Lifestyle",
          "14": "Others"
        },
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "description",
        "label": "Description",
        "hasValidator": true
      },
      {
        "type": "Select",
        "name": "auth_view",
        "label": "Privacy",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "owner": "Just Me"
        },
        "value": "everyone",
        "hasValidator": true
      },
      {
        "type": "Select",
        "name": "auth_comment",
        "label": "Comment Privacy",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "owner": "Just Me"
        },
        "value": "everyone",
        "hasValidator": true
      },
      {
        "type": "Checkbox",
        "name": "search",
        "label": "Show this video in search result",
        "value": 1
      },
      {
        "type": "File",
        "name": "filedata",
        "label": "Main Photo"
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Submit"
      }
    ],
    "subcategories": {
      "1": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "0": "",
            "15": "CNWK"
          }
        },
  },
  "2": {
    "form": {
      "type": "Select",
      "name": "subcategory_id",
      "label": "Sub-Category",
      "multiOptions": {
        "0": "",
        "17": "zee tv"
      }
    }
  }
},
"fields": {
  "14": [
    {
      "type": "Text",
      "name": "1_1_2_field_2",
      "label": "channel",
      "description": ""
    },

  ]
}
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Create Channel

Create Channel
POST/advancedvideos/channel/create

Example URI

POST /advancedvideos/channel/create
URI Parameters
HideShow
title
string (required) Example: title=Animal Planet

title.

category_id (required, integer, `category_id
string (required) Default: 4`) 

category_id.

tags
string (optional) Example: tags=john, Smith

tags.

description
string (required) Example: description=THE TIME TRAVELERS.

description.

auth_view (required, string, `auth_view
string (required) Default: everyone`) 

auth_view defualt value is everyone.

auth_comment (required, string, `auth_comment
string (required) Default: everyone`) 

auth_comment defualt value is everyone.

search
string (optional) Example: search=1

defualt set value is 1 for search else 0 .

channel_url (required, string, `channel_url
string (required) Default: www.example.com/animal-planet`) 

channel_url

filedata
file (optional) Example: filedata=example.mp4

filedata for cover photo.

subcategory_id (optional, string, `subcategory_id
string (required) Default: 1`) 

subcategory_id.

subsubcategory_id (optional, string, `subsubcategory_id
string (required) Default: 19`) 

subsubcategory_id.

1_1_2_field_2
string (optional) Example: 1_1_2_field_2=channel

profile field 1_1_2_field_2 .

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Edit Channel Form

Edit Channel Form
GET/advancedvideo/channel/edit/

Get the Edit Channel Form.

Example URI

GET /advancedvideo/channel/edit/
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "form": [
      {
        "type": "Text",
        "name": "title",
        "label": "Channel Title",
        "hasValidator": true
      },
  {
    "type": "Text",
    "name": "tags",
    "label": "Tags (Keywords)",
    "description": "Separate tags with commas."
  },
  {
    "type": "Select",
    "name": "category_id",
    "allowEmpty": 0,
    "label": "Category",
    "multiOptions": {
      "0": "",
      "1": "Comedy",
      "2": "Film & Entertainment",
      "3": "Gaming",
      "4": "Beauty & Fashion",
      "5": "From TV",
      "6": "Automotive",
      "7": "Animation",
      "8": "Sports",
      "9": "Technology",
      "10": "Science & Education",
      "11": "Cooking & Health",
      "12": "News & Politics",
      "13": "Lifestyle",
      "14": "Others"
    },
    "hasValidator": true
  },
  {
    "type": "Text",
    "name": "description",
    "label": "Description",
    "hasValidator": true
  },
  {
    "type": "Select",
    "name": "auth_view",
    "label": "Privacy",
    "multiOptions": {
      "everyone": "Everyone",
      "registered": "All Registered Members",
      "owner_network": "Friends and Networks",
      "owner_member_member": "Friends of Friends",
      "owner_member": "Friends Only",
      "owner": "Just Me"
    },
    "value": "everyone",
    "hasValidator": true
  },
  {
    "type": "Select",
    "name": "auth_comment",
    "label": "Comment Privacy",
    "multiOptions": {
      "everyone": "Everyone",
      "registered": "All Registered Members",
      "owner_network": "Friends and Networks",
      "owner_member_member": "Friends of Friends",
      "owner_member": "Friends Only",
      "owner": "Just Me"
    },
    "value": "everyone",
    "hasValidator": true
  },
  {
    "type": "Checkbox",
    "name": "search",
    "label": "Show this video in search result",
    "value": 1
  },

  {
    "type": "Submit",
    "name": "submit",
    "label": "Submit"
  }
],
"subcategories": {
  "1": {
    "form": {
      "type": "Select",
      "name": "subcategory_id",
      "label": "Sub-Category",
      "multiOptions": {
        "0": "",
        "15": "CNWK"
      }
    },

  },
  "2": {
    "form": {
      "type": "Select",
      "name": "subcategory_id",
      "label": "Sub-Category",
      "multiOptions": {
        "0": "",
        "17": "zee tv"
      }
    }
  }
},
"fields": {
  "14": [
    {
      "type": "Text",
      "name": "1_1_2_field_2",
      "label": "channel",
      "description": ""
    },

  ]
}
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Edit Channel

Edit Channel
POST/advancedvideo/channel/edit/

Example URI

POST /advancedvideo/channel/edit/
URI Parameters
HideShow
title
string (required) Example: title=Animal Planet

title.

category_id (required, integer, `category_id
string (required) Default: 4`) 

category_id.

tags
string (optional) Example: tags=john, Smith

tags.

description
string (required) Example: description=THE TIME TRAVELERS.

description.

auth_view (required, string, `auth_view
string (required) Default: everyone`) 

auth_view defualt value is everyone.

auth_comment (required, string, `auth_comment
string (required) Default: everyone`) 

auth_comment defualt value is everyone.

search
string (optional) Example: search=1

defualt set value is 1 for search else 0 .

subcategory_id (optional, string, `subcategory_id
string (required) Default: 1`) 

subcategory_id.

subsubcategory_id (optional, string, `subsubcategory_id
string (required) Default: 19`) 

subsubcategory_id.

1_1_2_field_2
string (optional) Example: 1_1_2_field_2=channel

profile field 1_1_2_field_2 .

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Channel

Delete Channel
DELETE/advancedvideo/channel/delete/

Example URI

DELETE /advancedvideo/channel/delete/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Channel url Validation

Channel url Validation
GET/advancedvideos/channelurl-validation

Example URI

GET /advancedvideos/channelurl-validation
URI Parameters
HideShow
channel_url (required, string, `channel_url
string (required) Default: animal-plannet`) 

channel_url.

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Response  204
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": "Parameter Validation Failure: URL not available."
}

Browse Channel

Browse channel
GET/advancedvideos/channel/browse{?search}{&orderby}{&page}{&limit}{&1_8_37_field_98}

Get Channels. Channels can also be browsed and searched based on keywords, categories, etc.

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of channels in response and use page for the page number. [i.e: If you have 100 channels and the first request has limit=20 and page=1, then in that case the recent 20 channels will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent channels will be returned.]

Example URI

GET /advancedvideos/channel/browse?search=search=Comedy&orderby=orderby=creation_date&page=page=2&limit=limit=20&1_8_37_field_98=1_8_37_field_98=52
URI Parameters
HideShow
search
string (optional) Example: search=Comedy

get channel that contain this keyword in title or description.

orderby
string (optional) Example: orderby=creation_date

get channels in the order of creation date (orderby=creation_date) or order of most like (orderby=title) or order of view count (orderby=view_count) or order of like count (orderby=like_count) or order of comment_count (orderby=comment_count) or order of rating avg (orderby=rating).

1_8_37_field_98
string (optional) Example: 1_8_37_field_98=52

get channels with matching value for this profile field.

user_id (optional, integer, `user_id
string (required) Default: 125`) 

user id of profile owner. Default value is logged-in user’s ID.

page
integer (optional) Example: page=2

return the ‘limit’ number of channels of that page of channels.

limit
integer (optional) Example: limit=20

number of channels. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Body
{
  "response": [
    {
      "channel_id": 8,
      "title": "Ovation",
      "channel_url": "ovation",
      "description": "Ovation is a network whose stated mission is to connect the world to all forms of art and artistic expression.",
      "owner_type": "user",
      "owner_id": 1,
      "profile_type": 1,
      "category_id": 14,
      "subcategory_id": 0,
      "subsubcategory_id": 0,
      "creation_date": "2017-02-21 06:52:53",
      "modified_date": "2017-02-21 06:53:12",
      "file_id": 186,
      "videos_count": 1,
      "rating": 0,
      "view_count": 2,
      "comment_count": 0,
      "search": 1,
      "type": null,
      "location": "",
      "seao_locationid": 0,
      "networks_privacy": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "like_count": 1,
      "subscribe_count": 0,
      "youtube_channel_id": null,
      "pending_video": null,
      "image": "http:/www.example.com/public/sitevideo_channel/ba/00ba_1f1f.jpg?c=c2be",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/bc/00bc_05b4.jpg?c=e67d",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/bb/00bb_f363.jpg?c=d4f1",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/bd/00bd_7895.jpg?c=ecc3",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0
    },
    {
      "channel_id": 7,
      "title": "HGTV",
      "channel_url": "hgtv",
      "description": "HGTV broadcasts a variety of how-to shows with a focus on home improvement, gardening, craft and remodeling. ",
      "owner_type": "user",
      "owner_id": 1,
      "profile_type": 1,
      "category_id": 14,
      "subcategory_id": 0,
      "subsubcategory_id": 0,
      "creation_date": "2017-02-21 06:52:53",
      "modified_date": "2017-02-21 06:53:10",
      "file_id": 182,
      "videos_count": 1,
      "rating": 0,
      "view_count": 0,
      "comment_count": 0,
      "search": 1,
      "type": null,
      "location": "",
      "seao_locationid": 0,
      "networks_privacy": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "like_count": 1,
      "subscribe_count": 2,
      "youtube_channel_id": null,
      "pending_video": null,
      "image": "http:/www.example.com/public/sitevideo_channel/b6/00b6_dbe3.jpg?c=f73a",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/b8/00b8_5e05.jpg?c=4837",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/b7/00b7_6ca1.jpg?c=e402",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/b9/00b9_6da1.jpg?c=5d6f",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0
    },
    {
      "channel_id": 6,
      "title": "Health Flavors",
      "channel_url": "health-flavors",
      "description": "Health Flavors is a channel whose primary focus is on health and nutrition.",
      "owner_type": "user",
      "owner_id": 1,
      "profile_type": 1,
      "category_id": 14,
      "subcategory_id": 0,
      "subsubcategory_id": 0,
      "creation_date": "2017-02-21 06:52:53",
      "modified_date": "2017-02-21 06:53:08",
      "file_id": 178,
      "videos_count": 1,
      "rating": 0,
      "view_count": 0,
      "comment_count": 0,
      "search": 1,
      "type": null,
      "location": "",
      "seao_locationid": 0,
      "networks_privacy": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "like_count": 1,
      "subscribe_count": 0,
      "youtube_channel_id": null,
      "pending_video": null,
      "image": "http:/www.example.com/public/sitevideo_channel/b2/00b2_053e.jpg?c=7751",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/b4/00b4_45c2.jpg?c=8b62",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/b3/00b3_41b7.jpg?c=9cb4",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/b5/00b5_12ee.jpg?c=bc43",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0
    },
    {
      "channel_id": 5,
      "title": "DIY Network",
      "channel_url": "diy-network",
      "description": "DIY Network is a channel that focuses on do it yourself projects at home.",
      "owner_type": "user",
      "owner_id": 1,
      "profile_type": 1,
      "category_id": 14,
      "subcategory_id": 0,
      "subsubcategory_id": 0,
      "creation_date": "2017-02-21 06:52:53",
      "modified_date": "2017-02-21 06:53:06",
      "file_id": 174,
      "videos_count": 1,
      "rating": 0,
      "view_count": 15,
      "comment_count": 0,
      "search": 1,
      "type": null,
      "location": "",
      "seao_locationid": 0,
      "networks_privacy": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "like_count": 1,
      "subscribe_count": 0,
      "youtube_channel_id": null,
      "pending_video": null,
      "image": "http:/www.example.com/public/sitevideo_channel/ae/00ae_eb0b.jpg?c=6d1c",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/b0/00b0_1de0.jpg?c=17ed",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/af/00af_04b8.jpg?c=43b6",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/b1/00b1_856e.jpg?c=82a1",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0
    }
  ],
  "totalItemCount": 4
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

My Channel

My channel
GET/advancedvideos/channel/manage{?search}{&orderby}{&page}{&limit}{&1_8_37_field_98}

Get Channels. Channels can also be browsed and searched based on keywords, categories, etc.

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of channels in response and use page for the page number. [i.e: If you have 100 channels and the first request has limit=20 and page=1, then in that case the recent 20 channels will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent channels will be returned.]

Example URI

GET /advancedvideos/channel/manage?search=search=Comedy&orderby=orderby=creation_date&page=page=2&limit=limit=20&1_8_37_field_98=1_8_37_field_98=52
URI Parameters
HideShow
search
string (optional) Example: search=Comedy

get channel that contain this keyword in title or description.

orderby
string (optional) Example: orderby=creation_date

get channels in the order of creation date (orderby=creation_date) or order of most like (orderby=title) or order of view count (orderby=view_count) or order of like count (orderby=like_count) or order of comment_count (orderby=comment_count) or order of rating avg (orderby=rating).

1_8_37_field_98
string (optional) Example: 1_8_37_field_98=52

get channels with matching value for this profile field.

user_id (optional, integer, `user_id
string (required) Default: 125`) 

user id of profile owner. Default value is logged-in user’s ID.

page
integer (optional) Example: page=2

return the ‘limit’ number of channels of that page of channels.

limit
integer (optional) Example: limit=20

number of channels. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Body
{
  "response": [
    {
      "channel_id": 3,
      "title": "Poker",
      "channel_url": "poker",
      "description": "The World Series of Poker is the Super Bowl of poker. It consists of over 55 events.",
      "owner_type": "user",
      "owner_id": 1,
      "profile_type": 1,
      "category_id": 14,
      "subcategory_id": 0,
      "subsubcategory_id": 0,
      "creation_date": "2017-02-21 06:52:53",
      "modified_date": "2017-02-21 06:53:01",
      "file_id": 166,
      "videos_count": 1,
      "rating": 0,
      "view_count": 0,
      "comment_count": 0,
      "search": 1,
      "type": null,
      "location": "",
      "seao_locationid": 0,
      "networks_privacy": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "like_count": 1,
      "subscribe_count": 0,
      "youtube_channel_id": null,
      "pending_video": null,
      "image": "http:/www.example.com/public/sitevideo_channel/a6/00a6_6e25.jpg?c=f6f5",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/a8/00a8_0e9f.jpg?c=1036",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/a7/00a7_324f.jpg?c=b90b",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/a9/00a9_3e29.jpg?c=6e2b",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0
    },
    {
      "channel_id": 2,
      "title": "Comedy Central",
      "channel_url": "comedy-central",
      "description": "Comedy Central is an American basic cable and satellite television channel that is owned by Viacom Music and Entertainment Group, a unit of the Viacom Media Networks division of Viacom. Aimed limitedly to mature audience, age 18 to up, the channel carries comedy programming, in the form of both original and syndicated series and stand-up comedy specials, as well as feature films.",
      "owner_type": "user",
      "owner_id": 1,
      "profile_type": 1,
      "category_id": 14,
      "subcategory_id": 0,
      "subsubcategory_id": 0,
      "creation_date": "2017-02-21 06:52:53",
      "modified_date": "2017-02-21 06:52:59",
      "file_id": 162,
      "videos_count": 1,
      "rating": 0,
      "view_count": 0,
      "comment_count": 0,
      "search": 1,
      "type": null,
      "location": "",
      "seao_locationid": 0,
      "networks_privacy": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "like_count": 1,
      "subscribe_count": 0,
      "youtube_channel_id": null,
      "pending_video": null,
      "image": "http:/www.example.com/public/sitevideo_channel/a2/00a2_12e7.jpg?c=5bd9",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/a4/00a4_02a4.jpg?c=1481",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/a3/00a3_42b8.jpg?c=2400",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/a5/00a5_00a6.jpg?c=d334",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0
    },
    {
      "channel_id": 1,
      "title": "Motors TV",
      "channel_url": "Motors-TV",
      "description": "Motors TV is a British digital television channel dedicated to motorsport. Launched in 2000, it broadcasts an extensive range of national and international racing.",
      "owner_type": "user",
      "owner_id": 1,
      "profile_type": 1,
      "category_id": 14,
      "subcategory_id": 0,
      "subsubcategory_id": 0,
      "creation_date": "2017-02-21 06:52:53",
      "modified_date": "2017-02-21 06:52:56",
      "file_id": 158,
      "videos_count": 2,
      "rating": 0,
      "view_count": 16,
      "comment_count": 0,
      "search": 1,
      "type": null,
      "location": "",
      "seao_locationid": 0,
      "networks_privacy": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "like_count": 0,
      "subscribe_count": 0,
      "youtube_channel_id": null,
      "pending_video": null,
      "image": "http:/www.example.com/public/sitevideo_channel/9e/009e_829b.jpg?c=0bfd",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/a0/00a0_dba2.jpg?c=64e0",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/9f/009f_82d5.jpg?c=8e52",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/a1/00a1_b682.jpg?c=bd69",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0
    }
  ],
  "totalItemCount": 3
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

View Channel

View Channel
GET/advancedvideo/channel/view/

Get a channels and its gutter menu’s (share, suggest to friend, report, favourite) and menu tab’s (update, subscriber, photos, videos).

Example URI

GET /advancedvideo/channel/view/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id

gutter_menu (optional, boolean, `gutter_menu
string (required) Default: 1 OR 0`) 

get gutter menu’s array. Default valus is 1.

profile_tabs (optional, boolean, `profile_tabs
string (required) Default: 1 OR 0`) 

get profile_tabs array. Default valus is 1.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "gutterMenu": [
    {
      "label": "Share",
      "name": "share",
      "url": "activity/share",
      "urlParams": {
        "type": "sitevideo_channel",
        "id": 9
      }
    },
    {
      "label": "Suggest to friends",
      "name": "share",
      "url": "suggestions/suggest-to-friend",
      "urlParams": {
        "type": "sitevideo_channel",
        "id": 9
      }
    },
    {
      "label": "Report",
      "name": "report",
      "url": "report/create/subject/sitevideo_channel_9",
      "urlParams": {
        "type": "sitevideo_channel",
        "id": 9
      }
    },
    {
      "label": "Unfavourite",
      "name": "favourite",
      "url": "advancedvideo/favourite-channel/9",
      "urlParams": {
        "value": 0
      }
    }
  ],
  "profile_tabs": [
    {
      "name": "update",
      "label": "Updates"
    },
    {
      "name": "Subscriber",
      "label": "Subscriber",
      "totalItemCount": 1,
      "url": "advancedvideo/channel/subscribers/9"
    },
    {
      "name": "photos",
      "label": "Photos",
      "totalItemCount": 1,
      "url": "advancedvideo/channel/photo/9"
    },
    {
      "name": "video",
      "label": "Videos",
      "totalItemCount": 1,
      "url": "advancedvideo/channel/videos/9"
    }
  ],
  "response": {
    "channel_id": 9,
    "title": "Cameras and Techniques",
    "channel_url": "cameras-and-techniques",
    "description": "While it can take years to master the camera techniques you need to take amazing images, whatever your skill level and whatever you choose to shoot, it often pays to keep things simple.",
    "owner_type": "user",
    "owner_id": 1,
    "profile_type": 1,
    "category_id": 14,
    "subcategory_id": 0,
    "subsubcategory_id": 0,
    "creation_date": "2017-02-21 06:52:53",
    "modified_date": "2017-02-21 06:53:15",
    "file_id": 190,
    "videos_count": 1,
    "rating": 0,
    "view_count": 10,
    "comment_count": 0,
    "search": 1,
    "type": null,
    "location": "",
    "seao_locationid": 0,
    "networks_privacy": null,
    "featured": 1,
    "favourite_count": 0,
    "sponsored": 1,
    "like_count": 1,
    "subscribe_count": 1,
    "youtube_channel_id": null,
    "pending_video": null,
    "image": "http:/www.example.com/public/sitevideo_channel/be/00be_97de.jpg?c=9322",
    "image_normal": "http:/www.example.com/public/sitevideo_channel/c0/00c0_8f16.jpg?c=9a86",
    "image_profile": "http:/www.example.com/public/sitevideo_channel/bf/00bf_81d8.jpg?c=f8f8",
    "image_icon": "http:/www.example.com/public/sitevideo_channel/c1/00c1_affd.jpg?c=c507",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "rating_count": 0,
    "is_like": false,
    "tags": null,
    "can_edit": 0,
    "can_delete": 0,
    "rated": false,
    "category": "Others",
    "is_subscribe": 0
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Channel Categories

Channel Categories
GET/advancedvideos/channel/categories/

Example URI

GET /advancedvideos/channel/categories/
URI Parameters
HideShow
category_id (optional, integer, `category_id
string (required) Default: 10`) 

category_id.

subCategory_id (optional, integer, `subCategory_id
string (required) Default: 2`) 

subCategory_id.

showAllCategories
integer (optional) Example: showAllCategories=1

default value is 1. 0 for show all category who has at least one channel.

showCategories
integer (optional) Example: showCategories=1

default value is 1. 0 for show all channel belong to this category.

showChannels
integer (optional) Example: showChannels=1

default value is one . for 0 show categories only.

showCount
integer (optional) Example: showCount=1

default value is 0. for 1 show count belong to this category.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "totalItemCount": 4,
  "categories": [
    {
      "category_id": 12,
      "category_name": "News & Politics",
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 13,
      "category_name": "Lifestyle",
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    },
    {
      "category_id": 14,
      "category_name": "Others",
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    }
  ],
  "subCategories": [
    {
      "sub_cat_id": 15,
      "sub_cat_name": "CNWK",
      "images": {
        "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
      }
    }
  ],
  "channels": {
    "totalItemCount": 0
  },
  "canCreate": 1
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Subscribe Channel

Subscribe Channel
POST/advancedvideos/channel-subscribe/

Example URI

POST /advancedvideos/channel-subscribe/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Value
integer (required) Example: value=0

value 0 for unsubscribe and 1 for subscribe.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Channel Photos

Channel Photos
GET/advancedvideo/channel/photo/

Example URI

GET /advancedvideo/channel/photo/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "totalItemCount": 1,
  " totalPhotoCount": 1,
  "images": [
    {
      "photo_id": 9,
      "album_id": 9,
      "channel_id": 9,
      "user_id": 1,
      "title": "",
      "description": "",
      "collection_id": 9,
      "file_id": 190,
      "creation_date": "2017-02-21 06:53:15",
      "modified_date": "2017-02-21 06:53:15",
      "view_count": 0,
      "comment_count": 0,
      "like_count": 0,
      "order": 8,
      "image": "http:/www.example.com/public/sitevideo_channel/be/00be_97de.jpg?c=9322",
      "image_normal": "http:/www.example.com/public/sitevideo_channel/c0/00c0_8f16.jpg?c=9a86",
      "image_profile": "http:/www.example.com/public/sitevideo_channel/bf/00bf_81d8.jpg?c=f8f8",
      "image_icon": "http:/www.example.com/public/sitevideo_channel/c1/00c1_affd.jpg?c=c507",
      "user_title": "John",
      "likes_count": 0,
      "is_like": 0
    }
  ],
  "canUpload": 1
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Channel Information

Channel Information
GET/advancedvideo/channel/information/

Example URI

GET /advancedvideo/channel/information/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "Basic Information": {
    "Created By": "admin",
    "Created On": "2017-03-27 09:23:18",
    "Last Updated": "2017-03-27 09:27:09",
    "Videos": 0,
    "Views": 2,
    "Likes": 0,
    "Subscribers": 0,
    "Favourites": 0,
    "Description": "Social engine",
    "Category": "Others"
  },
  "Profile Information": {
    "channel1": "New Show",
    "channel2": "finanl channel Testing12"
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Channel Videos

Channel Videos
GET/advancedvideo/channel/videos/

Example URI

GET /advancedvideo/channel/videos/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "response": [
    {
      "video_id": 6,
      "title": "DIY Spider Trax Dolly Track",
      "description": "This is a track that I made for my spider trax dolly. You can attach it to a tri-pod or K-pod and it can be made with simple tools like a few wrenches and a saw.",
      "search": 1,
      "owner_type": "user",
      "owner_id": 1,
      "parent_type": null,
      "parent_id": null,
      "creation_date": "2017-02-21 06:53:17",
      "modified_date": "2017-02-21 06:54:10",
      "view_count": 3,
      "comment_count": 0,
      "type": 2,
      "code": 13949623,
      "photo_id": 210,
      "rating": 0,
      "category_id": 16,
      "status": 1,
      "file_id": 0,
      "duration": 171,
      "rotation": 0,
      "main_channel_id": 5,
      "subcategory_id": null,
      "subsubcategory_id": null,
      "profile_type": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "seao_locationid": 0,
      "location": "",
      "networks_privacy": null,
      "like_count": 1,
      "synchronized": 1,
      "image": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
      "image_normal": "http:/www.example.com/public/video/d4/00d4_40a0.jpg?c=7690",
      "image_profile": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
      "image_icon": "http:/www.example.com/public/video/d2/00d2_07ac.jpg?c=07f6",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0,
      "video_url": "player.vimeo.com/video/13949623?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
    }
  ],
  "is_subscribe": 0,
  "totalItemCount": 1,
  "canCreate": 1,
  "quota": 20
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Channel Subscriber

Channel Subscriber
GET/advancedvideo/channel/subscribers/

Example URI

GET /advancedvideo/channel/subscribers/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "response": [
    {
      "user_id": 2,
      "email": "prem@gmail.com",
      "username": "prem",
      "displayname": "prem kumar",
      "photo_id": 0,
      "status": null,
      "status_date": null,
      "salt": 1134641,
      "locale": "English",
      "language": "English",
      "timezone": "US/Pacific",
      "search": 1,
      "show_profileviewers": 1,
      "level_id": 4,
      "invites_used": 0,
      "extra_invites": 0,
      "enabled": 1,
      "verified": 1,
      "approved": 1,
      "creation_date": "2017-02-15 07:50:56",
      "creation_ip": "\u0000\u0000\u0001",
      "modified_date": "2017-02-28 04:22:59",
      "lastlogin_date": "2017-03-10 12:33:20",
      "lastlogin_ip": "\u0000\u0000\u0001",
      "update_date": null,
      "member_count": 1,
      "view_count": 4,
      "user_cover": 0
    },
    {
      "user_id": 1,
      "email": "sanjeet.kumar@bigsteptech.com",
      "username": "John",
      "displayname": "John",
      "photo_id": 0,
      "status": null,
      "status_date": null,
      "salt": 6290703,
      "locale": "auto",
      "language": "en_US",
      "timezone": "US/Pacific",
      "search": 1,
      "show_profileviewers": 1,
      "level_id": 1,
      "invites_used": 0,
      "extra_invites": 0,
      "enabled": 1,
      "verified": 1,
      "approved": 1,
      "creation_date": "2017-02-14 10:23:05",
      "creation_ip": "",
      "modified_date": "2017-03-08 04:59:52",
      "lastlogin_date": "2017-03-14 04:22:15",
      "lastlogin_ip": "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0001",
      "update_date": null,
      "member_count": 2,
      "view_count": 0,
      "user_cover": 0
    }
  ],
  "totalItemCount": 2
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Favourite Channel

Favourite Channel
POST/advancedvideo/channel/favourite-channel/

Example URI

POST /advancedvideo/channel/favourite-channel/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Value
integer (required) Example: value=0

value 0 for unfavourite and 1 for favourite.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Overview

Overview
GET/advancedvideo/channel/description/

Example URI

GET /advancedvideo/channel/description/
URI Parameters
HideShow
channel_id (required, integer, `channel_id
string (required) Default: 878`) 

channel_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "response": "nice channel"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Advanced Video Plugin/Playlist

These are the APIs for the SocialEngineAddOns Plugin: Advanced Video Plugin.

Create Playlist Form

Create Playlist
GET/advancedvideos/playlist/create

Example URI

GET /advancedvideos/playlist/create
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "type": "Text",
      "name": "title",
      "label": "Playlist Name",
      "hasValidator": true
    },
    {
      "type": "Textarea",
      "name": "description",
      "label": "Description"
    },
    {
      "type": "Select",
      "name": "privacy",
      "label": "View Privacy",
      "description": "Who may see this playlist?",
      "multiOptions": {
        "public": "Public",
        "private": "Private"
      }
    },
    {
      "type": "file",
      "name": "photo",
      "label": "Main Photo"
    },
    {
      "type": "Submit",
      "name": "submit",
      "label": "Submit"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Create Playlist

Create Playlist
POST/advancedvideos/playlist/create

Example URI

POST /advancedvideos/playlist/create
URI Parameters
HideShow
title
string (required) Example: title=New Songs

title.

description
string (required) Example: description=latest.

description.

privacy
string (required) Example: privacy=private

private for owner can view and privacy=public for all.

photo
file (optional) Example: photo=example.jpg

photo for cover photo.

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Edit Playlist Form

Edit Playlist
GET/advancedvideo/playlist/edit/

Example URI

GET /advancedvideo/playlist/edit/
URI Parameters
HideShow
playlist_id (required, integer,`playlist_id
string (required) Default: 11`) 

playlist_id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "type": "Text",
      "name": "title",
      "label": "Playlist Name",
      "hasValidator": true
    },
    {
      "type": "Textarea",
      "name": "description",
      "label": "Description"
    },
    {
      "type": "Select",
      "name": "privacy",
      "label": "View Privacy",
      "description": "Who may see this playlist?",
      "multiOptions": {
        "public": "Public",
        "private": "Private"
      }
    },
    {
      "type": "Submit",
      "name": "submit",
      "label": "Submit"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Edit Playlist

Edit Playlist
POST/advancedvideo/playlist/edit/

Example URI

POST /advancedvideo/playlist/edit/
URI Parameters
HideShow
playlist_id (required, integer,`playlist_id
string (required) Default: 11`) 

playlist_id

title
string (required) Example: title=New Songs

title.

description
string (required) Example: description=Latest.

description.

privacy
string (required) Example: privacy=private

privacy=private for only owner view and privacy=public for all.

photo
file (optional) Example: photo=example.jpg

photo for cover photo.

Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Playlist

Delete Playlist
DELETE/advancedvideo/playlist/delete/

Example URI

DELETE /advancedvideo/playlist/delete/
URI Parameters
HideShow
playlist_id (required, integer, `playlist_id
string (required) Default: 878`) 

playlist_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Browse playlist

Browse playlist
GET/advancedvideos/playlist/browse{?search}{&playlistOrder}{&itemCountPerPage}

Get the playlist. playlist can also be browsed and searched based on keywords, categories, etc.

Example URI

GET /advancedvideos/playlist/browse?search=search=teacher&playlistOrder=playlistOrder=random&itemCountPerPage=itemCountPerPage=10
URI Parameters
HideShow
search
string (optional) Example: search=teacher

get playlist that contain this keyword in title or description.

video_title (optional, string, `video_title
string (required) Default: comedy`) 

get playlist that contain video of this title.

playlistOrder
string (optional) Example: playlistOrder=random

get playlist in the random order or creation date (playlistOrder=creation_date) .

user_id (optional, integer, `user_id
string (required) Default: 125`) 

user id of profile owner. Default value is logged-in user’s ID.

itemCountPerPage
string (optional) Example: itemCountPerPage=10

get 10 playlist per page.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
        "canCreate": 1,
        "response": [
          {
            "playlist_id": 13,
            "title": "Comedy",
            "owner_type": "user",
            "owner_id": 1,
            "creation_date": "2017-02-27 09:47:25",
            "modified_date": "2017-02-27 09:47:25",
            "video_count": 0,
            "description": null,
            "playlist_thumbnail_map_id": null,
            "file_id": 244,
            "like_count": 1,
            "view_count": 0,
            "privacy": "owner",
            "image": "http:/www.example.com/public/sitevideo_playlist/f4/00f4_c7e9.jpeg?c=6018",
            "image_normal": "http:/www.example.com/public/sitevideo_playlist/f4/00f4_c7e9.jpeg?c=6018",
            "image_profile": "http:/www.example.com/public/sitevideo_playlist/f4/00f4_c7e9.jpeg?c=6018",
            "image_icon": "http:/www.example.com/public/sitevideo_playlist/f5/00f5_2d24.jpeg?c=1cf4",
            "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
            "owner_title": "John",
            "allow_to_view": 0,
            "is_like": true
          },
          {
            "playlist_id": 12,
            "title": "Old",
            "owner_type": "user",
            "owner_id": 1,
            "creation_date": "2017-02-24 12:33:15",
            "modified_date": "2017-02-24 12:33:15",
            "video_count": 3,
            "description": "90's video",
            "playlist_thumbnail_map_id": null,
            "file_id": null,
            "like_count": 0,
            "view_count": 0,
            "privacy": "everyone",
            "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
            "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
            "owner_title": "John",
            "allow_to_view": 0,
            "is_like": false
          },
          {
            "playlist_id": 2,
            "title": "Favourite",
            "owner_type": "user",
            "owner_id": 1,
            "creation_date": "2017-02-24 06:22:29",
            "modified_date": "2017-02-24 06:22:29",
            "video_count": 0,
            "description": "My Collection",
            "playlist_thumbnail_map_id": null,
            "file_id": 240,
            "like_count": 0,
            "view_count": 0,
            "privacy": "public",
            "image": "http:/www.example.com/public/sitevideo_playlist/f0/00f0_c7e9.jpeg?c=6018",
            "image_normal": "http:/www.example.com/public/sitevideo_playlist/f2/00f2_b017.jpeg?c=abb2",
            "image_profile": "http:/www.example.com/public/sitevideo_playlist/f1/00f1_9995.jpeg?c=eed8",
            "image_icon": "http:/www.example.com/public/sitevideo_playlist/f3/00f3_2d24.jpeg?c=1cf4",
            "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
            "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
            "owner_title": "John",
            "allow_to_view": 0,
            "is_like": false
          },
    ],
    "totalItemCount": 3
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

My playlist

My playlist
GET/advancedvideos/playlist/manage{?search}{&playlistOrder}{&itemCountPerPage}

Get the videos. Videos can also be browsed and searched based on keywords, categories, etc.

Example URI

GET /advancedvideos/playlist/manage?search=search=teacher&playlistOrder=playlistOrder=random&itemCountPerPage=itemCountPerPage=10
URI Parameters
HideShow
search
string (optional) Example: search=teacher

get playlist that contain this keyword in title or description.

video_title (optional, string, `video_title
string (required) Default: comedy`) 

get playlist that contain video of this title.

playlistOrder
string (optional) Example: playlistOrder=random

get playlist in the random order or creation date (playlistOrder=creation_date) .

user_id (optional, integer, `user_id
string (required) Default: 125`) 

user id of profile owner. Default value is logged-in user’s ID.

itemCountPerPage
string (optional) Example: itemCountPerPage=10

get 10 playlist per page.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "canCreate": 1,
  "response": [
    {
      "playlist_id": 13,
      "title": "Photo Test",
      "owner_type": "user",
      "owner_id": 1,
      "creation_date": "2017-02-27 09:47:25",
      "modified_date": "2017-02-27 09:47:25",
      "video_count": 0,
      "description": null,
      "playlist_thumbnail_map_id": null,
      "file_id": 244,
      "like_count": 1,
      "view_count": 0,
      "privacy": "owner",
      "image": "http:/www.example.com/public/sitevideo_playlist/f4/00f4_c7e9.jpeg?c=6018",
      "image_normal": "http:/www.example.com/public/sitevideo_playlist/f4/00f4_c7e9.jpeg?c=6018",
      "image_profile": "http:/www.example.com/public/sitevideo_playlist/f4/00f4_c7e9.jpeg?c=6018",
      "image_icon": "http:/www.example.com/public/sitevideo_playlist/f5/00f5_2d24.jpeg?c=1cf4",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 0,
      "is_like": true
    },
    {
      "playlist_id": 12,
      "title": "Final Test",
      "owner_type": "user",
      "owner_id": 1,
      "creation_date": "2017-02-24 12:33:15",
      "modified_date": "2017-02-24 12:33:15",
      "video_count": 3,
      "description": "test",
      "playlist_thumbnail_map_id": null,
      "file_id": null,
      "like_count": 0,
      "view_count": 0,
      "privacy": "everyone",
      "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 0,
      "is_like": false
    },
    {
      "playlist_id": 2,
      "title": "test2",
      "owner_type": "user",
      "owner_id": 1,
      "creation_date": "2017-02-24 06:22:29",
      "modified_date": "2017-02-24 06:22:29",
      "video_count": 0,
      "description": "test2",
      "playlist_thumbnail_map_id": null,
      "file_id": 240,
      "like_count": 0,
      "view_count": 0,
      "privacy": "public",
      "image": "http:/www.example.com/public/sitevideo_playlist/f0/00f0_c7e9.jpeg?c=6018",
      "image_normal": "http:/www.example.com/public/sitevideo_playlist/f2/00f2_b017.jpeg?c=abb2",
      "image_profile": "http:/www.example.com/public/sitevideo_playlist/f1/00f1_9995.jpeg?c=eed8",
      "image_icon": "http:/www.example.com/public/sitevideo_playlist/f3/00f3_2d24.jpeg?c=1cf4",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 0,
      "is_like": false
    },
    {
      "playlist_id": 1,
      "title": "Test",
      "owner_type": "user",
      "owner_id": 1,
      "creation_date": "2017-02-24 06:18:07",
      "modified_date": "2017-02-24 06:18:07",
      "video_count": 0,
      "description": "test",
      "playlist_thumbnail_map_id": null,
      "file_id": 236,
      "like_count": 0,
      "view_count": 0,
      "privacy": "public",
      "image": "http:/www.example.com/public/sitevideo_playlist/ec/00ec_c7e9.jpeg?c=6018",
      "image_normal": "http:/www.example.com/public/sitevideo_playlist/ee/00ee_b017.jpeg?c=abb2",
      "image_profile": "http:/www.example.com/public/sitevideo_playlist/ed/00ed_9995.jpeg?c=eed8",
      "image_icon": "http:/www.example.com/public/sitevideo_playlist/ef/00ef_2d24.jpeg?c=1cf4",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 0,
      "is_like": false
    }
  ],
  "totalItemCount": 4
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Playlist Profile

Playlist Profile
GET/advancedvideo/playlist/view/

Example URI

GET /advancedvideo/playlist/view/
URI Parameters
HideShow
playlist_id (required, integer, `playlist_id
string (required) Default: 13`) 

playlist_id.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "response": {
    "playlist_id": 12,
    "title": "Final Test",
    "owner_type": "user",
    "owner_id": 1,
    "creation_date": "2017-02-24 12:33:15",
    "modified_date": "2017-02-24 12:33:15",
    "video_count": 3,
    "description": "test",
    "playlist_thumbnail_map_id": null,
    "file_id": null,
    "like_count": 0,
    "view_count": 0,
    "privacy": "everyone",
    "image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
    "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
    "owner_title": "John",
    "allow_to_view": 0,
    "canCreate": 1,
    "is_like": false
  },
  "videos": [
    {
      "video_id": 1,
      "title": "NEW 2015 Peugeot 508 Sedan",
      "description": "The Peugeot 508 is a large family car launched in 2010 by French automaker Peugeot, and followed by the 508 SW, an estate version, in March 2011.It replaces the Peugeot 407, as well as the larger Peugeot 607, for which no more direct replacement is scheduled. It shares its platform and most engine options with the second-generation Citroën C5: the two cars are produced alongside one another at the companys Rennes Plant, and in Wuhan, China for sales inside China.The Peugeot 508 got several international awards like the Car of the Year 2011 in Spain (award in 2012), Next Green Car Best Large Family car 2011 for  being spacious and well equipped, also noting that it represented excellent build quality and has the best fuel economy in its class  (Peugeot 508 1.6 e-HDi 109g CO2/km) or also Auto Zeitung Best imported family car 2011",
      "search": 1,
      "owner_type": "user",
      "owner_id": 1,
      "parent_type": null,
      "parent_id": null,
      "creation_date": "2017-02-24 12:33:15",
      "modified_date": "2017-02-21 06:53:23",
      "view_count": 12,
      "comment_count": 0,
      "type": 1,
      "code": "aM6iprJa-oc",
      "photo_id": 198,
      "rating": 4,
      "category_id": 16,
      "status": 1,
      "file_id": 0,
      "duration": 85,
      "rotation": 0,
      "main_channel_id": 1,
      "subcategory_id": null,
      "subsubcategory_id": null,
      "profile_type": 1,
      "featured": 1,
      "favourite_count": 2,
      "sponsored": 1,
      "seao_locationid": 0,
      "location": "",
      "networks_privacy": null,
      "like_count": 0,
      "synchronized": 1,
      "playlistmap_id": 2,
      "playlist_id": 12,
      "order": 0,
      "image": "http:/www.example.com/public/video/c6/00c6_b197.jpg?c=992e",
      "image_normal": "http:/www.example.com/public/video/c8/00c8_7ee7.jpg?c=a43d",
      "image_profile": "http:/www.example.com/public/video/c6/00c6_b197.jpg?c=992e",
      "image_icon": "http:/www.example.com/public/video/c6/00c6_b197.jpg?c=992e",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 1,
      "video_url": "www.youtube.com/embed/aM6iprJa-oc?wmode=opaque&autoplay=1",
      "menu": [
        {
          "label": "Delete Video",
          "name": "delete",
          "url": "advancedvideo/delete/1"
        }
      ]
    },
    {
      "video_id": 3,
      "title": "EAT",
      "description": "3 guys, 44 days, 11 countries, 18 flights, 38 thousand miles, an exploding volcano, 2 cameras and almost a terabyte of footage... all to turn 3 ambitious linear concepts based on movement, learning and food ....into 3 beautiful and hopefully compelling short films",
      "search": 1,
      "owner_type": "user",
      "owner_id": 1,
      "parent_type": null,
      "parent_id": null,
      "creation_date": "0000-00-00 00:00:00",
      "modified_date": "2017-02-21 06:53:44",
      "view_count": 7,
      "comment_count": 0,
      "type": 2,
      "code": 27243869,
      "photo_id": 204,
      "rating": 3,
      "category_id": 16,
      "status": 1,
      "file_id": 0,
      "duration": 61,
      "rotation": 0,
      "main_channel_id": 7,
      "subcategory_id": null,
      "subsubcategory_id": null,
      "profile_type": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "seao_locationid": 0,
      "location": "",
      "networks_privacy": null,
      "like_count": 1,
      "synchronized": 1,
      "playlistmap_id": 6,
      "playlist_id": 12,
      "order": 0,
      "image": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
      "image_normal": "http:/www.example.com/public/video/ce/00ce_9795.jpg?c=18a3",
      "image_profile": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
      "image_icon": "http:/www.example.com/public/video/cc/00cc_d8c1.jpg?c=ab6b",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 1,
      "video_url": "player.vimeo.com/video/27243869?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1",
      "menu": [
        {
          "label": "Delete Video",
          "name": "delete",
          "url": "advancedvideo/delete/3"
        }
      ]
    },
    {
      "video_id": 9,
      "title": "Lofoten Eternal Lights",
      "description": "An amazing 14 days touring the Lofoten islands, fromTromson to Reine, more than 2,300 km, a truly unforgettable life experience.An adventure shared with my great friend Jesus Hermana. Together, we enjoyed many of the beautiful spots of Lofoten and its magic northern lights, the Aurora Borealis.I virtually planned the entire trip with the help of Photopills app, which is a crucial tool for me. It helps me predict everything, the movement of the Sun, the Moon and the Milky Way, together with many other useful tools that make planning and shooting my ideas much easier.For the movement of the camera, I used the Mslider dolly. A unique tool to produce great camera movements in a simple way.The equipment used was composed by 3 cameras, the Canon 5D Mark III, the Canon 6D and the Canon 5Dsr, together with several Canon lenses and the Mslider dolly.Special thanks to Canon Spain for lending me the superb Canon 5Dsr. I really enjoyed its high performance and quality.",
      "search": 1,
      "owner_type": "user",
      "owner_id": 1,
      "parent_type": null,
      "parent_id": null,
      "creation_date": "2017-03-14 12:59:05",
      "modified_date": "2017-02-21 06:54:24",
      "view_count": 5,
      "comment_count": 0,
      "type": 2,
      "code": 154819915,
      "photo_id": 219,
      "rating": 0,
      "category_id": 16,
      "status": 1,
      "file_id": 0,
      "duration": 202,
      "rotation": 0,
      "main_channel_id": 9,
      "subcategory_id": null,
      "subsubcategory_id": null,
      "profile_type": null,
      "featured": 1,
      "favourite_count": 0,
      "sponsored": 1,
      "seao_locationid": 0,
      "location": "",
      "networks_privacy": null,
      "like_count": 1,
      "synchronized": 1,
      "playlistmap_id": 10,
      "playlist_id": 12,
      "order": 0,
      "image": "http:/www.example.com/public/video/db/00db_1d7c.jpg?c=20fc",
      "image_normal": "http:/www.example.com/public/video/dd/00dd_9bb7.jpg?c=2a91",
      "image_profile": "http:/www.example.com/public/video/db/00db_1d7c.jpg?c=20fc",
      "image_icon": "http:/www.example.com/public/video/db/00db_1d7c.jpg?c=20fc",
      "owner_image": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http:/www.example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "John",
      "allow_to_view": 1,
      "rating_count": 0,
      "video_url": "player.vimeo.com/video/154819915?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1",
      "menu": [
        {
          "label": "Delete Video",
          "name": "delete",
          "url": "advancedvideo/delete/9"
        }
      ]
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Generated by aglio on 29 Mar 2017