Achievements

Get Profile Achievements

URI
Partners/{partnerID}/Profiles/{entityIDType}/{entityID}/Achievements/{filter}
Description
Retrieves all Achievements for a Profile. Response data may contain Awarded and Unwarded Achievements. Each Achievement may also contain Condition Progress data indicating how close the Profile is to earning the Achievement.
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 Achievements requested. (Jason@Example.com)
Filter No /Awarded returns only Awarded Achievements
/Unawarded returns only Unawarded Achievements
No filter provided returns both
Sample Request
http://app.IActionable.com/API/Partners/99999/Profiles/email/Jason@example.com/Achievements
Sample Response
    {
        "Awarded": [
            {
                "AchievementID": 999,
                "CategoryID": 5,
                "Description": "Post a Comment on any blog post.",
                "ImageURL": "http://iactionable.blob.core.windows.net/achievementimages/999",
                "Name": "You can talk!",
                "Progress": [
                    {
                        "ConditionMetDate": /Date(1275706032317-0600)/,
                        "CurrentValue": 1,
                        "Description": "Make 1 Comment",
                        "RequiredValue": "1"
                    }
                ],
                "AwardDate": "/Date(1275706032317-0600)/",
                "CustomData": ""
            }
        ],
        "Unawarded": [
            {
                "AchievementID": 99999,
                "CategoryID": 5,
                "Description": "Post 35 Photos and make 50 Comments",
                "ImageURL": "http://iactionable.blob.core.windows.net/achievementimages/99999",
                "Name": "Super User Badge",
                "Progress": [
                    {
                        "ConditionMetDate": null,
                        "CurrentValue": 12,
                        "Description": "Post 35 Photos",
                        "RequiredValue": "35"
                    },
                    {
                        "ConditionMetDate": null,
                        "CurrentValue": 6,
                        "Description": "Make 50 Comments",
                        "RequiredValue": "50"
                    }
                ]
            }
        ]
    }

Get Partner Achievements

URI
Partners/{partnerID}/Achievements
Description
Retrieves all active Achievements for a Partner Account.
API Key Required
No
Method
GET
Parameters
Name Required Description
PartnerID Yes The numeric identifier for the Partner Account
Sample Request
http://app.IActionable.com/API/Partners/99999/Achievements
Sample Response
    [
        {
            "AchievementID": 333,
            "CategoryID": 10,
            "Description": "Leave 25 comments.",
            "ImageURL": "http://iactionable.blob.core.windows.net/achievementimages/333",
            "Name": "Opinionated Level 3"
        },
        {
            "AchievementID": 444,
            "CategoryID": 10,
            "Description": "Make 10 comments.",
            "ImageURL": "http://iactionable.blob.core.windows.net/achievementimages/444",
            "Name": "Opinionated Level 2"
        }
    ]

Award Achievement

URI
Partners/{partnerID}/Profiles/{entityIDType}/{entityID}/Achievements/{achievementID}?customData={customData}
Description
Awards a specific Achievement to a Profile. An Achievement’s ID can be found under the Achievement Detail in the IActionable system. Custom Data can be assigned with the badge cusing the CustomData attribute.
API Key Required
Yes (Authentication Documentation)
Method
POST
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 Achievements requested. (Jason@Example.com)
Achievement ID Yes The ID of the Achievement to award. (55)
CustomData No Custom MetaData associated with an Achievement. (CouponCode:AB1235)
Sample Request
http://app.IActionable.com/API/Partners/99999/Profiles/email/Jason@example.com/Achievements/55?customData=CouponCodeABC
Sample Response
    {
        "AchievementID": 999,
        "CategoryID": 5,
        "Description": "Click a button, get a Coupon!",
        "ImageURL": "http://iactionable.blob.core.windows.net/achievementimages/999",
        "Name": "Button Clicker",
        "Progress": null,
        "AwardDate": "/Date(1275706032317-0600)/",
        "CustomData": "CouponCodeABC"
    }