Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Hide If
special@authenticated
Note
titleTo access this API specification you wil need to be logged in

To login with your TM Forum account please click on the Login button below

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue

Show If
special@authenticated

Lifecycle management Use Case

The catalog management API allows the management of the entire lifecycle of the catalog elements.
UC1: A partner updates his catalog. He notifies his distributor the catalog change. The distributor requests a catalog export. Then, he retrieves the catalog at the provided URL.

UC2: A partner updates his catalog. He notifies all catalog changes in detail to his distributor. This one updates his catalog copy.

UC3: A catalog administrator wants to retrieve effective duration of a product offering based on product offering identifier or other search criteria (GET/productOffering).
UC4: A catalog administrator wants to retrieve all the bundled product offerings included in a product offering bundle (GET/productOffering).
UC5: A catalog administrator wants to update the lifecycle status (from Launched to retired for example) of a product offering (PUT or PATCH/productOffering).

Order management Use Case

The catalog management API allows the lookup of the catalog elements during order capture.
UC1: A distributor wants to browse product offerings during order capture and to retrieve product offerings belonging to a given category, for a given channel and a given place. He gets all details on product offerings, product offering prices, product specifications and its characteristics (GET/depth).
UC2: A distributor wants to retrieve the characteristics including prices of a given product offering (GET/productOffering).
UC3: A distributor wants to know if a product offering is available at customer's location (GET/productOffering).
UC4: A distributor wants to know which SLA applies on a given product offering (GET/productOffering).
UC5: A distributor wants to retrieve all product offerings belonging to a partner (GET/productOffering).


© TM Forum 2015. All Rights Reserved.