removeFavorite
- Home
- Bookmarks & Favorites
- SvcFavorites
- removeFavorite
removeFavorite
Adds a favorite piece of content.
Parameters
| Name | Description |
| userID required | The primary identifier of the user who is reading/adding/removing favorites. |
| contentID optional | The contentID of the content to set/remove as a favorite. |
| xrefID optional | The xref id of the content that is being referenced ~ this id is equivilent to content’s specific identifier; I.E.: video_id,photo_id,etc… |
| favoriteType optional | Type of content. For example: video, photo, blog_post. When passing in a “contentID” use “content. When passing in an “xrefID” use a particular type. Defaults to content. Use a particular type when possible. |
| output optional | The response output format. Accepts JSON and XML. |
Request Syntax
| https://services.onesite.com/rest/svcFavorites?action=removeFavorite&userID=229928503&xrefID=117102213&favoriteType=blog_post&devkey=[devkey] |
JSON Response
|
1 2 3 4 5 6 |
{ "service":"svcFavorites", "action":"removeFavorite", "code":1, "message":"Favorite Successfully removed." } |
Service Information
| Service | svcFavorites |
| Method | removeFavorite |
| Type | REST |
| Response Types | JSON, XML |