Open APIs

Expand all | Collapse all

TMF645 -Service Qualification API 18.05

  • 1.  TMF645 -Service Qualification API 18.05

    TM Forum Member
    Posted 15 days ago

    Hi,

    Which endpoints from TMF645 -Service Qualification API 18.05 to use  :

    1. To query the list of services available/serviceable at a given geographic address. Will this  GET /serviceQualification??serviceQualificationItem.service.place.id=XXXX, where place.is is the geographic address id .

    2.To query if certain service is available at a certain address.?

    Best,

    Isha



    ------------------------------
    Isha Khowala
    IBM Corporation
    ------------------------------


  • 2.  RE: TMF645 -Service Qualification API 18.05

    TM Forum Member
    Posted 14 days ago
    Hello Isha,

    You can probably take a look on the v4.0 version available for a couple of months.
    We improved this API by splitting in 2 resources:
    • CheckServiceQualification allows to specify (precisly) service with configuration (characteristic), place (location), date and get in response a qualification result but also unavailability reason and alternate (if requested service not qualified). I will use this API if I want to check if a Fiber access service is available at 1 Main street in Paris, 75001, France for Nov 21th.  This probably cover your point 2.
    • QueryServiceQualifation allows to provide query parametes- for example a service category ad a place - and in the result you'll have the list of service available there (it is possible to provide service configuration detail). A empty list will be send is no service available (and this is is not an error). There is no qualification result,unavailability reason and alternate in the response. I will use for example to check which are the available "internet " service  (a service category) in a given address. This cover you point 1.

    It is probably easier to understand/implement with these 2 resources instead of using only one as in the 18.5.

    Hope it helps,

    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 3.  RE: TMF645 -Service Qualification API 18.05

    TM Forum Member
    Posted 14 days ago

    Hello Ludovic,

    Thanks for your response .

    For this point ->To query the list of all services available/serviceable at a given geographic address, suggestion is to use the QueryServiceQualifation resource. However I am bit not clear if we have to use the GET /queryServiceQualification?fields=...&{filtering}  or POST /queryServiceQualification .
    Can you please clarify ?

    Best,
    Isha



    ------------------------------
    Isha Khowala
    IBM Corporation
    ------------------------------



  • 4.  RE: TMF645 -Service Qualification API 18.05

    TM Forum Member
    Posted 14 days ago
    Isha,

    A POST. You are creating a resource to manage this qualification.
    GET is to retrieve previous qualification performed.

    Note that we provided alternative with 200 and/or 201 return code.
    Both are compliant. You can as a server get a POST:
    • answer directly without id (and not storing the resource and providing GET) - 200
    •  create a resource (with id & href) and providing GET - 201
    Hope it helps

    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------