Web service API

How to use PageSeeder's Web service API

server autosuggest

/members/{member}/autosuggest [GET]

com.pageseeder.search.AutoSuggest

Description

Autosuggest for all member's group

This service returns the list of result suggestions from a prefix match on a set of fields. If there are multiple words in term, only the last word is used for prefix matching with an AND on the other words.

Parameters

Name Description Required Type Default value
fields A comma-separated list of fields to search in no strings pstitle,psfilename,psdocid,psid
filters A comma-separated list of field:term pairs to use as filters no strings
results The maximum number of results returned no int 10
term The prefix for the terms to use for the auto suggest yes string

Permission

Only the member themselves, or an administrator, can invoke this service.

Response

Example XML output:

<autosuggest term="lorem">
    <query empty="false"
           predicate="...">
        <suggestion-query>
            <terms>
                <term field="pstitle"
                      text="lorem"/>
                <term field="psfilename"
                      text="lorem"/>
                <term field="psdocid"
                      text="lorem"/>
                <term field="psid"
                      text="lorem"/>
            </terms>
            <condition>pstype:document</condition>
        </suggestion-query>
    </query>
    <results page="1"
             page-size="10"
             total-pages="1"
             total-results="2"
             first-result="1"
             last-result="2">
        <result score="1.6665791">
            <field name="psid">4482</field>
            <field name="pstitle">lorem_ipsum.psml</field>
       ...
       </result>
       <result score="1.6665700">
           <field name="psid">4400</field>
           <field name="pstitle">lorem.psml</field>
       ...
       </result>
    </results>
</autosuggest>

Error Handling

No specific errors expected for this generator.

Created on , last edited on