faq

Web Services Methods › Knowledge Management › Knowledge Management General Methods › faq

faq

The following parameters apply to the faq method:

Parameter	Type	Description
SID	Integer	Identifies the session retrieved from logging in.
categoryIds	String	Identifies the category ID used to perform the faq. Use 1 for the ‘Root’ category. Note: Multiple ids are supported, for example, "1, 2, 3”.
resultSize	Integer	Identifies the number of documents for which you want to retrieve detailed information. For the rest of the documents, only their IDs return. Detailed information for these documents can be accessed later using the getDocumentsByIDs() method. The default is 10.
propertyList	String	Identifies the comma-separated list of database fields from which you want to retrieve information. The following fields are always returned, regardless of the propertyList parameter: id DOC_TYPE_ID BU_RESULT
sortBy	String	Identifies the database field that you want to use for sorting the results. Multiple sort fields are not supported. The default is BU_RESULT, meaning that the faq rating sorts it. When id is used as a secondary sort, it always sorts the results.
descending	Boolean	Identifies an indicator available for sorting the results in descending order.
whereClause	String	Use this to add your own ‘SQL where clause’ for filtering the results of the search.
maxDocIds	Integer	Identifies the maximum amount of document IDs to be returned (the default is 100). For example, if you specify a resultSize of 10 and a maxDocIds of 50, if there are 100 matching documents in the database, then 10 have their detailed information retrieved and 40 have just their IDs returned. The remaining 50 are not returned at all.

Description

Use to perform a faq search. Documents are retrieved based on the category ID that is passed. Any documents residing in that category or in any sub-category are returned. To improve performance, these methods only retrieve detailed information on a user-defined set of documents, which is controlled through the resultSize parameter. The rest of the documents return their IDs only. Using this method, you can for example, set up a paging mechanism where the user can click on ‘Top’, ‘Previous’, ‘Next’, and ‘Bottom’ links. When you need to retrieve the next set of information, you can use the getDocumentsByIDs() method. The maximum number of 100 IDs is returned.

Returns

A <UDSObjectList> node with the following sections:

<UDSObject> node from the <UDSObject> Node Description section of this chapter. There is a <UDSObject> node with all the given properties for the first n documents that the method finds where n equals the resultSize parameter.

For example, if the resultSize parameter is 10, the maxDocIDs parameter is 50, and the method finds 100 documents, then there are 10 <UDSObject> with <Attributes> nodes in the first<UDSObject> section with detail attribute information from propertyList parameter and 40 <UDSObject> nodes with only ID <Attributes> in the following section. If you want to retrieve detailed ID <AttrName> information for documents numbering 11-20, you have to make a call to the getDocumentsByIDs() method and pass it those IDs from <AttrValue>.