isFavorite
- Home
- Bookmarks & Favorites
- SvcFavorites
- isFavorite
isFavorite
Checks to see if a piece of content is favorited by the user.
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… |
| type optional | The type of content that is being referenced. |
| output optional | The response output format. Accepts JSON and XML. |
Request Syntax
| https://services.onesite.com/rest/svcFavorites?action=isFavorite&userID=229928503&xrefID=117102213&type=blog_post&devkey=[devkey] |
JSON Response
|
1 2 |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <svcFavorites><isFavorite><status><code/><message>Fatal Error: You have submitted a malformed request to the requested xml service ("isFavorite" is not a valid action of "svcFavorites").</message></status><result><total/><page/><perPage/><items><item></item></items></result></isFavorite></svcFavorites> |
Service Information
| Service | svcFavorites |
| Method | isFavorite |
| Type | REST |
| Response Types | JSON, XML |