report error
com.pageseeder.system.ReportError
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.8008 | 5.7900 | json, xml |
Description
Report an error to the adequate person.
This class is not part of the public API, and might be subject to change without notice! It also include non-standard configuration, errors and responses and is 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
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| content | The content to be reported, usually a stack trace and/or some system information at time of error | yes | string | |
| notify-async | Whether emails should be sent asynchronously (for slow email servers) | no | boolean | false |
Permission
No permissions required.
Response
The XML acknowledges that the message was sent:
<error-report/>
Error Handling
No specific errors expected for this service.
This service returns non-standard error messages and is scheduled for revision.