Usage Management Process API
Brief Description
The following document is the specification of the REST Process API for Usage. It includes the model definition as well as all available operations.
The usage API provides orchestration mechanism for usage management such as retrieval collection of usages.
Business ID indicates a decision point to target billing system in a specific market.
Usage API manages usage resource:
- A usage represents an event that is of billing system's interest and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage
- Main usage attributes are its identifier, date, type, type related specification, characteristics (name and value), status, related parties and rating related information (date, amount, taxes, etc.)
Usage API performs the following operations on usage:
- Retrieval of a usage or a collection of usages depending on filter criteria
- Partial update of a usage or of a collection of usages
- Creation of a usage
Criticality
Medium
Layer/Category
Process
API Current State
Testing Phase
Usage
TBD
Base URI Summary of Methods
- Development
- Test
- Pre-Prod
- Prod
Transport Protocol(s)
HTTPS
3 Layer architecture flow diagram
Sequence Diagram
TBD
Quality of Service (QoS)
TBD
Avg. Response Time (Secs)
TBD
Avg. Payload Size (KB/MB)
TBD
Max Payload Size (KB/MB)
TBD
Avg. Volumes (per day)
TBD
Peak Volumes
TBD
Peak Volumes Timespan
TBD
Availability
High Availability
Service Level Agreement
N/A
Policies
N/A
GDPR
TBD
Constraints
There are no constraints applicable to this API.
Assumptions
Average/Peak Response time depends on the size of payload and speed and other network and processing factors.