Additional and Updated REST APIs

The following REST API enhancements and fixes are included in this release:

  • Case (C1-Case): Retrieves additional case details, including case type, case status, case condition, and case information through the enhanced Get Case operation.

  • Notification Preferences (C1-CommunicationsPreferences): Enhanced to support service agreement-based preferences through new and updated web service operations:

    • The new Notification Preferences Summary operation retrieves applicable notification types and preference summaries for a specified account and person, including service agreement preference counts with and without configured preferences.
    • The new Maintain Notification Preferences By Type (GET) operation retrieves preference details for a specified account, person, and notification type. For service agreement-level preferences, it supports delivery type and contact-detail context and returns applicable service agreement preference information.
    • The new Maintain Notification Preferences By Type (PATCH) operation updates account-level and service agreement-level preferences for a specified notification type. For service agreement-level preferences, updates apply to the specified delivery type, contact detail, and service agreements.
    • The enhanced Maintain Communication Preferences operation supports account-level notification types only and can optionally process a single notification type.

  • Notification Preferences for Accounts (C1-NotificationPreferencesForAccounts): Retrieves account-level or service agreement-level preferences based on notification level through the enhanced Retrieve Notification Preferences for Account operation.

  • Template-Based Notification Types (C1-TemplateBasedNotifTypes): Retrieves service agreement-level notification type information, including notification level, service point requirement, and the service agreement event used to inactivate service agreement preferences through the enhanced Get Template-Based Notification Types operation.

  • Unsubscribe Notifications (C1-UnsubscribeNotifications): Supports unsubscribing from service agreement-level preferences through the enhanced Unsubscribe Notifications operation.

  • Customer Contact Notification (C1-CustomerContactNotification): Supports service agreement preference and premise context when creating or updating customer contacts through the enhanced Create Update Customer Contact operation.

  • Account (C1-Account): Supports future-dated AutoPay enrollment information. When an account has a future AutoPay start date, the service provides the date so integrated applications can inform the user rather than attempt a duplicate enrollment.

  • Service Point Search (C1-ServicePointSearch): The getServicePointsInfoForPremise operation returns lookup codes for source status, service point status, and device status in addition to descriptions. Integrations can use the returned codes rather than translated descriptions when determining status or presentation behavior.

  • Customer Contact (C1-CustomerContact): Corrects the Get Customer Contact Summary response mapping so accountName returns the account name rather than account information. The response also correctly populates the entity name. (CCB-76141)

  • Person Search (C1-PersonSearch): Improves performance when searching by meter badge ID and resolves a timeout that could occur with Customer Experience for Utilities integrations.  (Bugs 39490721 and 39052465)

  • Budget (C1-Budget): Corrects the Get Budget operation so it does not unintentionally increment the account version. (Bug 39067253)

  • Payment (C1-Payment): Retrieves the cancellation reason for a payment, when applicable, through the enhanced Get Payment operation. (Bug 39559847)

  • Meter services: Updates characteristic-collection schemas for the Metering - Item, Measuring Component, Meter, and Usage Subscription REST services to use framework-delivered characteristic metadata. This provides consistent characteristic-value handling across REST service schemas. (CTM-24600)
  • Effective-dated characteristics: Refactors REST inbound web service scripts that directly define effective-dated characteristic collections to use the framework effective-dated characteristics data area or the generic characteristic-value metadata field, as applicable. (CCB-79708)
  • Usage Transaction (D1-UsageTransaction): Fixes several response issues in the getUsageTransaction operation. The operation now returns previously omitted collections, aligns characteristic fields with the source usage-characteristic data, and removes an extra empty entry at the beginning of trace and exception collections. (Bugs 39252385, 39409894, and 39676354)
  • Common Service Point (X1-ServicePoint): Updates the characteristic-collection schemas for the create, get, and update Service Point operations to use framework-delivered characteristic metadata. (CTM-24598). Corrects service point characteristic processing so create and update operations consistently update the applicable Meter Data Management and Customer Care and Billing service point characteristic data. (Bug 39004439)

You can use these REST inbound web services to decrease project costs and timelines.

Steps to enable and configure

Refer to the Oracle Utilities REST API documentation.

Tips and considerations

Implementations must purchase the appropriate subscriptions or license options to use the Inbound Web Services.

Key resources

Refer to the Oracle Utilities REST API documentation.