Entity Favourite API
Jan 1 2022 at 12:00 AM
Provides functionality for storing, maintaining and retrieving a user’s favourited entities.
APIs within Entity Favourite API
EntityFavorite
API Calls
Add
Permission
Checks DAPI current username.
Accessible
All. See response and accessibility information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFavorite/Add
URL Params
None
Data Params
{
"entityId": "text"
}
- entityId: text (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessibility information for more.
Notes
None
Remove
Permission
Checks DAPI current username.
Accessible
All. See response and accessibility information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFavorite/Remove
URL Params
None
Data Params
{
"entityId": "text"
}
- entityId: text (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessibility information for more.
Notes
None
GetFavoriteEntities
Permission
Checks DAPI current username.
Accessible
All. See response and accessibility information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFavorite/GetFavoriteEntities
URL Params
None
Data Params
None
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessibility information for more.
Notes
None
ClearFavoriteEntities
Permission
Checks DAPI current username.
Accessible
All. See response and accessibility information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFavorite/ClearFavoriteEntities
URL Params
None
Data Params
None
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessibility information for more.
Notes
None