Skip to main content

 Version 5

Legacy documentation for PageSeeder v5

Servlet: XRefLoaderServlet

com.pageseeder.xref.XRefLoaderServlet

Description

This servlet has been removed as of PageSeeder v6. Use services instead.

Returns all xrefs from the given URI.

Use the depth parameter to load xrefs from linked URIs as well.

Use the loadReverse parameter to load Reverse xrefs.

Use the ps-release and ps-releaseStatus parameters to load a specific version of the URI (and sub-URIS).

HTTP method: GET

Load the XRefs for the given URI.

HTTP parameters

NameDescriptionRequiredTypeDefault
uriURI ID (required if path is not specified)conditionalstring
pathURI path (required if uri is not specified)conditionalstring
hostURI host, used only when path is specified (optional, default is request’s host)nostring
portURI port, used only when path is specified (optional, default is request's port)nostring
depthThe depth of xrefs recursion to use (optional)nostring1
loadReverseIf true, the Reverse XRefs are loaded as well (optional)notrue|falsefalse
includeTypesA comma-separated list of types of xrefs to includes (optional, all xrefs are loaded if not specified)nostring
ps-releaseA release to load for the main document (optional, current release is loaded if not specified)nostring
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger200
Created on , last edited on