Open APIs

Expand all | Collapse all

Open API for Pin Reset/ setup box config

  • 1.  Open API for Pin Reset/ setup box config

    TM Forum Member
    Posted May 13, 2019 08:58
    Edited by Suman Bagde May 14, 2019 06:49
    Hi All,

    What API should be used for the following?
    1. Resetting a customer's smart card pin. Request will include the smart card details like id etc.
    2. Refreshing/resetting customer's settop box?

    Basically performing some operation on customer device. I am unclear which API can be used for this purpose. Will it be the resource activation and configuration API? In this case can this API be called as part of selfcare or agent care directly?

    Request you to please help

    ------------------------------
    Thanks and Regards,
    Suman Bagde
    Infosys Ltd.
    ------------------------------


  • 2.  RE: Open API for Pin Reset/ setup box config

    TM Forum Member
    Posted May 15, 2019 02:26
    These are examples of LogicalResource or PhysicalResource. Assuming that the items you mention can be represented as Characteristics of the Resources, then you would use a Resource Activation and Configuration API to GET the current state of the Resource from the network, and then PATCH the Resource with updated Values for the Characteristics back into the network.

    In earlier published Open API releases, this was TMF640, but in R18.5 we decided to separate Service Activation from Resource Activation, and there is not currently an API number for Resource Activation. Presumably this will be addressed in future releases. But we can be fairly sure that the information model and API will be similar to that for Resource Inventory (TMF639).

    You would have to decide if you will keep the Resource model entirely generic and catalog-driven, or rather to create concrete subclasses as extensions with strongly typed fields from Resource and ResourceSpecification, such as (perhaps) STBResource, STBResourceSpecification.
    Hope it helps.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: Open API for Pin Reset/ setup box config

    TM Forum Member
    Posted 28 days ago
    Thanks Jonathan. Will analyze this further

    ------------------------------
    Suman Bagde
    Infosys Ltd.
    ------------------------------



  • 4.  RE: Open API for Pin Reset/ setup box config

    TM Forum Member
    Posted 19 days ago
    Hi Jonathan,

    Couple of queries:
    • Giving an example for my query, if I want to refresh my setup box settings for say few characteristics. How can I specific the reset is for some characteristic and not the STB. Is there a design guideline for it?
    • If some operation is to be performed on a resource but supporting resource details are also required, again can we specify those resources as SupportingResources?

    Thank you


    ------------------------------
    Suman Bagde
    Infosys Ltd.
    ------------------------------



  • 5.  RE: Open API for Pin Reset/ setup box config

    TM Forum Member
    Posted 18 days ago
    Hi Suman
    I am really not an expert in Service and Resource modeling, so it is difficult for me to give you concrete advice.
    One way to achieve the reset for the entire STB would be to define a Boolean characteristic called (say) reset. You would generally not set a value for this characteristic, but if a reset was needed you would set reset to true and then PATCH the Resource.
    To reset specific characteristic values to their default, you would first need to know what the default values are. In the Service Catalog model, we have this as part of ServiceSpecCharacteristic, but I don't know if the equivalent exists in the resource model.

    Another way would be to create a dedicated API to address this use case (obviously outside the framework of Open API).

    Hope it helps

    Cannot give insights into your SupportingResource question, sorry.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------