Octopus allows users to set up Territories and assign them to Address Book entries (Company and Individual). This can be done manually or automatically (using territory rules).

This feature is accessible only to users with the Sales Manager role. Once Territories are assigned, all users can leverage the Territory and Territory Status fields for tasks like searching, reporting, and customizing views.

Metadata

Read Territory metadata (simple)

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

Read Territory 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,
                "Nullable": 1,
                "Assignable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "HasOption": 1,
                "DisplayValue": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/Territory"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

FieldOptions

Read Territory FieldOptions - AccountManager

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Territory": {
        "FieldOptions": {
            "AccountManager": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    }
}

Territory CRUD

Create - Territory

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "Territory": {
        "Data": {
            "Key": null, // Will be generated automatically
            "Name": "Territory Name", // Mandatory
            "AccountManager": [ // Check FieldOptions for possible values
                "VXNlcglCSE9MTFk="
            ],
            "Active": true,
            "SortOrder": 3
        }
    },
    // Required as it is only supported by SQL driver
    "Configuration": {
        "Drivers": {
            "ITerritoryAccess": "Maximizer.Model.Access.Sql.TerritoryAccess"
        }
    }
}

Read - Territory

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Territory": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Name": 1,
                "AccountManager": 1,
                "Active": 1,
                "SortOrder": 1
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    },
    // Required as it is only supported by SQL driver
    "Configuration": {
        "Drivers": {
            "ITerritorySearcher": "Maximizer.Model.Access.Sql.TerritorySearcher"
        }
    }
}

Update - Territory

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "Territory": {
        "Data": {
            "Key": "VGVycml0b3J5CTM0OTIzNjU3Mg==", // Mandatory
            "Name": "Territory Name Updated",
            "Active": false,
            "SortOrder": 4
        }
    },
    // Required as it is only supported by SQL driver
    "Configuration": {
        "Drivers": {
            "ITerritoryAccess": "Maximizer.Model.Access.Sql.TerritoryAccess"
        }
    }
}

Delete - Territory

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "Territory": {
        "Data": {
            "Key": "VGVycml0b3J5CTM0OTIzNjU3Mg==" // Mandatory
        }
    },
    // Required as it is only supported by SQL driver
    "Configuration": {
        "Drivers": {
            "ITerritoryAccess": "Maximizer.Model.Access.Sql.TerritoryAccess"
        }
    }
}