defaultheader

GET notification

Get data of one notification object.

Parameters

Parameters Detail
with
optional
Returns sub-object or count of sub-objects relating to the notification. If sub-object is requested, response will return the first 20 records
Accepted value: "member"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for GET notification

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/notification

Access Permission

Requester must be an Admin. See Authentication for details on authentication.

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/notification/3DA28600-9BA5-4750-A8EE-0D2D16F3D5ED

    {
    "notification": {
        "id": "3DA28600-9BA5-4750-A8EE-0D2D16F3D5ED",
        "tweet": "Hey there @John Doe",
        "action_type": 18,
        "url": "/ct/ct_view_post.bix?c=1F93FD4F-F06D-456A-AFE9-825CE9B591F2&t_id=F065DB08-1980-4334-BC3A-ECA770D39238",
        "profile": "/CT/getfile.php?a=OD3006&f=8585BB07-837B-48E0-9D82-FC5BB49B2BBF&thumb=100&thumb=50",
        "screen_name": [
            "David"
        ],
        "date": "3 weeks ago",
        "date_due": "",
        "timestamp": 1387482233,
        "status_class": "notifcation-item-unread",
        "read": false
    }
    }
    




LIST notification

Get data on a list of notification objects. Objects are order by started date descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters Detail
id
optional
Filter return by notification ID
Sample value: "45564"
date_started
optional
Filter return by notification started date. Response contains all notifications started within the 24 hours of the specified date
Sample value: "12/06/2009"
date_completed
optional
Filter return by completed date. Response contains all notifications completed within the 24 hours of the specified date
Sample value: "12/06/2009"
campaign_id
optional
Filter return by ID of campaign
Sample value: "11111111-1111-1111-1111-111111111111"
member_id
optional
Filter return by ID of member
Sample value: "11111111-1111-1111-1111-111111111111"
notification_type
optional
Filter return by notification type
Sample value: "ideacommentdetails"
page_size
optional
Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100
Sample value: 50
page
optional
Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count}
Sample value: 5
order
optional
A SQL style string that specifies the order the records should return in
Sample value: "date_started ASC, notification_type DESC"
Accepted attributes: "id", "notification_code", "title", "date_created", "date_modified", "visible", "anonymous", score"
with
optional
Returns sub-object or count of sub-objects relating to the member. If sub-object is requested, response will return the first 20 records
Accepted value: "member"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST notification

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/notification

Access Permission

Requester must be an Admin. See Authentication for detail on authentication.

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/notification?page=3&page_size=2

    {
        "notification_list": [
            {
                "id": "3DA28600-9BA5-4750-A8EE-0D2D16F3D5ED",
                "tweet": "Hey there @John Doe",
                "action_type": 18,
                "url": "/ct/ct_view_post.bix?c=1F93FD4F-F06D-456A-AFE9-825CE9B591F2&t_id=F065DB08-1980-4334-BC3A-ECA770D39238",
                "profile": "/CT/getfile.php?a=OD3006&f=8585BB07-837B-48E0-9D82-FC5BB49B2BBF&thumb=100&thumb=50",
                "screen_name": [
                    "David"
                ],
                "date": "3 weeks ago",
                "date_due": "",
                "timestamp": 1387482233,
                "status_class": "notifcation-item-unread",
                "read": false
            },
            {
                "id": "245DEED6-F4CF-480B-BF7B-FE5352DA9ABE",
                "name": "Great Webstorm",
                "date_due": "Nov 29 2013",
                "batch": "test batch - ROUND 1",
                "action_type": 8,
                "url": "/sc/6E598BF8",
                "date": "Nov 21 2013",
                "timestamp": 1385052456,
                "status_class": "notifcation-item-unread",
                "read": false,
                "screen_name": [
                    "Smith"
                ]
            }
        ],
        "stats": {
            "total": "18",
            "page_count": 9,
            "current_page": 3
        }
    }
    




DELETE notification

Delete a notification object.

Requester can delete his own submitted notification.

Parameters

Parameters Detail
id
required
This is the ID of the notification
Sample value: "1695"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

  • Authentication: Required. See Authentication for detail on authentication.
  • HTTP Methods: DELETE
  • Request URL Format: https://{api_domain}/api3/notification/{id}

Access Permission

Requester can delete thier own notification.

Errors

  • Invalid ID received

Example Request

  • Method: DELETE
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/notification/3DA28600-9BA5-4750-A8EE-0D2D16F3D5ED

    {
        "message": "success",
        "code": 200
    }