faqfindEntries

• 2 minutes to read

Description

Note

This method will search for a FAQ entry. The search words are given as a string, and the system will find the best entries based on that string. The method will find at most 10 entries.

Note

Keep in mind that the search database normally is updated only once every 12:00 AM.

To force an update run the following command from the command line:

Windows: C:\Service\bin\ejournalCron -force [mydomain.com]
Linux: /usr/local/ejournal/bin/ejournalCron -force [mydomain.com]

Replace [mydomain.com] with the domain SuperOffice is registered on. On some systems, the ejournalCron command is located in other folders.

In parameters

Parameter	Description
sessionKey	A valid session key. If empty only public FAQ entries will be found.
searchWords	A space-separated list of words that you wish to search for.
categoryId	The ID of the top node category you wish to search below. All subcategories will be searched too. "-1" = search the whole tree "0" = the root node of the language of the user will be used (only when the customer language module is installed).

Out parameters

Parameter	Description
errorCode	See list of codes
faqEntries	An array of the faq entries. The struct that is returned contains the elements below.

faqEntries element	Description
id	The FAQ entry ID
question	The question.
title	Title of the entry.
hasHtml	1 if this FAQ entry is HTML formatted, 0 if it is plain text.
score	The score this entry has achieved.
fullName	The name of the entry including all parent folders.
parentId	The ID of the folder this entry is stored in. -1 if top node.

Example

customer.customerService custService = new customer.customerService();

string sessionKey;

if(custService.login("test","test", out sessionKey) == "0")
{
  customer.FaqEntryStruct[] myFaqEntries;
  string ret = custService.faq_findEntries(sessionKey, "public", "-1", out myFaqEntries);
  if(ret == "0")
    //myFaqEntries now contains the results.
}