Product Offering Qualification Process API

(0 reviews)

GetLoan

/productOfferingQualification [GET]

ProductOfferingQualification is used to perform a commercial eligibility. It allows to retrieve a list of productOffering that are commercially available in the context of the interaction (defined be place, channel, party, product).

Uses Cases

The internal use cases to the method are defined.

Case	Description
1	GET Offers from Ericsson
2	Flow Market-useCases
3	GET Plan Offers from Myne
4	GET Loan Offers from Myne
5	list loan offerings for a Evolving customer.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[host]:[port]/tmf-api/productOfferingQualification/v4/{businessId}/productOfferingQualification

URI PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (BS,JM,CR,etc.) identifying the business unit	Y

Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. [Deprecated: use X-Correlation-ID]	N
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y
channeId	string	Channel to business [Deprecated: don use it]	N
lob	string	The Line of Business Identifier currently available are: FIXED PREPAID POSTPAID [Deprecated: don use it]	N

Query Params

name	type	description	required
logicalResource.id	string	Unique Identifier of the logical resource. [Deprecated: use relatedParty.id parameter]	N
category.name	string	The category for grouping recommendations. Name of the related entity	N
relatedParty.id	string	A related party defines party or party role linked to a specific entity. Unique identifier of a related entity.	N

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - listProductOfferingQualification request processed successfully, response body contains an entity corresponding to the requested resource.

TMF generic response

[
  {
    "id": "string",
    "href": "string",
    "description": "string",
    "effectiveQualificationDate": "2023-04-26T15:24:34.203Z",
    "expectedPOQCompletionDate": "2023-04-26T15:24:34.203Z",
    "expirationDate": "2023-04-26T15:24:34.203Z",
    "instantSyncQualification": true,
    "productOfferingQualificationDate": "2023-04-26T15:24:34.203Z",
    "provideAlternative": true,
    "provideOnlyAvailable": true,
    "provideUnavailabilityReason": true,
    "qualificationResult": "string",
    "requestedPOQCompletionDate": "2023-04-26T15:24:34.203Z",
    "category": {
      "id": "string",
      "href": "string",
      "name": "string",
      "version": "string",
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string",
      "@referredType": "string"
    },
    "channel": {
      "id": "string",
      "href": "string",
      "name": "string",
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string",
      "@referredType": "string"
    },
    "note": [
      {
        "id": "string",
        "author": "string",
        "date": "2023-04-26T15:24:34.203Z",
        "text": "string",
        "@baseType": "string",
        "@schemaLocation": "string",
        "@type": "string"
      }
    ],
    "place": [
      {
        "id": "string",
        "href": "string",
        "name": "string",
        "role": "string",
        "@baseType": "string",
        "@schemaLocation": "string",
        "@type": "string",
        "@referredType": "string"
      }
    ],
    "productOfferingQualificationItem": [
      {
        "id": "string",
        "expectedActivationDate": "2023-04-26T15:24:34.203Z",
        "qualificationItemResult": "string",
        "action": "add",
        "alternateProductOfferingProposal": [
          {
            "id": "string",
            "alternateActivationDate": "2023-04-26T15:24:34.203Z",
            "alternateProduct": {
              "id": "string",
              "href": "string",
              "description": "string",
              "isBundle": true,
              "isCustomerVisible": true,
              "name": "string",
              "orderDate": "2023-04-26T15:24:34.203Z",
              "productSerialNumber": "string",
              "startDate": "2023-04-26T15:24:34.203Z",
              "terminationDate": "2023-04-26T15:24:34.203Z",
              "agreement": [
                {
                  "id": "string",
                  "href": "string",
                  "agreementItemId": "string",
                  "name": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string",
                  "@referredType": "string"
                }
              ],
              "billingAccount": {
                "id": "string",
                "href": "string",
                "name": "string",
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string",
                "@referredType": "string"
              },
              "place": [
                {
                  "id": "string",
                  "href": "string",
                  "name": "string",
                  "role": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string",
                  "@referredType": "string"
                }
              ],
              "product": [
                "string"
              ],
              "productCharacteristic": [
                {
                  "name": "string",
                  "valueType": "string",
                  "value": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string"
                }
              ],
              "productOffering": {
                "id": "string",
                "href": "string",
                "name": "string",
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string",
                "@referredType": "string"
              },
              "productOrderItem": [
                {
                  "orderItemAction": "string",
                  "orderItemId": "string",
                  "productOrderHref": "string",
                  "productOrderId": "string",
                  "role": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string",
                  "@referredType": "string"
                }
              ],
              "productPrice": [
                {
                  "description": "string",
                  "name": "string",
                  "priceType": "string",
                  "recurringChargePeriod": "string",
                  "unitOfMeasure": "string",
                  "billingAccount": {
                    "id": "string",
                    "href": "string",
                    "name": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string",
                    "@referredType": "string"
                  },
                  "price": {
                    "percentage": 0,
                    "taxRate": 0,
                    "dutyFreeAmount": {
                      "unit": "string",
                      "value": 0
                    },
                    "taxIncludedAmount": {
                      "unit": "string",
                      "value": 0
                    },
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string"
                  },
                  "productOfferingPrice": {
                    "id": "string",
                    "href": "string",
                    "name": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string",
                    "@referredType": "string"
                  },
                  "productPriceAlteration": [
                    {
                      "applicationDuration": 0,
                      "description": "string",
                      "name": "string",
                      "priceType": "string",
                      "priority": 0,
                      "recurringChargePeriod": "string",
                      "unitOfMeasure": "string",
                      "price": {
                        "percentage": 0,
                        "taxRate": 0,
                        "dutyFreeAmount": {
                          "unit": "string",
                          "value": 0
                        },
                        "taxIncludedAmount": {
                          "unit": "string",
                          "value": 0
                        },
                        "@baseType": "string",
                        "@schemaLocation": "string",
                        "@type": "string"
                      },
                      "productOfferingPrice": {
                        "id": "string",
                        "href": "string",
                        "name": "string",
                        "@baseType": "string",
                        "@schemaLocation": "string",
                        "@type": "string",
                        "@referredType": "string"
                      },
                      "@baseType": "string",
                      "@schemaLocation": "string",
                      "@type": "string"
                    }
                  ],
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string"
                }
              ],
              "productRelationship": [
                {
                  "relationshipType": "string",
                  "product": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string"
                }
              ],
              "productSpecification": {
                "id": "string",
                "href": "string",
                "name": "string",
                "version": "string",
                "targetProductSchema": {
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string"
                },
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string",
                "@referredType": "string"
              },
              "productTerm": [
                {
                  "description": "string",
                  "name": "string",
                  "duration": {
                    "amount": 1,
                    "units": "string"
                  },
                  "validFor": {
                    "endDateTime": "2023-04-26T15:24:34.203Z",
                    "startDateTime": "2023-04-26T15:24:34.203Z"
                  },
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string"
                }
              ],
              "realizingResource": [
                {
                  "id": "string",
                  "href": "string",
                  "name": "string",
                  "value": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string",
                  "@referredType": "string"
                }
              ],
              "realizingService": [
                {
                  "id": "string",
                  "href": "string",
                  "name": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string",
                  "@referredType": "string"
                }
              ],
              "relatedParty": [
                {
                  "id": "string",
                  "href": "string",
                  "name": "string",
                  "role": "string",
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string",
                  "@referredType": "string"
                }
              ],
              "status": "created",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            },
            "alternateProductOffering": {
              "id": "string",
              "href": "string",
              "name": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            },
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
          }
        ],
        "eligibilityUnavailabilityReason": [
          {
            "code": "string",
            "label": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
          }
        ],
        "note": [
          {
            "id": "string",
            "author": "string",
            "date": "2023-04-26T15:24:34.203Z",
            "text": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
          }
        ],
        "product": {
          "id": "string",
          "href": "string",
          "description": "string",
          "isBundle": true,
          "isCustomerVisible": true,
          "name": "string",
          "orderDate": "2023-04-26T15:24:34.203Z",
          "productSerialNumber": "string",
          "startDate": "2023-04-26T15:24:34.203Z",
          "terminationDate": "2023-04-26T15:24:34.203Z",
          "agreement": [
            {
              "id": "string",
              "href": "string",
              "agreementItemId": "string",
              "name": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            }
          ],
          "billingAccount": {
            "id": "string",
            "href": "string",
            "name": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string",
            "@referredType": "string"
          },
          "place": [
            {
              "id": "string",
              "href": "string",
              "name": "string",
              "role": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            }
          ],
          "product": [
            "string"
          ],
          "productCharacteristic": [
            {
              "name": "string",
              "valueType": "string",
              "value": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string"
            }
          ],
          "productOffering": {
            "id": "string",
            "href": "string",
            "name": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string",
            "@referredType": "string"
          },
          "productOrderItem": [
            {
              "orderItemAction": "string",
              "orderItemId": "string",
              "productOrderHref": "string",
              "productOrderId": "string",
              "role": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            }
          ],
          "productPrice": [
            {
              "description": "string",
              "name": "string",
              "priceType": "string",
              "recurringChargePeriod": "string",
              "unitOfMeasure": "string",
              "billingAccount": {
                "id": "string",
                "href": "string",
                "name": "string",
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string",
                "@referredType": "string"
              },
              "price": {
                "percentage": 0,
                "taxRate": 0,
                "dutyFreeAmount": {
                  "unit": "string",
                  "value": 0
                },
                "taxIncludedAmount": {
                  "unit": "string",
                  "value": 0
                },
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string"
              },
              "productOfferingPrice": {
                "id": "string",
                "href": "string",
                "name": "string",
                "@baseType": "string",
                "@schemaLocation": "string",
                "@type": "string",
                "@referredType": "string"
              },
              "productPriceAlteration": [
                {
                  "applicationDuration": 0,
                  "description": "string",
                  "name": "string",
                  "priceType": "string",
                  "priority": 0,
                  "recurringChargePeriod": "string",
                  "unitOfMeasure": "string",
                  "price": {
                    "percentage": 0,
                    "taxRate": 0,
                    "dutyFreeAmount": {
                      "unit": "string",
                      "value": 0
                    },
                    "taxIncludedAmount": {
                      "unit": "string",
                      "value": 0
                    },
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string"
                  },
                  "productOfferingPrice": {
                    "id": "string",
                    "href": "string",
                    "name": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "@type": "string",
                    "@referredType": "string"
                  },
                  "@baseType": "string",
                  "@schemaLocation": "string",
                  "@type": "string"
                }
              ],
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string"
            }
          ],
          "productRelationship": [
            {
              "relationshipType": "string",
              "product": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string"
            }
          ],
          "productSpecification": {
            "id": "string",
            "href": "string",
            "name": "string",
            "version": "string",
            "targetProductSchema": {
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string"
            },
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string",
            "@referredType": "string"
          },
          "productTerm": [
            {
              "description": "string",
              "name": "string",
              "duration": {
                "amount": 1,
                "units": "string"
              },
              "validFor": {
                "endDateTime": "2023-04-26T15:24:34.203Z",
                "startDateTime": "2023-04-26T15:24:34.203Z"
              },
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string"
            }
          ],
          "realizingResource": [
            {
              "id": "string",
              "href": "string",
              "name": "string",
              "value": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            }
          ],
          "realizingService": [
            {
              "id": "string",
              "href": "string",
              "name": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            }
          ],
          "relatedParty": [
            {
              "id": "string",
              "href": "string",
              "name": "string",
              "role": "string",
              "@baseType": "string",
              "@schemaLocation": "string",
              "@type": "string",
              "@referredType": "string"
            }
          ],
          "status": "created",
          "@baseType": "string",
          "@schemaLocation": "string",
          "@type": "string",
          "@referredType": "string"
        },
        "productOffering": {
          "id": "string",
          "href": "string",
          "name": "string",
          "@baseType": "string",
          "@schemaLocation": "string",
          "@type": "string",
          "@referredType": "string"
        },
        "qualificationItemRelationship": [
          {
            "id": "string",
            "relationshipType": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
          }
        ],
        "state": "acknowledged",
        "terminationError": [
          {
            "id": "string",
            "value": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
          }
        ],
        "@baseType": "string",
        "@schemaLocation": "string",
        "@type": "string"
      }
    ],
    "relatedParty": [
      {
        "id": "string",
        "href": "string",
        "name": "string",
        "role": "string",
        "@baseType": "string",
        "@schemaLocation": "string",
        "@type": "string",
        "@referredType": "string"
      }
    ],
    "state": "acknowledged",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
  }
]

Definitions

Each of the response parameters is detailed.

name	type	description	required
id	String	Unique identifier of the productOfferingQualification resource	N
href	String	A string. Hyperlink to access the productOfferingQualification.	N
description	String	A string. Description of the productOfferingQualification.	N
effectiveQualificationDate	DateTime	A date time (DateTime). Effective date to productOfferingQualification completion.	N
expectedPOQCompletionDate	DateTime	A date time (DateTime). Date when the requester expect to provide an answer for the qualification request.	N
expirationDate	DateTime	A date time (DateTime). Date the qualification response expires.	N
instantSyncQualification	boolean	An indicator which when the value is "true" means that requester expects to get qualifcation result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201	N
productOfferingQualificationDate	DateTime	Date when the productOfferingQualification has been submitted	N
provideAlternative	boolean	An indicator which when the value is "true" means that alternative solutions should be provided	N
provideOnlyAvailable	boolean	An indicator which when the value is "true" means that only available product offering must be listed in the response	N
provideUnavailabilityReason	boolean	An indicator which when the value is "true" means that unavailability reason are expected for non available product offering	N
qualificationResult	string	Result of the qualification (example: green, yellow, red)	N
requestedPOQCompletionDate	DateTime	Deadline date when the requester expected a qualification answer	N
category	object	The category for grouping recommendations.	N
category.id	string	Unique identifier of a related entity.	N
category.href	string	Reference of the related entity.	N
category.name	string	Name of the related entity.	N
category.version	string	Category version	N
category.@baseType	string	When sub-classing, this defines the super-class	N
category.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
category.@type	string	When sub-classing, this defines the sub-class entity name	N
category.@referredType	string	The actual type of the target instance when needed for disambiguation.	N
channel	object	he channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..	N
channel.id	string	Unique identifier of a related entity.	N
channel.href	string	Reference of the related entity.	N
channel.name	string	Name of the channel.	N
channel.@baseType	string	When sub-classing, this defines the super-class	N
channel.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
channel.@type	string	When sub-classing, this defines the sub-class entity name	N
channel.@referredType	string	The actual type of the target instance when needed for disambiguation.	N
note	object array	Free form text associated with the qualification request	N
note.id	string	Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)	N
note.author	string	Author of the note	N
note.date	string	Date of the note	N
note.text	string	Text of the note	N
note.@baseType	string	When sub-classing, this defines the super-class	N
note.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
note.@type	string	When sub-classing, this defines the sub-class entity name	N
place	object array	Place reference. Place defines the places where the products are sold or delivered.	N
place.id	string	Unique identifier of the place	N
place.href	string	Unique reference of the place	N
place.name	string	A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]	N
place.@baseType	string	When sub-classing, this defines the super-class	N
place.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
place.@type	string	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem	object array		N
productOfferingQualificationItem.id	string	Id of the productOfferingQualification item	N
productOfferingQualificationItem.expectedActivationDate	DateTime	Date when the requester look for productOfferingQualification activation	N
productOfferingQualificationItem.qualificationItemResult	string	Qualification result for this productOfferingQualification item. It could be: qualified (request productOffering or productSpecification are available), unqualified (requested not available and not alternate available), alternate (requested not available but proposal available)	N
productOfferingQualificationItem.action	string	Can be "add" / "modify" / "no_change"/ "delete" - by default add is considered	N
productOfferingQualificationItem.alternateProductOfferingProposal	object array	Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.	N
productOfferingQualificationItem.alternateProductOfferingProposal.id	string	Identifier of a alternate product offering proposal
productOfferingQualificationItem.alternateProductOfferingProposal.alternateActivationDate	dateTime	Alternate activation date in case seller is not able to meet requested expected activation date.
productOfferingQualificationItem.alternateProductOfferingProposal.alternateProduct	ProductRefOrValue	Alternate product proposal
productOfferingQualificationItem.alternateProductOfferingProposal.alternateProductOffering	ProductOfferingRef	Alternate product offering proposal
productOfferingQualificationItem.alternateProductOfferingProposal.@baseType	string	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.alternateProductOfferingProposal.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.alternateProductOfferingProposal.@type	string	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.eligibilityUnavailabilityReason	object array	Reason for eligibility result if the productOfferingQualification result is no (meaning the productOffering or productSpec is not available).	N
productOfferingQualificationItem.eligibilityUnavailabilityReason.code	string	Unavailability reason code.
productOfferingQualificationItem.eligibilityUnavailabilityReason.label	string	Unavailability reason label.
productOfferingQualificationItem.eligibilityUnavailabilityReason.@baseType	string	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.eligibilityUnavailabilityReason.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.eligibilityUnavailabilityReason.@type	string	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.note	note
productOfferingQualificationItem.product	object	A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself
productOfferingQualificationItem.product.href	String	Reference of the product.	N
productOfferingQualificationItem.product.id	String	Unique identifier of the product.	N
productOfferingQualificationItem.product.name	String	Name of the product. It could be the same as the name of the product offering.	N
productOfferingQualificationItem.product.description	String	Is the description of the product. It could be copied from the description of the Product Offering.	N
productOfferingQualificationItem.product.isBundle	Boolean	If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering	N
productOfferingQualificationItem.product.isCustomerVisible	Boolean	If true, the product is visible by the customer.	N
productOfferingQualificationItem.product.orderDate	DateTime	Is the date when the product was ordered.	N
productOfferingQualificationItem.product.productSerialNumber	String	Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router	N
productOfferingQualificationItem.product.startDate	DateTime	Is the date from which the product starts.	N
productOfferingQualificationItem.product.terminationDate	DateTime	Is the date when the product was terminated	N
productOfferingQualificationItem.product.agreement	agreement	Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.	N
productOfferingQualificationItem.product.billingAccount	billingAccount	A BillingAccount is a detailed description of a bill structure.	N
productOfferingQualificationItem.product.place	relatedParty	Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity.	N
productOfferingQualificationItem.product.product	productOfferingQualificationItem.product	A product to be created defined by value or existing defined by reference.	N
productOfferingQualificationItem.product.productCharacteristic	Object Array	Describes a given characteristic of an object or entity through a name/value pair.	N
productOfferingQualificationItem.product.productCharacteristic.name	String	Name of the characteristic	N
productOfferingQualificationItem.product.productCharacteristic.valueType	String	Data type of the value of the characteristic	N
productOfferingQualificationItem.product.productCharacteristic.value	any	The value of the characteristic	N
productOfferingQualificationItem.product.productCharacteristic.@baseType	String	When sub-classing, this defines the super-class.	N
productOfferingQualificationItem.product.productCharacteristic.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships.	N
productOfferingQualificationItem.product.productCharacteristic.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productCharacteristic.@referredType	String	The actual type of the target instance when needed for disambiguation	N
productOfferingQualificationItem.product.productOffering	object	A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.	N
productOfferingQualificationItem.product.productOffering.id	String	Unique identifier Id of the EntityRef	N
productOfferingQualificationItem.product.productOffering.href	String	Unique reference of the EntityRef.	N
productOfferingQualificationItem.product.productOffering.description	String	Detailed description of the EntityRef.	N
productOfferingQualificationItem.product.productOffering.name	String	Name of the account.	N
productOfferingQualificationItem.product.productOffering.@baseType	String	When sub-classing, this defines the super-class.	N
productOfferingQualificationItem.product.productOffering.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships.	N
productOfferingQualificationItem.product.productOffering.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productOffering.@referredType	String	The actual type of the target instance when needed for disambiguation.	N
productOfferingQualificationItem.product.productOrderItem	object Array	An identified part of the order. A product order is decomposed into one or more order items.	N
productOfferingQualificationItem.product.productOrderItem.orderItemAction	String	Action of the order item for this product	N
productOfferingQualificationItem.product.productOrderItem.orderItemId	String	Identifier of the order item where the product was managed	N
productOfferingQualificationItem.product.productOrderItem.productOrderHref	String	Reference of the related entity.	N
productOfferingQualificationItem.product.productOrderItem.productOrderId	String	Unique identifier of a related entity.	N
productOfferingQualificationItem.product.productOrderItem.role	String	role of the product order item for this product	N
productOfferingQualificationItem.product.productOrderItem.@baseType	String	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.product.productOrderItem.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.product.productOrderItem.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productOrderItem.@referredType	String	The actual type of the target instance when needed for disambiguation.	N
productOfferingQualificationItem.product.productPrice	object Array	An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.	N
productOfferingQualificationItem.product.productPrice.description	String	A narrative that explains in detail the semantics of this product price.	N
productOfferingQualificationItem.product.productPrice.name	String	A short descriptive name such as "Subscription price".	N
productOfferingQualificationItem.product.productPrice.priceType	String	A category that describes the price, such as recurring, discount, allowance, penalty, and so forth	N
productOfferingQualificationItem.product.productPrice.recurringChargePeriod	string	Could be month, week...	N
productOfferingQualificationItem.product.productPrice.unitOfMeasure	string	Could be minutes, GB...	N
productOfferingQualificationItem.product.productPrice.billingAccount	object	BillingAccount reference. A BillingAccount is a detailed description of a bill structure.	N
productOfferingQualificationItem.product.productPrice.billingAccount.id	string	Unique identifier of a related entity.	N
productOfferingQualificationItem.product.productPrice.billingAccount.href	string	Reference of the related entity.	N
productOfferingQualificationItem.product.productPrice.billingAccount.name	string	Name of the related entity.	N
productOfferingQualificationItem.product.productPrice.billingAccount.@baseType	string	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.product.productPrice.billingAccount.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.product.productPrice.billingAccount.@type	string	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productPrice.price	object	Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.	N
productOfferingQualificationItem.product.productPrice.price.percentage	float	Percentage to apply for ProdOfferPriceAlteration	N
productOfferingQualificationItem.product.productPrice.price.taxRate	float	Tax rate	N
productOfferingQualificationItem.product.productPrice.price.dutyFreeAmount	object	All taxes excluded amount (expressed in the given currency)	N
productOfferingQualificationItem.product.productPrice.price.dutyFreeAmount.unit	string	Currency (ISO4217 norm uses 3 letters to define the currency)	N
productOfferingQualificationItem.product.productPrice.price.dutyFreeAmount.value	float	A positive floating point number	N
productOfferingQualificationItem.product.productPrice.price.taxIncludedAmount	object	All taxes included amount (expressed in the given currency)	N
productOfferingQualificationItem.product.productPrice.price.taxIncludedAmount.unit	string	Currency (ISO4217 norm uses 3 letters to define the currency)	N
productOfferingQualificationItem.product.productPrice.price.taxIncludedAmount.value	float	A positive floating point number	N
productOfferingQualificationItem.product.productPrice.price.@baseType	String	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.product.productPrice.price.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.product.productPrice.price.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productPrice.productOfferingPrice	ProductOfferingPriceRef		N
productOfferingQualificationItem.product.productPrice.productPriceAlteration	object Array		N
productOfferingQualificationItem.product.productPrice.@baseType	String	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.product.productPrice.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.product.productPrice.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productRelationship	Object Array	A list of product relationships.	N
productOfferingQualificationItem.product.productRelationship.product	productOrderItem.product	A product to be created defined by value or existing defined by reference.
productOfferingQualificationItem.product.productRelationship.@baseType	String	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.product.productRelationship.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.product.productRelationship.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productRelationship.relationshipType	string	Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful
productOfferingQualificationItem.product.productSpecification	Object	A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.	N
productOfferingQualificationItem.product.productSpecification.href	string	Reference of the related entity.	N
productOfferingQualificationItem.product.productSpecification.id	string	Unique identifier of a related entity.	N
productOfferingQualificationItem.product.productSpecification.name	string	Name of the related entity.	N
productOfferingQualificationItem.product.productSpecification.targetProductSchema	string	A target product schema reference. The reference object to the schema and type of target product which is described by product specification. Reference to Sub Object TargetProductSchema	N
productOfferingQualificationItem.product.productSpecification.targetProductSchema.@schemaLocation	string	The actual type of the target instance when needed for disambiguation.	N
productOfferingQualificationItem.product.productSpecification.targetProductSchema.@type	string	Class type of the target product.	N
productOfferingQualificationItem.product.productSpecification.targetProductSchema.@baseType	string	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.product.productSpecification.version	string	Version of the product specification.	N
productOfferingQualificationItem.product.productSpecification.@baseType	String	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.product.productSpecification.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.product.productSpecification.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.productSpecification.@referredType	string	The actual type of the target instance when needed for disambiguation.	N
productOfferingQualificationItem.product.productTerm	object Array	Description of a productTerm linked to this product. This represent a commitment with a duration.	N
productOfferingQualificationItem.product.realizingResource	Object array	A list of resource references.	N
productOfferingQualificationItem.product.realizingResource.id	String	Unique identifier Id of the related entity.	N
productOfferingQualificationItem.product.realizingResource.href	String	Unique reference of the related entity.	N
productOfferingQualificationItem.product.realizingResource.name	String	Name of the related entity..	N
productOfferingQualificationItem.product.realizingResource.@baseType	String	When sub-classing, this defines the super-class.	N
productOfferingQualificationItem.product.realizingResource.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships.	N
productOfferingQualificationItem.product.realizingResource.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.realizingResource.@referredType	String	The actual type of the target instance when needed for disambiguation.	N
productOfferingQualificationItem.product.realizingService	object array	A list of service references. Reference to Sub Object ServiceRef	N
productOrderItem.product.realizingService.id	String	Unique identifier Id of the EntityRef	N
productOfferingQualificationItem.product.realizingService.href	String	Unique reference of the EntityRef.	N
productOfferingQualificationItem.product.realizingService.description	String	Detailed description of the EntityRef.	N
productOfferingQualificationItem.product.realizingService.name	String	Name of the account.	N
productOfferingQualificationItem.product.realizingService.@baseType	String	When sub-classing, this defines the super-class.	N
productOfferingQualificationItem.product.realizingService.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships.	N
productOfferingQualificationItem.product.realizingService.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.product.realizingService.@referredType	String	The actual type of the target instance when needed for disambiguation.	N
productOfferingQualificationItem.product.relatedParty	relatedParty	Related Entity reference. A related party defines party or party role linked to a specific entity.	N
productOfferingQualificationItem.product.status	String	Is the lifecycle status of the product.
productOfferingQualificationItem.product.@baseType	String	When sub-classing, this defines the super-class.	N
productOfferingQualificationItem.product.@schemaLocation	String	A URI to a JSON-Schema file that defines additional attributes and relationships.	N
productOfferingQualificationItem.product.@type	String	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.productOffering	object	ProductOfferingRef
productOfferingQualificationItem.productOffering.id	string	Unique identifier of a related entity.	N
productOfferingQualificationItem.productOffering.href	string	Reference of the related entity.	N
relatproductOfferingQualificationItem.productOfferingdParty.name	string	Name of the related entity.	N
productOfferingQualificationItem.productOffering.@baseType	string	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.productOffering.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.productOffering.@type	string	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.productOffering.@referredType	string	The actual type of the target instance when needed for disambiguation.	N
productOfferingQualificationItem.qualificationItemRelationship	object array	Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.	N
productOfferingQualificationItem.qualificationItemRelationship.id	string	description: Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem).	N
productOfferingQualificationItem.qualificationItemRelationship.relationshipType	string	'Type of relationship (ex: reliesOn, connectedTo, etc...)'	N
productOfferingQualificationItem.qualificationItemRelationship.@baseType	string	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.qualificationItemRelationship.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.qualificationItemRelationship.@type	string	When sub-classing, this defines the sub-class entity name	N
productOfferingQualificationItem.state		State of the productOfferingQualification defined in the state engine. Possible values for the state of a task enum: - acknowledged - terminatedWithError - inProgress - done	N
productOfferingQualificationItem.terminationError	object array	TerminationError
productOfferingQualificationItem.@baseType	string	When sub-classing, this defines the super-class	N
productOfferingQualificationItem.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
productOfferingQualificationItem.@type	string	When sub-classing, this defines the sub-class entity name	N
relatedParty	object array	Related Entity reference. A related party defines party or party role linked to a specific entity.	N
relatedParty.id	string	Unique identifier of a related entity.	N
relatedParty.href	string	Reference of the related entity.	N
relatedParty.name	string	Name of the related entity.	N
relatedParty.role	string	Role played by the related party	N
relatedParty.@baseType	string	When sub-classing, this defines the super-class	N
relatedParty.@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
relatedParty.@type	string	When sub-classing, this defines the sub-class entity name	N
relatedParty.@referredType	string	The actual type of the target instance when needed for disambiguation.	N
state	string	State of the productOfferingQualification defined in the state engine. Possible values for the state of a task enum: - acknowledged - terminatedWithError - inProgress - done	N
@baseType	string	When sub-classing, this defines the super-class	N
@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships	N
@type	string	When sub-classing, this defines the sub-class entity name	N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The client sent too many requests and server is not able to serve them all at the moment"
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
    "errors": [
        {
            "code": 404,
            "message": "INVALID:Subscription Id",
            "description": "Subscription Id: 12345 is not found"
        }
    ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method POST not allowed for : /{businessId}/service/{id}"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /productOfferingQualification for Business Id: xxxx not implemented"
    }
  ]
  }

Administration and data management

In this section you define all the transformations, temporary and final repositories of the data within the method flow.

Transformation Request

In this section the matrix of all the data transformations that is carried out within the service is defined.

ericsson-air-sys

Original Payload	Mulesoft	transformation
queryParam.'logicalResource.id'		uriParam.subscriberNumber

prepay-limeware-sys

Original Payload	Mulesoft	transformation
queryParam.'logicalResource.id'		uriParam.id

myne-sys

Original Payload	Mulesoft	transformation
queryParam.'category.name'		queryParam.'category.name'
queryParam.'relatedParty.id'		queryParam.'relatedParty.id'

nontmf-evolving-sys

Original Payload	Mulesoft	transformation
queryParam.'channel.name'		queryParam.'channel.name'
queryParam.'relatedParty.id'		queryParam.'relatedParty.id'

Transformation Response

In this section the matrix of all the data transformations that is carried out within the service is defined.

ericsson-air-sys

note: Same SYS response without transformation

Original Payload	Mulesoft	transformation
payload		payload

prepay-limeware-sys

note: Same SYS response without transformation

Original Payload	Mulesoft	transformation
queryParam.'logicalResource.id'		uriParam.id

myne-sys

note: Same SYS response without transformation

Original Payload	Mulesoft	transformation
payload		payload

nontmf-evolving-sys

note: Same SYS response without transformation

Original Payload	Mulesoft	transformation
payload		payload

Services dependencies

This section defines all the connections to the web services and the methods that are used within the method.

ericsson-air-sys

Method	Type
/productOfferingQualification	GET

myne-sys

Method	Type
/productOfferingQualification	GET

nontmf-evolving-sys

Method	Type
\loanProductOfferingQualification	GET

GetLoan

/productOfferingQualification [GET]

Uses Cases

Request

URL

URI PARAMS

Headers

Query Params

Response

Possible response success

[ 200 ]

TMF generic response

Definitions

Possible response error

[ 400 ]

[ 401 ]

[ 404 ]

[ 405 ]

[ 500 ]

[ 501 ]

Administration and data management

Transformation Request

ericsson-air-sys

prepay-limeware-sys

myne-sys

nontmf-evolving-sys

Transformation Response

ericsson-air-sys

prepay-limeware-sys

myne-sys

nontmf-evolving-sys

Services dependencies

ericsson-air-sys

myne-sys

nontmf-evolving-sys

Reviews