Documentation Center

Load Missing Images report for specific document

This API call loads and XML instance that expresses all of the missing media resources for a single, specific document. The XML instance contains the document identifier, element level identifier of each the <figure/> (or other media tag), and the file name of the media resource that would be loaded, if it existed. This makes it easy to navigate a user directly to the document and media element on demand.

Example API call

/servlets3/wietmsd?id=1508942888680&eid=17&book=s1000d_bike_40&collection=default&target=utility&action=cur_images

Parameters

ParameterDescription
targetutility
actioncur_images
eidThe element level identifier on the <DOCUMENT/> for which the missing images report is to be loaded.
idA session ID that is valid for this collection and publication combination.
collectionThe name of the collection that the publication is registered in, such as default.
book The name of the publication, such as s1000d_bike_41.

Returns

On success
The XML instance expressing the missing media resources for a single, specific document. The number of missing media resources for the document is captured in the <DOCUMENT/> element's @IMGNUM attribute. The <DOCUMENT/> and <IMAGE/> elements help navigate a user directly to an element which references a missing media resource. The <IMAGE/> element contains the identifier for the media resource, and the media's title.
<IMGREPORT>
  <SYSTEM IMGCEID="17" TITLE="New DMs Chapter 2" IMGNUM="2">
  <DOCUMENT IMGCEID="19" DOCTYPE="description" IMGNUM="2">
    <TITLE>Description of how it is made</TITLE>
    <IMGLIST>
      <IMAGE TITLE="Welded frame joints" REFDOCID="19" IMGEID="90" IMAGETAG="graphic" IMAGEATTR="infoEntityIdent" FILENAME="ICN-S1000DBIKE-AAA-DA30000-0-U8025-00534-A-04-1"/>
      <IMAGE TITLE="Frame" REFDOCID="19" IMGEID="95" IMAGETAG="graphic" IMAGEATTR="infoEntityIdent" FILENAME="ICN-S1000DBIKE-AAA-DA30000-0-U8025-00503-A-04-1"/>
    </IMGLIST>
  </DOCUMENT>
  </SYSTEM>
</IMGREPORT>
On failure
<IMGREPORT>
  <NOIMAGES>No missing images found in the current document</NOIMAGES>
</IMGREPORT>