Open APIs

TMF654 - Bucket GET API - Missing Non-Monetary Representation

  • 1.  TMF654 - Bucket GET API - Missing Non-Monetary Representation

    TM Forum Member
    Posted 11 days ago
    Hello Experts,

    This query is related to Bucket GET API in TMF654 Prepay Balance Management.

    API User Guide has samples contradicting UML design
    List Bucket samples project non-monetary usageType buckets like DATA, VOICE included under bucketBalance property of Bucket Resources
    However, as per UML design, there is no field as bucketBalance

    I suppose the expectation should be -
    1. Each monetary and non-monetary resource is an independent Bucket and must be treated same.
    For example, given a Voice Product having 100 Free Minutes and 1 INR/minute usage charge, GET BUCKET API should return 2 BUCKETS
    [
        {
            "id""11",
            "usageType""monetary",
            "remainingValue": {
                "amount"0,
                "units""INR"
            },
            ...
        },
        {
            "id""12",
            "usageType""voice",
            "remainingValue": {
                "amount"100,
                "units""minutes"
            },
            ...
        }
    ]

    2. Specs / UserGuide should be updated to remove bucketBalance from samples and include a sample object representing a non-monetary resource from the same product/partyAccount

    Kindly share your inputs on the same.

    Thanks.

    ------------------------------
    Karan Agrawal
    Oracle Corporation
    ------------------------------