group autocomplete
/groups/{group}/autocomplete [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.7005 | 5.9900 | xml, json |
Description
Autocomplete the specified term in the group.
This service returns the list of terms that complete the specified prefix. If no prefixed terms are found, it returns similar terms.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| term | The term to autocomplete, effectively a prefix for possible terms | yes | string | |
| fields | Comma-separated list of index fields to look for terms in | no | strings | pstitle,pscontent |
| max-terms | The maximum number of terms to return | no | integer | 20 |
| prefix-only | Whether to only match prefixes, not similar terms | no | boolean | false |
Permission
This service is restricted to guest and higher.
Response
Example XML output:
<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 service.