Load figures list
This operation grants quick access to the figures on the document's TOC. The API returns an XML instance that expresses this list, and contains all the critical data for listing and linking to figures within a document.
Example API call
/servlets3/wietmsd?id=1460015059941&book=s1000d_bike_41&collection=default&time=1460015058949&target=text&action=figures&eid=10&refid=46
Parameters
| Parameter | Description |
|---|---|
target | text |
action | figures |
eid | The element level ID on the <DOCUMENT/> envelope tag that wraps all documents in LiveContent, such as 10. |
refid | The value of the @FIGREF attribute that is being targeted. |
collection | The name of the collection that the publication is registered in, such as default |
book | The name of the publication, such as s1000d_bike_41. |
id | A session ID that is valid for this collection and publication combination. |
time | To prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a time parameter that is based on the time at which the call is made. |
Returns
- On success
-
An XML instance listing the figures.
<FIGURES_LIST EID="46" LASTEID="61" REFDOCID="10" SIZE="5"> <FIGURE EID="47" FOLDOUT="" ID="" LASTEID="49" REFDOCID="10" REFID="175" TOCEID="104"> <TITLE EID="48">Unseating the tire with a tire lever</TITLE> <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA00000-0-U8025-00506-A-04-1" CONTROLS="" DURATION="" EID="49" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="" MULTIMEDIACLASS="" PREFIX="1" SHEETNO="1" WIDTH=""> </GRAPHIC> </FIGURE> <FIGURE EID="50" FOLDOUT="" ID="" LASTEID="52" REFDOCID="10" REFID="186" TOCEID="104"> <TITLE EID="51">Circle leak</TITLE> <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA01010-0-U8025-00508-A-04-1" CONTROLS="" DURATION="" EID="52" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="" MULTIMEDIACLASS="" PREFIX="2" SHEETNO="1" WIDTH=""> </GRAPHIC> </FIGURE> <FIGURE EID="53" FOLDOUT="" ID="" LASTEID="55" REFDOCID="10" REFID="194" TOCEID="104"> <TITLE EID="54">Sanding the application area</TITLE> <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA01010-0-U8025-00509-A-04-1" CONTROLS="" DURATION="" EID="55" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="" MULTIMEDIACLASS="" PREFIX="3" SHEETNO="1" WIDTH=""> </GRAPHIC> </FIGURE> <FIGURE EID="56" FOLDOUT="" ID="" LASTEID="58" REFDOCID="10" REFID="199" TOCEID="104"> <TITLE EID="57">Apply glue to application area</TITLE> <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA01010-0-U8025-00510-A-04-1" CONTROLS="" DURATION="" EID="58" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="" MULTIMEDIACLASS="" PREFIX="4" SHEETNO="1" WIDTH=""> </GRAPHIC> </FIGURE> <FIGURE EID="59" FOLDOUT="" ID="" LASTEID="61" REFDOCID="10" REFID="208" TOCEID="104"> <TITLE EID="60">Apply pressure to tube</TITLE> <GRAPHIC AUTOPLAY="" BOARDNO="ICN-S1000DBIKE-AAA-DA01010-0-U8025-00511-A-04-1" CONTROLS="" DURATION="" EID="61" FOLDOUT="" FULLSCREEN="" HEIGHT="" ID="" MULTIMEDIACLASS="" PREFIX="5" SHEETNO="1" WIDTH=""> </GRAPHIC> </FIGURE> </FIGURES_LIST> - On failure
-
Nothing.