Open APIs

Expand all | Collapse all

Event Notification Structure

  • 1.  Event Notification Structure

    TM Forum Member
    Posted Oct 27, 2020 11:14
    Hi All,

    We are implementing a TMF Open API (TMF655). In the first release, only notification operation to be implemented. As per API specification, the notification should have below payload and hence will contain entire resource payload.
    {
    "eventId": "00005",
    "eventTime": "2016-03-02T16:42:25",
    "eventType": " ChangeRequestAttributeValueChangeNotificationNotification",
    "event": {
    "ChangeRequest": {-- SEE ChangeRequest RESOURCE SAMPLE --}
    }
    }
    In our case, as the notifications are being sent to customers we want to suppress some of the mandatory elements is API data model like specification, targetEntity etc. Is this acceptable?

    Thanks,

    ------------------------------
    Kalpana HV
    Colt Technology Services
    ------------------------------


  • 2.  RE: Event Notification Structure

    TM Forum Member
    Posted Oct 27, 2020 12:15
    Hi Kalpana
    The event structure defines the contents of the event from the point of view of the event provider (typically this will be the same software module implementing the API that specified the event).
    It seems to me very unlikely that the event will be read as-is to a human customer. Humans can read JSON, but I suspect that your average Jane Doe will say Huh? to a JSON document even if all the "technical" fields were suppressed. Surely you will have some sort of software (middleware) that will translate the raw event contents into some friendly human-readable form, and this would also remove the non-needed elements.
    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: Event Notification Structure

    TM Forum Member
    Posted Oct 28, 2020 06:28
    Thank you @Jonathan Goldberg for the response. Customer in the sense clients of our organisation. I think, I should have used the term client/partner instead of customer. As these notifications to be sent to clients, we want to suppress the elements in notification structure. ​Would that be acceptable and still be conformed to Open API guidelines.

    Best regards,

    ------------------------------
    Kalpana HV
    Colt Technology Services
    ------------------------------