Usage Consumption TMF Webservices API

basic

extended

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

consumptionPeriod
optional

Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation.

TimePeriod

counterType
optional

Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)

string

level
optional

Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket

string

product
optional

Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource

NetworkProductRef

user
optional

Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource

RelatedParty

value
optional

Numeric value of the bucket counter in a given unit

Quantity

valueName
optional

Value of the counter in a formatted string used for display needs for example

string

@baseType
optional

When sub-classing, this defines the super-class.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name.

string

code
required

Application relevant detail, defined in the API or a common list.

integer(int32)

message
optional

More details and corrective actions related to the error which can be shown to a client user.

string

reason
optional

Explanation of the reason for the error which can be shown to a client user.

string

referenceError
optional

URI of documentation describing the error.

string

status
optional

HTTP Error code extension

integer(int32)

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference to the network product

string

id
optional

Unique identifier of the network product

string

name
optional

Network product name

string

outOfBucketCounter
optional

Counters detailing usage consumption out of the buckets

< ConsumptionSummary > array

publicIdentifier
optional

Public number associated to the network product (msisdn number for mobile line for example)

string

user
optional

References of the users of the network product

< RelatedParty > array

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

Generic attribute indicating the name of the class type of the referred resource entity

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
required

Reference to the network product

string

id
required

Unique identifier of the network product

string

name
optional

Network product name

string

publicIdentifier
optional

Public number associated to the product (msisdn number for mobile line for example)

string

amount
optional

Numeric value in a given unit

number(float)

units
optional

Unit

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related party, could be a party reference or a party role reference

string

id
optional

Unique identifier of a related party

string

name
optional

Name of the related party

string

role
optional

Role of the related party.

string

endDateTime
optional

End of the time period, using IETC-RFC-3339 format

string(date-time)

startDateTime
optional

Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end

string(date-time)

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

bucket
optional

Bucket(s) included in the offer or option subscribed.

< UsageVolumeProduct > array

description
optional

Free short text describing the usage consumption report content

string

effectiveDate
optional

Date and time when the usage consumption report was calculated and generated

string(date-time)

href
optional

Hyperlink to access the usage consumption report. The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server

string

id
optional

The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server

string

name
optional

Usage consumption report name

string

relatedParty
optional

RelatedParty

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

remainingValue
optional

Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example

Quantity

remainingValueName
optional

Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example

string

validFor
optional

Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date.

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

bucketBalance
optional

< UsageVolumeBalance > array

bucketCounter
optional

< ConsumptionSummary > array

id
optional

Unique identifier of the bucket

string

isShared
optional

True if the bucket is shared between several devices or users

boolean

name
optional

Bucket name

string

product
optional

< NetworkProduct > array

usageType
optional

Type of usage concerned by the bucket, such as voice, sms, data

string