Open APIs

 View Only
  • 1.  Party and PartyRole Management Open API

    TM Forum Member
    Posted Jun 12, 2018 09:39
    Hi,

    We are going to implement Party and PartyRole Management (e.g. Customers, Employees etc.) API in compliance with Open API, but we have a few questions: 

    1. Our data model is based on Information Framework (SID) data model, so that our PartyRole entities like Customer needs specification to be created. Could you tell me how we can add information about specification to request e.g. Create Customer? In Open Api Specification there is no place for Party Role Specification.

    2. I wonder if you could tell me how to deal with business process and creating entities directly. For example we could create customer in two ways:
    •      Create a process which has some tasks for validation etc. and in the end save customer in CIM.
    •     Create the customer directly in CIM.
    Which of these two should be run for Create Customer request?

    Thank you in advance.

    ------------------------------
    Adam Augustyn
    Comarch S.A.
    ------------------------------


  • 2.  RE: Party and PartyRole Management Open API

    TM Forum Member
    Posted Jun 13, 2018 03:09
    Hi ,
    Not sure if i understood it correctly but we already have the concrete resource called Customer defined by Open API specification and operations around it (POST/PATCH etc). Is that not good enough for your purpose ?
    There is also a mapping document between SID and Open API 
    I don't think TMF will suggest you what type of validations etc you want to perform. It will be up to your implementation.

    Vikas

    ------------------------------
    Vikas Magar
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: Party and PartyRole Management Open API

    Posted Jun 13, 2018 12:19
    Howdy, Vikas, Adam, and all. Adam, related to your eTOM question there is a Customer Management core process that supports a lot of what you want. And can be used with the Customer Information Management process you mentioned.

    I have posted a screen shot of its lower level process, Establish Customer Relationship, here. Each process is further described in the Clickable Frameworx model  on the TM Forum website and in eTOM guide book GB921D and DX.



    ------------------------------
    John Reilly
    John P. Reilly Sole Trader
    ------------------------------



  • 4.  RE: Party and PartyRole Management Open API

    TM Forum Member
    Posted Jun 15, 2018 05:26
    Thank you all for replying. 

    But you've misunderstood my question. I've tried to ask that for the Open API Create Customer request should I create process which John mentioned or should I only create entity without process?



    ------------------------------
    Adam Augustyn
    Comarch S.A.
    ------------------------------



  • 5.  RE: Party and PartyRole Management Open API

    TM Forum Member
    Posted Jun 18, 2018 06:02
    Hi Adam ,
    I think it depends very much on the use case. If you want to use the customer immediately post creation for example for selling a product, then you should create the and run the validation synchronously. In case you don't then you can run the process in background and maintain a status field.

    Vikas

    ------------------------------
    Vikas Magar
    Amdocs
    ------------------------------