Subscribed Product TMF Webservices 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

@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

@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
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

callback
required

The callback being registered.

string

id
required

Id of the listener

string

query
optional

additional data to be passed

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

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

@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)

correlationId
optional

The correlation id for this event.

string

description
optional

An explnatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

ProductAttributeValueChangeEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

fieldPath
optional

The path identifying the object field concerned by this notification.

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

product
optional

The involved resource data for the event

Product

correlationId
optional

The correlation id for this event.

string

description
optional

An explnatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

ProductCreateEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the ProcessFlow

string

id
optional

Identifier of the Process flow

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

product
optional

The involved resource data for the event

Product

correlationId
optional

The correlation id for this event.

string

description
optional

An explnatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

ProductDeleteEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the ProcessFlow

string

id
optional

Identifier of the Process flow

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

product
optional

The involved resource data for the event

Product

@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

@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

correlationId
optional

The correlation id for this event.

string

description
optional

An explnatory of the event.

string

domain
optional

The domain of the event.

string

event
optional

The event payload linked to the involved resource object

ProductStateChangeEventPayload

eventId
optional

The identifier of the notification.

string

eventTime
optional

Time of the event occurrence.

string(date-time)

eventType
optional

The type of the notification.

string

href
optional

Reference of the ProcessFlow

string

id
optional

Identifier of the Process flow

string

priority
optional

A priority.

string

timeOcurred
optional

The time the event occured.

string(date-time)

title
optional

The title of the event.

string

product
optional

The involved resource data for the event

Product

@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

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

body
optional

object

statusCode
optional

enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
optional

integer(int32)

@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

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)