Open APIs

Expand all | Collapse all

TMF647 Address API REST Specification R16.0.1

  • 1.  TMF647 Address API REST Specification R16.0.1

    TM Forum Member
    Posted 18 days ago
    Hello All, I found that in this specification a "street" type address format is mentioned, this being one of the many possible ones. At least in my country there are many other formats where the determinant is not the street but another group of variables, for example: neighborhood, block, building, staircase, door (just to mention a possible variant of the "n" that there are and keep appearing). I can't imagine how to solve that with this API.


    ------------------------------
    Andrés Contona
    Telefonica Moviles Argentina
    ------------------------------


  • 2.  RE: TMF647 Address API REST Specification R16.0.1

    TM Forum Member
    Posted 18 days ago
    Hi Andrés

    TMF647 has been effectively replaced by newer, more focused APIs:
    * TMF673 - Geographical Address Management
    * TMF674 - Geographical Site Management
    * TMF675 - Geographical Location Management
    I suggest you take a look at these and see if they can assist you.
    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: TMF647 Address API REST Specification R16.0.1

    TM Forum Member
    Posted 13 days ago
    Thanks to you all! I'll ckeck those options and documentation. For us, street format is the "sunny day" format, but there are many more...
    :)

    ------------------------------
    Andrés Contona
    Telefonica Moviles Argentina
    ------------------------------



  • 4.  RE: TMF647 Address API REST Specification R16.0.1

    TM Forum Member
    Posted 18 days ago
    Hi Andres,

    If you don't find an appropriate placeholder in the TMF Original object, then you can extend the model to include additional properties.

    ExtendedAddress:
        title: ExtendedAddress
        allOf: # Combines the main `Address` schema with `ExtendedAddress`-specific properties 
            - $ref: '#/definition/Address'
            - type: object
              # all other properties specific to your `ExtendedAddress`
              properties:
                neighborhood:
                  type: string
                block:
                  type: string
                staircase:
                  type: string​

    Then you can give a reference to your extended model as below:
    "@baseType": "Address",
    "@schemaLocation": "https://{openapidocument_location}#//definition/Address",
    "@type": "ExtendedAddress"​


    Note: This is an opinion based on my research and not an official TMF response.


    ------------------------------
    Aneesh Damodaran
    BT Group plc
    ------------------------------



  • 5.  RE: TMF647 Address API REST Specification R16.0.1

    TM Forum Member
    Posted 18 days ago
    Hi Andres,

    If you are not finding an approapriate placeholder for your model properties then you are extend the base TMF model to include additional properties, like:
    ExtendedAddress:
        title: ExtendedAddress
        allOf: # Combines the main `Address` schema with `ExtendedAddress`-specific properties 
            - $ref: '#/definition/Address'
            - type: object
              # all other properties specific to your `ExtendedAddress`
              properties:
                neighborhood:
                  type: string
                block:
                  type: string
                staircase:
                  type: string​

    then you can give reference to the extended model as below:

    "@baseType": "Address",
    "@schemaLocation": "https://{openapidocument_location}#//definition/Address",
    "@type": "ExtendedAddress"​


    ------------------------------
    Aneesh Damodaran
    BT Group plc
    ------------------------------



  • 6.  RE: TMF647 Address API REST Specification R16.0.1

    TM Forum Member
    Posted 13 days ago
    Thanks!

    ------------------------------
    Andrés Contona
    Telefonica Moviles Argentina
    ------------------------------