Home Page > Integration > XML and RSS

XML and RSS

XML / RSS Feeds

 

Please note feeds are available as plain XML or with additional RSS elements. The RSS feed isn't as clean as the pure XML, and may have redundant attribures you don't require. We recommend using format=xml unless you need any specific RSS elements.

 
XML is an industry standard way of exchanging data. The underlying technology of RSS also uses XML. Using the OpenAsset XML / RSS feeds you could:
  • Automatically pull images from an Album or Search onto your Intranet front page
  • Automatically pull images from an Album or Search onto your public website
  • Create image links on your Intranet that take you to OpenAsset
 
The 2 types of RSS feed available are for the files in an Album or a Search. The options for requesting additional data in the feed (e.g. available image sizes and dimensions) are the same for both Album and Search feeds. The format of the XML data returned by OpenAsset is also common to both Album and Search RSS feeds.
 

Album XML / RSS Feed

Album XML feeds are retrieved through links of the form:
 
http://example.com/Feed/Album?format=xml&code=fd4e2020c2e3134a21b45bb8fc3984cb

 

Album RSS feeds are retrieved through links of the form:

http://example.com/Feed/Album?format=rss2&code=fd4e2020c2e3134a21b45bb8fc3984cb

 

Please see Appendix 1 to find the code for an album, or alternatively you can use the link on the RSS icon on an album list.
 

Search XML / RSS Feed

A Search RSS feed is retrieved through a link of the form:
http://example.com/Feed/Search?format=rss2&categoryCode=Projects
 
Please see Appendix 1 to find values that can be used for categoryCode.The Search RSS Feed takes all the common options. 
 
Additional options and example values for the Search RSS Feed are:
projectCodes AXO001,ZZZ123
keywords model
fileFormats jpg,png
rankFrom 1
rankTo 2
accessLevels green,amber,red

 

Options common to XML / RSS feeds

By adding options to the URL you can control the results returned and request additional data in the RSS feed.

Maximum number of results - The maximum number of files returned in an RSS feed is controlled by using a URL of the form: 

http://example.com/Feed/Search?format=rss2&categoryCode=Projects&limit=100

 

Offset of the first result - The offset of the first file returned in an RSS feed is controlled by using a URL of the form (values start at “0”): 

http://example.com/Feed/Search?format=rss2&categoryCode=Projects&offset=15

 

Order of results returned - The order in which files are returned can be controlled by using a URL of the form: 

http://example.com/Feed/Search?format=rss2&categoryCode=Projects&orderBy=widthDesc

 

The following values are available:

 

albumOrder Only available with an Album RSS Feed
albumOrderDesc Only available with an Album RSS Feed
filename Alpha numeric sort
originalFilename Alpha numeric sort
projectCode Alpha numeric sort
projectName Alpha numeric sort
photographer Alpha numeric sort
copyrightHolder Alpha numeric sort
caption Alpha numeric sort
description Alpha numeric sort
rank Smallest number first
rankDesc Largest number first
accessLevel Green first
accessLevelDesc Red first
width Narrowest first
widthDesc Widest first
height Shortest first
heightDesc Tallest first
fileSize Smallest first
fileSizeDesc Largest first
dateCreated Oldest first
dateCreatedDesc Newest first
dateUploaded Oldest first
dateUploadedDesc Newest first
clickCount Least views first
clickCountDesc Most views first
downloadCount Least downloads first
downloadCountDesc Most downloads first

 

Additional Data - Keywords - By adding options to the URL you can request additional data to be returned in the XML feed. Please note that keywords are not available when format=rss2. Keywords can be included in the XML feed by using a URL of the form: 

http://example.com/Feed/Search?format=xml&categoryCode=Projects&includeKeywords=1

 

Additional Data - Project Keywords - By adding options to the URL you can request additional data to be returned in the XML feed. Please note that project keywords are not available when format=rss2. Project Keywords can be included in the XML feed by using a URL of the form: 

http://example.com/Feed/Search?format=xml&categoryCode=Projects&includeProjectKeywords=1

 

Additional Data - Image Sizes - By adding options to the URL you can request additional data to be returned in the XML / RSS feed. Image sizes can be included in the RSS feed by using a URL of the form: 

http://example.com/Feed/Search?format=rss2&categoryCode=Projects&imageSizes=thumbnail,webview

 

Additional Data - Display Fields - By adding options to the URL you can request additional data to be returned in the RSS feed. Display field information can be included in the feed by using a URL of the form: 

http://example.com/Feed/Search?format=rss2&categoryCode=Projects&displayfields=filename,photographer


​The following fields are available:

 

filename

Text
originalFilename Text
projectCode Text
projectName Text
photographer Text
copyrightHolder Text
caption Text
description Text
rank Integer
width Integer - Pixels
height Integer - Pixels
fileSize Integer - Bytes
dateCreated Integer - 14 digit timestamp YYYYMMDDhhmmss
dateUploaded Integer - 14 digit timestamp YYYYMMDDhhmmss
clickCount Integer – Number of views
downloadCount Integer – Number of downloads

Example RSS

Please note the RSS feed isn't as clean as the pure XML, and may have redundant attribures you don't require. We recommend using format=xml unless you need any specific RSS elements.
 
The following RSS was produced by requesting the feed:
 
http://example.com/Feed/Album?format=rss2&code=fd4e2020c2e3134a21b45bb8fc3984cb&imageSizes=thumbnail,webview&displayFields=photographer,copyrightHolder&includeKeywords=1&includeProjectKeywords=1
 
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0"
         xmlns:openAsset="http://openasset.axomic.com/OpenAsset/RSS2">
 <channel>
  <title>Test Album</title>
  <description></description>
  <language>en-GB</language>
  <pubDate>Tue, 11 Mar 2008 17:20:00 +0000</pubDate>
  <lastBuildDate>Tue, 04 Mar 2008 17:03:54 +0000</lastBuildDate>
  <generator>OpenAsset 3.0.7</generator>
  <item>
   <title>R_080304_N6.jpg: A sunny day</title>
   <description>A very nice sunny day</description>
   <category>Reference</category>
   <guid isPermaLink="false">R_080304_N6.jpg</guid>
   <pubDate>Tue, 04 Mar 2008 16:31:29 +0000</pubDate>
   <source url="http://example.com/Page/AlbumLink?co...b45bb8fc3984cb">Test Album</source>
<openAsset:imageSizes>
        
    <openAsset:imageSize
              postfix="thumbnail"
              relativePath="Reference/R_080304_N6_jpg/R_080304_N6_thumbnail.jpg"
              httpRoot="/Images/"
              uncRoot="//openasset/"
              type="image/jpeg"
              width="120"
              height="80" />
        
     <openAsset:imageSize
              postfix="webview"
              relativePath="Reference/R_080304_N6_jpg/R_080304_N6_webview.jpg"
              httpRoot="/Images/"
              uncRoot="//openasset/"
              type="image/jpeg"
              width="600"
              height="400" />
        
    </openAsset:imageSizes>
     
    <openAsset:displayFields>          
           <openAsset:copyrightHolder>Axomic Ltd</openAsset:copyrightHolder>          
           <openAsset:photographer>Peter Walsham</openAsset:photographer>          
    </openAsset:displayFields>
 
    <openAsset:keywordCategories>
        <openAsset:keywordCategory code="TypeofImage" name="Type of Asset">
            <openAsset:keyword>Photo</openAsset:keyword>
        </openAsset:keywordCategory>
    </openAsset:keywordCategories>
 
    <openAsset:projectKeywordCategories>
        <openAsset:projectKeywordCategory code="Services" name="Services">
            <openAsset:projectKeyword>Architecture</openAsset:projectKeyword>
            <openAsset:projectKeyword>Structural Engineering</openAsset:projectKeyword>
        </openAsset:projectKeywordCategory>
    </openAsset:projectKeywordCategories>
 
  </item>   
 </channel>
</rss>

 

 

Related

Topics
Create and Edit Projects
Integration
OpenAsset comes delivered with many tools for integrating into your existing systems. In some cases it may be necessary to use the APIs provided by Axomic to perform bespoke development work.
SharePoint Integration
SOAP API
URL Links
References
Last modified
04:39, 11 Jan 2016

Tags

Classifications

This page has no classifications.