Notification Topics
To receive notifications you must subscribe to one or more of the following topics.
Topics are hierarchical, e.g. a subscription for the ASSESSMENT.MAIL topic will receive both ASSESSMENT.MAIL.RECEIVED and ASSESSMENT.MAIL.SENT notifications.
Assessment Export
ASSESSMENT.EXPORT.CREATED
Raised when an assessment is exported in AEG. The resources collection contains a list of export formats and the resource ID for each.
Parameters
| Name | Description |
|---|---|
| assessmentid | ID (Guid) of the exported assessment. |
Note: The exportAxFormat endpoint does not raise this notification.
Assessment Images
ASSESSMENT.IMAGE.CREATED
Raised when an image is added to an assessment. The image resource is the ID (Guid) of the new image.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of theassessment to which the image was added. |
ASSESSMENT.IMAGE.DELETED
Raised when an image is removed from an assessment. The image resource is the ID (Guid) of the image that was removed.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the assessment from which the image was removed. |
Assessment Mail
ASSESSMENT.MAIL.RECEIVED
Raised when an assessment mail is received.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the associated assessment. |
| sender | ID of the terminal from which the mail was sent. |
| recipient | ID of the terminal to which the mail was sent. |
ASSESSMENT.MAIL.SENT
Raised when an assessment mail is sent.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the associated assessment. |
| recipient | ID of the terminal to which the mail was sent. |
Assessment Status
ASSESSMENT.STATUS.ASSIGNED
Raised when an assessment is assigned to another user. The userid resource is the ID (Guid) of the user to which the assessment was assigned.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the assessment that was reassigned. |
ASSESSMENT.STATUS.AUTHORISED
Raised when an authorization notice is received.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the assessment that was authorized. |
ASSESSMENT.STATUS.COMPLETED
Raised when an assessment is marked as completed.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the assessment that was completed. |
ASSESSMENT.STATUS.CREATED
Raised when a new assessment shell has been created.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the new assessment. |
Note: As this notification is raised when the shell has first be created, the assessment will contain no information other than the originator, work provider and assessment number.
Note: The importAxFormat endpoint does not raise this notification.
ASSESSMENT.STATUS.RECEIVED
Raised when an assessment is received from another terminal.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the assessment that was sent. |
| sender | ID of the terminal from which the assessment was sent. |
ASSESSMENT.STATUS.SENT
Raised when an assessment is sent to another terminal.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the assessment that was sent. |
| recipient | ID of the terminal to which the assessment was sent. |
ASSESSMENT.STATUS.UPDATED
Raised when an assessment document has been updated.
Parameters
| Name | Description |
|---|---|
| assessmentId | ID (Guid) of the assessment that has been updated. |
Note: The ASSESSMENT.STATUS.UPDATED notification is not raised when images are created or deleted, when mail is received or sent, or when the assessment is reassigned, authorised or marked as complete.