Documentation Center

Load invalid references in specific document

This API call loads an XML instance that expresses all of the invalid references within a specific document. The invalid references can include document-to-document references, or <xref/> links, those links that are internal to the document. The XML instance contains the document identifier and element level identifier of each reference, making it easy to load the document and navigate to the reference element on demand.

Example API call

/servlets3/wietmsd?id=1459929741226&book=s1000d_bike_41&collection=default&target=utility&action=cur_xrefs&eid=4

Parameters

ParameterDescription
targetutility
actioncur_xrefs
eidThe element level ID of the <DOCUMENT/> for which the invalid references report is being loaded.
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 invalid references for a single, specific document. At the <DOCUMENT/> level, the total number of invalid references of the children is captured in the <MISSNUM/> element. The <dmRef/> elements help navigate a user directly to a broken reference within the document when needed.

<XREFREPORT>
	<DOCUMENT DOCTYPE="description" DXREFCEID="4">
		<TITLE>Bicycle - Description of how it is made</TITLE>
		<MISSNUM>2</MISSNUM>
		<XREFLIST>
			<dmRef REFDOCID="4" DXREFEID="64" dmCode="S1000DBIKE-AAA-D00-00-00-00-AA-00W-A-D">
				<XREFCOMMENT>(dmRef dmCode="S1000DBIKE-AAA-D00-00-00-00-AA-00W-A-D")</XREFCOMMENT>
				<NOTARGETID/>
			</dmRef>
			<dmRef REFDOCID="4" DXREFEID="86" dmCode="S1000DBIKE-AAA-D00-00-00-00-AA-022-A-D">
				<XREFCOMMENT>(dmRef dmCode="S1000DBIKE-AAA-D00-00-00-00-AA-022-A-D")</XREFCOMMENT>
				<NOTARGETID/>
			</dmRef>
		</XREFLIST>
	</DOCUMENT>
</XREFREPORT>
On failure
<response status="error" message="Session expired." />