Favourites API

Get Favourites List

OVERVIEW

Method to obtain favourite items.

This method is supported in version 4 of the API and above

Request URI

GET         /api/4/favourites?contenttype=files

 

Parameter Name Value Description
contenttype String


/api/3/favourites?contenttype=files

  • Microblogs
  • Files
  • Wiki
  • Blog
  • Tasks
  • Events
  • Site
  • iSheet
  • Folder
  • SiteHome
  • sitetemplate
offset int The integer value of the last Favorite item fetched. 
limit int

No of Favorite items to return in one request. Default is 20  and the maximum value is 100

If a value of 0 or less is provided in the request then 20 Favorite items will be returned.

If a value of more than 100 is provided then 100 Favorite items are returned. 

 

Response

The response will contain a collection of Favorite items

<favouritecontents>

A Favorite Item object  list

<favouritecontents>


Response codes

 

CODE MEANING
    201    Favorite items returned successfully
    400    Problem with parameters
    401     Unauthorized
    403    Validation failed | Forbidden
    500    Internal error occurred while returning Favorite items

In case of an error code other than 201, an error object will be returned in the format 

Error Response

<error>
     <ref>{integer reference id, generated on the server side} </ref>
     <summary>{Description for the error message}</summary>
</error>

 

 

Comments


0 Comments

Last Updated: Nov 08,2024