PageCommandsServicesQuickSearchPage Method

Ingeniux CMS Web Services API

Searches Pages by the initial characters in their names

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<string[][]> QuickSearchPage(
	string search,
	string masterPageId,
	bool includeLocale,
	string[] excludeIds
)

Parameters

search
Type: SystemString
Initial characters in Page names, not case-sensitive
masterPageId
Type: SystemString
The Id of Master Page in a lingual map. This parameter is only needed when searching for Page that are available to map to the given master Page as clone.
includeLocale
Type: SystemBoolean
Specifies whether to include Page's lingual information in the search results
excludeIds
Type: SystemString

[Missing <param name="excludeIds"/> documentation for "M:IngeniuxCMService.PageCommandsServices.QuickSearchPage(System.String,System.String,System.Boolean,System.String[])"]

Return Value

Type: XHRServiceResponseGenericString

Array of search result entries. Each entry is a 2 items string array. First item is the Page's name, includes lingual information is specified; Second item is the Page Id

Examples

Sample JSON return
JavaScript
//When search text is  "home", returns the following result, without lingual information

{
    "code": 0,
    "error": null,
    "message": [
        ["HomeSlider (x33)", "x33"], 
        ["HomeSlider (x51)", "x51"], 
        ["HomeSlider (x69)", "x69"], 
        ["HomeSlider (x31)", "x31"],
        ["HomeSlider (x17)", "x17"], 
        ["Home (x5)", "x5"]]
}
See Also

Reference