Octopus API (Maximizer.Web.Data) uses a major and minor version number to identify each version of the API. Whenever a new version of the API is released, typically along with a new release of the main Maximizer application, the minor and/or major version numbers are incremented.
Major Version
A major version increment indicates a major change to API functionality, for example, changes to existing methods' names or request and response formats.
Backwards compatibility between major versions of the API is not guaranteed. Applications developed against a previous version of the API may not work correctly when run against a new version of the API following a major version increment.
Minor Version
A minor version increment indicates that functionality has been added to the API. The API version in which any new functionality, including methods, entities, or field types that have been added will be identified in the documentation.
Minor version increments are intended to maintain backwards compatibility with previous versions of the API, so applications developed against a previous version of the API will continue to work when run against a new version of the API following a minor version increment.
Querying API Version Information
If your application is intended to work with multiple versions of Maximizer CRM, you should check the major and minor version numbers for the API prior to making any subsequent calls to the API. You can retrieve version information for the current Maximizer CRM system by calling the GetSystemInfo method.
Beta Functionality
When new entities and methods are added to Octopus API, they are typically released in an extended "beta" or testing state. The purpose of this is to allow you to see and try out the new functionality before the final production version is released.
Although these entities and methods may be included in the Octopus API that is installed with Maximizer CRM, they should not be used in production applications, as they may not have undergone extensive testing, and their interfaces may be subject to change without warning.
In order to help you determine which methods are still in "beta" release, you can consult the "Msg" property of method responses.