Skip to main content

 Web service API

How to use PageSeeder's Web service API

get group folder forurl

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

com.pageseeder.groupfolder.GetGroupFolder

Description

Load the group folder (GroupURI) specified by the URL in the request.

This URL has been deprecated in PageSeeder 5.6 and has been scheduled to be removed.

Use Service: /members/{member}/groups/{group}/groupfolders/forpath [GET] instead.

Parameters

NameDescriptionRequiredTypeDefault value
urlthe group folder (/* suffix is added automatically)nostring

Permission

This service requires administrator.

Response

If a group folder was found, this service returns the corresponding <groupfolder> element:

<groupfolder id="[groupuri id]"
             scheme="[scheme]"
             host="[host]"
             port="[port]"
             path="[path]"
             external="[true|false]"
             public="[true|false]"  />

Error Handling

CodeCause / Description
0x1401 If the url is invalid
0x1404 If the group folder url not found
0x1405 If the group folder url not in group
Created on , last edited on