REST API Versions and URL Paths

A URL (Uniform Resource Locator) path identifies the REST resource that you want to call. A complete URL path consists of the server name and the resource path. Customer Experience for Utilities REST APIs follow the resource path pattern shown below:

<api-collection-name>/<api-version>/<resource-name>?
Where:
  • <api-collection-name> is the name given to a set of APIs (utilitiesCustomer).
  • <api-version> is the version applicable to a particular API for a given resource (for example, v1).
  • <resource-name> is the name of the particular resource being addressed by the API (for example, Individual).

An example of a versioned API is:

utilitiesCustomer/v1/Individual