Sonde Health API Platform Documentation

API upgrades

Backwards-compatible changes

Sonde considers the following changes to be backwards-compatible:

  • Adding new API resources

  • Adding new optional request parameters to existing API methods

  • Adding new properties to existing API responses

  • Changing the order of properties in existing API responses

  • Changing the length or format of opaque strings, such as resource IDs, error messages, and other human-readable strings.
    This includes adding or removing fixed prefixes (such as msr_ on measure ID).
    You can safely assume resource IDs we generate will never exceed 40 characters, but you should be able to handle IDs of up to that length. If for example you’re using MySQL, you should store IDs in a VARCHAR(40) COLLATE utf8_bin column (the COLLATE configuration ensures case-sensitivity in lookups).

Sonde Health