Open APIs

Expand all | Collapse all

Whether href is always a must?

  • 1.  Whether href is always a must?

    TM Forum Member
    Posted Oct 30, 2020 03:18
    Hi All,

    We are implementing Open APIs. In the first release, we will be sending only notification messages and CRUD operations are not implemented. But, "href" of resource is a mandatory field in resource model and hence to be sent in notification payload. As we have not implemented the GET operation on the resource, providing "href" would mislead the consumers. Hence, in this case, is it OK for notification messages for not to have the "href" field?

    Thanks,

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


  • 2.  RE: Whether href is always a must?

    TM Forum Member
    Posted Nov 01, 2020 01:10
    Hi Kalpana
    href is mandatory for entity messages since we assume that the messages relate to an accessible entity.

    If your circumstances are such that there is no accessible entity, perhaps consider returning (for the time being) a fixed uri that always gives a 404 HTTP return status or some other appropriate 4xx status.

    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: Whether href is always a must?

    TM Forum Member
    Posted 30 days ago
    Thank you @Jonathan Goldberg. It helps.

    Best regards,​

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