/
Versioning

Versioning

Versioning in LMFS Web Services is accomplished through a number of conventions in our implementation.

  1. New parameters that are introduced will be optional parameters.  Any validation that is needed with the new parameter will return an error in the typical error code format.  (Note that these types of changes will be available in the staging lab well in advance of it being deployed to operations.)
  2. New return values in the XML response for SOAP or the JSON string for REST will be controlled via the versionRequested parameter.  The versionRequested value is in the form of a date (YYYYMMDD).  When versionRequested is supplied, it restricts the set of return values to those that were defined as of that date.  If versionRequested is not supplied, it defaults to the initial (oldest) version of the web service response.  Note that the online documentation provides information on what versionRequested maps to particular return values.
  3. New functions will be offered as new web service requests so that previously offered functionality remains available.

Related content