Get Notifications
Request
URI
Partners/{partnerID}/Profiles/{entityIDType}/{entityID}/Notifications
Description
Retrieves all new Notifications for a Profile. Types of Notifications include recently earned Points and Achievements. A total of recently earned points is provide as wel as the current total number of points the Profile has earned.
API Key Required
No
Method
GET
Parameters
| Name | Required | Description |
|---|---|---|
| PartnerID | Yes | The numeric identifier for the Partner Account |
| EntityIDType | Yes | The Type of EntityID Provided. (Email) |
| EntityID | Yes | The ID of the Profile of the Notifications requested. (Jason@Example.com) |
Sample Request
http://app.IActionable.com/API/Partners/99999/Profiles/email/Jason@example.com/Achievements
Response
Parameters
| Name | Description |
|---|---|
| NewAchievements | Collection of new achievements earned since last request. |
| AchievementId | The Id of the achievement earned. |
| CategoryId | The Category Id of the category the earned achievement is in. |
| Description | The achievement’s description. |
| ImageURL | The URL to the achievement’s image. |
| Name | The name of the achievement. |
| NewPoints | Collection of individual point activities. The total of these points is equal to TotalNewPoints. |
| CreateDate | The date that these points were awarded. |
| Description | The reason these points were awarded. |
| Value | The number of points awarded. |
| TotalNewPoints | The total number of new points earned since last request. |
| TotalPoints | The total points this profile has earned over their lifetime, including the new points. |
Sample Response
{
"NewAchievements": [
{
"AchievementID": 50,
"CategoryID": 99,
"Description": "Achievement Description",
"ImageURL": "http://iactionable.blob.core.windows.net/achievementimages/99999",
"Name": "Achievement Name!"
}
],
"NewPoints": [
{
"CreateDate": "/Date(1278440536766)/",
"Description": "Your photo was up voted.",
"Value": 5
}
],
"TotalNewPoints": 5,
"TotalPoints": 243
}
