productqualificationtmfwebservices API

basic

extended

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

agreementId
optional

Identifier of the agreement

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

alternateActivationDate
optional

Alternate activation date in case seller is not able to meet requested expected activation date.

string(date-time)

alternateProduct
optional

Alternate product proposal

ProductRefOrValue

alternateProductOffering
optional

Alternate product offering proposal

ProductOfferingRef

id
optional

Identifier of a alternate product offering proposal

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the billing account

string

id
required

Unique identifier of the billing account

string

name
optional

Name of the billing account

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

version
optional

Category version

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the channel.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

name
required

Name of the characteristic

string

value
required

The value of the characteristic

string

valueType
optional

Data type of the value of the characteristic

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

code
optional

Unavailability reason code.

string

label
optional

Unavailability reason label.

string

@baseType
optional

When sub-classing, this defines the super-class.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name.

string

code
required

Application relevant detail, defined in the API or a common list.

string

message
optional

More details and corrective actions related to the error which can be shown to a client user.

string

reason
optional

Explanation of the reason for the error which can be shown to a client user.

string

referenceError
optional

URI of documentation describing the error.

string

status
optional

HTTP Error code extension

string

unit
optional

Currency (ISO4217 norm uses 3 letters to define the currency)

string

value
optional

A positive floating point number

number(float)

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

author
optional

Author of the note

string

date
optional

Date of the note

string(date-time)

id
required

Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)

string

text
required

Text of the note

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

dutyFreeAmount
optional

All taxes excluded amount (expressed in the given currency)

Money

percentage
optional

Percentage to apply for ProdOfferPriceAlteration

number(float)

taxIncludedAmount
optional

All taxes included amount (expressed in the given currency)

Money

taxRate
optional

Tax rate

number(float)

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

applicationDuration
optional

Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)

integer(int32)

description
optional

A narrative that explains in detail the semantics of this order item price alteration

string

name
optional

Name of the order item price alteration

string

price
required

Price

priceType
required

A category that describes the price such as recurring, one time and usage.

string

priority
optional

Priority level for applying this alteration among all the defined alterations on the order item price

integer(int32)

productOfferingPrice
optional

ProductOfferingPriceRef

recurringChargePeriod
optional

Could be month, week…

string

unitOfMeasure
optional

Could be minutes, GB…

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

category
optional

CategoryRef

channel
optional

Channel used for the qualification

ChannelRef

description
optional

Description of the productOfferingQualification

string

effectiveQualificationDate
optional

Effective date to productOfferingQualification completion

string(date-time)

expectedPOQCompletionDate
optional

Date when the requester expect to provide an answer for the qualification request

string(date-time)

expirationDate
optional

Date the qualification response expires

string(date-time)

href
optional

Hyperlink to access the productOfferingQualification

string

id
optional

Unique identifier of the productOfferingQualification resource

string

instantSyncQualification
optional

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.

boolean

note
optional

Free form text associated with the qualification request

< Note > array

place
optional

< RelatedPlaceRefOrValue > array

productOfferingQualificationDate
optional

Date when the productOfferingQualification has been submitted

string(date-time)

productOfferingQualificationItem
optional

Qualification item for a product or a category

< ProductOfferingQualificationItem > array

provideAlternative
optional

An indicator which when the value is "true" means that alternative solutions should be provided

boolean

provideOnlyAvailable
optional

An indicator which when the value is "true" means that only available product offering must be listed in the response

boolean

provideUnavailabilityReason
optional

An indicator which when the value is "true" means that unavailability reason are expected for non available product offering

boolean

qualificationResult
optional

Result of the qualification (example: green, yellow, red)

string

relatedParty
optional

Party playing a role for this qualification (as requester for example)

< RelatedParty > array

requestedPOQCompletionDate
optional

Deadline date when the requester expected a qualification answer

string(date-time)

state
optional

State of the productOfferingQualification defined in the state engine

enum (acknowledged, terminatedWithError, inProgress, done)

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

action
optional

Can be "add" / "modify" / "no_change"/ "delete" - by default add is considered

enum (add, modify, delete, noChange)

alternateProductOfferingProposal
optional

< AlternateProductOfferingProposal > array

eligibilityUnavailabilityReason
optional

< EligibilityUnavailabilityReason > array

expectedActivationDate
optional

Date when the requester look for productOfferingQualification activation

string(date-time)

id
required

Id of the productOfferingQualification item

string

note
optional

< Note > array

product
optional

ProductRefOrValue

productOffering
optional

ProductOfferingRef

qualificationItemRelationship
optional

< QualificationItemRelationship > array

qualificationItemResult
optional

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)

string

state
optional

State of the productOfferingQualification item defined in the state engine

enum (acknowledged, terminatedWithError, inProgress, done)

terminationError
optional

< TerminationError > array

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

billingAccount
optional

BillingAccountRef

description
optional

A narrative that explains in detail the semantics of this product price.

string

name
optional

A short descriptive name such as "Subscription price".

string

price
required

Price

priceType
required

A category that describes the price, such as recurring, discount, allowance, penalty, and so forth.

string

productOfferingPrice
optional

ProductOfferingPriceRef

productPriceAlteration
optional

< PriceAlteration > array

recurringChargePeriod
optional

Could be month, week…

string

unitOfMeasure
optional

Could be minutes, GB…

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

agreement
optional

< AgreementItemRef > array

billingAccount
optional

BillingAccountRef

description
optional

Is the description of the product. It could be copied from the description of the Product Offering.

string

href
optional

Reference of the product

string

id
optional

Unique identifier of the product

string

isBundle
optional

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.

boolean

isCustomerVisible
optional

If true, the product is visible by the customer.

boolean

name
optional

Name of the product. It could be the same as the name of the product offering

string

orderDate
optional

Is the date when the product was ordered

string(date-time)

place
optional

< RelatedPlaceRefOrValue > array

product
optional

< ProductRefOrValue > array

productCharacteristic
optional

< Characteristic > array

productOffering
optional

ProductOfferingRef

productOrderItem
optional

< RelatedProductOrderItem > array

productPrice
optional

< ProductPrice > array

productRelationship
optional

< ProductRelationship > array

productSerialNumber
optional

Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router.

string

productSpecification
optional

ProductSpecificationRef

productTerm
optional

< ProductTerm > array

realizingResource
optional

< ResourceRef > array

realizingService
optional

< ServiceRef > array

relatedParty
optional

< RelatedParty > array

startDate
optional

Is the date from which the product starts

string(date-time)

status
optional

Is the lifecycle status of the product.

enum (created, pendingActive, cancelled, active, pendingTerminate, terminated, suspended, aborted)

terminationDate
optional

Is the date when the product was terminated

string(date-time)

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

product
required

ProductRefOrValue

relationshipType
required

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

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

targetProductSchema
optional

A target product schema reference. The reference object to the schema and type of target product which is described by product specification.

TargetProductSchema

version
optional

Version of the product specification

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

description
optional

Description of the productTerm

string

duration
optional

Duration of the productTerm

Quantity

name
optional

Name of the productTerm

string

validFor
optional

productTerm validity period

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

id
optional

Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem).

string

relationshipType
optional

Type of relationship (ex: reliesOn, connectedTo, etc…)

string

amount
optional

Numeric value in a given unit

number(float)

units
optional

Unit

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

role
optional

Role played by the related party

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Unique reference of the place

string

id
optional

Unique identifier of the place

string

name
optional

A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]

string

role
required

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

orderItemAction
optional

Action of the order item for this product

string

orderItemId
required

Identifier of the order item where the product was managed

string

productOrderHref
optional

Reference of the related entity.

string

productOrderId
required

Unique identifier of a related entity.

string

role
optional

role of the product order item for this product

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the resource

string

value
optional

The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
required

This field provides a link to the schema describing the target product

string

@type
required

Class type of the target product

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

A URI to a JSON-Schema file that defines additional attributes and relationships

string

@type
optional

When sub-classing, this defines the sub-class entity name

string

id
optional

Unique identifier of the termination error

string

value
optional

Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided

string

endDateTime
optional

End of the time period, using IETC-RFC-3339 format

string(date-time)

startDateTime
optional

Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end

string(date-time)