SL_DetailedSearch

Given a search string and a high-level category, search results are returned from a single high-level category (bin). In addition, more detailed information is included for each result. For example, a course hit might include its topic hits, while a book hit might include its chapter hits.

This function initiates a search and returns the initial portion of the matching result set. The caller can page through the remainder of the result set by issuing a call to SL_PaginateSearch using the returned searchid value in the result set. The end of the result set is reached when all bins contain zero assets.

The returned assets are organized in bins. The assets within a bin are returned in decreasing relevancy-ranking order. This function supports the Simple-user-attributes option of the automatic-user-registration-or-update capability. For more information, see User Registration.

You can extract the nativid or assetid from the book bin and then apply the result to a SignOn, SAMA, or RO launch.

Note: If you are using OLSA with Privacy Support enabled, when invoking this web service, you must specify the login name of a user created using the UM_CreateUser web service, not the login name of a user created in SkillPort. This is because a hashed login name is required by this web service, and only OLSA (not SkillPort) creates this type of login name.

Inputs

• customerId - This refers to the sname provided by Skillsoft. The string identifies the customer of the OLSA environment.
• searchPhrase - The phrase to search.
• binName - A valid Skillsoft bin name to search.
• count - Number of top-level assets, such as, books or courses, found by the search for the bin. Skillsoft recommends a value between 5-10; the maximum is 50.
• languageCode - Valid Skillsoft language code.
• userName - The login name of the user.
• groupCode - This is the Organization code. It is optional and ignored if user already is registered.
• password - The password for the login userName. This is optional and ignored if user already is registered.
• enable508 - Enables Section508 Disability support. This is optional, the default is non-508.

Outputs

• A portion of the result set organized as a list of bins.
• Each bin has its name and various metadata values.
• Each bin lists its associated assets in decreasing relevancy rank order.
• Each asset includes its ID, relevancy rank value and various metadata values.

Additional Faults

• None