Notification

Notification provides access to system notifications.

Notification Properties

Property	Example	Description
id	"62F62D..."	The unique id for the notification record
fk_user	"C2355B..."	The foreign key to the user the notification is for (Mandatory)
createdDate	"2020-07-15T13:01:39"	The date the notification was created
type	"fileupdate"	The type of notification
read	true	Indicates if the message has been read or not
detail	{object}	An object containing the notification detail.
notification_user	{related entity}	The related user record detail

Notification Methods

GET	/api/notification

Returns all price records for the current scope with all published fields.

POST	*/api/notification

Allows for the update or creation of notification records (if allowed).

Example

Example of a returned notification entity with all fields

{
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 1,
        "recordsFound": 1,
        "notification": [
            {
                "id": "62F62D30FB8DF34488723C3A9F7C0C20",
                "fk_user": "C2355B803935B746B34AA48CB91E327D",
                "createdDate": "2020-07-15T13:01:39",
                "type": "fileupdate",
                "read": true,
                "detail": {
                    "fk_target": "7F2EE4A8A4A7704F8F823F37343E08E4",
                    "title": "File Processed",
                    "message": "Product file product_template.xlsx successfully processed."
                },
                "notification_user": {
                    "id": "C2355B803935B746B34AA48CB91E327D",
                    "name": "Dougie",
                    "email": "jdcryer@ilevelsoftware.co.uk",
                    "type": "system",
                    "detail": {
                        "lang": "en",
                        "companies": [
                            "7AE1E6E5FAE546499B36C013916DDEEC"
                        ]
                    },
                    "fk_sponsor": "00000000000000000000000000000000",
                    "fk_host": "00000000000000000000000000000000",
                    "fk_company": "7AE1E6E5FAE546499B36C013916DDEEC",
                    "fk_warehouse": "00000000000000000000000000000000"
                }
            }
        ]
    }
}