server autocomplete
/members/{member}/autocomplete [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9900 | 5.9900 | xml, json |
Description
Returns the list of terms to auto-complete a field or set of fields.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| fields | A comma-separated list of fields to search in | no | strings | pstitle,pscontent |
| max-terms | The maximum number of terms to return | no | int | 20 |
| prefix-only | Whether to only match prefixes, not similar terms | no | boolean | false |
| term | The term to auto complete | yes | string | |
| urls-only | Whether to only search URLs | no | boolean | false |
Permission
Restricted to the member themselves or administrator.
Response
<autocomplete term="test"> <term field="pstitle" text="test1" prefix="true"/> <term field="pstitle" text="test2" prefix="true"/> <term field="pscontent" text="testable" prefix="true"/> <term field="pscontent" text="tested" prefix="true"/> ... </autocomplete>
Error Handling
No specific errors expected for this generator.