Open APIs

Expand all | Collapse all

TMF678 for Bill Management

  • 1.  TMF678 for Bill Management

    TM Forum Member
    Posted Jul 28, 2021 01:26
    Can bill management API's return values by default ie no relevant request paramas passed via service. For instance getInvoiceImage service can they return the latest invoice always if there is no specific invoice id sent in the request. Are there any guideline in handling such requests ?

    ------------------------------
    Radhika Janarthanam
    Tata Consultancy Services
    ------------------------------


  • 2.  RE: TMF678 for Bill Management

    TM Forum Member
    Posted Jul 28, 2021 05:31

    Hi Radhika

    I understand your question to be a general question on the behaviour of the GET operation in TMF Open APIs, where no ID was specified (retrieve) and no filter criteria were specified.
    In this case, unless the specific API user guide/specification states differently, the entire population would be returned (subject to access privileges of the calling security principal). Of course these populations might be quite large for some entities (e.g. 10,000,000s for product inventory), so the output would be paged, as specified in the swagger for each Open API.

    It is possible that a specific implementation might take the view that an unfiltered GET is an illegal request, they would need to state that explicitly in their documentation.

    Hope it helps



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: TMF678 for Bill Management

    TM Forum Member
    Posted Jul 28, 2021 08:42
    Thanks Jonathan this helps

    ------------------------------
    Radhika Janarthanam
    Tata Consultancy Services
    ------------------------------



  • 4.  RE: TMF678 for Bill Management

    Posted Jul 29, 2021 02:07
    Hi Jonathan,

    Current standards completely leave it to the implementation of num. records returned in the response for GET (all)  without any query params.
    How about making it a standard as well with optional (or mandatory) params like limit, offset with some defaults for all GET  apis.

    Thoughts !!

    Thanks,
    Hanumantha.
    Open API Enthusiast.

    ------------------------------
    Hanumantha Marikanti
    Saralam Technologies
    ------------------------------



  • 5.  RE: TMF678 for Bill Management

    TM Forum Member
    Posted Jul 29, 2021 02:28
    Thanks for the suggestion
    I vaguely remember that I brought this up in the Open API team some years back, but nothing came of it.
    Anyway if you are a member of the Open API project you could open a JIRA CR to suggest this.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------