Versions Compared

Old Version 4

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version 5

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Evolution

ServicePower, like most modern software development organizations, has adopted an agile methodology where we deliver incremental functionality over shorter time periods. As it is impossible to guess all future client needs and market directions, this agile approach allows us to more rapidly meet our clients needs in a more timely fashion. This rapid release cycle means that as our ServiceMobility product evolves so too will our REST APIs.

ServiceMobility REST APIs are updated in an additive manner which means that:

  • New APIs will be added; and
  • New fields are added to existing APIs.

Wherever possible, changes to existing APIs will ensure that new fields added will be optional, so as not to break existing customer integration efforts.

However, if a major breaking change is required to a REST API, then a new implementation with a new version number will be added to the system. The old version of the interface will remain, for a specified period of time, in order to maintain backward compatibility.

 



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents


ServiceMobility Release API Information

Throughout the API documentation, there are two locations where ServiceMobility release version numbers are listed: 


  1. At the top of every REST API page is a single ServiceMobility release version number in green, for example: 
    Status
    colourGreen
    title3.0.0
    1. This number indicates the ServiceMobility release in which the API was introduced.
    2. So, for example, the 
      Status
      colourGreen
      title3.0.0
       version number listed on the top of the REST Standard REST APIs Account Locations REST API page indicates that this API was introduced in version 3.0.0 of ServiceMobility.
    3. Users of ServiceMobility running a version prior to the indicated introduced version on an API will need to upgrade to at least the listed version to be able to use the API in any integration with ServiceMobility.
  2. At the top of some REST API pages are one or more ServiceMobility release version numbers in yellow, for example: 
    Status
    colourYellow
    title3.18.0
    1. These numbers indicates the ServiceMobility releases in which the API was changed.
    2. So, for example, the 
      Status
      colourYellow
      title3.18.0
       version number listed on the top of the REST Standard REST APIs Inventory REST API page indicates that this API was changed in version 3.18.0 of ServiceMobility.
    3. Users of ServiceMobility upgrading to a new version where they integrate with APIs that have changed will need to review the changes to that API, to ensure that their integration remains compatible following on from an upgrade.
  3. In the description of some object properties there may be a single ServiceMobility release version number in grey, for example: 
    Status
    title3.19.0
    1. This number indicates the ServiceMobility release in which the relevant property was added to the existing object.
    2. So, for example, the 
      Status
      title3.19.0
       version number listed in the description of the TaxExempt property of the REST Object Definitions Account Location Related Objects Account Object page indicates that the TaxExempt property was introduced in version 3.19.0 of ServiceMobility.
    3. Users of ServiceMobility running a version prior to the indicated introduced version on an object property will need to upgrade to at least the listed version to be able to use the object property in any integration with ServiceMobility.