Skip to main content

 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
forwardWhether to include forward XRefsnobooleantrue
includetypesA comma-separated list of types of xrefs to include (none, embed,transclude)nointeger
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger1000
reverseWhether to include reverse XRefsnobooleantrue
versionVersion of the documentnostring
versionidVersion id of the documentnointeger

Permission

This service is restricted to guest and higher unless the group is accessible to public.

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