Web service API

How to use PageSeeder's Web service API

get uri forurl

/groups/{group}/uris/forurl [GET]

com.pageseeder.uri.GetURIWithURL

Description

Load a single URI object from the URL specified in the request.

This service does not return the actual URI content, it is designed instead to return useful information about the URI such as its media type, identifiers, type, etc...

Use this service when you know the URL of a document or URL but need an identifier or permalink.

 

Parameters

NameDescriptionRequiredTypeDefault value
url the url to look for no url

Permission

Undocumented permissions requirements.

Response

If found the corresponding URI is returned as a single <uri> element.

<uri id="[id]"
     scheme="[scheme]"
     host="[host]"
     port="[port]"
     path="[path]"
     decodedpath="[decodedpath]"
     external="[true|false]"
     [archived="true"]
     [folder="true"]
     [docid="[docid]"]
     [mediatype="[mediatype]"]
     [documenttype="[documenttype]"]
     [title="My Document"]
     [created="[created]"]
     [modified="[modified]"]>
    <displaytitle>My Document</displaytitle>
    [<description>This is my document</description>]
    [<labels>mylabel1,mylabel2</labels>]
</uri>

Error Handling

No specific errors expected for this service.

Created on , last edited on