cisco-cvp-ux
Get UsageConsumptionDetails - TMF677 GET
Request
URL
http://[host]:[port]/cisco-cvp-ux/v1/{businessId}/usageConsumptionReportCommon Parameters
Base URI parameters and headers are common to all the resources as part of cisco-cvp-ux api listed below with details.
URI Parameter
BusinessId is a part of Base URI which is an enumeration of two-character length representing market/country.
| Name | Type | M/O | Description |
|---|---|---|---|
| businessId | string | M | Business unit identifier. Can be one of: "JM", "PA", "PR", "CL", "CR" |
Query Parameter
| Name | Type | M/O | Description |
|---|---|---|---|
| product.publicIdentifier | string | M | Public number associated to the product (for PR: number for mobile line, for CWC and BTC: serviceNo/SubscriberNo) |
| product.publicIdentifierType | string | M | Customer Public Identifier type. Example: MSISDN/SubscriptionId For CWC and BTC it is always 'MSISDN' |
| relatedParty.id | string | cond.M | unique identifier of the account. Mandatory when businessIDs contains CWC (liberate) markets and LOB is Postpaid |
Headers
| name | value | description | required |
|---|---|---|---|
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b | O |
| lob | string | It defines the Line of Business . Example : PREPAID | M |
| channelId | string | Channel to identify the business group. Eg:ivrB2C Mandatory when businessID is PR | cond.M |
| targetSystem | string | this indicates target system name/id in your request. Example: matrixx Mandatory when businessID is PR. | cond.M |
Security Headers
| Name | Type | M/O | Description |
|---|---|---|---|
| Client-id | string | M | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332 |
| Client-secret | string | M | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a |
Response
Possible success response
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
PR Success Response
[
{
"id": "9077613",
"href": "https://esb-dev.lla.com/usageConsumption/v3/usageConsumptionReport/9077613",
"description": "Usage Consumption Report for MSISDN 9077613",
"effectiveDate": "2023-01-17T00:29:41.693Z",
"bucket": [
{
"id": "1",
"name": "Prepaid Balance",
"usageType": "United States dollar",
"isShared": false,
"remainingValue": {
"amount": 40.00,
"units": "USD"
},
"remainingValueName": "40 USD",
"product": [
{
"publicIdentifier": "9077613"
}
]
},
{
"id": "2",
"name": "Setup_Flag_Balance",
"usageType": "Flag",
"isShared": false,
"remainingValue": {
"amount": "infinity",
"units": ""
},
"remainingValueName": "infinity",
"product": [
{
"publicIdentifier": "9077613"
}
]
},
{
"id": "3",
"name": "Setup_Flag_Balance - SMS 3G",
"usageType": "Flag",
"isShared": false,
"remainingValue": {
"amount": "infinity",
"units": ""
},
"remainingValueName": "infinity",
"product": [
{
"publicIdentifier": "9077613"
}
]
},
{
"id": "4",
"name": "Setup_Flag_Balance - SMS LTE",
"usageType": "Flag",
"isShared": false,
"remainingValue": {
"amount": "infinity",
"units": ""
},
"remainingValueName": "infinity",
"product": [
{
"publicIdentifier": "9077613"
}
]
},
{
"id": "5",
"name": "Included Minutes - Prepaid",
"usageType": "Voice",
"isShared": false,
"product": [
{
"publicIdentifier": "9077613"
}
],
"bucketBalance": [
{
"remainingValue": {
"amount": 999999.00,
"units": "minutes"
},
"remainingValueName": "999999 minutes",
"validFor": {
"startDateTime": "2023-01-07T07:47:32.000Z",
"endDateTime": "2023-02-06T07:47:32.000Z"
},
"daysLeft": 20
}
],
"bucketCounter": [
{
"counterType": "used",
"consumptionPeriod": {
"endDateTime": "2023-02-06T07:47:32.000Z",
"startDateTime": "2023-01-07T07:47:32.000Z"
},
"value": {
"amount": 999999.00,
"units": "minutes"
}
}
]
},
{
"id": "6",
"name": "Included SMS - Prepaid",
"usageType": "Text",
"isShared": false,
"product": [
{
"publicIdentifier": "9077613"
}
],
"bucketBalance": [
{
"remainingValue": {
"amount": 999999.00
},
"remainingValueName": "999999",
"validFor": {
"startDateTime": "2023-01-07T07:47:32.000Z",
"endDateTime": "2023-02-06T07:47:32.000Z"
},
"daysLeft": 20
}
],
"bucketCounter": [
{
"counterType": "used",
"consumptionPeriod": {
"endDateTime": "2023-02-06T07:47:32.000Z",
"startDateTime": "2023-01-07T07:47:32.000Z"
},
"value": {
"amount": 999999.00
}
}
]
},
{
"id": "7",
"name": "Included Data - Prepaid",
"usageType": "Data",
"isShared": false,
"product": [
{
"publicIdentifier": "9077613"
}
],
"bucketBalance": [
{
"remainingValue": {
"amount": 4096.00,
"units": "megabytes"
},
"remainingValueName": "4096 megabytes",
"validFor": {
"startDateTime": "2023-01-07T07:47:32.000Z",
"endDateTime": "2023-02-06T07:47:32.000Z"
},
"daysLeft": 20
}
],
"bucketCounter": [
{
"counterType": "used",
"consumptionPeriod": {
"endDateTime": "2023-02-06T07:47:32.000Z",
"startDateTime": "2023-01-07T07:47:32.000Z"
},
"value": {
"amount": 4096.00,
"units": "megabytes"
}
}
]
},
{
"id": "8",
"name": "HotSpot Data - Prepaid",
"usageType": "Data",
"isShared": false,
"product": [
{
"publicIdentifier": "9077613"
}
],
"bucketBalance": [
{
"remainingValue": {
"amount": 4096.00,
"units": "megabytes"
},
"remainingValueName": "4096 megabytes",
"validFor": {
"startDateTime": "2023-01-07T07:47:32.000Z",
"endDateTime": "2023-02-06T07:47:32.000Z"
},
"daysLeft": 20
}
],
"bucketCounter": [
{
"counterType": "used",
"consumptionPeriod": {
"endDateTime": "2023-02-06T07:47:32.000Z",
"startDateTime": "2023-01-07T07:47:32.000Z"
},
"value": {
"amount": 4096.00,
"units": "megabytes"
}
}
]
},
{
"id": "9",
"name": "Included MMS - Prepaid",
"usageType": "Picture",
"isShared": false,
"product": [
{
"publicIdentifier": "9077613"
}
],
"bucketBalance": [
{
"remainingValue": {
"amount": 999999.00
},
"remainingValueName": "999999",
"validFor": {
"startDateTime": "2023-01-07T07:47:32.000Z",
"endDateTime": "2023-02-06T07:47:32.000Z"
},
"daysLeft": 20
}
],
"bucketCounter": [
{
"counterType": "used",
"consumptionPeriod": {
"endDateTime": "2023-02-06T07:47:32.000Z",
"startDateTime": "2023-01-07T07:47:32.000Z"
},
"value": {
"amount": 999999.00
}
}
]
}
]
}
]Note: bucketBalance and bucketCounter are not applicable for usageType United States dollar and Flag. We only display current month's bucketBalance and bucketCounter
Definitions for LCPR
| Name | Type | Description | M/O |
|---|---|---|---|
| id | string | 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 | O |
| href | string | 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 | O |
| description | description | Free short text describing the usage consumption report content | O |
| effectiveDate | dateTime | Date and time when the usage consumption report was calculated and generate | O |
| bucket.id | string | Unique identifier of the bucket | O |
| bucket.name | string | Bucket name | O |
| bucket.usageType | string | Type of usage concerned by the bucket, such as voice, sms, data | M |
| bucket.isShared | Boolean | True if the bucket is shared between several devices or users | O |
| bucket.remainingValue.amount | Float | Numeric value in a given unit | M |
| bucket.remainingValue.units | string | Unit | M |
| bucket.remainingValueName | string | Remaining value in a formatted string for the bucket. | O |
| bucket.product.publicIdentifier | string | Public number associated to the network product (msisdn number for mobile line for example) | O |
| bucket.bucketBalance.remainingValue.amount | Float | Numeric value in a given unit | M |
| bucket.bucketBalance.remainingValue.units | string | Unit | M |
| bucket.bucketBalance.remainingValueName | string | Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb | O |
| bucket.bucketBalance.validFor.startDateTime | DateTime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | O |
| bucket.bucketBalance.validFor.endDateTime | DateTime | End of the time period, using IETC-RFC-3339 format | O |
| bucket.bucketBalance.daysLeft | Integer | It defines the number of days left for a plan to get expired. | M |
| bucket.bucketCounter.counterType | string | 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). | O |
| bucket.bucketCounter.consumptionPeriod.endDateTime | DateTime | 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. | O |
| bucket.bucketCounter.consumptionPeriod.startDateTime | DateTime | 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. | O |
| bucket.bucketCounter.value.amount | Float | Numeric value of the bucket counter in a given unit. | M |
| bucket.bucketCounter.value.units | string | Unit of the bucket counter | O |
CWC Liberate Success Response
[
{
"id": "",
"queryUsageConsumptionDate": "2023-10-04T14:18:32.693-04:00",
"searchCriteria": {
"service": [
{
"id": "4933562",
"@type": "POSTPAID"
}
]
},
"relatedParty": [
{
"id": "150015680000",
"@type": "BillingAccount"
}
],
"usageConsumption": [
{
"id": "M-LARGE-STAFF",
"bucketRefOrValue": [
{
"id": "3",
"isShared": false,
"name": "Local SMS ( Flow & 3rd Party)",
"usageType": "Number of Calls",
"bucketCounter": [
{
"counterType": "used",
"valueName": "Calls",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 0,
"units": ""
},
"@type": "UnitsUsed"
},
{
"counterType": "allocated",
"valueName": "Calls",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 999999999999,
"units": ""
},
"@type": "UnitsAllocated"
},
{
"counterType": "carried",
"valueName": "Calls",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 0,
"units": ""
},
"@type": "UnitsCarriedOver"
}
],
"remainingValue": {
"amount": 999999999999,
"units": ""
},
"validFor": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
}
},
{
"id": "1",
"isShared": false,
"name": "Anytime Anywhere - 1000MINs",
"usageType": "Duration",
"bucketCounter": [
{
"counterType": "used",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": ""
},
"value": {
"amount": 1.21,
"units": "MINS"
},
"@type": "UnitsUsed"
},
{
"counterType": "allocated",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": ""
},
"value": {
"amount": 1000.00,
"units": "MINS"
},
"@type": "UnitsAllocated"
},
{
"counterType": "carried",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": ""
},
"value": {
"amount": 990.15,
"units": "MINS"
},
"@type": "UnitsCarriedOver"
}
],
"remainingValue": {
"amount": 1988.54,
"units": "MINS"
},
"validFor": {
"endDateTime": ""
}
},
{
"id": "2",
"isShared": false,
"name": "Flow to Flow unlimited Mins",
"usageType": "Duration",
"bucketCounter": [
{
"counterType": "used",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": ""
},
"value": {
"amount": 0.00,
"units": "MINS"
},
"@type": "UnitsUsed"
},
{
"counterType": "allocated",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": ""
},
"value": {
"amount": 16666666666.39,
"units": "MINS"
},
"@type": "UnitsAllocated"
},
{
"counterType": "carried",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": ""
},
"value": {
"amount": 0.00,
"units": "MINS"
},
"@type": "UnitsCarriedOver"
}
],
"remainingValue": {
"amount": 16666666666.39,
"units": "MINS"
},
"validFor": {
"endDateTime": ""
}
},
{
"id": "4",
"isShared": false,
"name": "Local and HRR DATA (Flow)- 12GB",
"usageType": "Volume",
"bucketCounter": [
{
"counterType": "used",
"valueName": "Megabytes",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 631.19,
"units": "MBS"
},
"@type": "UnitsUsed"
},
{
"counterType": "allocated",
"valueName": "Megabytes",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 12288.00,
"units": "MBS"
},
"@type": "UnitsAllocated"
},
{
"counterType": "carried",
"valueName": "Megabytes",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 11244.14,
"units": "MBS"
},
"@type": "UnitsCarriedOver"
}
],
"remainingValue": {
"amount": 22900.95,
"units": "MBS"
},
"validFor": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
}
}
],
"logicalResource": [
{
"id": "4933562",
"@type": "MSISDN"
}
],
"@type": "usageConsumption"
},
{
"id": "MB-D-7GB",
"bucketRefOrValue": [
{
"id": "1",
"isShared": false,
"name": "MOBILE DATA 7GB",
"usageType": "Volume",
"bucketCounter": [
{
"counterType": "used",
"valueName": "Airtime Minutes",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 0,
"units": "MINS"
},
"@type": "UnitsUsed"
},
{
"counterType": "allocated",
"valueName": "Airtime Minutes",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 0,
"units": "MINS"
},
"@type": "UnitsAllocated"
},
{
"counterType": "carried",
"valueName": "Airtime Minutes",
"consumptionPeriod": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
},
"value": {
"amount": 0,
"units": "MINS"
},
"@type": "UnitsCarriedOver"
}
],
"remainingValue": {
"amount": 0,
"units": "MINS"
},
"validFor": {
"endDateTime": "2021-02-28T00:00:00.000-04:00"
}
}
],
"logicalResource": [
{
"id": "4933562",
"@type": "MSISDN"
}
],
"@type": "usageConsumption"
},
{
"bucketRefOrValue": [
{
"name": "internet",
"description": "Mobile Internet",
"remainingValueName": "Mobile Internet",
"status": "active",
"usageType": "Internet",
"remainingValue": {
"amount": 31.28,
"units": "GB"
},
"validFor": {
"endDateTime": "2023-10-28T00:00:00.000-04:00"
}
}
],
"logicalResource": [
{
"id": "17844933562",
"@type": "MSISDN"
}
],
"@type": "UsageConsumption"
}
]
}
]CWC/BTC Cerillion Success Response
[
{
"id": "",
"queryUsageConsumptionDate": "2023-10-04T14:23:39.532-04:00",
"searchCriteria": {
"service": [
{
"id": "2466217773",
"@type": "POSTPAID"
}
]
},
"relatedParty": [
{
"id": "70006464",
"@type": "BillingAccount"
}
],
"usageConsumption": [
{
"bucketRefOrValue": [
{
"id": "",
"isShared": false,
"name": "2 Free Directory Enquiries",
"bucketCounter": [
{
"counterType": "used",
"valueName": "SMS",
"consumptionPeriod": {
"endDateTime": "2023-06-30T00:00:00.000-04:00",
"startDateTime": "2023-06-01T00:00:00.000-04:00"
},
"value": {
"amount": 0,
"units": "SMS"
}
},
{
"counterType": "carried",
"valueName": "SMS",
"consumptionPeriod": {
"endDateTime": "2023-06-30T00:00:00.000-04:00",
"startDateTime": "2023-06-01T00:00:00.000-04:00"
},
"value": {
"amount": 0,
"units": "SMS"
}
},
{
"counterType": "allocated",
"valueName": "SMS",
"consumptionPeriod": {
"endDateTime": "2023-06-30T00:00:00.000-04:00",
"startDateTime": "2023-06-01T00:00:00.000-04:00"
},
"value": {
"amount": 2,
"units": "SMS"
}
},
{
"counterType": "expiring",
"valueName": "SMS",
"consumptionPeriod": {
"endDateTime": "2023-06-30T00:00:00.000-04:00",
"startDateTime": "2023-06-01T00:00:00.000-04:00"
},
"value": {
"amount": 2,
"units": "SMS"
}
}
],
"remainingValue": {
"amount": 2,
"units": "SMS"
},
"validFor": {
"endDateTime": "2023-06-30T00:00:00.000-04:00",
"startDateTime": "2023-06-01T00:00:00.000-04:00"
}
}
],
"logicalResource": [
{
"id": "2466217773",
"@type": "MSISDN"
}
],
"@type": "usageConsumption"
},
{
"bucketRefOrValue": [
{
"name": "internet",
"description": "Mobile Internet",
"remainingValueName": "Mobile Internet",
"status": "active",
"usageType": "Internet",
"remainingValue": {
"amount": 31.28,
"units": "GB"
},
"validFor": {
"endDateTime": "2023-10-28T00:00:00.000-04:00"
}
}
],
"logicalResource": [
{
"id": "12466217773",
"@type": "MSISDN"
}
],
"@type": "UsageConsumption"
}
]
}
]CWC Limeware Success Response
[
{
"id": "",
"queryUsageConsumptionDate": "2023-10-30T10:26:59.132-05:00",
"searchCriteria": {
"service": [
{
"id": "18767911940",
"@type": "PREPAID"
}
]
},
"usageConsumption": [
{
"bucketRefOrValue": [
{
"name": "Social Media",
"description": "Social Media",
"remainingValueName": "Social Media",
"status": "active",
"usageType": "Social Media",
"remainingValue": {
"amount": 10.00,
"units": "GB"
},
"validFor": {
"endDateTime": "2023-11-03T12:00:14.000-05:00"
}
},
{
"name": "Spotify",
"description": "Spotify",
"remainingValueName": "Spotify",
"status": "active",
"usageType": "Internet",
"remainingValue": {
"amount": 2.50,
"units": "GB"
},
"validFor": {
"endDateTime": "2023-11-03T12:00:14.000-05:00"
}
},
{
"name": "local Text",
"description": "Local Text",
"remainingValueName": "Local Text",
"status": "active",
"usageType": "Sms",
"remainingValue": {
"amount": 200,
"units": "SMS"
},
"validFor": {
"endDateTime": "2023-11-03T12:00:14.000-05:00"
}
},
{
"name": "Intl",
"description": "USA Intl Mins",
"remainingValueName": "USA Intl Mins",
"status": "active",
"usageType": "Voice",
"remainingValue": {
"amount": 25,
"units": "mins"
},
"validFor": {
"endDateTime": "2023-11-03T12:00:14.000-05:00"
}
},
{
"name": "not displayed",
"description": "not displayed",
"remainingValueName": "not displayed",
"status": "active",
"usageType": "Internet",
"remainingValue": {
"amount": 30.00,
"units": "KB"
},
"validFor": {
"endDateTime": "2023-11-03T12:00:14.000-05:00"
}
},
{
"name": "Intl",
"description": "International Mins",
"remainingValueName": "International Mins",
"status": "active",
"usageType": "Voice",
"remainingValue": {
"amount": 1140,
"units": "mins"
},
"validFor": {
"endDateTime": "2023-11-16T13:06:14.000-05:00"
}
},
{
"name": "Core",
"description": "primaryBalance",
"remainingValueName": "primaryBalance",
"status": "active",
"usageType": "Core",
"remainingValue": {
"amount": 1814.94,
"units": "JMD"
},
"validFor": {
"endDateTime": "2023-12-04T12:00:11.000-05:00"
}
}
],
"logicalResource": [
{
"id": "18767911940",
"@type": "MSISDN"
}
],
"@type": "UsageConsumption"
}
]
}
]BTC Ericsson Success Response
[
{
"id": "",
"queryUsageConsumptionDate": "2023-11-21T08:16:42.226-05:00",
"searchCriteria": {
"service": [
{
"id": "12424495927",
"@type": "PREPAID"
}
]
},
"usageConsumption": [
{
"bucketRefOrValue": [
{
"id": "12424495927",
"isShared": true,
"name": "Core",
"usageType": "monetary",
"description": "Core monetary balance",
"remainingValueName": "33.9 BSD",
"remainingValue": {
"amount": 33.9,
"units": "BSD"
},
"validFor": {
"endDateTime": "2024-10-01T08:00:00.000-04:00"
},
"status": "Active"
},
{
"id": "1001",
"isShared": true,
"name": "Loan",
"usageType": "monetary",
"description": "Loan",
"remainingValueName": "0 BSD",
"remainingValue": {
"amount": 0,
"units": "BSD"
},
"validFor": {
"endDateTime": "9999-12-31T07:00:00.000-05:00"
},
"status": "Active"
}
],
"logicalResource": [
{
"id": "12424495927",
"@type": "MSISDN"
}
],
"@type": "usageConsumption"
}
]
}
]Definitions for CWC/BTC
| Name | Type | Description | M/O |
|---|---|---|---|
| id | string | 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 | O |
| href | string | 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 | O |
| queryUsageConsumptionDate | datetime | Date when the query was submitted | O |
| relatedParty | array | Reference and role of the related parties for which the usage consumption is requested | O |
| relatedParty.id | string | unique identifier | O |
| relatedParty.@type | string | When sub-classing, this defines the sub-class Extensible name | O |
| usageConsumption | array | Report with current counters and balances | O |
| usageConsumption.id | string | unique identifier | O |
| usageConsumption.description | string | Free short text describing the usage consumption content | O |
| usageConsumption.name | string | Usage consumption name | O |
| usageConsumption.bucketRefOrValue | array | Bucket(s) included in the offer or option subscribed. | O |
| usageConsumption.bucketRefOrValue.id | string | Unique Identifier within the server for the bucket | O |
| usageConsumption.bucketRefOrValue.href | string | A resource URI pointing to the resource in the OB that stores the detailed information for the bucket | O |
| usageConsumption.bucketRefOrValue.description | string | Text describing the contents of the balance managed by the bucket | O |
| usageConsumption.bucketRefOrValue.isShared | boolean | True if the bucket is shared between several devices or users | O |
| usageConsumption.bucketRefOrValue.name | string | Friendly name to identify the bucket | O |
| usageConsumption.bucketRefOrValue.remainingValueName | string | Remaining amount 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 | O |
| usageConsumption.bucketRefOrValue.status | string | status for the bucket. active, expired, suspended | O |
| usageConsumption.bucketRefOrValue.usageType | string | defines the type of the underlying Balance eg data,voice, any currency eg EUR, USD etc | O |
| usageConsumption.bucketRefOrValue.bucketCounter | array | The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket. | O |
| usageConsumption.bucketRefOrValue.bucketCounter.id | string | unique identifier | O |
| usageConsumption.bucketRefOrValue.bucketCounter.href | string | Hyperlink reference | O |
| usageConsumption.bucketRefOrValue.bucketCounter.counterType | string | 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) | O |
| usageConsumption.bucketRefOrValue.bucketCounter.level | string | 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 | O |
| usageConsumption.bucketRefOrValue.bucketCounter.valueName | string | Value of the counter in a formatted string used for display needs for example | O |
| usageConsumption.bucketRefOrValue.bucketCounter.consumptionPeriod | object | 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. | O |
| usageConsumption.bucketRefOrValue.bucketCounter.consumptionPeriod.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | O |
| usageConsumption.bucketRefOrValue.bucketCounter.value | object | Numeric value of the bucket counter in a given unit | O |
| usageConsumption.bucketRefOrValue.bucketCounter.value.amount | number | Numeric value in a given unit | O |
| usageConsumption.bucketRefOrValue.bucketCounter.value.units | string | unit | O |
| usageConsumption.bucketRefOrValue.bucketCounter.@baseType | string | When sub-classing, this defines the super-class | O |
| usageConsumption.bucketRefOrValue.bucketCounter.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | O |
| usageConsumption.bucketRefOrValue.bucketCounter.@type | string | When sub-classing, this defines the sub-class Extensible name | O |
| usageConsumption.bucketRefOrValue.logicalResource | array | reference to the LogicalResource eg MSISDN | O |
| usageConsumption.bucketRefOrValue.logicalResource.id | string | unique identifier | O |
| usageConsumption.bucketRefOrValue.logicalResource.@type | string | When sub-classing, this defines the sub-class Extensible name | O |
| usageConsumption.bucketRefOrValue.remainingValue | object | Indicate the amount on the bucket | O |
| usageConsumption.bucketRefOrValue.remainingValue.amount | number | Numeric value in a given unit | O |
| usageConsumption.bucketRefOrValue.remainingValue.units | string | unit | O |
| usageConsumption.bucketRefOrValue.validFor | object | The period for which the balance in the bucket is valid | O |
| usageConsumption.bucketRefOrValue.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | O |
| usageConsumption.@type | string | When sub-classing, this defines the sub-class Extensible name | O |
Possible response error
HTTP Status response is 400
with Response
[ 400 ]
Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
{
"errors" : [{
"code" : 400 ,
"message" : "The request is invalid or not properly formed.",
"description" : "The client sent too many requests and server is not able to serve them all at the moment"
}
]
}
[ 401 ]
Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.
{
"errors" : [{
"code" : 401,
"message" : "The user could not be authenticated for this request.",
"description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
]
}[ 403 ]
Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.
[ 404 ]
Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.
{
"errors" : [{
"code" : 404,
"message" : "The request is invalid or not properly formed.",
"description" : "The requested operation failed because a resource associated with the request could not be found."
}
]
}[ 405 ]
Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
{
"errors": [{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method post not allowed for : /tmf-api/usageConsumption/v3/{businessId}/usageConsumptionReport
}]
}[ 500 ]
Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.
{
"errors" : [{
"code" : 500,
"message" : "The request failed due to an internal error.",
"description": "error description"
}
]
}[ 501 ]
Check for the other BU Flows, if not implemented then throw a standard error message as below.
{
"errors" : [{
"code" : 501,
"message" : "Not implemented",
"description" : "Operation GET /usageConsumptionReport for Business Id: CL not implemented"
}]
}
[ 503 ]
Service Unavailable
{
"errors": [
{
"code": 503,
"message": "HTTP:SERVICE_UNAVAILABLE",
"description": "HTTP POST on resource 'http://0.0.0.0:9091/tmf-api/usageConsumption/v3/{businessId}/usageConsumptionReport' failed: service unavailable (503)."
}
]
}