MEF Product Offering Qualification Management (Mef Lso Cantata Product Offering Qualification Management) is one of 95 APIs that MEF publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
6 operations
across 4 paths,
organized into 2 resource areas,
and defines 52 schemas.
It is described by OpenAPI 3.0.1, at version 8.0.0.
Requests are made against a single base URL, https://{serverBase}/mefApi/cantata/productOfferingQualification/v8/.
The identity and technical contract details declared by the specification.
AlternateProductOfferingProposal
object
If in request the Buyer has requested to have alternate product proposals, then this class represents a single proposal. All properties are assigned by the Sel…
9 properties
5 required
AlternateServiceabilityColor
string
A color that indicates confidence to service the request. | ServiceabilityColor | Description | |------------------------- | ----------------------------------…
ContactInformation
object
Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the Seller (e.g.…
6 properties
3 required
DeliveryType
string
The mechanism used to deliver the Product to the place of its installation. | Delivery Type | Description | | ------------------ | ----------------------------…
Duration
object
A Duration in a given unit of time e.g. 3 hours, or 5 days.
2 properties
2 required
Error
object
Standard Class used to describe API response error Not intended to be used directly. The code in the HTTP header is used as a discriminator for the type of err…
3 properties
1 required
Error400
Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a requi…
Error401
Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired
Error403
Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231section-6.5.3)
Error403Code
string
This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access deni…
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error422Code
string
One of the following error codes: - missingProperty: The property the Seller has expected is not present in the payload - invalidValue: The property has an inc…
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
Error501
Not Implemented. Used in case Seller is not supporting an optional operation (https://tools.ietf.org/html/rfc7231section-6.6.2)
EventSubscription
object
This resource is used to manage notification subscriptions.
3 properties
2 required
EventSubscriptionInput
object
This class is used to register for Notifications.
2 properties
1 required
FieldedAddressRepresentation
object
A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example "street number" i…
20 properties
FormattedAddressRepresentation
object
A freeform text representation agreed to by the Buyer and Seller.
2 properties
1 required
GeographicAddressRef
object
A reference to a Geographic Address resource available through Address Validation API.
3 properties
2 required
GeographicAddress_Query
object
A list of representations being a subset of Geographic Address entity. This is to be used when providing a list of representations to validate or search for a…
5 properties
1 required
GeographicPointRepresentation
object
A GeographicPointRepresentation defines a geographic point through coordinates.
4 properties
3 required
GeographicSiteRef
object
A reference to a Geographic Site resource available through Service Site API
3 properties
2 required
LabelRepresentation
object
A unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
3 properties
2 required
MEFAlternateProduct
object
An alternative Product Offering that the Seller is proposing to the Buyer.
2 properties
2 required
MEFPOQItemStateChange
object
Holds the reached state, reasons, and associated date the POQ state changed, populated by the Seller.
3 properties
2 required
MEFPOQItemTaskStateType
string
POQ item states - The specific states are managed by the Seller based on its processing and/or based on the Buyer's action. | MEFPOQItemTaskStateType | Mplify…
MEFPOQStateChange
object
Holds the reached state, reasons, and associated date the POQ state changed, populated by the Seller.
3 properties
2 required
MEFPOQTaskStateType
string
These values represent the valid states through which the product offering qualification can transition. The following mapping has been used between MEFPOQTask…
MEFProductConfiguration
object
The extension point to provide product-specific payload. The @type is used as a discriminator.
1 property
1 required
MEFProductRefOrValue
object
Used by the Buyer to point to existing and/or describe the desired shape of the product. In the case of the add action - only productConfiguration MUST be spec…
7 properties
MEFServiceabilityColor
string
A color that indicates confidence to service the request. When the item state is done the Seller MUST provide a value. It MUST NOT be populated for other state…
PlaceRefOrQuery
object
A place described by reference to a Geographic Address, Geographic Site or by Geographic Address Representations.
PoqProductActionType
string
Action to be performed on the Product Item. The following mapping has been used between PoqProductActionType and Mplify 79.1: | PoqProductActionType | Mplify 7…
ProductOfferingQualification
Represents a response to the Buyer's POQ inquiry. This type defines a set of attributes that are assigned by the Seller while processing the request. A POQ res…
ProductOfferingQualificationItem
An individual article included in a POQ that describes a Product of a particular type (Product Offering) being delivered to a specific geographical location. T…
ProductOfferingQualificationItem_Common
object
Common attributes shared between a POQ request and response. These attributes are provided by the Buyer and must not be modified by the Seller.
5 properties
3 required
ProductOfferingQualificationItem_Create
This structure serves as a request for a product offering qualification item. A product qualification item is an individual article included in a POQ that desc…
ProductOfferingQualification_Common
object
Defines a set of POQ attributes that might be used by the Buyer and cannot be modified by the Seller. The relatedContactInformation entries provided by the Buy…
6 properties
3 required
ProductOfferingQualification_Create
Represents a request formulated by the Buyer that is composed of product offering qualification items.
ProductOfferingQualification_Find
object
This class represent a single list item for the response of listProductOfferingQualification operation.
6 properties
3 required
ProductOfferingRef
object
A reference to a Product Offering offered by the Seller to the Buyer. A Product Offering contains the commercial and technical details of a Product sold by a p…
2 properties
1 required
ProductRelationship
object
A relationship to an existing Product. The requirements for usage for given Product are described in the Product Specification. When the Buyer provides multipl…
3 properties
2 required
ProductSpecificationRef
object
A reference to a structured set of well-defined technical attributes and/or behaviors that are used to construct a Product Offering for sale to a market.
2 properties
1 required
QualificationItemRelationship
object
The relationship between product offering qualification items that can be used to validate business rules between POQ items.
2 properties
2 required
RelatedContactInformation
object
Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the Seller (e.g.…
7 properties
4 required
RelatedPlaceRefOrQueryWithSubUnit
object
Allows pointing to a place by referring to a GeographicAddress, GeographicSite, or providing GeographicAddress by value. It also provides additional informatio…
4 properties
2 required
SubUnit
object
Allows for sub unit identification
2 properties
2 required
TerminationError
object
This indicates an error that caused an Item to be terminated. The code and propertyPath should be used like in Error422.
3 properties
TimeUnit
string
Represents a unit of time.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.
