All REST Endpoints
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.
- Create collection Process
- Method: postPath:
https://server:port/spl/rest/apis/customer/collections/collectionProcesss/
- Get Collection Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/collectionProcesss/{collectionProcessId}
- Update Collection Process
- Method: putPath:
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.
- Action Cut Process
- Method: patchPath:
https://server:port/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}/action
- Get Cut Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}
- Update Cut Process
- Method: putPath:
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.
- Action Overdue Process
- Method: patchPath:
https://server:port/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}/action
- Create Overdue Process
- Method: postPath:
https://server:port/spl/rest/apis/customer/collections/overdueProcesses/
- Get Overdue Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}
- Update Overdue Process
- Method: putPath:
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.
- Create Severance Process
- Method: postPath:
https://server:port/spl/rest/apis/customer/collections/severanceProcesses/
- Get Severance Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/severanceProcesses/{severanceProcessId}
- Update Severance Process
- Method: putPath:
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.
- Create Write Off Process
- Method: postPath:
https://server:port/spl/rest/apis/customer/collections/writeoffProcesses/
- Get Write Off Process
- Method: getPath:
https://server:port/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}
- Update Write Off Process
- Method: putPath:
https://server:port/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}
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/ouaf/rest/apis/meter/devices/deviceConfigurations/
- Delete Device Configuration
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
- Get Device Configuration
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
- Update Device Configuration
- Method: putPath:
https://server:port/ouaf/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/ouaf/rest/apis/meter/devices/items/
- Delete Item
- Method: deletePath:
https://server:port/ouaf/rest/apis/meter/devices/items/{itemId}
- Get Item
- Method: getPath:
https://server:port/ouaf/rest/apis/meter/devices/items/{itemId}
- Update Item
- Method: putPath:
https://server:port/ouaf/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. There are different classes of meters with different attributes and behavior
Smart Meter: these meters are associated to a head end system and support smart meter commands. The measuring components associated to these devices are expected to be read very frequently. These meters support periodic estimation
AMR Meter: these meters may also be associated to a head end system but they do not support smart meter commands. The measuring components are read frequently.
Manual Meter: these meters are seldom read and do not support smart meter commands.
- 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/Account Financial History
Account Financial History shows how an account's current and payoff balance have changed over time.
- Get Account Financial History
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/accountFinancialHistory/{accountId}
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}
- 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}
- Update Adjustment
- Method: putPath:
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.
Note: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use.
- Action Bill
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/bills/{billId}/action
- 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}
- Update Bill
- Method: putPath:
https://server:port/spl/rest/apis/customer/financials/bills/{billId}
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.
Note: All REST services that are in the Integration Suite Web Service Category require the related Integration Suite add-on product option to use.
- Action Bill Segment
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/action
- 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}
- Update Bill Segment
- Method: putPath:
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}/action
- Get Budget
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/budgets/{accountId}
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}
- Update Pay Plan
- Method: putPath:
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}/action
- 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 Payment
- Method: getPath:
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}
- Update Payment
- Method: putPath:
https://server:port/spl/rest/apis/customer/financials/payments/{paymentId}
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.
Note: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use.
- Action Payment Event
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}/action
- 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}
- Update Payment Event
- Method: putPath:
https://server:port/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}
Financial Transactions/PaymentTender
Payment tenders exist for every form of tender remitted as part of a payment event. A payment event must have at least one tender otherwise nothing was remitted. A payment event may have many tenders when multiple payment methods are associated with an event (e.g., paying with cash, a check, and a credit card).
- Action Payment Tender
- Method: patchPath:
https://server:port/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}/action
- 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}
- Update Payment Tender
- Method: putPath:
https://server:port/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}
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: getPath:
https://server:port/spl/rest/apis/customer/interactions/cases/search/case
- 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.
Note: All REST services that are in the Customer Experience Web Service Categories require the related Customer Experience add-on product option to use.
- 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/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.
Note: All REST services that are in the Customer Experience Web Service Categories require the related Customer Experience add-on product option to use.
- Get Work Queue
- Method: getPath:
https://server:port/spl/rest/apis/customer/service/workQueue/
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.
When calculating a Usage Transaction, the first step in calculating the usage is for the system to determine the usage calculation group holding the rules set used in calculating or validating the quantities. Usage transaction requests must specify the date range for the usage transaction. This date range is referred to as the calculation period for 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}
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:
https://server:port/spl/rest/apis/customer/v-model/accounts/
- Delete Account
- Method: deletePath:
https://server:port/spl/rest/apis/customer/v-model/accounts/{accountId}
- Get Account
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/accounts/{accountId}
- Update Account
- Method: putPath:
https://server:port/spl/rest/apis/customer/v-model/accounts/{accountId}
V-Model/Business Person Queries
Get Business Summary retrieves summary details for the provided person id. This summary is intended for persons of type business that may have multiple active billing accounts and premise service locations.
- Business Person Search
- Method: postPath:
https://server:port/spl/rest/apis/cross/v-model/businessPersonQueries/personSearch
- Business Person Summary
- Method: postPath:
https://server:port/spl/rest/apis/cross/v-model/businessPersonQueries/
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:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}
- Get Mailing Addresses
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses
- Patch Communications Preferences
- Method: patchPath:
https://server:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}
- Update Mailing Address
- Method: patchPath:
https://server:port/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses
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/Person
Person records can exist for individuals or businesses with which your company has contact related to a service provided . Besides customers, persons can exist for landlords, contractors, third-party guarantors, energy distributors or other service providers, collection agencies and so on.
- 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}
- 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/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:
https://server:port/spl/rest/apis/customer/v-model/premises/
- Delete Premise
- Method: deletePath:
https://server:port/spl/rest/apis/customer/v-model/premises/{premiseId}
- Get Premise
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/premises/{premiseId}
- Update Premise
- Method: putPath:
https://server:port/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 as 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:
https://server:port/spl/rest/apis/customer/v-model/serviceAgreements/
- Delete Service Agreement
- Method: deletePath:
https://server:port/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
- Get Service Agreement
- Method: getPath:
https://server:port/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
- Update Service Agreement
- Method: putPath:
https://server:port/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
V-Model/Service Points/C2M
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.
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/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}
- Update Service Point
- Method: putPath:
https://server:port/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}
V-Model/Service Points/CC&B
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/MDM
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/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).
Usage subscriptions must reference a:
Service Provider: The service provider is used as the identity of the subscribing system.
- 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}
V-Model/V Model Relationships
- Get V Model Relationship
- Method: getPath:
https://server:port/spl/rest/apis/cross/v-model/vModelRelationships/{accountId}