notification.group.find

TR50 Request


                        {
    "cmd": {
        "command": "notification.group.find",
        "params": {
            "key": "notificationgroup1"
        }
    }
}

Request Parameters


Name	Type	Required	Description
key	String	Yes	The key of the group.

TR50 Response

If the command is sent successfully a success message and the notification group object is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true,
    "params": {
      "id": "500000000000000000000001",
      "key": "notificationgroup1",
      "name": "Group One",
      "desc": "Group One description.",
      "public": true,
      "count": 0,
      "createdBy": "admin@example.com",
      "createdOn": "2014-05-06T18:09:11.019-04:00",
      "updatedBy": "admin@example.com",
      "updatedOn": "2014-05-06T18:09:11.019-04:00",
      "members": [
        {
          "id": "533efe00c2da00746800100c",
          "emailAddress": "user@example.com",
          "firstName": "John",
          "lastName": "Doe",
          "mobilePhone": "800-987-6543"
        }
      ]
    }
  }
}

Response Parameters


Name	Type	Description
id	String	The object Id of the notification group.
key	String	The key.
name	String	The name.
desc	String	The description.
public	Boolean	If the notification group is public or private.
count	Integer	The number of members of the notification group.
createdBy	String	The email address of the user who created this notification group.
createdOn	String	The date and time that the group was created.
updatedBy	String	The email address of the user who last updated this group.
updatedOn	String	The date and time that the group was updated.
members	Array	An array of member objects. The member object is a subset of the fields returned when performing a user.find.

Member Object


Name	Type	Description
id	String	The object id of the user.
emailAddress	String	The email address of the user.
firstName	String	The first name of the user.
lastName	String	The last name of the user.
mobilePhone	String	The mobile phone number of the user.