Skip to main content

 Web service API

How to use PageSeeder's Web service API

validate folder

/members/{member}/groups/{group}/uris/{uri}/foldervalidate [POST]

com.pageseeder.uri.ValidateFolder

Description

Performs a validation on all documents in a folder.

Invoking this service starts an Asynchronous process.

Archived documents will not be validated.

Parameters

NameDescriptionRequiredTypeDefault value
schemaThe name of the schematron to use for validation  (e.g. myschema.sch)yesstring
documenttypeThe document type of PSML documents to validatenostring
extensionThe file extension of documents to validatenostring
failuresonlyWhether to only include results with failed assertionsnobooleanfalse 
include-descendantsWhether to also validate documents in descendant foldersnobooleanfalse 
shared
Whether report should be visible to all group members (manager only)noboolean
false

Permission

This service requires contributor or higher.

Response

This service returns the following XML:

<folder-validation>
  <thread ...> ... </thread>
</folder-validation>

Error Handling

CodeCause / Description
0x1205The URI selected is not a folder
0x1207No URIs to validate
Created on , last edited on