List Sub-folders

If you wish to get the list of sub-folders in a folder then this API enables you to list all the sub-folders inside any specific folder. You would need to send an

HTTP GET request to https://dev.vdocipher.com/api/videos/folders/:folderId.

note

Folder ID for root folder is root.

Sample Code for Listing Sub-Folders of a Folder

The sample folder ID is written as :folderId. Replace this with the desired folder ID.

The sample API Secret Key is a1b2c3d4e5.

CURL

curl -X GET \
  https://dev.vdocipher.com/api/videos/folders/:folderId \
  -H 'Accept: application/json' \
  -H 'Authorization: Apisecret a1b2c3d4e5'

NODE

var request = require('request');

var options = {
  method: 'GET',
  url: 'https://dev.vdocipher.com/api/videos/folders/:folderId',
  headers: {
    Accept: 'application/json',
    Authorization: 'Apisecret a1b2c3d4e5',
  },
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

PHP

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://dev.vdocipher.com/api/videos/folders/:folderId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Accept: application/json",
    "Authorization: Apisecret a1b2c3d4e5"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

C#

var client = new RestClient("https://dev.vdocipher.com/api/videos/folders/:folderId");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Apisecret a1b2c3d4e5");
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://dev.vdocipher.com/api/videos/folders/:folderId"

headers = {
  'Authorization': "Apisecret a1b2c3d4e5",
  'Accept': "application/json",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'

url = URI("https://dev.vdocipher.com/api/videos/folders/:folderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Apisecret a1b2c3d4e5'
request["Accept"] = 'application/json'

response = http.request(request)
puts response.read_body

Sample Response from API

{
  "folderList": [
    {
      "id": "b3d9f19b3dc4xxxxxxxxxxxxxxxxxxxx",
      "name": "Movies",
      "parent": "3ef518f01f6fxxxxxxxxxxxxxxxxxxxx",
      "videosCount": 0,
      "foldersCount": 84
    },
    {
      "id": "ca038407e1b0xxxxxxxxxxxxxxxxxxxx",
      "name": "Tutorials",
      "parent": "3ef518f01f6fxxxxxxxxxxxxxxxxxxxx",
      "videosCount": 270,
      "foldersCount": 2
    }
  ],
  "current": {
    "id": "3ef518f01f6fxxxxxxxxxxxxxxxxxxxx",
    "name": "Published Videos",
    "parent": "e1812a34c36axxxxxxxxxxxxxxxxxxxx"
  },
  "parent": {
    "id": "e1812a34c36axxxxxxxxxxxxxxxxxxxx",
    "name": "All Videos",
    "parent": "50d30b04273cxxxxxxxxxxxxxxxxxxxx"
  }
}

note

The property parent has the same structure as the property current but when the parent folder is root it will be just null.