Documentation Center

Get figure URL

Because a figure may be shared between publications, it is necessary to know where this figure is located. This API call is used to get the figure URL.

Example API call

/servlets3/wietmsd?id=1460015059941&book=s1000d_bike_41&collection=default&target=main&action=imageurl&file_name=ICN-S1000DBIKE-AAA-DA00000-0-U8025-00506-A-04-1

Parameters

ParameterDescription
targetmain
actionimageurl
file_nameThe name of the figure, without the file extension, such as ICN-S1000DBIKE-AAA-DA00000-0-U8025-00506-A-04-1.
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.
idA session ID that is valid for this collection and publication combination.

Returns

On success

An XML instance with the URL to figure, that is stored inside < imageurl > element.

<root>
     <status>true</status>
	    <imageurl-list>
	   	     <imageurl>http://localhost:2245/IETMBooks3/s1000d_bike_40/figures_shared/ICN-S1000DBIKE-AAA-DA00000-0-U8025-00506-A-04-1.CGM</imageurl>
	    </imageurl-list>
</root>
On failure
<root>
     <status>false</status>
     <imageurl-list>
     </imageurl-list>
</root>