TMF679-ProductOfferingQualification-v5 0 0

TM Forum Specification
Product Offering
Qualification
TMF679
TBD
September 2022
Release: TBD Status: TBD

Version: 5.0.0 IPR Mode: RAND
© TM Forum 2022. All Rights Reserved.

Product Offering Qualification
NOTICE
Copyright © TM Forum 2022. All Rights Reserved.
This document and translations of it may be copied and furnished to others, and derivative works
that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
published, and distributed, in whole or in part, without restriction of any kind, provided that the
above copyright notice and this section are included on all such copies and derivative works.
However, this document itself may not be modified in any way, including by removing the copyright
notice or references to TM FORUM, except as needed for the purpose of developing any document
or deliverable produced by a TM FORUM Collaboration Project Team (in which case the rules
applicable to copyrights, as set forth in the TM FORUM IPR Policy, must be followed) or as required
to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by TM FORUM or its
successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and TM FORUM
DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY
WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP
RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE.
Direct inquiries to the TM Forum office:
4 Century Drive, Suite 100

Parsippany, NJ 07054, USA
Tel No. +1 973 944 5100
Fax No. +1 973 988 7196
TM Forum Web Page: www.tmforum.org
© TM Forum 2022. All Rights Reserved. Page i

Table of Contents
NOTICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Sample Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Support of polymorphism and extension patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
RESOURCE MODEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Managed Entity and Task Resource Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
QueryProductOfferingQualification resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
CheckProductOfferingQualification resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Notification Resource Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Query Product Offering Qualification State Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Query Product Offering Qualification Create Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Query Product Offering Qualification Delete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Query Product Offering Qualification Attribute Value Change Event . . . . . . . . . . . . . . . . . . . . . . 18
Check Product Offering Qualification Create Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Check Product Offering Qualification State Change Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Check Product Offering Qualification Attribute Value Change Event . . . . . . . . . . . . . . . . . . . . . . 24
Check Product Offering Qualification Delete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
API OPERATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Operations on QueryProductOfferingQualification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
List or find QueryProductOfferingQualification objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Retrieves a QueryProductOfferingQualification by ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Creates a QueryProductOfferingQualification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Updates partially a QueryProductOfferingQualification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Deletes a QueryProductOfferingQualification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Operations on CheckProductOfferingQualification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
List or find CheckProductOfferingQualification objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Retrieves a CheckProductOfferingQualification by ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Creates a CheckProductOfferingQualification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Updates partially a CheckProductOfferingQualification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Deletes a CheckProductOfferingQualification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
API NOTIFICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Register listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Unregister listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Publish Event to listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Release History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Contributors to Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
© TM Forum 2022. All Rights Reserved. Page ii

Introduction
The following document is the user guide of the REST API for Any management. It includes the model
definition as well as all available operations.
© TM Forum 2022. All Rights Reserved. Page 1

Sample Use Cases

Reader will find example of use cases using Usage API in “Open Digital Business Scenarios and Use
Cases” document.

Support of polymorphism and extension

patterns
Support of polymorphic collections and types and schema based extension is provided by means of a
list of generic meta-attributes that we describe below. Polymorphism in collections occurs when
entities inherit from base entities, for instance a BillingAccount and SettlementAccount inheriting
properties from the abstract Account entity.
Generic support of polymorphism and pattern extensions is described in the TMF API Guidelines v3.0
Part 2 document.
The @type attribute provides a way to represent the actual class type of an entity. For example,
within a list of Account instances some may be instances of BillingAccount where other could be
instances of SettlementAccount. The @type gives this information. All resources and sub-resources
of this API have a @type attributes that can be provided when this is useful.
The @referredType can be used within reference entities (like for instance an AccountRef object) to
explicitly denote the actual entity type of the referred class. Notice that in reference entities the
@type, when used, denotes the class type of the reference itself, such as BillingAccountRef or
SettlementAccountRef, and not the class type of the referred object. However since reference
classes are rarely sub-classed, @type is generally not useful in reference objects.
The @schemaLocation property can be used in resources to allow specifying user-defined properties
of an Entity or to specify the expected characteristics of an entity.
The @baseType attribute gives a way to provide explicitly the base of class of a given resource that
has been extended.

RESOURCE MODEL
Managed Entity and Task Resource Models
QueryProductOfferingQualification resource
QueryProductOfferingQualification is used to perform a commercial eligibility. It allows client side to

pass a list of criteria (search criteria to provide the context of the qualification) and in the response
the seller send (if any) a list of product offering qualified.
Resource model
Figure 1 - QueryProductOfferingQualification
Field descriptions
QueryProductOfferingQualification fields

category A CategoryRef.
channel A ChannelRef.
creationDate A DateTime. Date and time when the

QueryProductOfferingQualification was created.
description A String. Description of the QueryProductOfferingQualification.
effectiveQualificationDate A DateTime. Effective date to QueryProductOfferingQualification

completion.
expectedQualificationCompletionDat A DateTime. Expected date rom the server to provide an answer for
e the query qualification request.
expirationDate A DateTime. Date the qualification response expires.
href A String. Hyperlink reference.
id A String. Unique identifier.
instantSyncQualification A 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.
note A Note. Free form text associated with the qualification request.
qualifiedProductOfferingItem A QueryProductOfferingQualificationItem. Qualification item for a

product or a category.
relatedParty A RelatedParty. Party playing a role for this qualification (as requester
for example).
requestedQualificationCompletionDa A DateTime. Deadline date when the requester expected a

te qualification answer.
searchCriteria A QueryProductOfferingQualificationItem.
state A TaskStateType. State of the QueryProductOfferingQualification :

described in the state-machine diagram.
CategoryRef sub-resource fields
Note sub-resource fields
author A String. Author of the note.
date A DateTime. Date of the note.
id A String. Identifier of the note within its containing entity.
text A String. Text of the note.

ProductOfferingQualificationItemRelationship sub-resource fields
id A String. Id of the related POQ item (must be in the same POQ).
relationshipType A String. Relationship type as relies on, bundles, etc…
ProductOfferingRef sub-resource fields
PromotionRef sub-resource fields
QueryProductOfferingQualificationItem sub-resource fields
id A String. Identifier of the ProductOfferingQualification item (generally

it is a sequence number 01, 02, 03, …).
product A ProductRefOrValue.
productOffering A ProductOfferingRef.
promotion A PromotionRef.
qualificationItemRelationship A ProductOfferingQualificationItemRelationship.
Reference sub-resource fields
id A String. Identifier of the referred entity.
name A String. Name of the referred entity.
@referredType A String. The actual type of the target instance when needed for
disambiguation.
RelatedParty sub-resource fields
role A String. Role played by the related party.
disambiguation.
SchemaContext sub-resource fields
@baseType A String. When sub-classing, this defines the super-class.

@schemaLocation A String. A URI to a JSON-Schema file that defines additional attributes

and relationships.
@type A String. When sub-classing, this defines the sub-class Extensible

name.
CheckProductOfferingQualification resource
CheckProductOfferingQualification is used to perform a commercial eligibility. It allows to request an

eligibility check for a list of productOfferings (one per item). The response will provide qualification
result depending on catalog rules and of the context of the interaction (defined be place, channel,
party, product).
Resource model
Figure 2 - CheckProductOfferingQualification

Figure 3 - CheckProductOfferingQualificationItem
Field descriptions
CheckProductOfferingQualification fields
channel A ChannelRef.
checkProductOfferingQualificationIte A CheckProductOfferingQualificationItem. Qualification item for a

m product or a category.
creationDate A DateTime. Date and time when the

CheckProductOfferingQualification was created.
description A String. Description of the CheckProductOfferingQualification.
effectiveQualificationDate A DateTime. Effective date to CheckProductOfferingQualification

completion.
expectedQualificationCompletionDat A DateTime. Expected Date from server side to provide an answer for
e the check qualification request.
expirationDate A DateTime. Date the qualification response expires.
id A String. Unique identifier.

instantSyncQualification A 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.
note A Note. Free form text associated with the qualification request.
provideAlternative A Boolean. An indicator which when the value is "true" means that
alternative solutions should be provided.
provideOnlyAvailable A Boolean. An indicator which when the value is "true" means that
only available product offering must be listed in the response.
provideUnavailabilityReason A Boolean. An indicator which when the value is "true" means that
unavailability reason are expected for non available product offering.
qualificationResult A String. Result of the qualification (example: green, yellow, red).
relatedParty A RelatedParty. Party playing a role for this qualification (as requester
for example).
requestedQualificationCompletionDa A DateTime. Deadline date when the requester expected a

te qualification answer.
state A TaskStateType. State of the CheckProductOfferingQualification :

described in the state-machine diagram.
AlternateProductOfferingProposal sub-resource fields
alternateActivationDate A DateTime. Alternate activation date in case seller is not able to meet
requested expected activation date.
alternateProduct A ProductRefOrValue.
alternateProductOffering A ProductOfferingRef.
id A String. Identifier of the AlternateProductOfferingProposal within its

containing entity.
CheckProductOfferingQualificationItem sub-resource fields
CheckProductOfferingQualificationIte A CheckProductOfferingQualificationItem. A structure to embed check

m qualification item within check qualification item.
action A String. Action to be performed on a ProductOffering or product in

order to be qualified(add, modify, remove, etc.).
alternateProductOfferingProposal An AlternateProductOfferingProposal.
eligibilityUnavailabilityReason An EligibilityUnavailabilityReason.
expectedActivationDate A DateTime. Date when the requester look for

productOfferingQualification activation.

id A String. Identifier of the ProductOfferingQualification item (generally

it is a sequence number 01, 02, 03, …).
note A Note.
product A ProductRefOrValue.
productOffering A ProductOfferingRef.
qualificationItemRelationship A ProductOfferingQualificationItemRelationship.
qualificationItemResult A 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 alternate proposal
available).
state A String. State of the ProductOfferingQualification item : described in

the state machine diagram.
terminationError A TerminationError.
EligibilityUnavailabilityReason sub-resource fields
code A String. Unavailability reason code.
label A String. Unavailability Reason label.
Note sub-resource fields
author A String. Author of the note.
date A DateTime. Date of the note.
id A String. Identifier of the note within its containing entity.
text A String. Text of the note.
ProductOfferingQualificationItemRelationship sub-resource fields
id A String. Id of the related POQ item (must be in the same POQ).
relationshipType A String. Relationship type as relies on, bundles, etc…
ProductOfferingRef sub-resource fields
PromotionRef sub-resource fields

Reference sub-resource fields
disambiguation.
RelatedParty sub-resource fields
role A String. Role played by the related party.
disambiguation.
SchemaContext sub-resource fields
@baseType A String. When sub-classing, this defines the super-class.
@schemaLocation A String. A URI to a JSON-Schema file that defines additional attributes

and relationships.
@type A String. When sub-classing, this defines the sub-class Extensible

name.
Notification Resource Models

8 notifications are defined for this API.
Notifications related to QueryProductOfferingQualification:
• Query Product Offering Qualification State Change Event

• Query Product Offering Qualification Create Event
• Query Product Offering Qualification Delete Event
• Query Product Offering Qualification Attribute Value Change Event
Notifications related to CheckProductOfferingQualification:
• Check Product Offering Qualification Create Event

• Check Product Offering Qualification State Change Event
• Check Product Offering Qualification Attribute Value Change Event
• Check Product Offering Qualification Delete Event
The notification structure for all notifications in this API follow the pattern depicted by the figure
below. A notification event resource (depicted by "SpecificEvent" placeholder) is a sub class of a
generic Event structure containing at least an id of the event occurrence (eventId), an event
timestamp (eventTime), and the name of the resource (eventType). This notification structure owns
an event payload structure ("SpecificEventPayload" placeholder) linked to the resource concerned
by the notification using the resource name as access field ("resourceName" placeholder).
Figure 1 - Notification Pattern
Query Product Offering Qualification State Change Event
Json representation sample
Message example for QueryProductOfferingQualificationStateChangeEvent event
Content-Type: application/json
{
"correlationId": "qsd-ff",
"description": "QueryProductOfferingQualificationStateChangeEvent illustration",
"domain": "Commercial",
"eventId": "698",
"eventTime": "2021-09-27T07:43:59.059Z",

"eventType": "QueryProductOfferingQualificationStateChangeEvent",
"priority": "2",
"timeOcurred": "2021-09-27T07:43:59.059Z",
"title": "QueryProductOfferingQualificationStateChangeEvent",
"event": {
"queryProductOfferingQualification": {
"href":
"https://host:port/ProductOfferingQualificationManagement/v5/QueryProductOfferingQua
lification/11",
"id": "11",
"@type": "QueryProductOfferingQualification",
"channel": {
"id": "1",
"name": "Web"
},
"category": {
"id": "24",
"name": "International Data plan",
"href": "https://host:port/productCatalogManagement/v5/category/24",
"@type": "CategoryRef"
},
"description": "Example for a QueryProductOfferingQualification resource",
"effectiveQualificationDate": "2021-08-31T15:25:54.172Z",
"expectedQualificationCompletionDate": "2021-08-31T15:25:54.172Z",
"expirationDate": "2021-09-03T15:25:54.172Z",
"instantSyncQualification": true,
"qualifiedProductOfferingItem": [
{
"@type": "QualifiedProductOfferingItem",
"productOffering": {
"id": "DPI89",
"name": "European Data Plan - 20 GB",
"href":
"https://host:port/productCatalogManagement/v5/productOffering/DPI89",
"@type": "ProductOfferingRef"
},
"id": "1"
},
{
"id": "DPI90",
"href":
},
"id": "2"
},
{
"id": "DPI91",
"href":
},
"id": "3"
},
{

"id": "DPI123",
"name": "International Data Plan - 20 GB",
"href":
},
"id": "4"
},
{
"id": "DPI124",
"href":
},
"id": "5"
},
{
"id": "DPI125",
"href":
},
"id": "6"
}
],
"relatedParty": [
{
"id": "45hj-999",
"href": "https://host:port/partyManagement/v5/individual/45hj-9999",
"name": "Louise",
"role": "requester",
"@type": "@relatedParty",
"@referredType": "Individual"
}
],
"requestedQualificationCompletionDate": "2021-08-31T15:25:54.172Z",
"state": "done",
"creationDate": "2021-08-31T15:25:54.172Z"
}
},
"reportingSystem": {
"id": "123",
"name": "CRM app",
"@type": "ReportingResource",
"@referredType": "LogicalResource"
},
"source": {
"id": "123",
"name": "CRM app",
},
"@baseType": "Event",
"@type": "QueryProductOfferingQualificationStateChangeEvent"
}

Query Product Offering Qualification Create Event
Message example for QueryProductOfferingQualificationCreateEvent event
{
"correlationId": "dft-652",
"description": "QueryProductOfferingQualificationCreateEvent illustration",
"eventId": "256",
"eventTime": "2021-09-27T07:43:59.059Z",
"eventType": "QueryProductOfferingQualificationCreateEvent",
"priority": "1",
"timeOcurred": "2021-09-27T07:43:59.059Z",
"title": "QueryProductOfferingQualificationCreateEvent",
"event": {
"href":
"https://host:port/ProductOfferingQualificatio/v5/QueryProductOfferingQualification/
11",
"id": "11",
"channel": {
"id": "1",
"name": "Web"
},
"category": {
"id": "24",
},
"instantSyncQualification": false,
{
"id": "DPI89",
"href":
},
"id": "1"
},
{
"id": "DPI90",
"href":
},
"id": "2"
},

{
"id": "DPI91",
"href":
},
"id": "3"
},
{
"id": "DPI123",
"href":
},
"id": "4"
},
{
"id": "DPI124",
"href":
},
"id": "5"
},
{
"id": "DPI125",
"href":
},
"id": "6"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "acknowledged",
"creationDate": "2021-08-31T15:25:54.172Z"
},
"relatedParty": [
{
"id": "56d",
"role": "Issuer",
"@type": "RelatedParty",

"@referredType": "Organization"
}
],
"id": "123",
"name": "CRM app",
},
"source": {
"id": "123",
"name": "CRM app",
},
"@type": "QueryProductOfferingQualificationCreateEvent"
}
}
Query Product Offering Qualification Delete Event
Message example for QueryProductOfferingQualificationDeleteEvent event
{
"correlationId": "fg-56h",
"description": "QueryProductOfferingQualificationDeleteEvent illustration",
"eventId": "753",
"eventTime": "2021-09-27T07:43:59.059Z",
"eventType": "QueryProductOfferingQualificationDeleteEvent",
"priority": "3",
"timeOcurred": "2021-09-30T07:43:59.059Z",
"title": "QueryProductOfferingQualificationDeleteEvent",
"event": {
"id": "14"
}
},
"id": "123",
"name": "CRM app",
},
"source": {
"id": "123",
"name": "CRM app",
},
"@type": "QueryProductOfferingQualificationDeleteEvent"
}

Query Product Offering Qualification Attribute Value Change Event
Message example for QueryProductOfferingQualificationAttributeValueChangeEvent event
{
"correlationId": "azer-55",
"description": "QueryProductOfferingQualificationAttributeValueChangeEvent
illustration",
"eventId": "467",
"eventTime": "2022-09-14T12:14:28.774Z",
"eventType": "ProductAttributeValueChangeEvent",
"priority": "3",
"timeOcurred": "2022-09-14T12:14:23.473Z",
"title": "QueryProductOfferingQualificationAttributeValueChangeEvent",
"event": {
"href":
lification/14",
"id": "14",
"description": "Example for an inProgress QueryProductOfferingQualification
resource",
{
"product": {
"@type": "ProductValue",
"productSpecification": {
"id": "dfg-56d",
"href":
"https://host:port/productCatalogManagement/v5/productSpecification/dfg-56d",
"version": "v2",
"name": "UNI specification"
},
"productCharacteristic": [
{
"@type": "ObjectCharacteristic",
"id": "UNI_Characteristic",
"name": "UNI order configuration",
"valueType": "UNISpec JSON descriptor",
"value": {
"@valueSchemaLocation": "https://github.com/..UNISpec.json",
"@type": "UNIJsonSpecification",
"physicalLayer": "100BASE-T",
"synchronousModeEnabled": true,
"numberOfLinks": 1,
"tokenShareEnabled": true,
"uniResiliency": "NONE",
"maxServiceFrameSize": 1256
}
}
]

},
"id": "1"
}
],
"place": [
{
"role": "INSTALL_LOCATION",
"@type": "GeographicAddress",
"streetType": "rue",
"streetName": "Pelletier",
"streetNr": "14",
"city": "Paris",
"postcode": "75006",
"country": "France" }
],
"state": "inProgress",
"creationDate": "2021-08-31T15:51:12.570Z"
}
},
"id": "533",
"name": "APP-963",
},
"source": {
"id": "200",
"name": "APP-893",
},
"@type": "QueryProductOfferingQualificationAttributeValueChangeEvent"
}
Check Product Offering Qualification Create Event
Message example for CheckProductOfferingQualificationCreateEvent event
{
"correlationId": "126-54f",
"description": "CheckProductOfferingQualificationCreateEvent illustration",
"eventId": "125",
"eventTime": "2021-09-27T07:43:59.059Z",
"eventType": "CheckProductOfferingQualificationCreateEvent",
"priority": "1",
"timeOcurred": "2021-09-27T07:43:59.059Z",
"title": "CheckProductOfferingQualificationCreateEvent",
"event": {
"checkProductOfferingQualification": {
"href":
"https://host:port/ProductOfferingQualification/v5/CheckProductOfferingQualification
/99",

"id": "99",
"@type": "CheckProductOfferingQualification",
"channel": {
"id": "1",
"name": "Web"
},
"description": "Example for a CheckProductOfferingQualification resource",
"note": [
{
"@type": "Note",
"author": "Mr. N. Bene",
"date": "2020-11-20T08:00:00Z",
"id": "1",
"text": "Not for a CheckProductOfferingQualification"
}
],
"checkProductOfferingQualificationItem": [
{
"@type": "CheckProductOfferingQualificationItem",
"expectedActivationDate": "2021-09-01T14:21:03.352Z",
"id": "DPI123",
"href":
},
"action": "add",
"id": "1",
"qualificationItemResult": "green",
"state": "done"
},
{
"eligibilityUnavailabilityReason": [
{
"@type": "EligibilityUnavailabilityReason",
"label": "This offering is not anymore available but similar offer
exists",
"code": "TE45A"
}
],
"id": "DPI123",
"href":
},
"alternateProductOfferingProposal": [
{
"@type": "AlternateProductOfferingProposal",
"alternateActivationDate": "2021-09-01T14:21:03.353Z",
"alternateProductOffering": {
"id": "DPI124",
"href":

},
"id": "1"
}
],
"action": "add",
"id": "2",
"qualificationItemResult": "orange",
"state": "done"
},
{
{
"label": "This offering is not anymore open to new customer",
"code": "TE45"
}
],
"id": "DPI128",
"name": "France Voice Plan - 3 hours",
"href":
},
"action": "add",
"id": "3",
"qualificationItemResult": "red",
"state": "done"
}
],
"provideAlternative": true,
"provideUnavailabilityReason": true,
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "done",
"creationDate": "2021-09-01T14:21:03.354Z"
},
"relatedParty": [
{
"id": "56d",
"role": "Issuer",
"@type": "RelatedParty",
"@referredType": "Organization"
}
],
"id": "123",
"name": "CRM app",
},

"source": {
"id": "123",
"name": "CRM app",
},
"@type": "CheckProductOfferingQualificationCreateEvent"
}
}
Check Product Offering Qualification State Change Event
Message example for CheckProductOfferingQualificationStateChangeEvent event
{
"correlationId": "qsd-ff",
"description": "CheckProductOfferingQualificationStateChangeEvent illustration",
"eventId": "698",
"eventTime": "2021-09-27T07:43:59.059Z",
"eventType": "CheckProductOfferingQualificationStateChangeEvent",
"priority": "2",
"timeOcurred": "2021-09-27T07:43:59.059Z",
"title": "CheckProductOfferingQualificationStateChangeEvent",
"event": {
"href":
/99",
"id": "99",
"channel": {
"id": "1",
"name": "Web"
},
"note": [
{
"@type": "Note",
"date": "2020-11-20T08:00:00Z",
"id": "1",
}
],
{

"id": "DPI123",
"href":
},
"action": "add",
"id": "1",
"state": "done"
},
{
{
exists",
"code": "TE45A"
}
],
"id": "DPI123",
"href":
},
{
"id": "DPI124",
"href":
},
"id": "1"
}
],
"action": "add",
"id": "2",
"state": "done"
},
{
{
"code": "TE45"
}
],
"id": "DPI128",
"href":

},
"action": "add",
"id": "3",
"state": "done"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "done",
"creationDate": "2021-09-01T14:21:03.354Z"
}
},
"id": "123",
"name": "CRM app",
},
"source": {
"id": "123",
"name": "CRM app",
},
"@type": "CheckProductOfferingQualificationStateChangeEvent"
}
Check Product Offering Qualification Attribute Value Change Event
Message example for CheckProductOfferingQualificationAttributeValueChangeEvent event
{
"correlationId": "azer-55",
"description": "CheckProductOfferingQualificationAttributeValueChangeEvent
illustration",
"eventId": "467",
"eventTime": "2022-09-14T12:14:28.774Z",
"eventType": "CheckProductOfferingQualificationAttributeValueChangeEvent",
"priority": "3",
"timeOcurred": "2022-09-14T12:14:23.473Z",

"title": "CheckProductOfferingQualificationAttributeValueChangeEvent",
"event": {
"href":
/99",
"id": "99",
"channel": {
"id": "1",
"name": "Web"
},
"note": [
{
"@type": "Note",
"date": "2020-11-20T08:00:00Z",
"id": "1",
}
],
{
"id": "DPI123",
"href":
},
"action": "add",
"id": "1",
"state": "done"
},
{
{
exists",
"code": "TE45A"
}
],
"id": "DPI123",
"href":
},
{

"id": "DPI124",
"href":
},
"id": "1"
}
],
"action": "add",
"id": "2",
"state": "done"
},
{
{
"code": "TE45"
}
],
"id": "DPI128",
"href":
},
"action": "add",
"id": "3",
"state": "done"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "done",
"creationDate": "2021-09-01T14:21:03.354Z"
}
},
"id": "533",
"name": "APP-963",
},
"source": {

"id": "200",
"name": "APP-893",
},
"@type": "CheckProductOfferingQualificationAttributeValueChangeEvent"
}
Check Product Offering Qualification Delete Event
Message example for CheckProductOfferingQualificationDeleteEvent event
{
"correlationId": "fg-56h",
"description": "CheckProductOfferingQualificationDeleteEvent illustration",
"eventId": "753",
"eventTime": "2021-09-27T07:43:59.059Z",
"eventType": "CheckProductOfferingQualificationDeleteEvent",
"priority": "3",
"timeOcurred": "2021-09-30T07:43:59.059Z",
"title": "CheckProductOfferingQualificationDeleteEvent",
"event": {
"CheckProductOfferingQualification": {
"id": "14"
}
},
"id": "123",
"name": "CRM app",
},
"source": {
"id": "123",
"name": "CRM app",
},
"@type": "CheckProductOfferingQualificationDeleteEvent"
}

API OPERATIONS
Remember the following Uniform Contract:
Operation on Entities Uniform API Operation Description
Query Entities GET Resource GET must be used to retrieve a

representation of a resource.
Create Entity POST Resource POST must be used to create a new

resource
Partial Update of an Entity PATCH Resource PATCH must be used to partially

update a resource
Remove an Entity DELETE Resource DELETE must be used to remove a

resource
Execute an Action on an Entity POST on TASK Resource POST must be used to execute Task
Resources
Other Request Methods POST on TASK Resource GET and POST must not be used to
tunnel other request methods.
Filtering and attribute selection rules are described in the TMF REST Design Guidelines.
Notifications are also described in a subsequent section.
Operations on QueryProductOfferingQualification
List or find QueryProductOfferingQualification objects

GET /queryProductOfferingQualification
Description
This operation list QueryProductOfferingQualification entities. Attribute selection is enabled for all
first level attributes. Filtering may be available depending on the compliance level supported by an
implementation.
Usage samples
Retrieve a list of QueryProductOfferingQualification(s).
Request
Response

200
[
{
"href":
lification/11",
"id": "11",
"channel": {
"id": "1",
"name": "Web"
},
"category": {
"id": "24",
},
{
"id": "DPI89",
"href":
},
"id": "1"
},
{
"id": "DPI90",
"href":
},
"id": "2"
},
{
"id": "DPI91",
"href":
},
"id": "3"
},
{
"id": "DPI123",

"href":
},
"id": "4"
},
{
"id": "DPI124",
"href":
},
"id": "5"
},
{
"id": "DPI125",
"href":
},
"id": "6"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "done",
"creationDate": "2021-08-31T15:25:54.172Z"
},
{
"href":
lification/14",
"id": "14",
resource",
{
"product": {
"id": "dfg-56d",
"href":
"version": "v2",


},
{
"value": {
"numberOfLinks": 1,
}
}
]
},
"id": "1"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"place": [
{
"streetName": "Pellisier",
"streetNr": "14",
"city": "Paris",
],
"creationDate": "2021-08-31T15:51:12.570Z"
}
]
Retrieve a list of QueryProductOfferingQualification(s).
Request

Response
200
[
{
"id": "11",
"href":
lification/11",
"state" : "qualified",
"@type": "QueryProductOfferingQualification"
},
{
"id": "12",
"href":
lification/12",
},
{
"id": "32",
"href":
lification/32",
},
{
"id": "47",
"href":
lification/47",
}
]
Retrieves a QueryProductOfferingQualification by ID
GET /queryProductOfferingQualification/{id}?fields=…&{filtering}
Description
This operation retrieves a QueryProductOfferingQualification entity. Attribute selection is enabled

for all first level attributes. Filtering may be available depending on the compliance level supported
by an implementation.
Usage samples
Retrieve a QueryProductOfferingQualification from its identifier

Request
GET /queryProductOfferingQualification/{id}
Response
200
{
"href":
lification/11",
"id": "11",
"channel": {
"id": "1",
"name": "Web"
},
"category": {
"id": "24",
},
{
"id": "DPI89",
"href":
},
"id": "1"
},
{
"id": "DPI90",
"href":
},
"id": "2"
},
{
"id": "DPI91",
"href":

},
"id": "3"
},
{
"id": "DPI123",
"href":
},
"id": "4"
},
{
"id": "DPI124",
"href":
},
"id": "5"
},
{
"id": "DPI125",
"href":
},
"id": "6"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "done",
"creationDate": "2021-08-31T15:25:54.172Z"
}
Retrieve a QueryProductOfferingQualification from its identifier
Request

GET /queryProductOfferingQualification/{id}
Response
200
{
"href":
lification/14",
"id": "14",
resource",
{
"product": {
"id": "dfg-56d",
"href":
"version": "v2",
},
{
"value": {
"numberOfLinks": 1,
}
}
]
},
"id": "1"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",

}
],
"place": [
{
"streetNr": "14",
"city": "Paris",
],
"creationDate": "2021-08-31T15:51:12.570Z"
}
Creates a QueryProductOfferingQualification
POST /queryProductOfferingQualification
Description
This operation creates a QueryProductOfferingQualification entity.
Mandatory Attributes
Mandatory Attributes Rule
Usage samples
Creation of a new QueryProductOfferingQualification with POST operation
Request

POST /queryProductOfferingQualification
{
"channel": {
"id": "1",
"name": "Web"
},
"category": {
"id": "24",
},
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"requestedQualificationCompletionDate": "2021-08-31T15:25:54.172Z"
}
Response
201
{
"href":
lification/11",
"id": "11",
"channel": {
"id": "1",
"name": "Web"
},
"category": {
"id": "24",
},
{

"id": "DPI89",
"href":
},
"id": "1"
},
{
"id": "DPI90",
"href":
},
"id": "2"
},
{
"id": "DPI91",
"href":
},
"id": "3"
},
{
"id": "DPI123",
"href":
},
"id": "4"
},
{
"id": "DPI124",
"href":
},
"id": "5"
},
{
"id": "DPI125",
"href":
},
"id": "6"
}

],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "done",
"creationDate": "2021-08-31T15:25:54.172Z"
}
Updates partially a QueryProductOfferingQualification

PATCH /queryProductOfferingQualification/{id}?fields=…&{filtering}
Description
This operation allows partial updates of a QueryProductOfferingQualification entity. Support of

json/merge (https://tools.ietf.org/html/rfc7386) is mandatory, support of json/patch
(http://tools.ietf.org/html/rfc5789) is optiona. Note: If the update operation yields to the creation of
sub-resources or relationships, the same rules concerning mandatory sub-resource attributes and
default value settings in the POST operation applies to the PATCH operation. Hence these tables are
not repeated here.
Patchable and Non Patchable Attributes
Non Patchable Attributes Rule
creationDate
href
id
Patchable Attributes Rule
@baseType
@schemaLocation
@type
category
channel
description
effectiveQualificationDate

expectedQualificationCompletionDat
e
expirationDate
instantSyncQualification
note
qualifiedProductOfferingItem
relatedParty
requestedQualificationCompletionDa
te
searchCriteria
state
Usage samples
Update a QueryProductOfferingQualification using json-patch
Request
PATCH /queryProductOfferingQualification/{id}
Content-Type: application/json-patch+json
[
{"op":"replace",
"path":
"/qualifiedProductOfferingItem/productCharacteristic/value/physicalLayer?qualifiedPr
oductOfferingItem.id=1",
"value": "100BASE-T"
},
{"op":"replace",
"path": "/place/postcode?role=INSTALL_LOCATION",
"value": "75005"
}
]
Response
200
{
"href":
lification/14",
"id": "14",
resource",
{
"product": {
"id": "dfg-56d",
"href":
"version": "v2",
},
{
"value": {
"numberOfLinks": 1,
}
}
]
},
"id": "1"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"place": [
{
"streetNr": "14",
"city": "Paris",
],
"creationDate": "2021-08-31T15:51:12.570Z"
}

Update a QueryProductOfferingQualification using merge-patch
Request
PATCH /queryProductOfferingQualification/{id}
Content-Type: application/merge-patch+json
{
"id": "14",
{
"id": "1",
"product": {
{
"value": {
"numberOfLinks": 1,
}
}
]
}
}
],
"place": [
{
"streetNr": "14",
"city": "Paris",
"country": "France"
}
]
}
Response
200
{
"href":

lification/14",
"id": "14",
resource",
{
"product": {
"id": "dfg-56d",
"href":
"version": "v2",
},
{
"value": {
"numberOfLinks": 1,
}
}
]
},
"id": "1"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"place": [
{
"streetNr": "14",
"city": "Paris",
],

"creationDate": "2021-08-31T15:51:12.570Z"
}
Deletes a QueryProductOfferingQualification
DELETE /queryProductOfferingQualification/{id}?fields=…&{filtering}
Description
This operation deletes a QueryProductOfferingQualification entity.
Operations on CheckProductOfferingQualification
List or find CheckProductOfferingQualification objects

GET /checkProductOfferingQualification
Description
This operation list CheckProductOfferingQualification entities. Attribute selection is enabled for all
first level attributes. Filtering may be available depending on the compliance level supported by an
implementation.
Usage samples
Retrieve a list of CheckProductOfferingQualification(s)
Request
Response
200
[
{
"href":
"https://host:port/ProductOfferingQualificationManagement/v5/CheckProductOfferingQua
lification/99",
"id": "99",
"channel": {
"id": "1",
"name": "Web"
},
"note": [
{
"@type": "Note",
"date": "2020-11-20T08:00:00Z",
"id": "1",
}
],
{
"id": "DPI123",
"href":
},
"action": "add",
"id": "1",
"state": "done"
},
{
{
exists",
"code": "TE45A"
}
],
"id": "DPI123",
"href":
},
{
"id": "DPI124",
"href":
},
"id": "1"
}
],
"action": "add",
"id": "2",
"state": "done"
},

{
{
"code": "TE45"
}
],
"id": "DPI128",
"href":
},
"action": "add",
"id": "3",
"state": "done"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"state": "done",
"creationDate": "2021-09-01T14:21:03.354Z"
},
{
"href":
lification/101",
"id": "101",
"channel": {
"id": "1",
"name": "Web"
},
"description": "Example for an acknowledged CheckProductOfferingQualification
resource",
"CheckProductOfferingQualificationItem": [
{
"product": {
"id": "77",
"href":
"https://host:port/productCatalogManagement/v5/productSpecification/77",

"name": "NEST for enhanced MobileBroadband with IMS support"

},
{
"id": "Slice5G_Characteristic",
"name": "Slice 5G POQ configuration",
"valueType": "Slice5G JSON descriptor",
"value": {
"@valueSchemaLocation": "https://github.com/..5GPOQ.json",
"@type": "5GSliceJsonSpecification",
"availability": 99.999,
"MMTel_Support": 1,
"Session _Service_Continuity_support": 1,
"Slice_Quality_Of_Service": [1, 2, 5, 6, 7, 8, 9]
}
}
],
"place": [
{
"role": "Coverage",
"@type": "PlaceRef",
"@referredType": "GeographicLocation",
"name": "France",
"id": "FRA",
"href":
"https://host:port/geographicLocationManagement/v5/geographicLocation/FRA"
}
]
},
"action": "add",
"id": "1",
"state": "acknowledged"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"creationDate": "2021-09-02T07:11:53.168Z"
}
]
Retrieve a list of CheckProductOfferingQualification(s) with filter selection
Request

Response
200
[
{
"id": "9",
"href":
lification/9",
"state" : "done",
"qualificationResult": "green",
"@type": "CheckProductOfferingQualification"
},
{
"id": "19",
"href":
lification/19",
"state" : "done",
"qualificationResult": "red",
},
{
"id": "31",
"href":
lification/31",
"state" : "done",
},
{
"id": "547",
"href":
lification/547",
"state" : "done",
}
]
Retrieves a CheckProductOfferingQualification by ID
GET /checkProductOfferingQualification/{id}?fields=…&{filtering}
Description
This operation retrieves a CheckProductOfferingQualification entity. Attribute selection is enabled

for all first level attributes. Filtering may be available depending on the compliance level supported
by an implementation.

Usage samples
Retrieve a CheckProductOfferingQualification from its identifier
Request
GET /checkProductOfferingQualification/{id}
Response
200
{
"href":
lification/99",
"id": "99",
"channel": {
"id": "1",
"name": "Web"
},
"note": [
{
"@type": "Note",
"date": "2020-11-20T08:00:00Z",
"id": "1",
}
],
{
"id": "DPI123",
"href":
},
"action": "add",
"id": "1",
"state": "done"
},
{
{

exists",
"code": "TE45A"
}
],
"id": "DPI123",
"href":
},
{
"id": "DPI124",
"href":
},
"id": "1"
}
],
"action": "add",
"id": "2",
"state": "done"
},
{
{
"code": "TE45"
}
],
"id": "DPI128",
"href":
},
"action": "add",
"id": "3",
"state": "done"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",

}
],
"state": "done",
"creationDate": "2021-09-01T14:21:03.354Z"
}
Retrieve a CheckProductOfferingQualification from its identifier
Request
GET /checkProductOfferingQualification/{id}
Response
200
{
"href":
lification/101",
"id": "101",
"channel": {
"id": "1",
"name": "Web"
},
resource",
{
"product": {
"id": "77",
"href":
},
{
"value": {
"MMTel_Support": 1,

}
}
],
"place": [
{
"role": "Coverage",
"name": "France",
"id": "FRA",
"href":
}
]
},
"action": "add",
"id": "1",
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"creationDate": "2021-09-02T07:11:53.168Z"
}
Creates a CheckProductOfferingQualification
POST /checkProductOfferingQualification
Description
This operation creates a CheckProductOfferingQualification entity.
Mandatory Attributes
Mandatory Attributes Rule
checkProductOfferingQualificationIte
m
Usage samples
Creation of a new CheckProductOfferingQualification with POST operation

Request
POST /checkProductOfferingQualification
{
"channel": {
"id": "1",
"name": "Web"
},
"note": [
{
"@type": "Note",
"date": "2020-11-20T08:00:00Z",
"id": "1",
}
],
{
"id": "DPI123",
},
"action": "add",
"id": "1"
},
{
"id": "DPI123",
},
"action": "add",
"id": "2"
},
{
"id": "DPI128",
},
"action": "add",
"id": "3"
}
],
"relatedParty": [
{

"id": "45hj-999",
"name": "Louise",
}
],
"requestedQualificationCompletionDate": "2021-09-01T14:21:03.354Z"
}
Response
201
{
"href":
/99",
"id": "99",
"channel": {
"id": "1",
"name": "Web"
},
"note": [
{
"@type": "Note",
"date": "2020-11-20T08:00:00Z",
"id": "1",
}
],
{
"id": "DPI123",
"href":
},
"action": "add",
"id": "1",
"state": "done"
},
{
{

exists",
"code": "TE45A"
}
],
"id": "DPI123",
"href":
},
{
"id": "DPI124",
"href":
},
"id": "1"
}
],
"action": "add",
"id": "2",
"state": "done"
},
{
{
"code": "TE45"
}
],
"id": "DPI128",
"href":
},
"action": "add",
"id": "3",
"state": "done"
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",

}
],
"state": "done",
"creationDate": "2021-09-01T14:21:03.354Z"
}
Updates partially a CheckProductOfferingQualification

PATCH /checkProductOfferingQualification/{id}?fields=…&{filtering}
Description
This operation allows partial updates of a CheckProductOfferingQualification entity. Support of

json/merge (https://tools.ietf.org/html/rfc7386) is mandatory, support of json/patch
(http://tools.ietf.org/html/rfc5789) is optiona. Note: If the update operation yields to the creation of
sub-resources or relationships, the same rules concerning mandatory sub-resource attributes and
default value settings in the POST operation applies to the PATCH operation. Hence these tables are
not repeated here.
Patchable and Non Patchable Attributes
Non Patchable Attributes Rule
creationDate
href
id
@baseType
@schemaLocation
@type
channel
checkProductOfferingQualificationIte
m
description
effectiveQualificationDate
expectedQualificationCompletionDat
e
expirationDate
instantSyncQualification

note
provideAlternative
provideOnlyAvailable
provideUnavailabilityReason
qualificationResult
relatedParty
requestedQualificationCompletionDa
te
state
Usage samples
Update a CheckProductOfferingQualification using json-patch
Request
PATCH /checkProductOfferingQualification/{id}
Content-Type: application/json-patch+json
[
{
"op": "add",
"path":
"/CheckProductOfferingQualificationItem/product/place?CheckProductOfferingQualificat
ionItem.id=1",
"value": {
"role": "Coverage",
"name": "Belgium",
"id": "BEL",
"href":
"https://host:port/geographicLocationManagement/v5/geographicLocation/BEL"
}
}
]
Response
200
{
"href":
lification/101",
"id": "101",
"channel": {
"id": "1",
"name": "Web"
},
resource",
{
"product": {
"id": "77",
"href":
},
{
"value": {
"MMTel_Support": 1,
}
}
],
"place": [
{
"role": "Coverage",
"name": "France",
"id": "FRA",
"href":
},
{
"role": "Coverage",
"name": "Belgium",
"id": "BEL",
"href":
}
]
},
"action": "add",
"id": "1",
}
],

"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"creationDate": "2021-09-02T07:11:53.168Z"
}
Update a CheckProductOfferingQualification using merge-patch
Request
PATCH /checkProductOfferingQualification/{id}
Content-Type: application/merge-patch+json
{
"id": "101",
{
"place": [
{
"role": "Coverage",
"name": "France",
"id": "FRA",
"href":
},
{
"role": "Coverage",
"name": "Belgium",
"id": "BEL",
"href":
}
],
"id": "1"
}
]
}
Response
200

"href":
lification/101",
"id": "101",
"channel": {
"id": "1",
"name": "Web"
},
resource",
{
"product": {
"id": "77",
"href":
},
{
"value": {
"MMTel_Support": 1,
}
}
],
"place": [
{
"role": "Coverage",
"name": "France",
"id": "FRA",
"href":
},
{
"role": "Coverage",
"name": "Belgium",
"id": "BEL",
"href":
}
]
},
"action": "add",

"id": "1",
}
],
"relatedParty": [
{
"id": "45hj-999",
"name": "Louise",
}
],
"creationDate": "2021-09-02T07:11:53.168Z"
}
Deletes a CheckProductOfferingQualification
DELETE /checkProductOfferingQualification/{id}?fields=…&{filtering}
Description
This operation deletes a CheckProductOfferingQualification entity.

API NOTIFICATIONS
For every single of operation on the entities use the following templates and provide sample REST
notification POST calls.
It is assumed that the Pub/Sub uses the Register and UnRegister mechanisms described in the REST
Guidelines reproduced below.
Register listener
POST /hub
Description
Sets the communication endpoint address the service instance must use to deliver information
about its health state, execution state, failures and metrics. Subsequent POST calls will be rejected
by the service if it does not support multiple listeners. In this case DELETE /api/hub/{id} must be
called before an endpoint can be created again.
Behavior
Returns HTTP/1.1 status code 204 if the request was successful.
Returns HTTP/1.1 status code 409 if request is not successful.
Usage Samples
Here’s an example of a request for registering a listener.
Request
POST /api/hub
Accept: application/json
{
"callback": "http://in.listener.com"
}
Response

201
Location: /api/hub/42
{
"id":"42",
"callback": "http://in.listener.com",
"query":""
}
Unregister listener
DELETE /hub/{id}
Description
Clears the communication endpoint address that was set by creating the Hub..
Behavior
Returns HTTP/1.1 status code 204 if the request was successful.
Returns HTTP/1.1 status code 404 if the resource is not found.
Usage Samples
Here’s an example of a request for un-registering a listener.
Request
DELETE /api/hub/42
Response
204
Publish Event to listener

POST /client/listener
Description
Clears the communication endpoint address that was set by creating the Hub.

Provides to a registered listener the description of the event that was raised. The /client/listener url
is the callback url passed when registering the listener.
Behavior
Returns HTTP/1.1 status code 201 if the service is able to set the configuration.
Usage Samples
Here’s an example of a notification received by the listener. In this example “EVENT TYPE” should be
replaced by one of the notification types supported by this API (see Notification resources Models
section) and EVENT BODY refers to the data structure of the given notification type.
Request
POST /client/listener
{
"event": {
EVENT BODY
},
"eventType": "EVENT_TYPE"
}
Response
201
For detailed examples on the general TM Forum notification mechanism, see the TMF REST Design
Guidelines.

Acknowledgements
Release History
Release Date Release led by: Description
Number
Contributors to Document

TMF679-ProductOfferingQualification-v5 0 0

Uploaded by

Copyright:

Available Formats

You might also like

TMF679-ProductOfferingQualification-v5 0 0

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TMF679-ProductOfferingQualification-v5 0 0

Uploaded by

Copyright:

Available Formats

TM Forum Specification

Release: TBD Status: TBD

© TM Forum 2022. All Rights Reserved.

Direct inquiries to the TM Forum office:

4 Century Drive, Suite 100

TM Forum Web Page: www.tmforum.org

© TM Forum 2022. All Rights Reserved. Page i

Sample Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Support of polymorphism and extension patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Managed Entity and Task Resource Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Notification Resource Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Query Product Offering Qualification State Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Query Product Offering Qualification Create Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Query Product Offering Qualification Delete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Query Product Offering Qualification Attribute Value Change Event . . . . . . . . . . . . . . . . . . . . . . 18

Check Product Offering Qualification Create Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Check Product Offering Qualification State Change Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Check Product Offering Qualification Attribute Value Change Event . . . . . . . . . . . . . . . . . . . . . . 24

Check Product Offering Qualification Delete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

List or find QueryProductOfferingQualification objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Updates partially a QueryProductOfferingQualification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

List or find CheckProductOfferingQualification objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Updates partially a CheckProductOfferingQualification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Publish Event to listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

© TM Forum 2022. All Rights Reserved. Page ii

© TM Forum 2022. All Rights Reserved. Page 1

Sample Use Cases

© TM Forum 2022. All Rights Reserved. Page 2

Support of polymorphism and extension

© TM Forum 2022. All Rights Reserved. Page 3

QueryProductOfferingQualification is used to perform a commercial eligibility. It allows client side to

© TM Forum 2022. All Rights Reserved. Page 4

creationDate A DateTime. Date and time when the

description A String. Description of the QueryProductOfferingQualification.

effectiveQualificationDate A DateTime. Effective date to QueryProductOfferingQualification

expirationDate A DateTime. Date the qualification response expires.

href A String. Hyperlink reference.

id A String. Unique identifier.

qualifiedProductOfferingItem A QueryProductOfferingQualificationItem. Qualification item for a

requestedQualificationCompletionDa A DateTime. Deadline date when the requester expected a

state A TaskStateType. State of the QueryProductOfferingQualification :

CategoryRef sub-resource fields

href A String. Hyperlink reference.

Note sub-resource fields

author A String. Author of the note.

date A DateTime. Date of the note.

id A String. Identifier of the note within its containing entity.

text A String. Text of the note.

© TM Forum 2022. All Rights Reserved. Page 5

ProductOfferingQualificationItemRelationship sub-resource fields

id A String. Id of the related POQ item (must be in the same POQ).

relationshipType A String. Relationship type as relies on, bundles, etc…

ProductOfferingRef sub-resource fields

href A String. Hyperlink reference.

PromotionRef sub-resource fields

href A String. Hyperlink reference.

QueryProductOfferingQualificationItem sub-resource fields

id A String. Identifier of the ProductOfferingQualification item (generally