Open APIs

 View Only

  • 1.  Telco Use Case. What TMF API to use?

    Posted Jul 14, 2025 19:05

    Hi Team,

    I have the next use cases I want to know what TMF API use:

    1. Customer provides x,y address coordinates, What TMF API use to validate Address?  TMF 673?
    2. if customer does not have x,y address coordinates, is there any API to obtain the coordinates?  if not, how to validate that Address?
    3. After Address validation, we need to determine what  are the technologies available(geographical coverage) in that Address.  What API should I use in this case?

    Thansk for your help.

    Regards, Juan



    ------------------------------
    Juan Gallego
    Oracle Corporation
    ------------------------------


  • 2.  RE: Telco Use Case. What TMF API to use?

    Posted Jul 15, 2025 03:38

    Hi,

    for 1 and 2, you should be able to use TMF673

    for 3, use TMF645
    you can also look at TMF674, maybe it could help your use cases.

    you should definitely search these API numbers in the communities, we have many discussions on the topic of locations, addresses, technical capabilities.
    IG1228 describes use cases that also use Address APIs.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Digital Sales Domain Architect
    Lyse Tele AS
    ------------------------------

    Original Message


  • 3.  RE: Telco Use Case. What TMF API to use?

    Posted Jul 15, 2025 08:08

    Dear colleague, I hope the answer is helpful to you.

    ✅ 1. Customer provides x,y address coordinates: What TMF API to use to validate the address?

    Yes, TMF673 - Geographic Address Management API is the correct API.

    It allows you to validate, normalize, and verify postal addresses, including those that already include geographic coordinates (X, Y or lat/lon).

    It also supports searching for existing addresses by coordinates or by text.

    🔧 Example usage:

    GET /geographicAddress?geographicLocation.latitude=...&geographicLocation.longitude=...

    ---

    ✅ 2. If the customer does not have x,y address coordinates, is there any API to obtain them?

    TMF673 also covers this use case.

    When the customer provides a textual address (e.g., street, number, city), you can use TMF673 to:

    Validate if the address exists.

    Get its normalized format.

    Obtain its geographic coordinates (lat/lon) if available in the system.

    🔧 Example usage:

    GET /geographicAddress?streetNr=123&streetName=Main St&city=Buenos Aires

    ---

    ✅ 3. After address validation, determine what technologies (geographical coverage) are available at that address. What API should I use?

    This use case corresponds to:

    TMF645 - Service Qualification API

    TMF645 is used to determine whether a service or technology (e.g., fiber, 5G, copper) is available at a given location (address or coordinates).

    🔧 Typical usage:

    POST /serviceQualification

    {

      "address": {

        "id": "validAddressId" // Can come from TMF673

      },

      "serviceSpecification": {

        "id": "fiber-access" // Or the service type you want to check

      }

    }

    The response will include the services available at that address, along with technology type, speed, coverage, etc.

    ---

    🧩 Typical API flow:

    1. Customer provides address

    → Use TMF673 to validate and get coordinates.

    2. With valid coordinates or addressId

    → Use TMF645 to check which services are available at that location.



    ------------------------------
    Matias Ridelnik
    TO BE VERIFIED
    ------------------------------

    Original Message


  • 4.  RE: Telco Use Case. What TMF API to use?

    Posted Jul 15, 2025 11:09
    Edited by Juan Gallego Jul 15, 2025 11:48
    Thanks @Matthieu Hattab, @Matias Ridelnik for your help.  Very helpful your answers
    Only one question about your inputs:  If i need to determine the coverage for example in a system like Smallworld thats handles the outside plan, should I use the same API 645?
     
    Suppose that you have to different systems, one to handle outside plan inventory and the other to handle the inside plan.  After i determine the technology available in that location i need to reserve resources.  So, the idea is that the CRM sends a request to UIM(inside plan), UIM first reserves the resources in Smallworld(outside plan) and then UIM, based on the outside plan response, completes the reservation and sends the answer to CRM
     
    In this scenario:
     
    1. What TMF API should call CRM to reserve the resources?  TMF 638?
    2. The reservation between UIM and Smallworld should use the same TMF 638?
     
    Regards,
    Juan



    ------------------------------
    Juan Gallego
    Oracle Corporation
    ------------------------------

    Original Message


  • 5.  RE: Telco Use Case. What TMF API to use?

    Posted Jul 15, 2025 21:31

    Dear Juan,

    Based on the scenario you described - where CRM triggers a resource reservation process involving UIM (for inside plant) and Smallworld (for outside plant) - here's how the TM Forum APIs apply:

    ---

    1. What TMF API should CRM call to reserve the resources? TMF638?

    Yes, you are correct - TMF638: Resource Inventory Management API is the right choice if the CRM is interacting directly with UIM to query or reserve specific resources.

    However, if the CRM's intent is to request resource reservation as part of a service order process, a more appropriate and standardized approach would be to use:

    TMF641: Service Order Management API, where the service order includes resource requirements.

    Then internally, the service orchestration or UIM would use TMF638 to reserve the necessary physical or logical resources.

    So:

    If CRM is tightly coupled to the resource layer: TMF638 can be used directly.

    If CRM is service-oriented: prefer TMF641, and let the orchestration layer handle the TMF638 interaction.

    ---

    2. Should UIM use TMF638 to interact with Smallworld for outside plant reservation?

    Yes, TMF638 can also be used between UIM and Smallworld, as both systems manage different segments of the resource inventory.

    UIM (inside plant) can act as a client of TMF638 to query or reserve resources in Smallworld (outside plant).

    Smallworld would need to expose a TMF638-compliant interface that allows resource querying, checking availability, and reservation.

    -



    ------------------------------
    Matias Ridelnik
    ------------------------------

    Original Message


  • 6.  RE: Telco Use Case. What TMF API to use?

    Posted Jul 16, 2025 09:59

    Thanks @Matias Ridelnik for your response.  TMF638 is Service Inventory Management and not Resource Inventory Management as you mentioned.  At the end you are talking about 638, right?

    The other question that i have is, If I need to determine what technologies (geographical coverage) is present in a customer location and this is only and interaction between CRM and Smallworld, in this case Smallworld would need to expose a TMF645-compliant interface for this purpose, correct?

    Thanks for your help.



    ------------------------------
    Juan Gallego
    Oracle Corporation
    ------------------------------

    Original Message


  • 7.  RE: Telco Use Case. What TMF API to use?

    Posted Jul 16, 2025 13:48

    Welcome @Juan Gallego,

    You're absolutely right  TMF638 is Service Inventory Management; I meant TMF639 for Resource Inventory Management.

    And yes, if the CRM needs to check available technologies at a customer location and this is handled by Smallworld, then Smallworld should expose a TMF645-compliant interface (Service Qualification) to support that use case.



    ------------------------------
    Matias Ridelnik
    TO BE VERIFIED
    ------------------------------

    Original Message


  • 8.  RE: Telco Use Case. What TMF API to use?

    Posted Jul 16, 2025 21:34

    Hi @Matias Ridelnik,  

    I have my doubts about using TMF 639 for reservations, based on what I've read. Have you implemented it for reservations? What are your thoughts on TMF 716 and 638?



    ------------------------------
    Juan Gallego
    Oracle Corporation
    ------------------------------

    Original Message


Related Content