Documentation Center

Load All Missing Images report

This API call loads and XML instance that expresses all of the missing media files for an entire publication (the missing images). The XML instance contains the document identifier, element level identifier of each <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=1459929741226&book=s1000d_bike_41&collection=default&target=utility&action=images

Parameters

ParameterDescription
targetutility
actionimages
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 an entire publication. Each level of the hierarchy matches either the entire publication (<MKBOOK/>), a level in the TOC (<SYSTEM/>), or a document (<DOCUMENT/>). At each level, the total number of missing media resources of the children is captured by the @IMGNUM attribute on the element. The <DOCUMENT/> and <IMAGE/> elements help navigate a user directly to an element that references a missing media resource. The <IMAGE/> element contains the identifier for the media resource, and the media's title.

<IMGREPORT>
	<MKBOOK IMGEID="" IMGNUM="2">
		<SYSTEM IMGEID="" IMGNUM="2" SHOW="1" TITLE="Bike 4.1">
			<SYSTEM IMGEID="" IMGNUM="2" SHOW="1" TITLE="Bicycle">
				<DOCUMENT DOCTYPE="procedure" IMGCEID="7" IMGNUM="2" SHOW="1">
					<TITLE>Bicycle - Pre-operation procedures (crew)</TITLE>
					<IMGLIST>
						<IMAGE FILENAME="ICN-S1000DBIKE-AAA-DA10000-0-U8025-00537-A-03-1" IMAGEATTR="infoEntityIdent" IMAGETAG="graphic" IMGEID="190" REFDOCID="7" TITLE="Hydraulic brake function"/>
						<IMAGE FILENAME="ICN-S1000DBIKE-AAA-DA10000-0-U8025-00537-A-03-1" IMAGEATTR="infoEntityIdent" IMAGETAG="graphic" IMGEID="202" REFDOCID="7" TITLE="Mechanical brake function"/>
					</IMGLIST>
				</DOCUMENT>
			</SYSTEM>
		</SYSTEM>
	</MKBOOK>
</IMGREPORT>	
On failure
<response status="error" message="Session expired." />