Open APIs

Expand all | Collapse all

TMF Standard returning Multiple Errors (TMF622)

  • 1.  TMF Standard returning Multiple Errors (TMF622)

    TM Forum Member
    Posted 21 days ago
    Hi Team,

    I want to know if TMF Standard supports returning multiple error codes/message in form of array in the Synchronous Response.

    I am using TMF622 for handling Product Order, there are set of Business Validation that I need to perform before placing the Order. My requirement is perform all the validates in one go and return all errors encounters back to the user in 1 single response. So, that User can fix/correct all issue together and repost a error free request. Does TMF Standard support this feature of sending back multiple errors in form on array/occurrence. I have been to the standard guideline of TMF630 & also read through TMF622 but I did not find anything mentioned for this. Can you please assist.

    Example :

    400 Bad Request

    {

          "code": "ERR001",

          "reason": "Missing mandatory field",

          "message": "Please provide and Authorisation header"

          "code1": "<Code1>",

          "reason1": "<reason1>",

          "message1": "<message1>"

        ......

    }

    ------------------------------
    Princy Rodrigues
    BT Group plc
    ------------------------------


  • 2.  RE: TMF Standard returning Multiple Errors (TMF622)

    TM Forum Member
    Posted 20 days ago
    Hi Princy

    Currently the general Error structure is returned as a payload ​for all non-success HTTP statuses (as you can see from the Open API swagger files). But this is a single structure, not an array.
    Specifically for orders, we have started to introduce a new pattern, whereby the order structure itself will include a list of errors. This will probably answer your use case.
    It is being done initially for Service Order (TMF641), presumably it will eventually reach Product and Resource Order as well. If you want to align your current implementation with the pattern, suggest you reach out to @Kamal Maghsoudlou to find out details of the change.
    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.
    ------------------------------