Web service API

How to use PageSeeder's Web service API

get group folder forurl

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

com.pageseeder.groupfolder.GetGroupFolder

This service is deprecated since version 5.7900

Description

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

Deprecation warning!

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

Use Service: /groups/{group}/groupfolders/forurl [GET] instead.

Parameters

NameDescriptionRequiredTypeDefault value
url the group folder (/* suffix will be added automatically) no string

Permission

Only Administrators can invoke this service.

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