About Versions for API Methods
Article posted on June 1st, 2009
Article posted on June 1st, 2009
Future changes to the Switchvox software will include changes and additions to the Extend API. To minimize the impact those changes could have on your integrated applications, we have added a version number to each API method. If a Switchvox software update includes significant changes to an API method, such as new required parameters or different attribute names, we will make those changes available in a new version of the method. That way, if your methods indicate a version number then you can feel free to update your Switchvox software, secure in the knowledge that your apps will continue to function normally until you have a chance to update your code to the new version of the API.
We’ve assigned a first version number to each method: 17487. Although this is the only version right now, we encourage you to include it in your API requests. To indicate the version, use the ‘version’ attribute of the request tag (just like you do with the method itself). Here’s an example:
100 200
(We will be updating the information and code across Developer Central to reflect this change to the request tag.)
- If you do not indicate a version number, the latest version available is used.
- If you indicate a version number that does not match a version number for that method, the closest earlier version is used. This lets you use one version number across all of your requests.
- If we make a minor change to an API method, such as adding a new optional parameter, we will include those changes in the existing version of the method. That means that minor changes will be automatically included when you update your Switchvox software. As much as possible, we will try to create a new version of a method if our changes will mean that you have to change your code.