Notification

Description

This endpoint allows you to get or update a specific notification.

URI

GET returns the notification identified by {id} for the user identified by {guid}.

http://social.yahooapis.com/v1/notification/{id}

PUT updates the elements of the Notification Object that are specified by the fields. The following fields can be updated: choice, new, and state. If only choice is specified, new is set to false and state is set to COMPLETED. When state and choice are updated, state can only be given the value COMPLETED. The values for the specified fields should be in the request body. The returned response will contain the updated Notification Object with the variable substituted URL template.

http://social.yahooapis.com/v1/notification/{id};fields={field_to_update}

Filters

None available.

HTTP Operations Supported

GET
PUT

Query Parameters Supported

format

Matrix Parameters Supported

None available.

Scopes Required

GET: Read/Write Yahoo! Updates
POST: Read/Write Yahoo! Updates

JSON Syntax for the Notification Object

{
  "notification": 
  {
    "id": "string",     // Notification ID
    "appid" : "string", // App ID for which the 
                         // notification belongs to  
    "state": "string", 
    "created": "string", // Timestamp in seconds
                         // RFC 3339 date format;   
    "updated": "string", // Timestamp in seconds 
                         // RFC 3339 date format; 
    "recipient": "string", // GUID of target/receiver user
    "sender": "string",    // GUID of sender
    "appname": "string",   // Commercial name of app
    "favicon": "string",   // Favicon url
    "appurl": "string",  // URL of app
    "new" : boolean,     // Indicates whether user has
                         // seen the notification.
                         // new=false (notification was seen)
    "title": "string",      // Title shown to user
    "type": "string",  // Denotes the notification type.                                                                                            // The only allowed value is
    "nfsimple".
    "appmsg": "string",   // App defined message (required)
    "category": "string", // Category specific to
                          // the app that can be used
                          // for filtering
    "usrmsg": "string",   // User-defined message (optional)
    "image": 
    {
      "size": "string",  // In the format "WxH"
      "width": number,
      "height": number,
      "imageUrl": "string" // URL to image
    },
    "sendmsg": boolean,   // Deliver message via email to receiver
    "expiry": "string",   // Time in seconds, RFC 3339 date format
    "choice": "string",   // Selected choice. The value
                          // of the "id" element
                          // in the Choice Objects.
                          // Empty when the state is pending.
    "choices": 
    [
      {
        "label": "string", 
        "urltemplate": "string"  // URL to template
      }, 
      {
        "label":"string", 
        "urltemplate": "string"
      },
      {
        "label":"string", 
        "urltemplate" : "string"
      } 
    ]  
    "uri": "string" // URI of this notification object         }
}

XML Syntax for Notification Object

Example JSON Response Body for GET Notification

{
  "notification":
  {
    "uri":"/v1/notification/du4bis221ab8f5k8kg90o01lcjjv8",
    "id":"du4bis221ab8f5k8kg90o01lcjjv8",
    "new":true,
    "state":"PENDING",
    "created":"2010-10-25T19:57:12Z",
    "updated":"2010-10-25T19:57:12Z",
    "recipient":"UQIDWJNWVNQD4GXZ5NGMZUSTQ4",
    "sender":"UQIDWJNWVNQD4GXZ5NGMZUSTQ4",
    "appid":"-yossd3e",
    "appname":"Application Name",
    "favicon":"http://www.rw-designer.com/icon-view/3089.png",
    "appurl":"http://www.facebook.com/path_to_source_page",
    "title":"Farmville",
    "type":"nfsimple",
    "appmsg":"Have fun!",
    "category":"novice",
    "usrmsg":"I dare you to play! You won&#39;t stay alive long, haha.",
    "image":
    {
      "size":"48x48",
      "width":48,
      "height":48,
      "imageUrl":"http://ext.yimg.com/ec?url=http%3a%2f%2fzhouyaoji.com%2fimages%2fbird.jpg&t=1288036632&ttl=604800&sig=ECcBjz4KvKOSRPiDLX1y.g--~B"
    },
    "expiry":"2011-10-25T19:41:52Z",
    "choices":
    [
      {
        "label":"Accept",
"urltemplate":"http://apps.yahoo.com/farmville?choice={choice}&id={id}&sender_guid={sender_guid}?action=accept"
      },
      {
        "label":"Deny",
        "urltemplate":"http://apps.yahoo.com/farmville?choice={choice}&id={id}&sender_guid={sender_guid}?action=deny"
      }
    ],
    "sendmsg":true
  }
}

Example XML Response Body for GET Notifications

<notification xmlns="http://social.yahooapis.com/v1/schema.rng" xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" yahoo:uri="/v1/notification/du4bis221ab8f5k8kg90o01lcjjv8">
  <id>du4bis221ab8f5k8kg90o01lcjjv8</id>
  <new>true</new>
  <state>PENDING</state>
  <created>2010-10-25T19:57:12Z</created>
  <updated>2010-10-25T19:57:12Z</updated>
  <recipient>UQIDWJNWVNQD4GXZ5NGMZUSTZZ</recipient>
  <sender>UQIDWJNWVNQD4GXZ5NGMZUSTZZ</sender>
  <appid>-yossd3e</appid>
  <appname>Car Shop</appname>
  <favicon>http://www.rw-designer.com/icon-view/3089.png</favicon>
  <appurl>http://www.facebook.com/car_shop/</appurl>
  <title>Car Shop</title>
  <type>nfsimple</type>
  <appmsg>Have fun!</appmsg>
  <category>novice</category>
  <usrmsg>Fix your car and earn points to buy a new one.</usrmsg>
  <image>
    <size>48x48</size>
    <width>48</width>
    <height>48</height>
    <imageUrl>http://ext.yimg.com/ec?url=http%3a%2f%2fzhouyaoji.com%2fimages%2fbird.jpg&amp;t=1288036632&amp;ttl=604800&amp;sig=ECcBjz4KvKOSRPiDLX1y.g--~B</imageUrl>
  </image>
  <expiry>2011-10-25T19:41:52Z</expiry>
  <choices>
    <label>Accept</label>
    <urltemplate>http://apps.yahoo.com/farmville?choice={choice}&amp;id={id}&amp;sender_guid={sender_guid}?action=accept</urltemplate>
  </choices>
  <choices>
    <label>Deny</label>
    <urltemplate>http://apps.yahoo.com/farmville?choice={choice}&amp;id={id}&amp;sender_guid={sender_guid}?action=deny</urltemplate>
  </choices>
  <sendmsg>true</sendmsg>
</notification>

Example JSON Request Body for PUT Notification

PUT /v1/notification/{id};fields=choice?format=json

PUT /v1/notification/{id};fields=new?format=json

PUT /v1/notification/{id};fields=state?format=json

Example XML Request Body for PUT Notification

PUT /v1/notification/{id};fields=choice

PUT /v1/notification/{id};fields=new

PUT /v1/notification/{id};fields=state

Yahoo! Developer Network