The following document is the specification of the REST API for Usage. It includes the model definition as well as all available operations.
The usage API provides standardized mechanism for usage management such as creation, update, retrieval, import and export of a collection of usages.
Usage API manages both rated and non-rated usages.
For example, Usage API allows a service provider: - To retrieve usage generated by a partner service platform in order to rate it
- To provide rated usages to a partner for consumption follow up purpose
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
- Export of a collection of usages
- Import of a collection of usages
|