Notification

Description

An individual notification for the given user that can be of different types as described in the Notification types section below. Available only to the user recipient of the notification.

In the JSON response for a notification, the data property will vary based on the notification type.

Notification types

Notifications can be generated for many types of events—user applying to join a group, acceptance of a group application, rejection of a group application, and so on. Notifications are categorized by their notificationType. In the JSON response for a notification, the data property will vary based on the notification type.

The supported notification types along with their data property examples are listed below. More types will be added as needed, and developers should ignore types they're unfamiliar with rather than throw an error.

group_join

A notification of this type is generated when a user applies to join a group.

data property—Includes the ID and title of the group that received the application.

{
  "groupId": "cc5f73ab367544d6b954d82cc9c6dab7",
  "groupTitle": "Street Maps"
}

group_application_accepted

A notification of this type is generated when the user's application to join a group has been accepted.

data property—Includes the ID and title of the group that accepted the application.

{
  "groupId": "cc5f73ab367544d6b954d82cc9c6dab7",
  "groupTitle": "Street Maps"
}

group_application_declined

A notification of this type is generated when the user's application to join a group has been declined.

data property—Includes the ID and title of the group that declined the application.

{
  "groupId": "cc5f73ab367544d6b954d82cc9c6dab7",
  "groupTitle": "Street Maps"
}

user_invite

A notification of this type is generated when a user is invited to a group.

data property—Includes the ID and title of the group that invited the user.

{
  "groupId": "cc5f73ab367544d6b954d82cc9c6dab7",
  "groupTitle": "Street Maps"
}

user_invitation_accepted

A notification of this type is generated when the user accepts an invitation to join a group.

data property—Includes the ID and title of the group for which the invitation was accepted.

{
  "groupId": "cc5f73ab367544d6b954d82cc9c6dab7",
  "groupTitle": "Street Maps"
}

user_invitation_declined

A notification of this type is generated when the user declines an invitation to join a group.

data property—Includes the ID and title of the group for which the invitation was declined.

"groupId": "cc5f73ab367544d6b954d82cc9c6dab7",
  "groupTitle": "Street Maps"
}

Request Parameters

Parameter

Details

[Common Parameter]

For a complete listing, see Common parameters.

Response Properties

Property

Details

id

The ID of the notification.

type

The notification type. See the Notification types section above for the list of notification types.

target

The intended user of the notification.

targetType

Currently, only "user" is acceptable, but in the future, there may be other target types for notifications.

received

Date the notification was received, in UNIX time in milliseconds.

data

The data for the notification. See the Notification types section above for data properties for each notification type.

Example Usage

URL for Notification

http://www.arcgis.com/sharing/rest/community/users/jsmith/notifications/9315e22b2f99423f8d06228d04719efe

JSON Response Syntax

{
  "id": "<notification id>",
  "type": "group join | group_application_accepted | group_application_declined | user_invite | 
		user_invitation_accepted | user_invitation_declined",
  "target": "<recipient username>",
  "targetType": "user",
  "received": date received,
  "data": {
    "groupId": "<group id>",
    "groupTitle": "<group title>"
  }
}

JSON Response Example

{
  "id": "9315e22b2f99423f8d06228d04719efe",
  "type": "group_application_declined",
  "target": "jsmith",
  "targetType": "user",
  "received": 1230072232000,
  "data": {
    "groupId": "cc5f73ab367544d6b954d82cc9c6dab7",
    "groupTitle": "Street Maps"
  }
}

3/3/2017