API Documentation

Asset.GetDetail

Asset.GetDetail

Returns asset specific data.

Parameters and required information

Here's a list of all the parameters you'll need to pass to the Asset.GetDetail method. All of the parameters are required unless otherwise noted.

SessionKey
The session key obtained from User.Login
AssetID
The id of a asset obtained from Workspace.GetAssets

Return Codes

Success

Status: success
Returns a list of all assets for the current workspace.
Status: fail
The call was not successful. Either the session has expired or the XML was not formatted correctly.

Error

5002: Authentication Failure
No active session exists with this session key and developer account id. The user session has expired and the user has to to log on again.
101: The ASSETID attribute is required in the ASSET.GETDETAIL function
The ASSETID was not passed along.
506: This user is not authorized to view assets
This user is not authorized to view assets

HTTP POST

<?xml version="1.0" encoding="utf-8"?>  
<request>  
	<sessionkey>string</sessionkey>
	<assetid>string</assetid>     
</request>  
<?xml version="1.0" encoding="utf-8"?>
<mediasilo_response method="Asset.GetDetail" status="success">
	<asset>
		<title>string</title>
		<assetstatus>string</assetstatus>
		<isuserapprovalrequired>boolean</isuserapprovalrequired>
		<sourcewidth>integer</sourcewidth>
		<sourceheight>integer</sourceheight>
		<totalcomments>integer</totalcomments>
		<totalannotations>integer</totalannotations>
		<name>string</name>
		<totalapprovals>integer</totalapprovals>
		<userrating>currently returns empty</userrating>
		<size>integer</size>
		<id>integer</id>
		<thumbnail_small>string</thumbnail_small>
		<thumbnail_large>string</thumbnail_large>
		<hasuserapproved>boolean</hasuserapproved>
		<datecreated>yyyy-mm-dd hh:mm:ss</datecreated>
		<ownerusername>currently returns empty</ownerusername>
		<description>string</description>
		<duration>integer</duration>
		<accountid>integer</accountid>
		<ownerid>integer</ownerid>
		<proxysource>string</proxysource>
		<source>string</source>
		<totalapprovalsrequired>integer</totalapprovalsrequired>
		<taglist>string</taglist>
		<isapprovedbyallrequired>boolean</isapprovedbyallrequired>
		<custommetadata>
			<metadataa>
				<key>String</key>
				<value>String</value>
				<type>String</type>
			</metadataa>
		</custommetadata>
	</asset>
</mediasilo_response>

Legend

title
Title of the file as displayed in MediaSilo.
assetstatus
File status.
isuserapprovalrequired
Returns 1 if the current user has been asked to approve the current asset. Otherwise returns empty.
sourcewidth
The width of the uploaded source file in pixels.
sourceheight
The height of the uploaded source file in pixels.
totalcomments
Total number of comments for this asset. Currently not implemented.
totalannotations
Total number of annotations for this asset.
name
Name of the file as it was ingested by MediaSilo.
totalapprovals
Currently not implemented.
userrating
Currently not implemented.
size
File size in kilobytes (KB).
id
ID of the current file.
thumbnail_small
Complete URL to the small thumbnail of the current file.
thumbnail_large.
Complete URL to the large thumbnail of the current file. Currently the same as the small thumbnail.
hasuserapproved
Currently not implemented.
datecreated
Date on which the asset was uploaded. Example: 2008-10-15 09:54:37.0
ownerusername
Currently not implemented.
description
Description of the file.
duration
The duration of the source file in miliseconds, i.e. 115030ms = 1:55.
accountid
ID of the account under which this user is registered.
ownerid
ID of the user who uploaded the asset.
proxysource
Complete URL of the encoded proxy file. Either H.264 .mov or On2.VP6 .flv.
source
Complete URL of the uploaded file before encoding.
totalapprovalsrequired
Currently not implemented.
taglist
Comma separated list of tags associated with this asset.
isapprovedbyallrequired
Currently not implemented.