Documentation Center

Load figure, tables, or activity list

This operation grants quick access to the figures, tables, or items on the document's TOC (often called "activity list"). The API returns an XML instance that expresses this list, and contains all the critical data for listing and linking to these structures within a document.

Example API call

/servlets3/wietmsd?id=1523878300992&book=s1000d_bike_41&collection=default&target=text&action=activity&server=1&refid=4&_=1523963912843

Parameters

ParameterDescription
targettext
actionCan be one of figures, tables, or activity. When this parameter is set to activity, the server parameter determines whether the return content will be HTML or XML.
serverSet to 1 to specify that the return content will be HTML; otherwise, it will be XML. This parameter has no effect when the action parameter is set to figures or tables.
refidThe value of the @FIGREF, @TABREF, or @ACTREF attribute on the that is being targeted.
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

Activity request would return:

<div id="ACTIVITY_LIST" EID="10" LASTEID="13" REFID="">
	<div>
		<span class="normal" onClick="CVPortal.components.cvDocHandler.toggleActivityGroup(event);">
			<img class="link plusbutton" ondrag="event.returnValue=false;" SRC="?target=resource&amp;action=image&amp;file_name=plus.png"/>Sections
		</span>
		<div act_group="1" style="display:none;">
			<div ID="11" EID="11" LASTEID="11" REFID="131" LEVEL="1" class="activity_level1">
				<span class="simpleButton" onclick="CVPortal.components['cvDocHandler'].handle_xref('131', 'text', event);">
					<img class="link" ondrag="event.returnValue=false;" ID="I.11" SRC="?target=resource&amp;action=image&amp;file_name=activ1.gif"/>
					<span class="itemCode" style="color:black;font-weight:normal;" ID="S.11">Functional description of a bicycle</span>
				</span>
			</div>
		</div>
	</div>
</div>

Figures request would return:

<FIGURES_LIST EID="8" LASTEID="45" REFDOCID="7" SIZE="3">
     <FIGURE EID="16" FOLDOUT="" ID="" LASTEID="25" REFDOCID="7" REFID="188" TOCEID="59">
		        <TITLE EID="17">Hydraulic brake function</TITLE>
		        <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA10000-0-U8025-00537-A-03-1" CONTROLS="" DURATION="" EID="25" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="fig-003" MULTIMEDIACLASS="" PREFIX="1" SHEETNO="1" WIDTH=""/>
	    </FIGURE>
	    <FIGURE EID="33" FOLDOUT="" ID="" LASTEID="42" REFDOCID="7" REFID="200" TOCEID="59">
		        <TITLE EID="34">Mechanical brake function</TITLE>
		        <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA10000-0-U8025-00537-A-03-1" CONTROLS="" DURATION="" EID="42" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="fig-002" MULTIMEDIACLASS="" PREFIX="2" SHEETNO="1" WIDTH=""/>
	    </FIGURE>
	    <FIGURE EID="43" FOLDOUT="" ID="fig-0001" LASTEID="45" REFDOCID="7" REFID="209" TOCEID="59">
		        <TITLE EID="44">Brake pad seating</TITLE>
		        <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA10000-0-U8025-00515-A-04-1" CONTROLS="" DURATION="" EID="45" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="" MULTIMEDIACLASS="" PREFIX="3" SHEETNO="1" WIDTH=""/>
	    </FIGURE>
</FIGURES_LIST>

Tables request would return:

<TABLE COUNT="2" DMC="S1000DBIKE-AAA-D00-00-00-00AA-043A-A" DOCTYPE="crew" EID="10" ID="tab-0002" LASTEID="11" REFDOCID="6" REFID="167" SIZE="0">
     <TITLE EID="11" TOCEID="42">brake lever correlation</TITLE>
</TABLE>
On failure

An example of an exception when failed to load table list:

<ERROR>
  <MESSAGE>Failed to find TABLE_LIST node.</MESSAGE>
</ERROR>