All REST Endpoints
Admin/Dropdown Lists
This service retrieves the code and description values for a list of dropdowns.
- Retrieve Dropdown Lists
- Method: postPath:
https://server:port/spl/rest/apis/common/admin/dropdownLists/
Admin/Extendable Lookup Values
This service includes operations related to the extendable lookup values for a given extendable lookup business object.
- Get Extendable Lookup Values
- Method: getPath:
https://server:port/spl/rest/apis/common/admin/extendableLookupValues/{lookupBO}
Batch Services/Batch Job Submission
Batch Job Submission is used to submit application batch jobs for processing. This is the API to be used by external schedulers that do not want to use the internal scheduler.
- Cancel Batch Job
- Method: patchPath:
https://server:port/spl/rest/apis/common/batch/batchJobSubmission/{batchJobId}/cancel
- Get Batch Job / Batch Run Details
- Method: getPath:
https://server:port/spl/rest/apis/common/batch/batchJobSubmission/{batchJobId}
- Submit Batch Job
- Method: postPath:
https://server:port/spl/rest/apis/common/batch/batchJobSubmission/
Credit & Collections/Collection Process
A collection process is a series of events (e.g., letters, To Do entries) meant to encourage an account to pay its delinquent debt. Linked to the collection process are the specific service agreements that contributed to the delinquent debt.
- Get Collection Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/collectionProcesss/{collectionProcessId}
Credit & Collections/Cut Process
A cut process is a series of events (e.g., letters, To Do entries, field activities) that lead to the disconnection of service if outstanding debt is not paid.
- Get Cut Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}
Credit & Collections/Overdue Process
An overdue process is a series of events (e.g., letters, To Do entries) meant to encourage an account to pay its delinquent debt. The system creates an overdue process when an account violates your overdue rules. In addition, a user can manually create an overdue process at their discretion.
- Get Overdue Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}
Credit & Collections/Severance Process
A severance process is a series of events (e.g., letters, To Do entries, field activities) that lead to the severance of a service agreement if the outstanding debt is not paid. A separate severance process is required for each service agreement to be severed.
- Get Severance Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/severanceProcesses/{severanceProcessId}
Credit & Collections/Write Off Process
A write-off process is a series of events (e.g., letters, collection agency referrals) meant to encourage an account to pay its delinquent debt. Linked to the write-off process are the specific service agreements that contributed to the delinquent debt.
- Get Write Off Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}
Data Synchronization/Update Service Call Communication
This inbound service is used to process a service call communication acknowledgement message. The message contains communication ID, service call ID, service call number and error information. This service stores these information into the service call communication. If the message indicates an error, the service call communication is transitioned to the Error state. Otherwise, the service call communication is transitioned to the Synchronized state.
For more information about service call communication, launch the online help and search for "Asset Management System Integration"
- Update Service Call Communication
- Method: patchPath:
https://server:port/spl/rest/apis/customer/sync/serviceCallCommunication/{serviceCallCommId}
Devices/Device Configurations
Device configurations manage details of a device such as measuring components of a physical meter.
- Create Device Configuration
- Method: postPath:
https://server:port/spl/rest/apis/meter/devices/deviceConfigurations/
- Delete Device Configuration
- Method: deletePath:
https://server:port/spl/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
- Get Device Configuration
- Method: getPath:
https://server:port/spl/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
- Update Device Configuration
- Method: putPath:
https://server:port/spl/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
Devices/Item
Items can be either "badged" or "unbadged" . Badged items are devices that are individually tracked and can be installed at service point locations that typically have consumption but are not directly measured and therefore do not have any measuring components.
- Create Item
- Method: postPath:
https://server:port/spl/rest/apis/meter/devices/items/
- Delete Item
- Method: deletePath:
https://server:port/spl/rest/apis/meter/devices/items/{itemId}
- Get Item
- Method: getPath:
https://server:port/spl/rest/apis/meter/devices/items/{itemId}
- Update Item
- Method: putPath:
https://server:port/spl/rest/apis/meter/devices/items/{itemId}
Devices/Measuring Component
Measuring components are points for which data will be received and stored in the system. A measuring component can be associated to a device, which can have one or more measuring components, or it can be "virtual" or "stand-alone" meaning that it is not associated to a device.
- Create Measuring Component
- Method: postPath:
https://server:port/ouaf/rest/apis/meter/devices/measuringComponents/
- Delete Measuring Component
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/devices/measuringComponents/{measuringComponentId}
- Get Measuring Component
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/devices/measuringComponents/{measuringComponentId}
- Update Measuring Component
- Method: putPath:
https://server:port/ouaf/rest/apis/meter/devices/measuringComponents/{measuringComponentId}
Devices/Meter
Meters are devices that measure utility consumption and can be installed at service point locations.
- Create Meter
- Method: postPath:
https://server:port/ouaf/rest/apis/meter/devices/meters/
- Delete Meter
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/devices/meters/{meterId}
- Get Meter Details
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/devices/meters/{meterId}
- Update Meter
- Method: putPath:
https://server:port/ouaf/rest/apis/meter/devices/meters/{meterId}
Financial Transactions/AP Check Request
This service allows an external system to update the check-related information on an existing Accounts Payable Check Request record after the check has been cut.
If the Accounts Payable Check Request is being canceled, this service also cancels the related adjustment.
- Accounts Payable Check Request Maintenance
- Method: putPath:
https://server:port/spl/rest/apis/customer/financials/apCheckRequest/{apRequestId}
Financial Transactions/Adjustment
An adjustment is a type of financial transaction that effects a service agreement's debt and financial impact on the general ledger.
- Action Adjustment
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/adjustments/{adjustmentId}/lifecycle
- Adjustment Summary
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/adjustments/{adjustmentId}/summary
- Create Adjustment
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/adjustments/
- Delete Adjustment
- Method: deletePath:
https://server:port/spl/rest/apis/customer/financials/adjustments/{adjustmentId}
- Get Adjustment
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/adjustments/{adjustmentId}
Financial Transactions/Bill
A bill is produced for an account and many bills are produced for an account over time. Bills charge for the services or products supplied to a customer.
- Action Bill
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/bills/{billId}/lifecycle
- Bill Summary
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/bills/{billId}/billSummary
- Create Bill
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/bills/
- Delete Bill
- Method: deletePath:
https://server:port/spl/rest/apis/customer/financials/bills/{billId}
- Get Bill
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/bills/{billId}
- Search Bills
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/bills/search
Financial Transactions/Bill Segment
A bill typically contains one bill segment for every active service agreement linked to its account. A bill segment contains information showing how the segment was calculated and how it should be printed on the customer's bill.
- Action Bill Segment
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/lifecycle
- Bill Segment Search
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/billSegments/search
- Bill Segment Summary
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/summary
- Create Bill Segment
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/billSegments/
- Delete Bill Segment
- Method: deletePath:
https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}
- Get Bill Segment
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}
Financial Transactions/Budget
The Budget contains information about all service agreements linked to an account that are eligible to participate in a budget billing plan.
- Action Budget
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/budgets/{accountId}/lifecycle
- Get Budget
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/budgets/{accountId}
Financial Transactions/Financial Data for Accounts
Account Data provides financial history, current financial details, and financial statistics for a historical period.
- Account Financial Statistics
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/accountData/{accountId}/financialStatistics
- Get Account Financial Details
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/accountData/{accountId}/financialDetails
- Get Account Financial History
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/accountData/{accountId}/financialHistory
- Multi-Account Billing Statistics
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/accountData/multiAccountStatistics
Financial Transactions/Pay Plan
A pay plan (PP) is an agreement with a customer to make payments on specific dates. Pay plans differ from payment arrangements in that pay plans have user-defined scheduled payment dates, which are independent from the customer's billing dates. In other words, payment arrangements appear on the customer's bills, pay plan scheduled payments do not.
- Create Pay Plan
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/payPlans/
- Get Pay Plan
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/payPlans/{payPlanId}
Financial Transactions/Payment
Payments record the financial impact to offset arrears of an account. A payment can have multiple payment segments for the financial impact to offset arrears of each service agreement.
- Action Payment
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/lifecycle
- Create Payment
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/payments/
- Delete Payment
- Method: deletePath:
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}
- Get Pay Segments
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/paySegments
- Get Payment
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}
- Get Payment Summary
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}/summary
Financial Transactions/Payment Event
A payment event records an overall transaction whenever any form of payment is received. The payment event can span payments across multiple accounts and can include multiple payment tenders.
- Action Payment Event
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}/lifecycle
- Create Payment Event
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/paymentEvents/
- Delete Payment Event
- Method: deletePath:
https://server:port/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}
- Get Payment Event
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}
- Search Payment Event Payments
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/paymentEvents/payments/search
Financial Transactions/PaymentTender
Payment tenders exist for every form of tender, such as paying with cash, a check, or a credit card, remitted as part of a payment event. A payment event must have at least one tender otherwise nothing is remitted. A payment event may have many tenders when multiple payment methods are associated with an event.
- Action Payment Tender
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}/lifecycle
- Create Payment Tender
- Method: postPath:
https://server:port/spl/rest/apis/customer/financials/paymentTenders/
- Get Payment Tender
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}
Financial Transactions/SA Data
This web service provides a list of UOMs applicable to SA, and financial statistics
- Get Service Agreement UOMs and Financial Statistics
- Method: getPath:
/spl/rest/apis/customer/financials/saData/billingDetails/{serviceAgreementId}
Interactions/Case
Cases are a highly configurable object that can be used to handle various types of requests that can be tracked and require a workflow to enable resolution.
- Action Case
- Method: patchPath:
https://server:port/spl/rest/apis/customer/interactions/cases/{caseId}/action
- Create Case
- Method: postPath:
https://server:port/spl/rest/apis/customer/interactions/cases/
- Delete Case
- Method: deletePath:
https://server:port/spl/rest/apis/customer/interactions/cases/{caseId}
- Get Case
- Method: getPath:
https://server:port/spl/rest/apis/customer/interactions/cases/{caseId}
- Search Case
- Method: postPath:
https://server:port/spl/rest/apis/customer/interactions/cases/search
- Update Case
- Method: putPath:
https://server:port/spl/rest/apis/customer/interactions/cases/{caseId}
Interactions/Customer Activity History
Historical customer activity records and navigation details for activity types including customer contacts, bills, payments, field activities, service orders, service tasks.
- Get Customer Activity History
- Method: getPath:
https://server:port/spl/rest/apis/customer/interactions/customerActivityHistory/{accountId}
Interactions/Customer Contact
Customer contacts are used to record when and why a customer contacted your company or to initiate an outbound communication such as a letter that can be extracted for print and delivery.
- Create Customer Contact
- Method: postPath:
https://server:port/spl/rest/apis/customer/interactions/customerContacts/
- Delete Customer Contact
- Method: deletePath:
https://server:port/spl/rest/apis/customer/interactions/customerContacts/{customerContactId}
- Get Customer Contact
- Method: getPath:
https://server:port/spl/rest/apis/customer/interactions/customerContacts/{customerContactId}
- Update Customer Contact
- Method: putPath:
https://server:port/spl/rest/apis/customer/interactions/customerContacts/{customerContactId}
Service/Appointment Tasks
Appointment tasks are used to request and track appointments related to service order field activities for the customer via self-service portals.
- Book Appointment
- Method: postPath:
https://server:port/spl/rest/apis/cross/service/appointmentTasks/
- Cancel Appointment
- Method: patchPath:
https://server:port/spl/rest/apis/cross/service/appointmentTasks/{referenceId}/cancel
- Retrieve Pending Tasks
- Method: postPath:
https://server:port/spl/rest/apis/cross/service/appointmentTasks/tasks
- Search Appointment Slots
- Method: postPath:
https://server:port/spl/rest/apis/cross/service/appointmentTasks/availableSlots
- Search For Tasks
- Method: postPath:
https://server:port/spl/rest/apis/cross/service/appointmentTasks/reasons
Service/Start Stop Transfer Tasks
- Clear Other Person
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/otherPersonReset
- Deposit Assessment
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/depositAssessment
- Determine Services To Start
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/servicesToStart
- Determine Services To Stop
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/servicesToStop
- Process Other Person
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/otherPersonProcessing
- Process Services To Start
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceToStartProcessing
- Process Services To Stop
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceToStopProcessing
- Retrieve Request Type Details
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/requestTypeDetails
- Retrieve Service-Related Customer Details
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceRelatedCustomerDetails
- Retrieve Services To Stop
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/stoppableServiceDetails
- Service Eligibility
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceEligibility
- Service Questions
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceQuestions
- Start Service Finalization
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/startServiceFinalization
- Stop Service Finalization
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/stopServiceFinalization
- Transfer Service Finalization
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/transferServiceFinalization
- Validate Start SP Selection
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/startSPSelectionValidation
- Validate Stop Service Agreement Selection
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/stopSASelectionValidation
Service/Web User
Web users can be associated with customer persons to keep logins from an integrated self-service application, such as Oracle Utilities Digital Self-Service.
- Create Web User
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/webUsers/
- Delete Web User
- Method: deletePath:
https://server:port/spl/rest/apis/customer/service/webUsers/{webUserId}
- Get Web User
- Method: getPath:
https://server:port/spl/rest/apis/customer/service/webUsers/{webUserId}
- Update Web User
- Method: putPath:
https://server:port/spl/rest/apis/customer/service/webUsers/{webUserId}
Service/Web User Account
Web users can be associated with customer accounts that are linked to a login from an integrated self-service application, such as Oracle Utilities Digital Self-Service.
- Create Web User Account
- Method: postPath:
https://server:port/spl/rest/apis/customer/service/webUserAccounts/
- Delete Web User Account
- Method: deletePath:
https://server:port/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}
- Get Account Verification Details
- Method: getPath:
https://server:port/spl/rest/apis/customer/service/webUserAccounts/{accountId}/accountVerificationInfo
- Get Web User Account
- Method: getPath:
https://server:port/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}
- Search Web User Accounts
- Method: getPath:
https://server:port/spl/rest/apis/customer/service/webUserAccounts/{webUserId}
- Update Web User Account
- Method: putPath:
https://server:port/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}
Service/Work Queue
Work queue of To Do Entries assigned to the user.
- Get Work Queue
- Method: getPath:
/spl/rest/apis/customer/service/workQueue/
System Services/Expand Tree
This service handles tree node expansion functionality.
- Expand Tree Node
- Method: postPath:
/spl/rest/apis/common/system/treeNodes/expandNode
System Services/Insights
This service includes operations related to retrieval of context based insights.
- Retrieve Insights
- Method: postPath:
/spl/rest/apis/common/system/insights/
System Services/Installation Options
This service includes operations related to the Framework installation options. Its primary purpose is to provide the ability to view and update customer release details.
- Get Customer Release
- Method: getPath:
https://server:port/spl/rest/apis/common/system/installationOptions/customerRelease
- Update Customer Release
- Method: patchPath:
https://server:port/spl/rest/apis/common/system/installationOptions/customerRelease
To Do Entries/To Do Entry
A To Do Entry is either created manually by a user or generated by the system as a result of an event or issue that needs attention. The To Do Entry represents a task to be performed or an issue to be investigated.
- Get To Do Entry
- Method: getPath:
https://server:port/spl/rest/apis/common/toDos/toDoEntries/{toDoEntryId}
- Get To Do Entry Logs
- Method: getPath:
https://server:port/spl/rest/apis/common/toDos/toDoEntries/{toDoEntryId}/logs
Usage/Usage Transaction
Usage Transactions are records of a given usage calculation for a period of time for a Usage Subscription. All of the Service Quantities (often referred to as bill determinants) calculated are stored in the Usage Transaction.
- Create Usage Transaction
- Method: postPath:
https://server:port/ouaf/rest/apis/meter/usage/usageTransactions/
- Delete Usage Transaction
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}
- Get Usage Transaction
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}
- Patch Usage Transaction
- Method: patchPath:
https://server:port/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}/action
- Update Usage Transaction
- Method: putPath:
https://server:port/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}
Usage/Usage data from Bills
Service to get usage values from bill segment SQ collections - for Accounts and Service Agreements over time periods
- Billed Usage for SA
- Method: postPath:
https://server:port/spl/rest/apis/customer/usage/usageData/serviceAgreementBilledUsage
- Multi-Account Usage Summary for a date range
- Method: postPath:
https://server:port/spl/rest/apis/customer/usage/usageData/multiAccountSummary
- Single Service Usage Summary for a date range
- Method: postPath:
https://server:port/spl/rest/apis/customer/usage/usageData/singleServiceSummary
V-Model/Account
Accounts manage the financial relationship with an end customer for which bills are created based on service agreements. The account contains information that controls when the bills are generated and how they are formatted for related persons.
- Create Account
- Method: postPath:
/spl/rest/apis/customer/v-model/accounts/
- Create Account Person
- Method: postPath:
/spl/rest/apis/customer/v-model/accounts/{accountId}/persons
- Delete Account
- Method: deletePath:
/spl/rest/apis/customer/v-model/accounts/{accountId}
- Delete Account Person
- Method: deletePath:
/spl/rest/apis/customer/v-model/accounts/{accountId}/persons
- Get Account
- Method: getPath:
/spl/rest/apis/customer/v-model/accounts/{accountId}
- Get Account Person
- Method: getPath:
/spl/rest/apis/customer/v-model/accounts/{accountId}/persons/{personId}
- Update Account
- Method: putPath:
/spl/rest/apis/customer/v-model/accounts/{accountId}
- Update Account Person
- Method: putPath:
/spl/rest/apis/customer/v-model/accounts/{accountId}/persons
V-Model/Billing Context
Represents a billing context for various types of queries.
- Get Billing Account Context
- Method: getPath:
/spl/rest/apis/customer/v-model/billingContext/accountContext/{accountId}
- Get Person Accounts
- Method: getPath:
/spl/rest/apis/customer/v-model/billingContext/personContext/{personId}
- Search Account Premises
- Method: postPath:
/spl/rest/apis/customer/v-model/billingContext/premises
- Search Person Accounts
- Method: postPath:
/spl/rest/apis/customer/v-model/billingContext/searchPersonAccounts
V-Model/Business Person Queries
- Business Person Summary
- Method: postPath:
/spl/rest/apis/customer/v-model/businessPersonQueries/
V-Model/Business Search
This service is used by the CX4U Key Account Management (KAM) Customer List page to find business person records based on specific filters.
- Business Search
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/businessSearch/
V-Model/Communications Preferences
Centralized maintenance of a person's communication preferences by notification types allowed for an account.
- Get Communications Preferences
- Method: getPath:
https://server.com:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}
- Get Mailing Addresses
- Method: getPath:
https://server.com:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses
- Patch Communications Preferences
- Method: patchPath:
https://server.com:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}
- Update Mailing Address
- Method: patchPath:
https://server.com:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses
V-Model/Entity References
- Entity References Summary
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/entityReferences/hierarchyInfo
V-Model/Install Events
Install Events manage the physical installation of devices such as meters or badged items at service point connection locations including relationships to markets and service providers and communication between devices or schedules for manual meter reading.
- Create Install Event
- Method: postPath:
https://server:port/ouaf/rest/apis/meter/v-model/installEvents/
- Delete Install Event Details
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/v-model/installEvents/{installEventId}
- Get Install Event
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/v-model/installEvents/{installEventId}
- Update Install Event Details
- Method: putPath:
https://server:port/ouaf/rest/apis/meter/v-model/installEvents/{installEventId}
V-Model/Landlord Agreements
A landlord agreement maintains a landlord's service reversion preferences. A landlord will have at least one landlord agreement. However, if the landlord has different service reversion preferences for different properties, you can create multiple landlord agreements - one for each set of preferences. After a landlord's reversion preferences have been defined, the landlord agreement record can be linked to the respective premises.
- Create Landlord Agreement
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/landlordAgreements/
- Delete Landlord Agreement
- Method: deletePath:
https://server:port/spl/rest/apis/customer/v-model/landlordAgreements/{landLordId}
- Get Landlord Agreement
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/landlordAgreements/{landLordId}
- Update Landlord Agreement
- Method: putPath:
https://server:port/spl/rest/apis/customer/v-model/landlordAgreements/{landLordId}
V-Model/Notification Preferences for Accounts
This REST web service retrieves notification preferences for a collection of accounts and notification types.
- Retrieve Notification Preferences for Accounts
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/notificationPreferencesForAccounts/
V-Model/Person
- Create Person
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/persons/
- Delete Person
- Method: deletePath:
https://server:port/spl/rest/apis/customer/v-model/persons/{personId}
- Get Person
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/persons/{personId}
- Person Search
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/persons/search
- Update Person
- Method: putPath:
https://server:port/spl/rest/apis/customer/v-model/persons/{personId}
V-Model/Person Context
Retrieves a list of related accounts for a person along with other related persons to each account.
- Get Person Context
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/personContext/{personId}
V-Model/Person Information Synchronization
Synchronization of person records for an individual or business with which your company has interactions and could be synchronized with CX applications.
Synchronized person information includes primary name and contact information such as phone number or email address.
- Sync Person
- Method: putPath:
https://server:port/spl/rest/apis/customer/v-model/cxPersons/{cxContactId}
V-Model/Person Search
- Person Search
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/personSearch/
V-Model/Premise
The premise record contains geographic information about your service addresses. A premise can have service points at which meters can be installed to measure utility services supplied to the premise.
- Create Premise
- Method: postPath:
/spl/rest/apis/customer/v-model/premises/
- Delete Premise
- Method: deletePath:
/spl/rest/apis/customer/v-model/premises/{premiseId}
- Get Premise
- Method: getPath:
/spl/rest/apis/customer/v-model/premises/{premiseId}
- Search Premises
- Method: postPath:
/spl/rest/apis/customer/v-model/premises/search
- Update Premise
- Method: putPath:
/spl/rest/apis/customer/v-model/premises/{premiseId}
V-Model/Program Context
Program Context includes name value pairs to indicate customer context such as various programs in which the customer may be enrolled.
- Get Program Contexts
- Method: getPath:
https://server:port/spl/rest/apis/cross/v-model/programContexts/{accountId}/{personId}
V-Model/Service Agreement
A service agreement is a contract between your company and a customer. The service agreement contains the terms and conditions controlling how the system calculates charges for the specific service or product supplied to the customer.
- Create Service Agreement
- Method: postPath:
/spl/rest/apis/customer/v-model/serviceAgreements/
- Delete Service Agreement
- Method: deletePath:
/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
- Get Service Agreement
- Method: getPath:
/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
- Search SA for Account
- Method: postPath:
/spl/rest/apis/customer/v-model/serviceAgreements/search
- Update Service Agreement
- Method: putPath:
/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
V-Model/Service Point Search
- Search Service Point
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/servicePointSearch/
V-Model/Service Points Common
This Inbound Web Service provides an operation for the display-oriented summary of a Service Point, which can be used across both CCB and C2M environments. When used in C2M the summary will also include additional fields that are stored on the MDM Service Point.
- Get Service Point Summary
- Method: getPath:
/spl/rest/apis/customer/v-model/servicePointsCommon/{servicePointId}/summary
V-Model/Service Points/Customer Care and Billing
Service points are a physical location (usually meter connection socket) at which a company supplies service. Devices are installed at service points, and the relationship between individual service points and devices can change over time.
- Create Service Point
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/servicePoints/
- Delete Service Point
- Method: deletePath:
https://server:port/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}
- Get Service Point
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}
- Update Service Point
- Method: putPath:
https://server:port/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}
V-Model/Service Points/Customer to Meter
Service points are a physical location (usually meter connection socket) at which a company supplies service that can be used to store information describing the type of service supplied and how it is measured.
- Create Service Point
- Method: postPath:
https://server:port/spl/rest/apis/cross/v-model/servicePoints/
- Delete Service Point
- Method: deletePath:
https://server:port/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}
- Get Service Point
- Method: getPath:
https://server:port/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}
- Search SP for Premise
- Method: postPath:
https://server:port/spl/rest/apis/cross/v-model/servicePoints/summary
- Update Service Point
- Method: putPath:
https://server:port/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}
V-Model/Service Points/Meter Data Management
Service points are a physical location (usually meter connection socket) at which a company supplies service that can be used to store information describing the type of service supplied and how it is measured.
- Create Service Point
- Method: postPath:
https://server:port/ouaf/rest/apis/meter/v-model/servicePoints/
- Delete Service Point
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/v-model/servicePoints/{servicePointId}
- Get Service Point
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/v-model/servicePoints/{servicePointId}
- Update Service Point
- Method: putPath:
https://server:port/ouaf/rest/apis/meter/v-model/servicePoints/{servicePointId}
V-Model/Unsubscribe Notifications
This service is used to process request to unsubscribe or opt-out of receiving notifications.
Notifications are sent based on active preferences, or the system can derive a default preference. Some notification types allow customers to opt-out from receiving future notifications while some do not. Sometimes a customer has signed up to receive the same notification to more than one destination such as two email address or an email and text (SMS). In these instances, the customer is only unsubscribed from the source of the message where this request originated. Lastly, the customer's preferences may have changed since the notification as send. For example, the user may unsubscribe from an old email. This service ensures the information in the request is current before processing the request.
This service handles the above situations and returns an informational message based on the situation. The informational message catalog entries are provided here so you can customize the message text.
Already unsubscribed. (11120, 11071)
Unsubscribe successful. (11120, 11072)
Unsubscribe successful. Other active preferences for the same notification type. (11120, 11073)
Unsubscribe successful. Opt-out created. (11120, 11075)
Unsubscribe not successful. Information in request does not match system. (11120, 11076)
Unsubscribe not successful. Opt-out not created. Notification type belongs to a different parent than when it was sent. (11120, 11078)
(11120, 11079) Unsubscribe successful. Opt-out not allowed.
- Unsubscribe Notifications
- Method: postPath:
https://server:port/spl/rest/apis/customer/v-model/C1UnsubscribeNotifications/
V-Model/Usage Subscription
A Usage Subscription is an ongoing request to send one or more Service Points' usage detail to one or more external systems. The Usage Subscription defines which usage calculation group should be used to calculate Service Quantities (often referred to as bill determinants).
- Create Usage Subscription
- Method: postPath:
https://server:port/ouaf/rest/apis/meter/v-model/usageSubscriptions/
- Delete Usage Subscription
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}
- Get Usage Subscription
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}
- Update Usage Subscription
- Method: putPath:
https://server:port/ouaf/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}