Web service API

How to use PageSeeder's Web service API

list uri xrefs

/groups/{group}/uris/{uri}/xrefs [GET]

com.pageseeder.xref.XRefLoader

Description

Load a URI's XRefs.

Returns all XRefs from the given URI.

 

Parameters

NameDescriptionRequiredTypeDefault value
forward whether to include forward XRefs no boolean true
includetypes a comma-separated list of types of xrefs to include (none, embed, transclude) no integer
page the page to load no integer 1
pagesize the number of results per page no integer 1000
reverse whether to include reverse XRefs no boolean true
version version of the document no string
versionid version id of the document no integer

Permission

Undocumented permissions requirements.

Response

Format is as follows (ordered by urititle then title):

<uri id=[id] ... >
     <!-- URI details -->
     <displaytitle>[displaytitle]</displaytitle>
     ...
     <!-- XRefs found -->
     <xrefs>
       <xref title="[title]"
             urititle="[target URI title]"
             uriid="[target ID]" ..... />
       <xref title="[title]"
             urititle="[target URI title]"
             uriid="[target ID]" ..... />
       ...
     </xrefs>
     <!-- Reverse XRefs found, if required -->
     <reversexrefs>
       <reversexref title="[title]"
                    urititle="[source URI title]"
                    uriid="[source ID]" ..... />
       ...
     </reversexrefs>
   </uri>

Error Handling

No specific errors expected for this service.

Created on , last edited on