Archive Agent File List XML

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Note: The Preview Agent API is deprecated and will be set to End of Life on July 1st, 2024.

If you have integrations that display previews in real-time, we recommend looking into alternative solutions such as obtaining temporary preview links from the RESTful API.

Introduction

The Archive Agent File List XML document contains information about the files matching a request sent to the Archive Agent.

Elements

All elements are required, except under these circumstances:

When MetaData=0 is specified, the MetaData element may be missing.
When FileInformation=0 is specified, the FileInfo element may be missing.
If no PreviewSize parameters are specified, the PreviewLinks element must be missing.

The number of PreviewUrl elements returned must match the number of PreviewSize parameters passed on the query string. If one of the requested preview sizes is out of range, the server must return a 400 Bad Request message. It must not ignore the parameter and return an incomplete XML document.

Example

<?xml version="1.0" ?>
  <FileList Version="1.0"
    CreatorApplication="FotoWare Archive Agent"
    Created="Tue, 07 Jan 2003 15:01:56 GMT"
    TotalHits="258"
    ReturnedHits="50"
    SearchTimeMs="322.2212"
    ProcessingTimeMs="2826.432">
  <File Name="gjestp_bw.jpg" Id="fileId_1">
    <FileInfo>
     <Path>C:\Database\2003\01\12<Path>
     <Created>Tue, 07 Jan 2003 15:01:56 GMT</Created>
     <LastModified>Tue, 07 Jan 2003 15:01:56 GMT</LastModified>
     <FileSize>355422</FileSize>
     <MimeType>image/jpeg</MimeType>
    </FileInfo>
    <PreviewLinks>
     <PreviewUrl Id="0"
Size="120">http://.../ArchiveAgent.dll/Preview?Id=previewId_1</PreviewUrl>
<PreviewUrl Id="1"
Size="180">http://.../ArchiveAgent.dll/Preview?Id=previewId_2</PreviewUrl>
     </PreviewLinks>
     <MetaData>
       <PixelWidth>1312</PixelWidth>
       <PixelHeight>2000</PixelHeight>
       <Resolution>300.00</Resolution>
       <ColorSpace>Rgb</ColorSpace>
       <Text>
         <Field Id="IPTC2:30" Name="Release Date">20020303</Field>
         <Field Id="IPTC2:55" Name="Created Date">20020302</Field>
         <Field Id="IPTC2:80" Name="Byline">Boesen Michael</Field>
         <Field Id="IPTC2:110" Name="Credit">All Over Press</Field>
         <Field Id="IPTC2:115" Name="Source">Polfoto</Field>
         <Field Id="IPTC2:120" Name="Caption">POLFOTO, COPENHAGEN, DENMARK
3MAR2002: Australian singer Kylie Minogue</Field>
         <Field Id="IPTC2:122" Name="Caption Writer">Trine Hansen</Field>
         <Field Id="IPTC2:200" Name="Custom Field 1">69d0xk8o</Field>
         <Field Id="IPTC2:201" Name="Custom Field 2">211475</Field>
       </Text>
    </MetaData>
 </File>
</FileList>