Favourite¶
Favourite - Is Favourite¶
HTTP Request
GET /api/favourites/{type}/{id}
📋 Description: Retrieves the specified favorite item, identified by its type and ID, from the Nakisa Portfolio Management Suite, enabling users to access key portfolio, asset, and real estate property analytics efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
type |
path |
string |
true |
Type of the resource |
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
Example Responses
1true
Favourite - Add Favourite¶
HTTP Request
POST /api/favourites/{type}/{id}
📋 Description: Adds a specified item to the user’s favorites list within the Nakisa Portfolio Management Suite, allowing for quick access to key portfolio, asset, analytics, or real estate property information.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
type |
path |
string |
true |
Type of the resource |
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
None |
Favourite - Remove Favourite¶
HTTP Request
DELETE /api/favourites/{type}/{id}
📋 Description: Deletes a specified favorite item from the Nakisa Portfolio Management Suite, allowing users to manage their portfolio, asset, analytics, or real estate property preferences effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
type |
path |
string |
true |
Type of the resource |
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |