Breaking Change in v4.12
Friday, July 13, 2018
On July 18th we will be updating our main services to version 4.12. The update will also be done automatically in the Fleet Freedom portal, so unless you have a custom written program using Fleet Freedom services, no action is required.
Included in the update is a possible breaking change to the Asset and AssetGeneral obj ects. This change is also included for Person, Vehicle, and Trailer assets. We are depreciating the property reference, and adding a new property references. The references property will act as a dictionary for multiple reference fields.
The reason for this change is a request from multiple parties looking to link multiple external systems with Fleet Freedom.
Here is our plan to help you update your integration code, and maintain backwards compatibility:
- All existing asset reference values will be added to the references dictionary under the key "Reference". You can access it like this; asset.references["
Reference"]. - The asset.reference property will remain for the next two releases (until v4.14) when it will be removed.
- The asset.reference property
will act as a getter for the asset.references[" Reference"] value. If there is no value in the dictionary, the asset.reference value will be an empty string, not null. - The getAssetsListByReference
method will continue to work as expected searching asset.references[" Reference"] values. - A new method getAssetsListByReferenc
es has been created to help search assets with specific reference key/value pairs. - The mergeAsset method will accept a dictionary for references, however, if nothing is provided, it will also accept a string reference and modify the asset.references["
Reference"] value.