Resolve document reference by ID
This API call helps translate a document ID (such as a data module code in S1000D) into the element level ID that LiveContent has assigned to the document.
Example API call
/servlets3/wietmsd?id=1528457867865&time=1528875861352&book=s1000d_bike_41&collection=default&target=utility&action=xref&xrefid=22
Parameters
| Parameter | Description |
|---|---|
target | utility |
action | xref |
xrefid | An integer equal to the CEID value of the document that is targeted. |
id | A session ID that is valid for this collection and publication combination. |
book | The name of the publication, such as s1000d_bike_41. |
collection | The name of the collection that the publication is registered in, such as default. |
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
-
<?xml version="1.0" encoding="iso-8859-1" ?> <RESULT> <INDEX-ITEM ID="S1000DBIKE-AAA-DA0-00-00-00-AA-041-A-A" CEID="22" EID="" TAGNAME="DOCUMENT" DOCTYPE="description"></INDEX-ITEM> </RESULT>The
@CEIDelement is used as the element level ID when making API calls such as Load XHTML Formatted Document. - On failure
-
<RESULT> <NOTARGET/> </RESULT>