Open APIs

Hi Team,
We have a requirement where we will have multiple service consumers registering their hub endpoints.When sending notifications back to service consumers, how do we identify the right callback url to send notifications to the service consumers whose order changed state?
Do we need to make use of query parameter specified in /hub API specification & somehow tie the request to specific consumer to whom notification needs to be sent?
We are using TMF 641 specification.Probably use one of the key elements from service order payload that uniquely identifies the consumer & pass it as query parameter ,so it can be mapped back ?
Any input on this is greatly appreciated.

{
  "query": "query",
  "callback": "callback"
}

------------------------------
Reshmi G C
Cisco Systems
------------------------------

Hi Reshmi,

the best way is indeed to use properties on the ServiceOrder to specify the query part (filter) when creating the Hub. The best candidate would be the externalReference element using the externalReferenceType and name to identify the sending application. In this case, the correct hub will be selected and the correct callback will be invoked.
This is a sample hub that we use:
}

We are using TMF688 and thus TMF688 events.

Best regards,

------------------------------
Frederic Thise
Proximus SA
------------------------------

Original Message:
Sent: Oct 06, 2022 22:29
From: Reshmi G C
Subject: TMF 641 - Hub endpoint - Clarification on Query attribute

Hi Team,
We have a requirement where we will have multiple service consumers registering their hub endpoints.When sending notifications back to service consumers, how do we identify the right callback url to send notifications to the service consumers whose order changed state?
Do we need to make use of query parameter specified in /hub API specification & somehow tie the request to specific consumer to whom notification needs to be sent?
We are using TMF 641 specification.Probably use one of the key elements from service order payload that uniquely identifies the consumer & pass it as query parameter ,so it can be mapped back ?
Any input on this is greatly appreciated.

{  "query": "query",  "callback": "callback"}

------------------------------
Reshmi G C
Cisco Systems
------------------------------

Please see this similar post and my recent reply there. In general, going forward we recommend using the more robust ExternalIdentifier construct, that has started to appear in APIs. This includes the owner attribute, that would be mapped to the originating system/callback endpoint.

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

Original Message:
Sent: Oct 10, 2022 03:56
From: Frederic Thise
Subject: TMF 641 - Hub endpoint - Clarification on Query attribute

Hi Reshmi,

the best way is indeed to use properties on the ServiceOrder to specify the query part (filter) when creating the Hub. The best candidate would be the externalReference element using the externalReferenceType and name to identify the sending application. In this case, the correct hub will be selected and the correct callback will be invoked.
This is a sample hub that we use:

{

        "id": "XXX",

        "callback": "anyCallback",

        "query": "eventType=ServiceOrderXXXEvent&event.serviceOrder.externalReference.externalReferenceType=CallerApplicationId&event.serviceOrder.externalReference.name=ApplicationName"

}
The matching ServiceOrder would look like:

{
    "id": "XXX",

    "externalReference": [

        {

            "externalReferenceType": "CallerApplicationId",

            "name": "ApplicationName"

        }

    ],
    ...

}

We are using TMF688 and thus TMF688 events.

Best regards,

------------------------------
Frederic Thise
Proximus SA

Original Message:
Sent: Oct 06, 2022 22:29
From: Reshmi G C
Subject: TMF 641 - Hub endpoint - Clarification on Query attribute

Hi Team,
We have a requirement where we will have multiple service consumers registering their hub endpoints.When sending notifications back to service consumers, how do we identify the right callback url to send notifications to the service consumers whose order changed state?
Do we need to make use of query parameter specified in /hub API specification & somehow tie the request to specific consumer to whom notification needs to be sent?
We are using TMF 641 specification.Probably use one of the key elements from service order payload that uniquely identifies the consumer & pass it as query parameter ,so it can be mapped back ?
Any input on this is greatly appreciated.

{  "query": "query",  "callback": "callback"}

------------------------------
Reshmi G C
Cisco Systems
------------------------------