Open APIs

 View Only
  • 1.  External id in TMF666 AccountManagement API

    TM Forum Member
    Posted Aug 05, 2022 10:05
    Hi,
    I am working on aligning BillingAccount of our product to TMF666 AccountManagement API. There are external ids & types against Billing Account stored in our system which provides reference to corresponding entities in external systems. I tried to map them to fields of TMF666 but could not find.

    1) Should I included these fields as extension of BillingAccount?
    2) Can I map them either to RelatedParty or accountRelationship?

    Please advice

    ------------------------------
    Javed
    ------------------------------


  • 2.  RE: External id in TMF666 AccountManagement API

    TM Forum Member
    Posted Aug 11, 2022 11:40
    Looks like a good candidate for an enhancement to the standard. But depending on what the nature is of the external entities, relatedparty might be a better fit.

    ------------------------------
    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: External id in TMF666 AccountManagement API

    TM Forum Member
    Posted Aug 11, 2022 12:06
    Thanks Jonathan for your response. The external entities are billing accounts in external systems, so will RelatedParty fit here? (The external entity is not a person)

    ------------------------------
    Javed
    ------------------------------



  • 4.  RE: External id in TMF666 AccountManagement API

    TM Forum Member
    Posted Aug 12, 2022 09:16
    Some times we use structure as follow:
    externalReference { [
        {
             externalSystemId = <name of the external system>
             externalId = <corresponding system Id>
         },
         {
          .....
          }
    ] }

    In some cases you may have several systems where the same information is stored with different Ids.
    Hope that helps.


    ------------------------------
    Igor Dubrovin
    Bell Canada
    ------------------------------



  • 5.  RE: External id in TMF666 AccountManagement API

    TM Forum Member
    Posted Aug 15, 2022 19:03
    Thanks a lot Igor. That will work in our case as well. So this is an extension to the BillingAccount resource as pointed by Jonathan.

    ------------------------------
    Abdul Javed
    ------------------------------



  • 6.  RE: External id in TMF666 AccountManagement API

    TM Forum Member
    Posted Aug 17, 2022 03:49
    We have a new ExternalIdentification resource designed specifically for these use cases, it has started to appear in published APIs.
    I dismally failed to upload the schema (even after changing the extension), so copying the content here:
    {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "$id": "ExternalIdentifier.schema.json",
        "title": "ExternalIdentifier",
        "definitions": {
            "ExternalIdentifier": {
                "$id": "#ExternalIdentifier",
                "description": "An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list.",
                "type": "object",
                "required": [
                    "id"
                ],
                "properties": {
                     "owner": {
                        "type": "string",
                        "description": "Name of the external system that owns the entity.",
                        "examples": [
                            "MagentoCommerce"
                        ]
                     },
                     "externalIdentifierType": {
                        "type": "string",
                        "description": "Type of the identification, typically would be the type of the entity within the external system",
                        "examples": [
                            "ProductOrder"
                        ]
                     },
                     "id": {
                        "type": "string",
                        "description": "identification of the entity within the external system.",
                        "examples": [
                            "MC2255771199555"
                        ]
                    }
                }
            }
        }
    }​


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



  • 7.  RE: External id in TMF666 AccountManagement API

    TM Forum Member
    Posted Aug 17, 2022 09:54
    Thank you Jonathan. That looks good. Technically we can extend any object.

    ------------------------------
    Igor Dubrovin
    Bell Canada
    ------------------------------



  • 8.  RE: External id in TMF666 AccountManagement API

    TM Forum Member
    Posted 29 days ago
    Thanks Jonathan. Would it also help if we add TimePeriod (From date / To Date) in this object?

    ------------------------------
    Abdul Javed
    ------------------------------