Documentation Center

Multiple categorical searches with OR operator

This API call is the doorway into LiveContent's built-in search engine. This API call can run multiple Categorical Searches using OR operator. This search may be filtered on TOC selection.

Example API call

/servlets3/wietmsd?id=1458924067614&book=s1000d_bike_41&collection=default&uniqid=1458924066930&target=query&action=dmc_code:fault_code:&search=S1000DBIKE-AAA-DA3-00-00-00AA-041A-A%20200FC01&op1=&term2=&ignore_case=true&whole_words=false

Parameters

ParameterDescription
targetquery
actionList of categorical scope identifiers separated by a ":" (colon). Examples of categorical scope identifiers: sys_title (TOC title search), topic_title (Topic Titles search), figure_title (Figure Titles search), part_pnr (Part Numbers search), part_dfp (Part Nomenclature search), fault_code (Fault Code search), dmc_code (Data module search)
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.
searchList of searched terms, like S1000DBIKE-AAA-DA3-00-00-00AA-041A-A and 200FC01, separated by %20.
ignore_caseIf true, search engine ignores case.
whole_wordsIf false, search engine looks for matches inside the words.
toc_eid_listOptional, toc_eid_list contains the ID of the TOC node in which to search
uniqidTo 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 instance expressing the results and information about where those results lie within the TOC. The results of categorical search are returned in a <TOPIC/> element. The search type is listed in a <SEARCH_TYPE/>, and the total number of results is contained in the <TOTAL/> element. A categorical search returns <TITLE/> elements, each one a document. Within a result, there are extracts from the document that show where the search term was found, and the nearby context.

<RESULT>
	<STATUS>OK</STATUS>
	<TOPIC>
		<SEARCH_TYPE>Data Module Code</SEARCH_TYPE>
		<TOTAL>1</TOTAL>
		<XQLRESULTS>
			<SEARCH_DATA SEARCH_TYPE="dmc_code">
				<SEARCH_RES_PARTITION>
					<TITLE REFDOCID="47" TOCEID="624" DOCID="S1000DBIKE-AAA-DA3-00-00-00-AA-041-A-A" DMC="S1000DBIKE-AAA-DA3-00-00-00AA-041A-A">Frame - Description of how it is made<PATH>Frame/Bike 4.1
						</PATH>
					</TITLE>
				</SEARCH_RES_PARTITION>
			</SEARCH_DATA>
		</XQLRESULTS>
	</TOPIC>
	<TOPIC>
		<SEARCH_TYPE>Fault Code</SEARCH_TYPE>
		<TOTAL>1</TOTAL>
		<XQLRESULTS>
			<SEARCH_DATA SEARCH_TYPE="fault_code">
				<SEARCH_RES_PARTITION>
					<TITLE FAULTCODE="200FC01" ID="" INCODE="414" REFDOCID="55" REFID="105" TOCEID="724" TOC_PARENT_EID="711">The derailleur is jammed</TITLE>
				</SEARCH_RES_PARTITION>
			</SEARCH_DATA>
		</XQLRESULTS>
	</TOPIC>
	<TOC_RESULTS>
		<TOCENTRY TOCEID="724" COUNTER="1"/>
		<TOCENTRY TOCEID="2" COUNTER="2"/>
		<TOCENTRY TOCEID="711" COUNTER="1"/>
		<TOCENTRY TOCEID="1" COUNTER="2"/>
		<TOCENTRY TOCEID="624" COUNTER="1"/>
		<TOCENTRY TOCEID="661" COUNTER="1"/>
		<TOCENTRY TOCEID="611" COUNTER="1"/>
		<TOCENTRY TOCEID="609" COUNTER="1"/>
	</TOC_RESULTS>
</RESULT>
On failure

Zero results are returned:

<RESULT>
	<STATUS>OK</STATUS>
	<TOPIC>
		<SEARCH_TYPE>Data Module Code</SEARCH_TYPE>
		<TOTAL>0</TOTAL>
		<XQLRESULTS>
			<SEARCH_DATA SEARCH_TYPE="dmc_code">
				<SEARCH_RES_PARTITION/>
			</SEARCH_DATA>
		</XQLRESULTS>
	</TOPIC>
	<TOPIC>
		<SEARCH_TYPE>Fault Code</SEARCH_TYPE>
		<TOTAL>0</TOTAL>
		<XQLRESULTS>
			<SEARCH_DATA SEARCH_TYPE="fault_code">
				<SEARCH_RES_PARTITION/>
			</SEARCH_DATA>
		</XQLRESULTS>
	</TOPIC>
	<TOC_RESULTS/>
</RESULT>