FavoriteList allows users to manage favorites list which are specific groups of different entities. See below some considerations for FavoriteList:

The field Entity Type defines the type of entities contained in the favorite list. A favorite list can have only one single type of entity, accepted ones are:
- AbEntry = 1\
- Opportunity = 2\
- Case = 5\
- Lead = 19\
MemberKeys field is an array of keys depending on the entity type selected. For example, if EntityType = 1 then all MemberKeys will be AbEntry Keys.

MetaData

Read FavoriteList metadata (simple)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": 1
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/FavoriteList"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read FavoriteList metadata (more)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Alias": 1,
                "Type": 1,
                "Name": 1,
                "AppliesTo": 1,
                "Sortable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "HasOption": 1,
                "DisplayValue": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/FavoriteList"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

FavoriteList CRUD

Create - FavoriteList

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "FavoriteList": {
        "Data": {
            "Key": null,
            "Name": "Favorite List 1",
            "Description": "This is the Favorite List 1 containing elements of type EntityType",
            // Type of entities included in the favorite list
            // AbEntry = 1
            // Opportunity = 2
            // Case = 5
            // Lead = 19
            "EntityType": 1,
            // Entity Keys based on EntityType defined.
            // Example, If EntityType = 1 then all MemberKeys should be AbEntry Keys
            "MemberKeys": [
                "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTI=",
                "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTM=",
                "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTQ="
            ]
        }
    },
    // Required for full support of above mentioned entity types
    "Configuration": {
        "Drivers": {
            "IFavoriteListAccess": "Maximizer.Model.Access.Sql.FavoriteListAccess"
        }
    }
}

Read - FavoriteList

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "FavoriteList": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Name": 1,
                "Description": 1,
                // Type of entities included in the favorite list
                // AbEntry = 1
                // Opportunity = 2
                // Case = 5
                // Lead = 19
                "EntityType": 1,
                // Entity Keys based on EntityType defined.
                // Example, If EntityType = 1 then all MemberKeys will be AbEntry Keys
                "MemberKeys": [
                    1
                ]
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    },
    // Required for full support of above mentioned entity types
    "Configuration": {
        "Drivers": {
            "IFavoriteListSearcher": "Maximizer.Model.Access.Sql.FavoriteListSearcher"
        }
    }
}

Update - FavoriteList

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
//
{
    "FavoriteList": {
        "Data": {
            "Key": "RmF2b3JpdGVMaXN0CTIwMjkwNTAxOQ==", // Mandatory
            "Name": "New name for Favorite list",
            "Description": "FavoriteList Description Update2 Lead212"
        }
    },
    "Configuration": {
        "Drivers": {
            "IFavoriteListAccess": "Maximizer.Model.Access.Sql.FavoriteListAccess"
        }
    }
}

Delete - FavoriteList

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "FavoriteList": {
        "Data": {
            "Key": "RmF2b3JpdGVMaXN0CTMJMg==" // Mandatory
        }
    },
    "Configuration": {
        "Drivers": {
            "IFavoriteListAccess": "Maximizer.Model.Access.Sql.FavoriteListAccess"
        }
    }
}