API Catalog

This file forms part of Mplify 116.1

This API implements Business Requirements described in MEF 81 and MEF 81.0.1

It allows the Buyer to retrieve the information about existing Product instances from Seller's Product Inventory.

List of supported use cases:

• Retrieve Product List

• Retrieve Product by Identifier

Copyright 2025 Mplify Alliance and its contributors.

This file includes [...]

This file forms part of Mplify 123.1 This API implements Business Requirements described in MEF 57.2 and Mplify 57.2.1

Product Order Management allows the Buyer to request the Seller to initiate and complete the fulfillment process of an installation of a Product Offering, an update to an existing Product, or a disconnect of an existing Product at the address defined by the Buyer.

List of [...]

This file forms part of Mplify 115.1 This API implements Business Requirements described in MEF 80 and Mplify 80.0.1 Quote API allows the Buyer to submit a request to find out how much the installation of an instance of a Product Offering, an update to an existing Product, or a disconnect of an existing Product will cost. List of supported Use Cases:

• Create Quote
• Retrieve Quote List
• [...]

This file forms part of Mplify 121.1 This API implements Business Requirements described in Mplify 150

It allows the Buyer to retrieve address information from the Seller, including exact formats, for addresses known to the Seller.

List of supported use cases:

• Validate Geographic Address
• Retrieve a Geographic Address Validation
• Retrieve a Geographic Address by Identifier
• Register for [...]

This file forms part of Mplify 87.1

This API implements Business Requirements described in Mplify 79.1 The Product Offering Qualification (POQ) Management API allows a Buyer to check whether the Seller can deliver a product or set of products from among their product offerings at the geographic address or a service site specified by the Buyer; or modify a previously purchased product.

The [...]

This file forms part of Mplify 122.1

This API implements Business Requirements described in Mplify 150

It allows to retrieve a list of Geographic Sites and to get all information for one geographic site.

List of supported Use Cases:

• Retrieve Service Site List
• Retrieve Service Site by Identifier

Copyright 2025 Mplify Alliance and its contributors.

This file includes content based on [...]

This file forms part of Mplify 124.1

This API implements Business Requirements described in MEF 113

It allows the Buyer to create, retrieve, and update Trouble Tickets as well as receive notifications about Incidents' and Trouble Tickets' updates. This allows managing issues and situations that are not part of normal operations of the Product provided by the Seller.

List of supported use [...]

This file forms part of Mplify 137.1

This API implements Business Requirements described in MEF 113.

An Appointment is an arrangement to do something or meet someone at a particular time and place. It is previously made during an interaction or may be necessary to solve a customer problem or to deliver a product order item. The appointment API goal is to manage an appointment with all [...]

This file forms part of Mplify 137.1

This API implements Business Requirements described in MEF 113.

It allows the Buyer to create, retrieve, and update WorkOrders as well as receive notifications about Incidents and WorkOrders updates. This allows managing issues and situations that are not part of normal operations of the Product provided by the Seller.

List of supported [...]

This file forms part of Mplify 146

This API implements part of Business Requirements & Use Cases described in Mplify 133.1

Mplify Alarm Management is used to notify listening client about a specific event that has occurred. An alarm may or may not represent an error.

The Service Catalog API provides a standardized mechanism for retrieving ServiceSpecifications. Using these APIs Business Applications (BUS) systems query the Service Catalog for ServiceSpecifications supported by the Service Orchestration Function (SOF).

Additionally, the APIs also allow the BUS to register listeners to be notified of the changes to the ServiceSpecifications.

• [...]

This file forms part of Mplify 148

This API implements part of Business Requirements & Use Cases described in Mplify 133.1.

Mplify Fault Management API allows to manage Fault Management Jobs, collect Fault Management Reports, as well as receive notifications related to these entities. This provides the ability for the Buyer/Client to request that the Seller/Server performs actions [...]