Documentation Center

Load all invalid references

This API call loads an XML instance that expresses all the invalid references within either the current data module or the entire publication.. The invalid references can include document-to-document references, or <xref/> links, that is, links internal to a document. The report is organized based on the TOC, making it easy to find the documents that contain the invalid references. In addition, the XML instance contains the document identifiers of each document, making it easy to load the document on demand.

Example API call

/servlets3/wietmsd?id=1459928738144&book=s1000d_bike_41&collection=default&target=utility&action=dxrefs

Parameters

ParameterDescription
targetutility
actioncur_xrefs to find invalid references within the current data module, or dxrefs to find invalid references within the entire publication.
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 throughout the entire publication. Each level of the hierarchy matches either the entire publication (<MKBOOK/>), a level in the TOC (<SYSTEM/>), or a document (<DOCUMENT/>). At each level, the total number of invalid references of the children is captured in the <MISSNUM/> element. The <DOCUMENT/> and <dmRef/> elements help navigate a user directly to a broken reference when needed.

<DXREFREPORT>
	<MKBOOK DXREFCEID="1">
		<MISSNUM>2</MISSNUM>
		<SYSTEM DXREFCEID="2">
			<TITLE>Bike 4.1</TITLE>
			<MISSNUM>2</MISSNUM>
			<SYSTEM DXREFCEID="3">
				<TITLE>Bicycle</TITLE>
				<MISSNUM>2</MISSNUM>
				<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>
		 </SYSTEM>
	</MKBOOK>
</DXREFREPORT>
On failure
<response status="error" message="Session expired." />