What is the Archive Agent API?

Getting started with the Archive Agent API

This document is a starting point to help you get going with the FotoWeb Archive Agent API.

Requirements for using the Archive Agent API

Access URLs

Interface

Portal Agent Information XML

The Archive Agent Information XML document contains information about the company or entity running the Archive Agent and any contact information they choose to disclose.

Archive Agent File List XML

Data Formats

Enabling the Preview Agent and Archive Agent

User authentication with the Archive Agent API

Why does FotoWeb return 405 errors on requests with verbs like PUT or DELETE?

Example of XSL Transform

Information method

This method returns general information about the company running the Archive Agent.

GetSmallLogo method

This method returns the small company logo. This logo can be used when presenting the archive to users.

GetLargeLogo method

This method returns the large company logo. This logo can be used when presenting the archive to users.

Search method

This method executes a search through the agent and returns the resulting file list as an XML document.

FileInfo method

This method returns information about a file, such as file attributes, metadata, etc. This function requires input delivered by the ‘Search’ method.

Download method

This method downloads the specified file. You must have download permissions in the archive to call this method.

Getting previews