Report group error
/groups/{group}/error/report [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.8008 | 6.3004 | json, xml |
Description
Reports an error to the appropriate person when they occur within the context of a group.
This service allows 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.
To report errors which occur outside a group use the Service: /error/report [POST] instead.
Configuration
For this service to be functional, ensure that the errorReportAddress property is defined in the Group Properties for the specified group.
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 are sent asynchronously (for slow email servers) | no | boolean | false |
Permission
The user must be authenticated.
Response
The XML acknowledges that the message was sent:
<error-report report-sent="true" />
Or in JSON:
{
"reportSent":"true"
}Error Handling
| Code | Cause / Description |
|---|---|
| 0x010E | This feature is not enabled on this server |
| 0x0604 | Required service is unavailable |
| 0x0606 | Required configuration property is missing or invalid |