Skip to main content

 Web service API

How to use PageSeeder's Web service API

get externaluri forurl

/members/{member}/externaluris/forurl [GET]

com.pageseeder.uri.GetExternalURIWithURL

Description

Get an external URI (also known as URL).

Parameters

NameDescriptionRequiredTypeDefault value
returngroupsthe groups to return in the output, can be "none","user","all" (administrator only)nostringnone
urlthe url for the external URIyesurl

Permission

Restricted to the member themselves or administrator.

Response

The output has the following format:

<uri id="[id]" path="[path]" ...>
  <displaytitle>[title]</displaytitle>
  ...
 [<usage hidden="2">
    <group ... />
    ...
  </usage>]
</uri>

Error Handling

No specific errors expected for this generator.

Created on , last edited on