This method will return a list of folders on ONE level. To iterate for subfolders you will need to call this method each time. If you rather like to retrieve ALL folder and subfolders at once please take a look at the below function.
Method
Method Name
getfolders
Input Parameter
Parameter
Description
Type
Required
Sample Input
sessiontoken
A valid sessiontoken
String
yes
54592180-7060-4D4B-BC74-2566F4B2F943
folderid
The ID of the folder you want to retrieve assets from.
Numeric
yes
0 = all folders on the root level
e4x
To return the XML in e4x format or not
Numeric
yes
0 = No 1 = yes
Output Value
Name
Description
Sample Output
Note
Response
A result code with the status of the login. If the result is 0 the method was successful.
0
listfolders
The body node of the returned list of folders
folderid
ID of folder
2
foldername
Name of folder
Demo Folder
hassubfolder
Folder contains sub-folder
true or false
totalassets
Total of all assets in this folder
8
Razuna 1.3.5
totalimg
Total of all images in this folder
5
Razuna 1.3.5
totalvid
Total of all videos in this folder
2
Razuna 1.3.5
totaldoc
Total of all documents in this folder
1
Razuna 1.3.5
totalaud
Total of all audios in this folder
3
Razuna 1.3.5
folderowner
The userid that the folder belong to
8
Razuna 1.3.5
SOAP: Sample Request
REST: Sample Request
Sample Output
Sample Output for e4x
Get ALL folders
This method will return all folders and subfolders. Please be aware that with a lot of folders this can put a strain on your Razuna server!
Method
Method Name
getfolderstree
Input Parameter
Parameter
Description
Type
Required
Sample Input
sessiontoken
A valid sessiontoken
String
yes
54592180-7060-4D4B-BC74-2566F4B2F943
e4x
To return the XML in e4x format or not
Numeric
yes
0 = No 1 = yes
Output Value
Name
Description
Sample Output
Note
Response
A result code with the status of the login. If the result is 0 the method was successful.
0
listfolders
The body node of the returned list of folders
folder
The root element
folderid
ID of folder
2
foldername
Name of folder
Demo Folder
folderlevel
Level of this folder
1
parentid
Parent ID of this folder
1
hassubfolder
Folder contains sub-folder
true or false
subfolder
The root element of subfolder
The subfolder element may contain all subfolders with each element of the folder
totalassets
Total of all assets in this folder
8
Razuna 1.3.5
totalimg
Total of all images in this folder
5
Razuna 1.3.5
totalvid
Total of all videos in this folder
2
Razuna 1.3.5
totaldoc
Total of all documents in this folder
1
Razuna 1.3.5
totalaud
Total of all audios in this folder
3
Razuna 1.3.5
folderowner
The userid that the folder belong to
8
Razuna 1.3.5
SOAP: Sample Request
REST: Sample Request
Sample Output
Sample Output for e4x
Retrieving all assets in a folder
Method
Method Name
getassets
Input Parameter
Parameter
Description
Type
Required
Sample Input
sessiontoken
A valid sessiontoken
String
yes
54592180-7060-4D4B-BC74-2566F4B2F943
folderid
The ID of the folder you want to retrieve assets from.
Numeric
yes
1
showsubfolders
To include assets from subfolders as well.
Numeric
yes
1 = true 0 = false
offset
This request supports paging. Enter the offset here.
Numeric
yes
0
maxrows
The maximum rows you want to request.
Numeric
yes
25 = show 25 assets 0 = show ALL assets
show
What kind of assets to show
String
yes
all = All assets img = Images only vid = Videos only doc = Documents only aud = Audios only
The offset and the maxrows values are the same as the LIMIT option of the MySQL database. You enter the page (offset) and the amount of records you want to request.
Example; There are 125 assets in a folder and you want to return 50 assets then your offset and maxrows would look like; offset=0&maxrows=50. For the next 50 assets you would use; offset=1&maxrows=50 to get to page 2 and so on. Note: To return all records, you need to give maxrows a value of 0 (zero)!
Output Value
Name
Description
Sample Output
Response
A result code with the status of the login. If the result is 0 the method was successful.
0
totalassetscount
How many assets are in this folder
8
calledwith
The folderid you passed to this method
1
listassets
The body node of the returned list of assets
assets
For each asset an asset node is returned with information of the asset
see sample output
SOAP: Sample Request
REST: Sample Request
Sample Output
Get Folder Information
Method
Method Name
Available
getfolder
Razuna 1.4.6
Input Parameter
Parameter
Description
Type
Required
Sample Input
sessiontoken
A valid sessiontoken
String
yes
54592180-7060-4D4B-BC74-2566F4B2F943
folderid
The ID of the folder you want to retrieve assets from.
String
yes
1
Output Value
Name
Description
Sample Output
Response
A result code with the status of the login. If the result is 0 the method was successful.
0
folder_id
The folderid you passed to this method
1
folder_related
To which folder this folder is related to
if this is the root folder it will be the same ID as the folder id
folder_name
Name of this folder
Renderings
SOAP: Sample Request
REST: Sample Request
Sample Output
Create Folder
Method
Method Name
Available
setfolder
Razuna 1.4.6
Input Parameter
Parameter
Description
Type
Required
Sample Input
sessiontoken
A valid sessiontoken
String
yes
54592180-7060-4D4B-BC74-2566F4B2F943
folder_name
Name of folder
String
yes
Test Folder
folder_owner
The user id that this folder belongs to. If left blank then the current user is the owner.
String
yes
874329847
folder_related
The ID of the related folder. Important if you create a folder in a sublevel.
String
yes
You have to pass the ID of the related folder in order to make it work If the value is empty then your folder will be created in the "root"!
folder_collection
Is this folder a collection folder
String
yes
true false
folder_description
Description of folder
String
yes
This folder is created with the API
Output Value
Name
Description
Sample Output
Response
A result code with the status of the login. If the result is 0 the method was successful.
0
folder_id
The ID of the created folder
1
SOAP: Sample Request
REST: Sample Request
You should always escape URL values!
Sample Output
Delete Folder
This method will remove the folder, any subfolders and content within!
There is no to redo this action!!!
Method
Method Name
Available
removefolder
Razuna 1.4.6
Input Parameter
Parameter
Description
Type
Required
Sample Input
sessiontoken
A valid sessiontoken
String
yes
54592180-7060-4D4B-BC74-2566F4B2F943
folder_id
Name of folder
String
yes
454329579845097425097
Output Value
Name
Description
Sample Output
Response
A result code with the status of the login. If the result is 0 the method was successful.
