Get List of Notification Sent to Mobile API

Require Authentication

This API is used to get list of notifications and alerts sent to mobile for user based on combination of deviceID and token.

URL

api/notifications/listmobile

Required parameter (POST)

deviceID
token

Optional parameter (GET)

All optional parameters use GET method. So it should be embedded in the URL, e.g: api/notifications/listmobile?a=Y&o=createdDate

a «used to filter notification based on acknowledge field. Available value: Y, N»
e «used to filter notification based on emergency field (or immediate flag). Available value: Y, N»
r «used to filter notification based on isRead field. Available value: Y, N»
t «used to filter notification based on notificationType field. Available value: notification, alert»
c «used to filter companyID to override current session companyID and userID. Used for user with multiple account login»
o «used to sort data, contains field name. Available value: isRead, createdDate. Default value: createdDate»
ot «used to sort data, contains sort type. Available value: asc, desc. Default value: desc»
per_page «indicates how many data that will be displayed in each call. Value must be a number between 1 to 500. Default value: none (unlimited result)»
offset «indicates the first data index that will be displayed in each call. Value must be a number with minimum value is 0. Default value: 0»

Example JSON Payload

{
	"deviceID": "ABCD-EFGH-IJKL-MNOP",
	"token": "bb602ab13b8090268cd6e3bb9dfa39e2"
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "current_parameter": "?offset=0",
    "next_parameter": "?offset=0",
    "previous_parameter": "?offset=0",
    "start": 0,
    "total": 3,
    "lists": [{
      "notificationrecipientsendingID": 44,
      "content": "You received SmartSensor notification based on your configuration. [1 bin]",
      "isRead": "N",
      "readDate": 0,
      "acknowledge": "N",
      "createdDate": 1465934171,
      "notificationconfigID": 4,
      "notificationName": "no emergency",
      "notificationType": "notification",
      "emergency": "N",
      "alertSensorTriggerSecond": 0
    }, {
      "notificationrecipientsendingID": 34,
      "content": "[test pin type API aedit] You received SmartSensor notification based on your configuration.",
      "isRead": "Y",
      "readDate": 1467229931,
      "acknowledge": "Y",
      "createdDate": 1465770815,
      "notificationconfigID": 3,
      "notificationName": "test",
      "notificationType": "notification",
      "emergency": "Y",
      "alertSensorTriggerSecond": 0
    }, {
      "notificationrecipientsendingID": 30,
      "content": "[test pin type API aedit] You received SmartSensor alert based on your configuration.",
      "isRead": "Y",
      "readDate": 1465940773,
      "acknowledge": "Y",
      "createdDate": 1465770765,
      "notificationconfigID": 3,
      "notificationName": "test",
      "notificationType": "alert",
      "emergency": "N",
      "alertSensorTriggerSecond": 3600
    }]
  }
}

Note:
If notificationType = 'notification', you can ignore alertSensorTriggerSecond field.
If notificationType = 'alert', you can ignore emergency field (or immediate flag). alertSensorTriggerSecond contains threshold of last sensor data reading in seconds.

Note: use "next_parameter" and "previous_parameter" to go to next or previous result page. Just combine it with the API URL, e.g: "api/notifications/listmobile"+next_parameter or "api/notifications/listmobile"+previous_parameter

Superfy Platform API Documentation