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

Triggers the validation of documents contained in a folder.

Invoking this service will start an Asynchronous process.

Only the URI with a format of "PSML" are validated.

Parameters

NameDescriptionRequiredTypeDefault value
schema The name of the schematron to use for validation  (e.g. myschema.sch) yes string
documenttype The document type of PSML documents to validate no string
extension The file extension of documents to validate no string
failuresonly Whether to only include results with failed assertions no boolean false 
include-descendants Whether to also validate documents in descendant folders no boolean false 

Permission

Undocumented permissions requirements.

Response

This service returns the following XML:

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

Error Handling

CodeCause / Description
0x1205 The URI selected is not a folder
0x1207 No URIs to validate

Created on , last edited on