Open APIs

 View Only
  • 1.  TMF679: Error handling

    Posted Jun 14, 2022 14:40
    Hello,

    I needed to apply business validations and accordingly return application error codes and message in the response to ProductOfferingQualification request.
    I can find as per TMF630 API design guidelines, the errors can be returned in below format-
    400 Bad Request
    Content-type:application/json
    {
    "code": "ERR001",
    "reason": "Missing mandatory field",
    "message": "Please provide an Authorisation header"
    }
    But, in the TMF-679 specification, it mentions about sending the response with setting productOfferingQualificationItem.terminationError with id and value. Eg-
     "terminationError": [
               {
                  "id": "ERR001",
                  "value": "Missing mandatory field"
                }
           ]
    Is it mandatory to use the terminationError for this purpose or we can simply send failure response as defined in TMF630? The issue with TerminationError is that in that case we may need to generate full response body structure but many details may be missing as the request itself might not have all details (leading to validation failure).



    ------------------------------
    Paras Agrawal
    Infosys
    ------------------------------