...
Name | Description | Validation |
---|---|---|
q | Freetext query for finding matching profiles | Required parameter |
page | Current page within the result set, starts at 0 | Optional, number >= 0 |
pageSize | Maximum number of results per page. Default 10 | Optional, number > 0 and <= 100 |
scope | Search scope | Optional, may be one of:
|
p | Search scope parameter | Required if scope=GENERIC_FIELD: Name of the generic field to search in Optional for scope=RECORD_LOCATOR: System type or Label (e.g. “CSX”, “GALILEO_WS”, “My HR-System”) Prohibited otherwise |
matchType | Search string match type | Optional parameter. Controls for certain scopes how the search string from "q" is matched against the profile database value
The parameter may be given for the following scopes and will be ignored if provided for any other scope not listed here:
|
detailSections | Specify additional profile areas to be returned if includeDetails is set to true. Only explicitly specified sections will be included. | Any section may be specified, with more data-heavy sections only being allowed if pageSize is <= 25 The following sections are allowed regardless of page size:
|
...