Open APIs

Expand all | Collapse all

How to send response to API notifications

  • 1.  How to send response to API notifications

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

    We have a requirement where API notifications to be sent to customers and  an option to be given to customers to provide feedback on the notification. Would like to know forum's recommendation for accepting customer's feedback for notification message.

    Thanks,


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


  • 2.  RE: How to send response to API notifications

    TM Forum Member
    Posted Oct 27, 2020 12:17
    Hi Kalpana
    It would help if you could give a concrete business example for this interaction, with realistic names for the customer, the content of the notification, and what type of feedback you expect the customer to give.
    I guess the community will be able to advise you more easily once concrete use cases are on the table.

    ------------------------------
    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: How to send response to API notifications

    TM Forum Member
    Posted Oct 28, 2020 06:53
    The API under discussion is Change Management API. As a network service provider, we will be to notifying customers like Microsoft on the planned outages. We are planning to extend changeRequest notification resource model as below:
    But, we don't want to send "specification" field to customer. But "specification" is a mandatory field in ChangeRequest data model (As per Change Management API conformance document). Would it be OK if we remove the "specification" field in the notification payload to Microsoft.

    Best regards,

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



  • 4.  RE: How to send response to API notifications

    TM Forum Member
    Posted Oct 28, 2020 12:22
    Hi Kalpana

    See also the discussion on the other thread here.
    But as a general rule my opinion is that you should not modify event contents at source because you don't know (or sometimes even care) who is listening to the events.
    It's up to the listener to ignore fields that it does not need/understand.

    Why is there a problem sending the specification field - as I understand it it's just an entity ref with opaque IDs.

    ------------------------------
    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.
    ------------------------------



  • 5.  RE: How to send response to API notifications

    TM Forum Member
    Posted Oct 28, 2020 13:00
    Thank you @Jonathan Goldberg for the response. Its related to the same requirement. Customer is asking there should be a way to indicate their acceptance and their preferred date with respect to the "plannedStartdate". So, if possible, we could reschedule. How to accept such responses for notifications.

    Thanks,
    ​​

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