Web service API

How to use PageSeeder's Web service API

report error

/error/report [POST]

com.pageseeder.system.ReportError

Description

Report an error to the adequate person.

Warning!

This class is not part of the public API, and may be subject to change without notice! It also include non-standard configuration, errors and responses and will be scheduled for revision.

This service allows system errors to be sent by email to a configurable address. The address is not necessarily the address of an existing member and can be an address for a support person.

Configuration

For this service to be functional, ensure that the errorReportAddress property is defined in the default project properties.

Parameters

NameDescriptionRequiredTypeDefault value
contentThe content to be reported, usually a stack trace and/or some system information at time of error. yesstring
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse

Permission

Permissions requirements to be updated.

Response

The XML simply acknowledges that the message was sent:

<error-report/>

Error Handling

No specific errors expected for this service.

Warning!

This service returns non-standard error messages and will be scheduled for revision.

Created on , last edited on