TM Forum Community

 View Only

  • 1.  TMF673 - Geographicsubaddress

    TM Forum Member
    Posted Aug 06, 2023 12:40

    Hi,

    We are implementing TMF673 for address search and validation.

    What would be the valid API response structure for returning geographic sub addresses as per TMF?

    1. GeographicAddress object and an array of nested GeographicSubAddress objects
    GeographicAddres{
    id:"",
    suburb:"",
    ........
    .........
     
    GeographicSubaddress1{},
    GeographicSubaddress2{},
    ................
    ................
    }

         2. Array of GeographicAddress objects with nested GeographicSubAddress object

    {
     
    GeographicAddres1{
    id:"",
    suburb:"",
    ........
    .........
     
    GeographicSubaddress1{},
    ................
    ................
    },
     
    GeographicAddres2{
    id:"",
    suburb:"",
    ........
    .........
     
    GeographicSubaddress2{},
    ................
    ................
    }
    }


    #General

    ------------------------------
    Rajesh Devineni
    SingTel Optus
    ------------------------------



  • 2.  RE: TMF673 - Geographicsubaddress

    TM Forum Member
    Posted Aug 06, 2023 15:01

    Hi Rajesh

    In the GeographicAddress model, the address contains an array of sub-addresses. So you will always need to return an array of sub-addresses syntactically. The question is, depending on your internal implementation of the API, do you practically speaking allow one sub-address or multiple sub-addresses for the same address.

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

    Original Message


  • 3.  RE: TMF673 - Geographicsubaddress

    TM Forum Member
    Posted Aug 10, 2023 04:55

    Hi @Jonathan Goldberg, 

    Sending this message on behalf of @Rajesh Devineni as he is somehow not able to put a public reply. 

    Thanks for your feedback. Let us explain the scenario and use case just to be clear on the ask.  

    We are referring TMF673 Version 4.1.0 Release 21.5.0,September 2021.

    We're seeking to return a single GeographicAddress object for each sub-address. ExternalIdentifiers in our use case are populated and available at sub-address level. 

    Example of our requirements:

    Consider Street Address : 271 Collins Street, Melbourne, 3000

    It has Sub-addresses for each unit level : Unit1 to 10

    Each subaddress has external identifiers referred to by different external applications.

    So from model perspective, we plan to return subaddress details as an array under GeographicAccess, however, only one GeographicSubAddress object would be populated in the array.

    We are thinking to populate response as below for the above example of requirements when address search is performed by street address.

    [

    GeographicAddress

    {

    271 Collins Street, Melbourne

    ExternalIdentifier[{}],

    GeographicSubAddress [

     {

          Unit 1

     }

    ]

    },

    GeographicAddress

    {

    271 Collins Street, Melbourne

    ExternalIdentifier[{}],

    GeographicSubAddress [

     {

          Unit 2

     }

    ]

    },

    GeographicAddress

    {

    271 Collins Street, Melbourne

    ExternalIdentifier[{}],

    GeographicSubAddress [

     {

          Unit 3

     }

    ]

    }

    ]

    We could see following benefits:

    • For each address, we just refer to the single consistent identifier at the GeographicAddress Level (client doesn't need to understand whether they refer to geographicAddress level or geographicSubAddress level).
    • Response structure will allow us to tag externalIdentifiers at subAddress level.

    As per MEF121 Address Search specification, GeographicSubAddress is returned as 1-1 with GeographicAddress, there is no Array of sub-addresses. This response structure will allow us to tag externalidentifiers at subaddress level. Do you see any issue in populating response in this fashion?




    ------------------------------
    Anuraag Gupta
    SingTel Optus
    ------------------------------

    Original Message


  • 4.  RE: TMF673 - Geographicsubaddress

    TM Forum Member
    Posted Aug 21, 2023 05:04

    Hi @Jonathan Goldberg

    Can you pls provide assistance to validate our usage of TMF673 API. 

    Regards

    Anuraag 



    ------------------------------
    Anuraag Gupta
    Amdocs Management Limited
    ------------------------------

    Original Message


  • 5.  RE: TMF673 - Geographicsubaddress

    TM Forum Member
    Posted Nov 14, 2023 05:01

    Hi Anuraag

    Apologies for the late response.

    If it's still relevant, I repeat my earlier response that you have to ensure that your returned structure is syntactically correct with respect to TMF673 published swagger file. This means that the sub-address needs to be represented as an array with [ { } ], even if in practice there is only one array element.



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