Open APIs

Expand all | Collapse all

TMF-673 (API Place - GeographicAddress) : Postcode based search

  • 1.  TMF-673 (API Place - GeographicAddress) : Postcode based search

    TM Forum Member
    Posted Mar 31, 2021 14:50
    Hello,

    I am looking at TMF-673 (API Place - GeographicAddress) to get the list of addresses based on Postcode search.

    Method: GET
    URI: /geographicAddress

    I understand from the TMF documentation that there is 'fullText' search capability which could be used for such Post code searches.

    Could you suggest if I am on right path to use TMF Open API to meet the requirement? In future, if we would like to also extend few more fields like flat number, etc along with Postcode for address search, will this option be extensible?

    Also, could you help me with a sample / reference on how to use fullText capability please?

    Regards
    Anitha

    ------------------------------
    Anitha G
    Vodafone UK Ltd
    ------------------------------


  • 2.  RE: TMF-673 (API Place - GeographicAddress) : Postcode based search

    TM Forum Member
    Posted Apr 01, 2021 04:07
    Hi Anitha,

    Please be sure to use v4.0.0 of the TMF673.
    This has 3 different resources:
    • GeographicAddress: this is a structured model that models the "public domain" part of the address. In principle you can implement a filtering on Postcode when searching for this
    • GeographicSubAddress: this is a structured model for the "private domain" part of the address. This model has the extra fields like flat numbers that you require.
    • GeographicAddressValidation: this is a validation task that can be used to implement to validate and correct input data.

    Address validation can be a complex process and the actual implementation is not defined by the API.

    You can definitely implement fullText searches yourselve using a full text search engine such as ElasticSearch. For fixed networking this can be implemented on top of a GIS systems that documents the fiber/copper infrastructure.

    For mobile networking, addresses are probably only relevant for billing. In that case you could implement the OpenAPI on top of a commercial address provider in order to outsource the burden of maintaining the address database. The use of the OpenAPI enables you to decouple your applications for the provider and will make it easier to change address provider.

    Regards



    ------------------------------
    Koen Peeters
    Ciminko Luxembourg
    ------------------------------



  • 3.  RE: TMF-673 (API Place - GeographicAddress) : Postcode based search

    TM Forum Member
    Posted Apr 14, 2021 01:58

    Hi @Anitha G
    I think a simple search by postal code should be possible without a fulltext search. Simply by using a filter.

    GET https://server/tmf-api/geographicAddressManagement/v4/geographicAddress?postcode=0815

    should return a collection of all geographic addresses with the postal code 0815.​

    I think the GeographicAddress schema is pretty complete and it has almost all required fields, apart from country-specific aspects.

    Cheers,

    Jan



    ------------------------------
    Jan Lemmermann
    OSS Lead Architect
    EWE TEL GmbH
    ------------------------------



  • 4.  RE: TMF-673 (API Place - GeographicAddress) : Postcode based search

    TM Forum Member
    Posted Apr 14, 2021 08:10
    Thank you @Koen Peeters and @Jan Lemmermann ! Filters are right fit here.  ​​​​

    ------------------------------
    Anitha G
    Vodafone UK Ltd
    ------------------------------