MediaPost Social Network

Up.notifications.get

Returns information on outstanding Community notifications for current session user.

Parameters

Type	Name	Required	Description
string	api_key	✔	The application key associated with the calling application.
string	community	✔	Community system name. Use up.community.getList method to retrieve available communities.
string	session_key	✔	The session key of the logged in user.
string	sig	✔	An MD5 hash of the current request and your secret key, as described in the authentication guide.
string	format		Desired response format. Either XML (default) or JSON.

Example return XML

<?xml version="1.0" encoding="UTF-8"?>
<notifications_get_response list="true">
    <messages>
      <unread>1</unread>
      <most_recent>1170644932</most_recent>
    </messages>
    <friend_requests list="true">
      <uid>2231342839</uid>
      <uid>2231511925</uid>
      <uid>2239284527</uid>
    </friend_requests>
    <group_invites list="true"/>
      <gid>3673282</gid>
    </group_invites>
</notifications_get_response>

Response

This method returns the same set of subelements, whether or not there are outstanding notifications in any area. Note that if the unread subelement value is 0 for any of the pokes or shares elements, the most_recent element will be 0. Otherwise, the most_recent element will contain an identifier for the most recent notification of the enclosing type.

If you are building an application that notifies users of new messages/pokes/shares, we encourage you to use the following logic when deciding whether to show a notification:

if (unread > 0 && most_recent > old_most_recent) {
  display_notification();
}
old_most_recent = most_recent;

Privacy note: The subelement lists can contain uids of users not using the calling application.

Error codes

Code	Description
1	An unknown error occurred. Please resubmit the request.
2	The service is not available at this time.
4	The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5	The request came from a remote address not allowed by this application.
101	The api key submitted is not associated with any known application.
102	The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
104	Incorrect signature.