Web service API

How to use PageSeeder's Web service API

get uri sharing forurl

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

com.pageseeder.uri.GetURIWithURL

Description

Load a URI object with sharing information.

Parameters

NameDescriptionRequiredTypeDefault value
urlThe url to look for.yesurl
sharingWhether to include sharing information.nobooleanfalse

Permission

Permissions requirements to be updated.

Response

The output has the following format:

<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>]
    [<sharing hidden="2">
        <share editable="true"
               shareedits="true"
               sharexrefs="true"
               addcomments="true"
               default="true">
            <group name="my-group1" .../>
        </share>
        <share editable="true"
               shareedits="true"
               sharexrefs="true"
               addcomments="false">
            <group name="my-group2" .../>
        </share>
        <share editable="false"
               addcomments="true">
            <group name="my-group3" .../>
        </share>
    </sharing>]
</uri>

Error Handling

No specific errors expected for this service.

Created on , last edited on