Return feed

Leave a comment Go to comments

Every API call that manipulates assets return an atom feed as the container of the data fetched. Some of these calls are: create; uploadMaterial or getAssetsByTags.

The asset in the feed is represented as an entry where some calls may retrieve multiple entries under one feed.

A feed for the asset management has several properties that describe the search query. These values are not generated for any of the calls in the create section.

Feed properties for GetAssets and GetAssetsByTags
Return Parameter Description
id Unique asset ID, maybe set to *,* in case of multiple returns
published Indicates the date the material was created, <published>2007-02-16T20:22:57.000Z</published>.
title Provides the asset name, <title></title>. In case of multiple results this title is defined by the query
generator Provides the version, the url, and the generator string (gizmo.com), <generator version=’1.0’uri= http://www.gizmoz.com/’>Gizmoz API- GAWS</generator>.
link Provides the wdsl service call link, which returns the data. This parameter is optional. <link href=”www.gizmoz.com….” rel=”alternate” /> /* links for item view page */
Info Provides a detailed call description.
opensearch:totalResults Indicates how many results were found by the query
opensearch:startIndex Indicates the point at which the index starts. This return is dependent on the from and to parameters.
opensearch:itemsPerPage Indicates how many entries were retrieved by this search, starting at the startIndex parameter
opensearch:Query Indicates which parameters were queried, for example sonsOf or getAssets.

Example

</p>
<p>&lt;feed xmlns=&quot;http://www.w3.org/2005/Atom&quot; xmlns:asset=&quot;http://www.gizmoz.com/api/module/item/1.0.rdf&quot; xmlns:comment=&quot;http://www.gizmoz.com/api/module/comment/1.0.rdf&quot; xmlns:dc=&quot;http://purl.org/dc/elements/1.1/&quot; xmlns:opensearch=&quot;http://a9.com/-/spec/opensearch/1.1/&quot; xmlns:partner=&quot;http://www.gizmoz.com/api/module/partner/1.0.rdf&quot; xmlns:rdf=&quot;http://www.w3.org/1999/02/22-rdf-syntax-ns#&quot; xmlns:sy=&quot;http://purl.org/rss/1.0/modules/syndication/&quot; xmlns:taxo=&quot;http://purl.org/rss/1.0/modules/taxonomy/&quot; xmlns:user=&quot;http://www.gizmoz.com/api/module/category/1.0.rdf&quot;&gt;</p>
<p>&lt;title&gt;Tags:sport,football&lt;/title&gt;</p>
<p>&lt;id&gt;*,*&lt;/id&gt;</p>
<p>&lt;generator uri=&quot;http://www.gizmoz.com&quot; version=&quot;1.0&quot;&gt;Gizmoz API - GAWS&lt;/generator&gt;</p>
<p>&lt;updated&gt;2010-01-31T16:17:53Z&lt;/updated&gt;</p>
<p>&lt;opensearch:itemsPerPage&gt;8&lt;/opensearch:itemsPerPage&gt;</p>
<p>&lt;opensearch:totalResults&gt;78&lt;/opensearch:totalResults&gt;</p>
<p>&lt;opensearch:startIndex&gt;1&lt;/opensearch:startIndex&gt;</p>
<p>&lt;opensearch:Query role=&quot;belongsToTag&quot; searchTerms=&quot;null:sport,football&quot;/&gt;<br />
&lt;entry&gt;&lt;/entry&gt;<br />
&lt;!-- Here will be the list of entries --&gt;</p>
<p>&lt;/feed&gt;</p>
<p>

Asset Entry xml explained
Return Parameter Description
title Asset’s name, this value is not unique per asset
author.name The ID of the user that generated the asset – deprecated
id The assets unique ID
updated Date of last update call
published Date of creation
asset:group This node holds the field which are the core details of the asset.
asset:type Type of the asset (see appendix…)
asset:subtype Subtype of the asset (see appendix …)
asset:attribs Some values are stored during the creation process. The parameters that defined the asset then are saved under root.system

The asset attributes are in XML format. They contain a system section of internal attributes, and external section the user can change.
asset:content Reference to a linked asset which serves as content of the main asset in the entry. There may be more than one such tag.

Stores the media content of the asset with the following attributes:

  • format: the mime type of the media
  • url: path to the media data
  • creation_date
  • width, height
  • id (of the related asset)
  • name
  • role
  • asset: link_attribs – The relation between the linked asset and the main asset.
asset:thumbnail Reference to a linked asset which serves as a thumbnail of the main asset in the entry. There may be more than one such tag.

Stores the media content of the asset with the following attributes:

  • format: the mime type of the media
  • url: path to the media data
  • creation_date
  • width, height
  • id (of the related asset)
  • name
  • role
asset: link_attribs The relation between an asset and a referred asset, such as head and its preview image.
Linkattrs.role Child of the asset: link_attribs node. Define the purpose of the content asset within the main asset
Asset:tags A tag attached to the asset. There may be more than one such tag. Contains these attributes:

  • tag – the tag text
  • type – tag type (need appendix)
asset:authorid The user who created the asset – user ID
asset:authorname The user who created the asset – username
asset:authorcontent Like the asset:content, this gives information of some linked asset which represents the user. Usually the default head image.
asset:authorization Defines who can view the newly created asset (private/public)

Example:

<br />
&lt;entry&gt;<br />
 &lt;title&gt;My Head&lt;/title&gt;<br />
 &lt;author&gt;<br />
 &lt;name&gt;62292&lt;/name&gt;<br />
 &lt;/author&gt;<br />
 &lt;id&gt;17317035&lt;/id&gt;<br />
 &lt;updated&gt;2010-01-31T16:49:00Z&lt;/updated&gt;<br />
 &lt;published&gt;2010-01-31T16:49:00Z&lt;/published&gt;<br />
 &lt;asset:group&gt;<br />
 &lt;asset:type&gt;head&lt;/asset:type&gt;<br />
 &lt;asset:subtype&gt;TDC&lt;/asset:subtype&gt;<br />
 &lt;asset:attribs&gt;<br />
 &lt;root&gt;<br />
 &lt;system&gt;<br />
 &lt;centeredEyes&gt;0&lt;/centeredEyes&gt;<br />
 &lt;make_zip&gt;0&lt;/make_zip&gt;<br />
 &lt;PreviewHeight&gt;640&lt;/PreviewHeight&gt;<br />
 &lt;Wait&gt;1&lt;/Wait&gt;<br />
 &lt;environment&gt;instantheads&lt;/environment&gt;<br />
 &lt;Transparent&gt;1&lt;/Transparent&gt;<br />
 &lt;OutputWidth&gt;640&lt;/OutputWidth&gt;<br />
 &lt;createAction&gt;gizmoz/head&lt;/createAction&gt;<br />
 &lt;PreviewWidth&gt;640&lt;/PreviewWidth&gt;<br />
 &lt;GeneratePreview&gt;1&lt;/GeneratePreview&gt;<br />
 &lt;Title&gt;My Head&lt;/Title&gt;<br />
 &lt;extention&gt;.tdc&lt;/extention&gt;<br />
 &lt;OutputHeight&gt;640&lt;/OutputHeight&gt;<br />
 &lt;/system&gt;<br />
 &lt;/root&gt;<br />
 &lt;/asset:attribs&gt;<br />
 &lt;asset:content creation_date=&quot;201001311149&quot; format=&quot;video/flv&quot; height=&quot;640&quot; id=&quot;17317044&quot; modified_date=&quot;201001311149&quot; name=&quot;Gizmoz4U&quot; role=&quot;idle&quot; url=&quot;http://c-static.gizmoz.com/file/material/62292/icon/17317044.flv?v=1264956821156&quot; width=&quot;640&quot;&gt;<br />
 &lt;asset:linkAttrs&gt;<br />
 &lt;linkAttrs&gt;<br />
 &lt;role&gt;idle&lt;/role&gt;<br />
 &lt;injectToGroup&gt;content&lt;/injectToGroup&gt;<br />
 &lt;/linkAttrs&gt;<br />
 &lt;/asset:linkAttrs&gt;<br />
 &lt;/asset:content&gt;<br />
 &lt;asset:thumbnail creation_date=&quot;201001311149&quot; format=&quot;image/png&quot; height=&quot;640&quot; id=&quot;17317037&quot; modified_date=&quot;201001311149&quot; name=&quot;17317037&quot; role=&quot;preview&quot; url=&quot;http://c-static.gizmoz.com/file/material/62292/icon/17317037.png?v=1264956799936&quot; width=&quot;640&quot;&gt;<br />
 &lt;asset:linkAttrs&gt;<br />
 &lt;linkAttrs&gt;<br />
 &lt;role&gt;preview&lt;/role&gt;<br />
 &lt;injectToGroup&gt;thumbnail&lt;/injectToGroup&gt;<br />
 &lt;/linkAttrs&gt;<br />
 &lt;/asset:linkAttrs&gt;<br />
 &lt;/asset:thumbnail&gt;<br />
 &lt;asset:thumbnail creation_date=&quot;201001311149&quot; format=&quot;image/png&quot; height=&quot;160&quot; id=&quot;17317038&quot; modified_date=&quot;201001311149&quot; name=&quot;17317038&quot; role=&quot;icon&quot; url=&quot;http://c-static.gizmoz.com/file/material/62292/icon/17317038.png?v=1264956821463&quot; width=&quot;160&quot;&gt;<br />
 &lt;asset:linkAttrs&gt;<br />
 &lt;linkAttrs&gt;<br />
 &lt;role&gt;icon&lt;/role&gt;<br />
 &lt;injectToGroup&gt;thumbnail&lt;/injectToGroup&gt;<br />
 &lt;/linkAttrs&gt;<br />
 &lt;/asset:linkAttrs&gt;<br />
 &lt;/asset:thumbnail&gt;<br />
 &lt;asset:authorid&gt;62292&lt;/asset:authorid&gt;<br />
 &lt;asset:desc&gt;API_HEAD&lt;/asset:desc&gt;<br />
 &lt;asset:authorization&gt;public&lt;/asset:authorization&gt;<br />
 &lt;asset:link_attribs&gt;<br />
 &lt;linkAttrs/&gt;<br />
 &lt;/asset:link_attribs&gt;<br />
 &lt;/asset:group&gt;<br />
&lt;/entry&gt;<br />

  1. No comments yet.
  1. February 3, 2010 at 4:18 pm
    Quick start tutorial « Gizmoz Developers Center

Leave a comment