Asset.GetAnnotations

Returns a list (array) of all comments for the specified asset.

Parameters and required information

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

SessionKey

The session key obtained from User.Login

AssetID

The id of an asset obtained from Workspace.GetAll or Asset.GetDetail

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.GETANNOTATIONS function

The ASSETID was not passed along.

505: Restricted - This user is not authorized to access this asset

The user tried to access an asset id that is outside of the list of permitted workspaces.

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.GetAnnotations" status="success">
	<annotation>
		<id>integer</id>
		<assetid>integer</assetid>
		<timecode>number</timecode>
		<datecreated>yyyy-mm-dd hh:mm:ss</datecreated>
		<description>string</description>
		<username>string</username>
		<userid>integer</userid>
	</annotation>
</mediasilo_response>