assets.list

This function retrieves a list of all assets for specified roomid.

Parameters

string	api_key	(required) your api key
string	roomid	(required) the roomid of the room for which to fetch the assets list for

Sample return XML
<?xml version="1.0" encoding="UTF-8"?> <response function="assets.list" status="ok"> <result_set totalResults="1"> <result> <assetid>5D9584D4-1111-1701-BFA8FDE11BE9EDBD</assetid> <roomid>f37dzs</roomid> <userid>0</userid> <uploadtype>urlsnapshot</uploadtype> <added>2009-05-14 16:23:09.0</added> <path>3FB8054F-C29F-26BA-6563259FB447D4A7.jpg</path> <clientfilename>myimage.jpg</clientfilename> <allowdownload>1</allowdownload> <width>980</width> <height>720</height> <url>http://api.muchosmedia.com/.../766B2072-DAEA-BCC6-F95A41C1559D6A25.jpg</url> </result> </result_set> </response>

Result explanation

string	assetid	Globally unique identifier for this asset
string	roomid	The room associated with this asset
string	userid	The userid of the user that uploaded or generated this image. May be 0 for anonymous users or API uploads.
string	uploadtype	Type of image. Valid values: urlsnaphot snapshot upload api_image
datetime	added	Date and time of when this asset was created or uploaded
string	path	Specifies the actual file name on disk on the Scribblar system
string	clientfilename	This is the name of the file as it originated before being uploaded. This defaults to 'URL Snapshot' for website snapshots and 'Snapshot' for normal whiteboard snapshots. The default for images added via the API is 'Image'.
integer	allowdownload	Signals if a file in the assetslist shows a download button for easy downloading. 1=download enabled 0=download disabled
integer	width	The width of the image in pixels.
integer	height	The height of the image in pixels.
string	url	The public URL of the asset.

Error Response
If the function call does not succeed it returns the following error response.

An example of an error response would be the following