B2ctelco Tmf Webservices

Responses

HTTP Code	Description	Schema
201	Created	ProductOffering
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	No Content
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

No Content

405

Method Not allowed

409

Conflict

500

Internal Server Error

Consumes

application/json;charset=utf-8

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.2. Retrieves a list of 'ProductOffering'

GET /productOffering

Description

This operation retrieves a list of product offering entities

Parameters

Type	Name	Description	Schema
Query	@baseType optional	For filtering: Immediate base (class) type of the product offering	string
Query	@schemaLocation optional	For filtering: A link to the schema describing this product offering	string
Query	@type optional	For filtering: Class type of the product offering	string
Query	agreement.@referredType optional	For filtering: class type of the referred Agreement	string
Query	agreement.name optional	For filtering: Name of the agreement	string
Query	attachment.@baseType optional	For filtering: The immediate base class type of the attachment	string
Query	attachment.@schemaLocation optional	For filtering: A link to the schema describing this attachment entity	string
Query	attachment.@type optional	For filtering: the class type of the Attachment	string
Query	attachment.mimeType optional	For filtering: Attachment mime type such as extension file for video, picture and document	string
Query	attachment.type optional	For filtering: Attachment type such as video, picture	string
Query	attachment.url optional	For filtering: Uniform Resource Locator, is a web page address (a subset of URI)	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	bundledProductOffering.lifecycleStatus optional	For filtering: Used to indicate the current lifecycle status	string
Query	bundledProductOffering.name optional	For filtering: Name of the BundledProductOffering	string
Query	category.@referredType optional	For filtering: the class type of the referred Category	string
Query	category.name optional	For filtering: Name of the category	string
Query	category.version optional	For filtering: Category version	string
Query	channel.@referredType optional	For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on	string
Query	channel.name optional	For filtering: Name of the channel	string
Query	facetSearchOption.id optional	For filtering by facet options. The identifier of the facet search option.	< string > array(multi)
Query	fields optional	Comma separated properties to display in response	string
Query	isBundle optional	For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).	boolean
Query	lastUpdate optional	For filtering: Date and time of the last update	string
Query	lifecycleStatus optional	For filtering: Used to indicate the current lifecycle status	string
Query	limit optional	Requested number of resources to be provided in response requested by client.	integer(int32)
Query	marketSegment.@referredType optional	For filtering: (Class) type of the referred market segment	string
Query	marketSegment.name optional	For filtering: Name of the market segment	string
Query	name optional	For filtering: Name of the productOffering	string
Query	offeringGroup.id optional	For filtering: Id of the productOfferingGroup	string
Query	offset optional	Requested index for start of resources to be provided in response requested by client.	integer(int32)
Query	parentBundledProductOffering.id optional	For filtering: Id of the parentBundledProductOffering	string
Query	place.@referredType optional	For filtering: class type of the referred Place object	string
Query	place.address optional	For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).	string
Query	place.name optional	For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"	string
Query	place.role optional	For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')	string
Query	prodSpecCharValueUse.maxCardinality optional	For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.	integer(int32)
Query	prodSpecCharValueUse.minCardinality optional	For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.	integer(int32)
Query	prodSpecCharValueUse.name optional	For filtering: Name of the associated productSpecCharacteristic	string
Query	prodSpecCharValueUse.valueType optional	For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth	string
Query	productOfferingPrice.@baseType optional	For filtering: the immediate base class of product offering price	string
Query	productOfferingPrice.@schemaLocation optional	For filtering: hyperlink reference to the product offering price schema	string
Query	productOfferingPrice.@type optional	For filtering: The class type of the product offering price	string
Query	productOfferingPrice.isBundle optional	For filtering: a flag indicating if this product offering price is bundle (composite) or not	boolean
Query	productOfferingPrice.name optional	For filtering: Name of the productOfferingPrice	string
Query	productOfferingPrice.place.id optional	For filtering: Identifier of the place for which product offering has prices available	string
Query	productOfferingPrice.priceType optional	For filtering: Indicates the price type: recurring, one time, usage	string
Query	productOfferingPrice.recurringChargePeriod optional	For filtering: Could be month, week…	string
Query	productOfferingPrice.relatedParty.id optional	For filtering: Identifier of the related party for which the price applies.	string
Query	productOfferingPrice.unitOfMeasure optional	For filtering: Could be minutes, GB…	string
Query	productOfferingPrice.version optional	For filtering: ProductOffering version	string
Query	productOfferingTerm.@schemaLocation optional	For filtering: A link to the schema describing this product offering term	string
Query	productOfferingTerm.@type optional	For filtering: The class type of ProductOfferingTerm	string
Query	productOfferingTerm.name optional	For filtering: Name of the productOfferingTerm	string
Query	productSpecification.@referredType optional	For filtering: class type of referred Product Specification	string
Query	productSpecification.name optional	For filtering: Name of the product specification	string
Query	productSpecification.version optional	For filtering: Version of the product specification	string
Query	resourceCandidate.@referredType optional	For filtering: The Class type of referred Resource Candidate	string
Query	resourceCandidate.name optional	For filtering: Name of the resource candidate	string
Query	resourceCandidate.version optional	For filtering: Version of the resource candidate	string
Query	serviceCandidate.@referredType optional	For filtering: The Class type of referred Service Candidate	string
Query	serviceCandidate.name optional	For filtering: Name of the service candidate	string
Query	serviceCandidate.version optional	For filtering: Version of the service candidate	string
Query	serviceLevelAgreement.@referredType optional	For filtering: class type of referred Service Level Agreement	string
Query	serviceLevelAgreement.name optional	For filtering: Name of the service level agreement	string
Query	sort optional	For sorting: The options the product offerings can be sorted by.	< string > array(multi)
Query	validFor.endDateTime optional	For filtering: An instant of time, ending at the TimePeriod.	string(date-time)
Query	validFor.startDateTime optional	For filtering: An instant of time, starting at the TimePeriod	string(date-time)
Query	version optional	For filtering: ProductOffering version	string

Type

Name

Description

Schema

Query

@baseType
optional

For filtering: Immediate base (class) type of the product offering

string

Query

@schemaLocation
optional

For filtering: A link to the schema describing this product offering

string

Query

@type
optional

For filtering: Class type of the product offering

string

Query

agreement.@referredType
optional

For filtering: class type of the referred Agreement

string

Query

agreement.name
optional

For filtering: Name of the agreement

string

Query

attachment.@baseType
optional

For filtering: The immediate base class type of the attachment

string

Query

attachment.@schemaLocation
optional

For filtering: A link to the schema describing this attachment entity

string

Query

attachment.@type
optional

For filtering: the class type of the Attachment

string

Query

attachment.mimeType
optional

For filtering: Attachment mime type such as extension file for video, picture and document

string

Query

attachment.type
optional

For filtering: Attachment type such as video, picture

string

Query

attachment.url
optional

For filtering: Uniform Resource Locator, is a web page address (a subset of URI)

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

bundledProductOffering.lifecycleStatus
optional

For filtering: Used to indicate the current lifecycle status

string

Query

bundledProductOffering.name
optional

For filtering: Name of the BundledProductOffering

string

Query

category.@referredType
optional

For filtering: the class type of the referred Category

string

Query

category.name
optional

For filtering: Name of the category

string

Query

category.version
optional

For filtering: Category version

string

Query

channel.@referredType
optional

For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on

string

Query

channel.name
optional

For filtering: Name of the channel

string

Query

facetSearchOption.id
optional

For filtering by facet options. The identifier of the facet search option.

< string > array(multi)

Query

fields
optional

Comma separated properties to display in response

string

Query

isBundle
optional

For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).

boolean

Query

lastUpdate
optional

For filtering: Date and time of the last update

string

Query

lifecycleStatus
optional

For filtering: Used to indicate the current lifecycle status

string

Query

limit
optional

Requested number of resources to be provided in response requested by client.

integer(int32)

Query

marketSegment.@referredType
optional

For filtering: (Class) type of the referred market segment

string

Query

marketSegment.name
optional

For filtering: Name of the market segment

string

Query

name
optional

For filtering: Name of the productOffering

string

Query

offeringGroup.id
optional

For filtering: Id of the productOfferingGroup

string

Query

offset
optional

Requested index for start of resources to be provided in response requested by client.

integer(int32)

Query

parentBundledProductOffering.id
optional

For filtering: Id of the parentBundledProductOffering

string

Query

place.@referredType
optional

For filtering: class type of the referred Place object

string

Query

place.address
optional

For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).

string

Query

place.name
optional

For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home"

string

Query

place.role
optional

For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval')

string

Query

prodSpecCharValueUse.maxCardinality
optional

For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.

integer(int32)

Query

prodSpecCharValueUse.minCardinality
optional

For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.

integer(int32)

Query

prodSpecCharValueUse.name
optional

For filtering: Name of the associated productSpecCharacteristic

string

Query

prodSpecCharValueUse.valueType
optional

For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth

string

Query

productOfferingPrice.@baseType
optional

For filtering: the immediate base class of product offering price

string

Query

productOfferingPrice.@schemaLocation
optional

For filtering: hyperlink reference to the product offering price schema

string

Query

productOfferingPrice.@type
optional

For filtering: The class type of the product offering price

string

Query

productOfferingPrice.isBundle
optional

For filtering: a flag indicating if this product offering price is bundle (composite) or not

boolean

Query

productOfferingPrice.name
optional

For filtering: Name of the productOfferingPrice

string

Query

productOfferingPrice.place.id
optional

For filtering: Identifier of the place for which product offering has prices available

string

Query

productOfferingPrice.priceType
optional

For filtering: Indicates the price type: recurring, one time, usage

string

Query

productOfferingPrice.recurringChargePeriod
optional

For filtering: Could be month, week…

string

Query

productOfferingPrice.relatedParty.id
optional

For filtering: Identifier of the related party for which the price applies.

string

Query

productOfferingPrice.unitOfMeasure
optional

For filtering: Could be minutes, GB…

string

Query

productOfferingPrice.version
optional

For filtering: ProductOffering version

string

Query

productOfferingTerm.@schemaLocation
optional

For filtering: A link to the schema describing this product offering term

string

Query

productOfferingTerm.@type
optional

For filtering: The class type of ProductOfferingTerm

string

Query

productOfferingTerm.name
optional

For filtering: Name of the productOfferingTerm

string

Query

productSpecification.@referredType
optional

For filtering: class type of referred Product Specification

string

Query

productSpecification.name
optional

For filtering: Name of the product specification

string

Query

productSpecification.version
optional

For filtering: Version of the product specification

string

Query

resourceCandidate.@referredType
optional

For filtering: The Class type of referred Resource Candidate

string

Query

resourceCandidate.name
optional

For filtering: Name of the resource candidate

string

Query

resourceCandidate.version
optional

For filtering: Version of the resource candidate

string

Query

serviceCandidate.@referredType
optional

For filtering: The Class type of referred Service Candidate

string

Query

serviceCandidate.name
optional

For filtering: Name of the service candidate

string

Query

serviceCandidate.version
optional

For filtering: Version of the service candidate

string

Query

serviceLevelAgreement.@referredType
optional

For filtering: class type of referred Service Level Agreement

string

Query

serviceLevelAgreement.name
optional

For filtering: Name of the service level agreement

string

Query

sort
optional

For sorting: The options the product offerings can be sorted by.

< string > array(multi)

Query

validFor.endDateTime
optional

For filtering: An instant of time, ending at the TimePeriod.

string(date-time)

Query

validFor.startDateTime
optional

For filtering: An instant of time, starting at the TimePeriod

string(date-time)

Query

version
optional

For filtering: ProductOffering version

string

Responses

HTTP Code	Description	Schema
200	Ok	< ProductOffering > array
400	Bad Request	Error
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	Error
405	Method Not Allowed	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

< ProductOffering > array

400

Bad Request

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

405

Method Not Allowed

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.3. Retrieves a 'ProductOffering' by Id

GET /productOffering/{id}

Description

This operation retrieves a product offering entity using its unique ID

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the Product Offering	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body	string
Query	priceContext.place.id optional	Identifier of the place for which product offering has prices available	string
Query	priceContext.processType.id optional	For filtering by the process type of the product offering price.	< string > array(multi)
Query	priceContext.relatedParty.id optional	For filtering: Identifier of the related party for which the price applies.	string

Type

Name

Description

Schema

Path

id
required

Identifier of the Product Offering

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body

string

Query

priceContext.place.id
optional

Identifier of the place for which product offering has prices available

string

Query

priceContext.processType.id
optional

For filtering by the process type of the product offering price.

< string > array(multi)

Query

priceContext.relatedParty.id
optional

For filtering: Identifier of the related party for which the price applies.

string

Responses

HTTP Code	Description	Schema
200	Ok	< ProductOffering > array
400	Bad Request	Error
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

< ProductOffering > array

400

Bad Request

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.4. Deletes a ProductOffering

DELETE /productOffering/{id}

Description

This operation deletes a ProductOffering entity.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the ProductOffering	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string

Type

Name

Description

Schema

Path

id
required

Identifier of the ProductOffering

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Responses

HTTP Code	Description	Schema
204	Deleted	No Content
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

204

Deleted

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.5. Updates partially a ProductOffering

PATCH /productOffering/{id}

Description

This operation updates partially a ProductOffering entity.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the ProductOffering	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Body	productOffering required	The ProductOffering to be updated	ProductOffering

Type

Name

Description

Schema

Path

id
required

Identifier of the ProductOffering

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Body

productOffering
required

The ProductOffering to be updated

Responses

HTTP Code	Description	Schema
200	Updated	ProductOffering
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Updated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Consumes

application/json;charset=utf-8

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.6. Creates a ProductOfferingPrice

POST /productOfferingPrice

Description

This operation creates a ProductOfferingPrice entity.

Parameters

Type	Name	Description	Schema
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Body	productOfferingPrice required	The ProductOfferingPrice to be created	ProductOfferingPrice

Type

Name

Description

Schema

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Body

productOfferingPrice
required

The ProductOfferingPrice to be created

Responses

HTTP Code	Description	Schema
201	Created	ProductOfferingPrice
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	No Content
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

No Content

405

Method Not allowed

409

Conflict

500

Internal Server Error

Consumes

application/json;charset=utf-8

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.7. List or find ProductOfferingPrice objects

GET /productOfferingPrice

Description

This operation list or find ProductOfferingPrice entities

Parameters

Type	Name	Description	Schema
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Query	fields optional	Comma-separated properties to be provided in response	string
Query	isBundle optional	For filtering to get only the product offering prices that are composite(true) or component(false)	boolean
Query	lastUpdate optional	For filtering: Date and time of the last update	string
Query	lifecycleStatus optional	Used to indicate the current lifecycle status	string
Query	limit optional	Requested number of resources to be provided in response	integer(int32)
Query	name optional	Name of the Product Offering Price	string
Query	offset optional	Requested index for start of resources to be provided in response	integer(int32)
Query	priceType optional	For filtering to get only the product offering prices with a given price type(recurring, usage, etc)	string

Type

Name

Description

Schema

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Query

fields
optional

Comma-separated properties to be provided in response

string

Query

isBundle
optional

For filtering to get only the product offering prices that are composite(true) or component(false)

boolean

Query

lastUpdate
optional

For filtering: Date and time of the last update

string

Query

lifecycleStatus
optional

Used to indicate the current lifecycle status

string

Query

limit
optional

Requested number of resources to be provided in response

integer(int32)

Query

name
optional

Name of the Product Offering Price

string

Query

offset
optional

Requested index for start of resources to be provided in response

integer(int32)

Query

priceType
optional

For filtering to get only the product offering prices with a given price type(recurring, usage, etc)

string

Responses

HTTP Code	Description	Schema
200	Success	< ProductOfferingPrice > array
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Success

< ProductOfferingPrice > array

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.8. Retrieves a ProductOfferingPrice by ID

GET /productOfferingPrice/{id}

Description

This operation retrieves a ProductOfferingPrice entity. Attribute selection is enabled for all first level attributes.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the Product Offering Price	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body	string

Type

Name

Description

Schema

Path

id
required

Identifier of the Product Offering Price

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body

string

Responses

HTTP Code	Description	Schema
200	Success	ProductOfferingPrice
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.9. Deletes a ProductOfferingPrice

DELETE /productOfferingPrice/{id}

Description

This operation deletes a ProductOfferingPrice entity.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the ProductOfferingPrice	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string

Type

Name

Description

Schema

Path

id
required

Identifier of the ProductOfferingPrice

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Responses

HTTP Code	Description	Schema
204	Deleted	No Content
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

204

Deleted

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.10. Updates partially a ProductOfferingPrice

PATCH /productOfferingPrice/{id}

Description

This operation updates partially a ProductOfferingPrice entity.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the ProductOfferingPrice	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Body	productOfferingPrice required	The ProductOfferingPrice to be updated	ProductOfferingPrice

Type

Name

Description

Schema

Path

id
required

Identifier of the ProductOfferingPrice

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Body

productOfferingPrice
required

The ProductOfferingPrice to be updated

Responses

HTTP Code	Description	Schema
200	Updated	ProductOfferingPrice
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Updated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Consumes

application/json;charset=utf-8

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.11. Creates a ProductSpecification

POST /productSpecification

Description

This operation creates a ProductSpecification entity.

Parameters

Type	Name	Description	Schema
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Body	productSpecification required	The ProductSpecification to be created	ProductSpecification

Type

Name

Description

Schema

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Body

productSpecification
required

The ProductSpecification to be created

Responses

HTTP Code	Description	Schema
201	Created	ProductSpecification
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	No Content
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

No Content

405

Method Not allowed

409

Conflict

500

Internal Server Error

Consumes

application/json;charset=utf-8

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.12. List or find ProductSpecification objects

GET /productSpecification

Description

This operation list or find ProductSpecification entities

Parameters

Type	Name	Description	Schema
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Query	fields optional	Comma-separated properties to be provided in response	string
Query	lastUpdate optional	For filtering: Date and time of the last update	string
Query	lifecycleStatus optional	Used to indicate the current lifecycle status	string
Query	limit optional	Requested number of resources to be provided in response	integer(int32)
Query	name optional	Name of the catalog	string
Query	offset optional	Requested index for start of resources to be provided in response	integer(int32)
Query	productSpecCharacteristic.id optional	For filtering by the productSpecCharacteristic Id.	< string > array(multi)
Query	productSpecCharacteristic.name optional	For filtering by the productSpecCharacteristic Name.	< string > array(multi)
Query	productSpecType.id optional	For filtering only the product specifications having the given type - can be internet, GSM, etc	< string > array(multi)

Type

Name

Description

Schema

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Query

fields
optional

Comma-separated properties to be provided in response

string

Query

lastUpdate
optional

For filtering: Date and time of the last update

string

Query

lifecycleStatus
optional

Used to indicate the current lifecycle status

string

Query

limit
optional

Requested number of resources to be provided in response

integer(int32)

Query

name
optional

Name of the catalog

string

Query

offset
optional

Requested index for start of resources to be provided in response

integer(int32)

Query

productSpecCharacteristic.id
optional

For filtering by the productSpecCharacteristic Id.

< string > array(multi)

Query

productSpecCharacteristic.name
optional

For filtering by the productSpecCharacteristic Name.

< string > array(multi)

Query

productSpecType.id
optional

For filtering only the product specifications having the given type - can be internet, GSM, etc

< string > array(multi)

Responses

HTTP Code	Description	Schema
200	Success	< ProductSpecification > array
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Success

< ProductSpecification > array

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.13. Retrieves a ProductSpecification by ID

GET /productSpecification/{id}

Description

This operation retrieves a ProductSpecification entity. Attribute selection is enabled for all first level attributes.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the ProductSpecification	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Query	fields optional	Comma-separated properties to provide in response	string

Type

Name

Description

Schema

Path

id
required

Identifier of the ProductSpecification

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Query

fields
optional

Comma-separated properties to provide in response

string

Responses

HTTP Code	Description	Schema
200	Success	ProductSpecification
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.14. Deletes a ProductSpecification

DELETE /productSpecification/{id}

Description

This operation deletes a ProductSpecification entity.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the ProductSpecification	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string

Type

Name

Description

Schema

Path

id
required

Identifier of the ProductSpecification

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Responses

HTTP Code	Description	Schema
204	Deleted	No Content
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

204

Deleted

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.1.15. Updates partially a ProductSpecification

PATCH /productSpecification/{id}

Description

This operation updates partially a ProductSpecification entity.

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the ProductSpecification	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	catalogId optional	Id of the catalog	string
Query	catalogVersion optional	Version of the catalog	string
Body	productSpecification required	The ProductSpecification to be updated	ProductSpecification

Type

Name

Description

Schema

Path

id
required

Identifier of the ProductSpecification

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

catalogId
optional

Id of the catalog

string

Query

catalogVersion
optional

Version of the catalog

string

Body

productSpecification
required

The ProductSpecification to be updated

Responses

HTTP Code	Description	Schema
200	Updated	ProductSpecification
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
405	Method Not allowed	Error
409	Conflict	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Updated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not allowed

409

Conflict

500

Internal Server Error

Consumes

application/json;charset=utf-8

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

3.2. Product Inventory Management

Tma Product Api Controller

3.2.1. Retrieves a Product by Id

GET /product/{id}

Description

This operation retrieves a subscribed product using its unique ID

Parameters

Type	Name	Description	Schema
Path	id required	Identifier of the Product Offering	string
Query	baseSiteId optional	Identifier of the BaseSite	string
Query	fields optional	Response configuration. This is the list of fields that should be returned in the response body	string

Type

Name

Description

Schema

Path

id
required

Identifier of the Product Offering

string

Query

baseSiteId
optional

Identifier of the BaseSite

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body

string

Responses

HTTP Code	Description	Schema
200	Ok	Product
400	Bad Request	Error
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	Error
500	Internal Server Error	Error

HTTP Code

Description

Schema

200

Product

400

Bad Request

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

500

Internal Server Error

Produces

application/json;charset=utf-8

Security

Type	Name
oauth2	oauth2_client_credentials
oauth2	oauth2_password

Type

Name

oauth2

oauth2

4. Definitions

4.1. AgreementItemRef

Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.

Name

Description

Schema

@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

agreementItemId
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

4.2. AgreementRef

Name

Description

Schema

@referredType
optional

class type of the referred Agreement

string

href
optional

Reference of the agreement

string

id
optional

Identifier of the agreement

string

name
optional

Name of the agreement

string

4.3. Attachment

Media items configured for a product offering (images, videos).

Name

Description

Schema

@baseType
optional

The immediate base class type of the attachment

string

@schemaLocation
optional

A link to the schema describing this attachment entity

string

@type
optional

the class type of the Attachment

string

description
optional

A narrative text describing the content of the attachment

string

href
optional

Not Sent.Reference of the attachment.

string

id
optional

Unique identifier of the attachment

string

mimeType
optional

Attachment mime type such as extension file for video, picture and document

string

type
optional

Attachment type format.

string

url
optional

Uniform Resource Locator, is a web page address (a subset of URI)

string

validFor
optional

Not Sent.

BundledProductOfferingOption

4.4. BillingAccountRef

A BillingAccount is a detailed description of a bill structure

Name

Description

Schema

@referredType
optional

Indicates the (class) type of the billing account

string

href
optional

Reference of the billing account

string

id
required

Unique identier of the billing account

string

name
optional

Name of the billing account

string

4.5. BundledPopRelationship

this object represents a bundle relationship from a bundle product offering (parent) to a simple product offering (child). A simple product offering may participate in more than one bundle relationships.

Name

Description

Schema

@type
optional

(Class) type of the associated product offering

string

href
optional

hyperlink reference of the associated product offering

string

id
optional

Unique identifier of the associated product offering

string

name
optional

Name of the associated product offering

string

4.6. BundledProductOffering

A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.

Name

Description

Schema

@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

bundledProductOfferingOption
optional

A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded.

href
optional

Unique reference of the BundledProductOffering

string

id
optional

Unique identifier of the BundledProductOffering

string

lifecycleStatus
optional

Used to indicate the current lifecycle status

string

name
optional

Name of the BundledProductOffering

string

4.7. BundledProductOfferingOption

A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded

Name

Description

Schema

@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

numberRelOfferDefault
optional

Default number of product offerings that should be procured as part of the related BundledProductOffering

integer(int32)

numberRelOfferLowerLimit
optional

Lower limit for a product offering that can be procured as part of the related BundledProductOffering

integer(int32)

numberRelOfferUpperLimit
optional

Upper limit for a product offering that can be procured as part of the related BundledProductOffering

integer(int32)

4.8. BundledProductSpecification

A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.

Name

Description

Schema

@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

the class type of the corresponding product specification

string

href
optional

Reference of the product specification

string

id
optional

Unique identifier of the product specification

string

lifecycleStatus
optional

Used to indicate the current lifecycle status

string

name
optional

Name of the product specification

string

4.9. CategoryRef

Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings.

Name

Description

Schema

@referredType
optional

The class type of the referred Category

string

href
optional

Not Sent.Unique reference of the category.

string

id
optional

Unique reference of the category

string

name
optional

Name of the category

string

type
optional

Category type, can be Category,VariantCategory or VariantValueCategory.

string

version
optional

Not Sent.Category version.

string

4.10. ChannelRef

Channel reference. The channel defines the channel for selling product offerings.

Name

Description

Schema

@referredType
optional

(Class) type of the referred channel

string

href
optional

Not Sent.Reference of the channel.

string

id
optional

Unique identifier of the channel

string

name
optional

Not Sent

string

4.11. ConstraintRef

Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.

Name

Description

Schema

@referredType
optional

The (class) type of the referred constraint

string

href
optional

Hyperlink reference to the target constraint

string

id
optional

reference id to the target constraint

string

name
optional

Name given to the constraint

string

version
optional

constraint version

string

4.12. Cycle

Represents the billing cycle.

Name

Description

Schema

cycleEnd
optional

Ending cycle.

integer(int32)

cycleStart
optional

Starting cycle.

integer(int32)

4.13. Error

Name

Description

Schema

code
required

An integer coding the error type. This is given to caller so he can translate them if required.

integer(int32)

description
optional

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

string

infoURL
optional

(optional) A URL to online documentation that provides more information about the error.

string

message
required

A short localized string that describes the error.

string

4.14. ExternalIdentifier

Name

Description

Schema

externalIdentifierType
optional

Type of the identification, typically would be the type of the entity within the external system

string

id
optional

Identification of the entity within the external system.

string

owner
optional

Name of the external system that owns the entity.

string

4.15. MarketSegmentRef

provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.

Name

Description

Schema

@referredType
optional

(Class) type of the referred market segment

string

href
optional

Reference of the market segment

string

id
optional

Unique identifier of the market segment

string

name
optional

Name of the market segment

string

4.16. Money

A base / value business entity used to represent money.

Name

Description

Schema

unit
required

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

string

value
required

A positive floating point number

string

4.17. OfferingGroup

Represents a product offering group entity.

Name

Description

Schema

childProductOffering
optional

List of containing product offerings.

< BundledProductOffering > array

id
required

Unique identifier of the offering group.

string

name
optional

Name of the offering group.

string

4.18. Place

Place defines the places where the products are sold, delivered. A place may be used for marking a geo location.

Name

Description

Schema

@referredType
optional

Indicate the type of Place class (example: 'geographicAddress')

string

@schemaLocation
optional

A link to the schema describing this REST resource

string

href
optional

Reference of the place

string

id
optional

Unique identifier of the place

string

name
optional

A user-friendly name for the place

string

role
required

Role of the place (for instance: 'installation site', 'A-extremity site', 'Supervised Perimeter' etc…)

string

4.19. PlaceRef

Place reference. Place defines the places where the products are sold or delivered.

Name

Description

Schema

@referredType
optional

class type of the referred Place object

string

address
optional

A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API).

string

geoLocationUrl
optional

A url providing a map for localizing the place

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
optional

Role of the place (for instance: 'home delivery', 'shop retrieval')

string

4.20. PoRelationshipRef

PoRelationshipRef reference. The PoRelationshipRef defines the affectedProductOffering and requiredProductOfferings of price for selling product offerings.

Name

Description

Schema

@referredType
optional

(Class) type of the referred productOffering

string

bpoId
optional

Id of the BPO where current POP is defined in case the current BPO is a price override

string

href
optional

Reference of the productOffering

string

id
optional

Unique identifier of the productOffering.

string

name
optional

Name of the productOffering.

string

poAttributeType
optional

PoAttributeType of the PoRelationshipRef

enum (AFFECTED_PRODUCT, REQUIRED_PRODUCT)

4.21. PopRelationship

product offering relationship

Name

Description

Schema

@type
optional

(Class) type of the associated product offering

string

href
optional

hyperlink reference of the associated product offering

string

id
optional

Unique identifier of the associated product offering

string

name
optional

Name of the associated product offering

string

relationshipType
optional

type of the relationship, for example override, discount, etc.

string

4.22. Price

Provides all amounts (tax included, duty free, tax rate), used currency and percentage applied for price and price alteration

Name

Description

Schema

@schemaLocation
optional

Link to the schema describing this REST resource.

string

@type
optional

Indicates the (class) type of the price

string

dutyFreeAmount
optional

percentage
optional

Percentage applied

number(float)

taxIncludedAmount
optional

taxRate
optional

Applied tax rate on amount

number(float)

4.23. PriceAlteration

Is an amount, usually of money, that modifies the price charged for an order item.

Name

Description

Schema

@baseType
optional

Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation.

string

@schemaLocation
optional

Generic attribute containing the link to the schema that defines the structure of the class type of the current object.

string

@type
optional

Generic attribute containing the name of the resource class type

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)

cycle
optional

Cycle

description
optional

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

string

name
optional

A short descriptive name such as "Monthly discount"

string

price
optional

Price

priceType
optional

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

4.24. PriceContext

Represents the context in which the product offering price is available to customer.

Name Description Schema

channel
optional

< ChannelRef > array

id
optional

Price context’s identifier.

string

isPriceOverride
optional

A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering.
Example : false

boolean

place
optional

Place references where the products are sold or delivered.

< PlaceRef > array

poRelationship
optional

Represents the product offering affected, or required by the price. This field is used for bundle product offerings.

< PoRelationshipRef > array

priority
optional

The priority.

integer(int32)

processType
optional

Represents the purchasing flows for which the price is applicable.

< ProcessType > array

productOfferingPrice
optional

Product offering price reference.

ProductOfferingPriceRef

productOfferingTerm
optional

< ProductOfferingTerm > array

relatedParty
optional

RelatedPartyRef

validFor
optional

The period for which the productOfferingPrice is valid.

4.25. PricingLogicAlgorithm

The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)

Name

Description

Schema

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

string

externalIdentifier
optional

< ExternalIdentifier > array

href
optional

hyperlink reference of this PricingLogicAlgorithm

string

id
optional

unique id of the PricingLogicAlgorithm

string

name
optional

Name given to the PricingLogicAlgorithm

string

plaSpecId
optional

id of corresponding PricingLogicAlgorithm specification

string

validFor
optional

The period for which the PricingLogicAlgorithm is valid

4.26. ProcessType

Process type. It could be ACQUISITION, RETENTION, CHANGE TARIFF

Name

Description

Schema

@schemaLocation
optional

A link to the schema describing the ProcessType

string

@type
optional

Indicated the type of the ProcessType

string

href
optional

Reference of the Process Type.

string

id
optional

Process Type id.

string

4.27. ProdSpecCharValueUse

A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProdSpecCharValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.

Name

Description

Schema

description
optional

A narrative that explains in detail what the productSpecCharacteristic is.

string

id
optional

Identifier

string

maxCardinality
optional

Not Sent

integer(int32)

minCardinality
optional

Not Sent

integer(int32)

name
optional

Not Sent

string

productSpecCharacteristicValue
optional

< ProductSpecCharacteristicValue > array

productSpecification
optional

ProductSpecificationRef

validFor
optional

Not Sent

valueType
optional

Not Sent

string

4.28. Product

A Product represents the subscription of a ProductOffering by a Party playing a PartyRole, such as a Customer. For example, Jean has subscribed to company ABC�s internet ProductOffering. The association between ProductSpecification and Product allows ProductSpecification, to be instantiated as Product and related to customers or other involved parties.

Name

Description

Schema

@baseType
optional

Indicates the base type of the resource. Here can be 'Product'

string

@schemaLocation
optional

A link to the schema describing this REST resource.

string

@type
optional

Indicated the type of resource.

string

agreement
optional

< AgreementItemRef > array

billingAccount
optional

object

description
optional

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

The name of the product. It could be the same as the name of the Product Offering

string

orderDate
optional

The date from which the product starts

string(date-time)

place
optional

< Place > array

product
optional

< ProductRef > array

productCharacteristic
optional

< ProductCharacteristic > array

productOffering
optional

ProductOfferingRef

productOrderItem
optional

< RelatedProductOrderItem > array

productPrice
optional

< ProductPrice > array

productRelationship
optional

< ProductRelationship > array

productSerialNumber
optional

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

string

productSpecification
optional

productTerm
optional

< ProductTerm > array

realizingResource
optional

< ResourceRef > array

realizingService
optional

< ServiceRef > array

relatedParty
optional

< RelatedPartyRef > array

startDate
optional

The date from which the product starts

string(date-time)

status
optional

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

terminationDate
optional

The date when the product was terminated. Not applicable to active products

string(date-time)

4.29. ProductCharacteristic

Characteristics of the product to instantiate or to modify.

Name

Description

Schema

@schemaLocation
optional

This field provided a link to the schema describing this REST resource.

string

@type
optional

Indicates the (class) type of resource

string

id
optional

Id of the characteristic

string

name
optional

Name of the characteristic

string

value
optional

Value of the characteristic

string

4.30. ProductOffering

Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

Name Description Schema

@baseType
optional

Immediate base (class) type of the product offering

string

@schemaLocation
optional

A link to the schema describing this product offering

string

@type
optional

Class type of the product offering

string

agreement
optional

Not Sent

< AgreementRef > array

attachment
optional

Media items configured for a product offering (images, videos).

< Attachment > array

baseProduct
optional

Base product of a variant.

ProductOfferingRef

bundledProductOffering
optional

List of children product offering reference (sent only for bundled product offerings).

< BundledProductOffering > array

category
optional

< CategoryRef > array

channel
optional

Not Sent

< ChannelRef > array

classificationAttributeValueUse
optional

The list of classification attributes defined for the ProductOffering.

< ProdSpecCharValueUse > array

description
optional

Description of the ProductOffering.

string

href
optional

Reference of the ProductOffering.

string

id
optional

Unique identifier of the ProductOffering.

string

isBundle
optional

isBundle determines whether a productOffering represents a simple product Offering (false), or a bundled product offering(true).If false, then a productSpecification will be returned, but the bundledProductOfferings will be absent or empty and vice-versa if isBundle is true.
Example : false

boolean

isSellable
optional

A flag indicating if this product offering can be sold as stand-alone or not. If this flag is false it indicates that the offer can only be sold within a bundled product offering.

boolean

lastUpdate
optional

Date and time of the last update.

string(date-time)

lifecycleStatus
optional

Used to indicate the current product offering approval status (approved/check/unapproved).

string

marketSegment
optional

Not Sent.

< MarketSegmentRef > array

name
optional

Name of the ProductOffering.

string

offeringGroup
optional

List of containing offering groups (sent only for BundleProductOfferings).

< OfferingGroup > array

parentBundleProductOffering
optional

A list of BundledProductOffering representing all parents of the offering.

< BundledProductOffering > array

place
optional

Not Sent

< PlaceRef > array

priceContext
optional

Price context list.

< PriceContext > array

prodSpecCharValueUse
optional

The list of Product Specification Characteristic Values defined for the ProductOffering.

< ProdSpecCharValueUse > array

productOfferingPrice
optional

< ProductOfferingPrice > array

productOfferingTerm
optional

not sent

< ProductOfferingTerm > array

productSpecification
optional

ProductSpecificationRef

rating
optional

Rating of the product offering.

string

resourceCandidate
optional

Not Sent

ResourceCandidateRef

serviceCandidate
optional

Not Sent

ServiceCandidateRef

serviceLevelAgreement
optional

Not Sent

SLARef

validFor
optional

The period for which the productOffering is valid (online date - offline date).

variantOption
optional

Variant options, in case of a variant product offering.

< VariantOption > array

variantProductOffering
optional

List of variants of the product offering.

< ProductOfferingRef > array

version
optional

Not Sent.Product offering version.

string

4.31. ProductOfferingPrice

Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.

Name

Description

Schema

@schemaLocation
optional

hyperlink reference to the schema describing this resource

string

@type
optional

The class type of this Product offering price

string

bundledPop
optional

Represents the contained prices (charges), for a composed price.

< ProductOfferingPrice > array

bundledPopRelationship
optional

not sent

< BundledPopRelationship > array

constraint
optional

not sent

< ConstraintRef > array

cycle
optional

Represents the start time, and end time of the recurring cycle (the first 3 months) . If empty, the cycle is the entire recurring period.

Cycle

description
optional

Description of the productOfferingPrice

string

href
optional

Reference of the ProductOfferingPrice

string

id
optional

unique id of this resource

string

isBundle
optional

A flag indicating if this ProductOfferingPrice is composite (bundle) or not

boolean

lastUpdate
optional

not sent

string(date-time)

lifecycleStatus
optional

not sent

string

name
optional

Name of the productOfferingPrice

string

percentage
optional

Percentage to apply for ProdOfferPriceAlteration (Discount).

number(float)

place
optional

not sent

< PlaceRef > array

popRelationship
optional

not sent

< PopRelationship > array

price
optional

The amount of money that characterizes the price.

priceEvent
optional

The price event

string

priceType
optional

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

string

pricingLogicAlgorithm
optional

not sent

< PricingLogicAlgorithm > array

prodSpecCharValueUse
optional

not sent

< ProdSpecCharValueUse > array

productOfferingTerm
optional

not sent

< ProductOfferingTerm > array

recurringChargePeriodLength
optional

not sent

integer(int32)

recurringChargePeriodType
optional

not sent

string

tax
optional

not sent

< Tax > array

tierEnd
optional

Tier end of usage charge.

integer(int32)

tierStart
optional

Tier start of usage charge.

integer(int32)

unitOfMeasure
optional

A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount.

Quantity

usageChargeType
optional

The type of the usage charge

string

usageSpecification
optional

UsageSpecificationRef

usageUnit
optional

Usage unit applicable for the price.

UsageUnit

validFor
optional

not sent

version
optional

not sent

string

4.32. ProductOfferingPriceRef

ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.

Name

Description

Schema

@referredType
optional

(Class) type of the referred ProductOfferingPrice

string

@schemaLocation
optional

Hyperlink reference to the schema describing this resource

string

href
optional

Reference of the ProductOfferingPrice.

string

id
optional

Reference id of the ProductOfferingPrice.

string

name
optional

Name of the ProductOfferingPrice.

string

4.33. ProductOfferingRecommendationRef

ProductOfferingRecommendationRef subtype of the ProductOfferingRef entity.

Polymorphism : Composition

Name

Description

Schema

@referredType
optional

Type (class) of the product offering

string

@type
optional

Type (class) of the product offering

string

href
optional

Reference of the product offering

string

id
required

Unique identifier of the product offering

string

image
optional

Thumbnail image of the product offering

Attachment

name
optional

Name of the product offering

string

productOfferingTerm
optional

< ProductOfferingTermRef > array

variantOption
optional

Variant options, in case of a variant product offering.

< VariantOption > array

4.34. ProductOfferingRef

ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

Name

Description

Schema

@referredType
optional

Type (class) of the product offering

string

@type
optional

Type (class) of the product offering

string

href
optional

Reference of the product offering

string

id
required

Unique identifier of the product offering

string

image
optional

Thumbnail image of the product offering

Attachment

name
optional

Name of the product offering

string

variantOption
optional

Variant options, in case of a variant product offering.

< VariantOption > array

4.35. ProductOfferingTerm

A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.

Name

Description

Schema

@schemaLocation
optional

A link to the schema describing this product offering term

string

@type
optional

The class type of ProductOfferingTerm

string

description
optional

Not Sent.Description of the productOfferingTerm

string

duration
optional

Duration of the productOfferingTerm

Quantity

id
optional

Id of the productOfferingTerm

string

name
optional

Name of the productOfferingTerm

string

validFor
optional

Not Sent.The period for which the productOfferingterm is valid

4.36. ProductPrice

An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.

Name

Description

Schema

@schemaLocation
optional

A link to the schema describing this REST resource

string

@type
optional

Indicates the type of ProductPrice class

string

billingAccount
optional

BillingAccountRef

description
optional

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

string

id
optional

Unique identifier of a productOfferingPrice

string

name
optional

A short descriptive name such as "Subscription price"

string

price
optional

Price

priceType
optional

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

string

prodPriceAlteration
optional

PriceAlteration

recurringChargePeriod
optional

Could be month, week…

string

unitOfMeasure
optional

Could be minutes, GB…

string

4.37. ProductRef

A product reference to be used for relationship target

Name

Description

Schema

href
optional

Reference of the product

string

id
required

Unique identifier of the product

string

4.38. ProductRelationship

Type of the product relationship. it can be '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) or 'targets' or 'isTargeted' (depending on the way of expressing the link) for any other kind of links that may be useful

Name

Description

Schema

product
required

ProductRef

type
optional

Type of the product relationship

string

4.39. ProductSpecCharRelationship

An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.

Name

Description

Schema

@type
optional

Class type of target product specification

string

charSpecSeq
optional

The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications. For example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third.

integer(int32)

href
optional

Hyperlink reference to the target product specification

string

id
optional

the identifier of the associated product specification

string

name
optional

Name of the target product specification characteristic

string

type
optional

Type of relationship such as aggregation, migration, substitution, dependency, exclusivity

string

validFor
optional

The period for which the productSpecCharRelationship is valid

4.40. ProductSpecCharacteristic

A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.

Name

Description

Schema

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

hyperlink reference to the schema describing this characteristic

string

@type
optional

the class type of this characteristic

string

@valueSchemaLocation
optional

This (optional) field provides a link to the schema describing the value type.

string

configurable
optional

If true, the Boolean indicates that the productSpecCharacteristic is configurable

boolean

description
optional

A narrative that explains in detail what the productSpecCharacteristic is

string

extensible
optional

An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product

boolean

id
optional

Unique identifier of the productSpecCharacteristic

string

isUnique
optional

An indicator that specifies if a value is unique for the specification. Possible values are; "unique while value is in effect" and "unique whether value is in effect or not"

boolean

maxCardinality
optional

The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality

integer(int32)

minCardinality
optional

The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality

integer(int32)

name
optional

Name of the productSpecCharacteristic

string

productSpecCharRelationship
optional

< ProductSpecCharRelationship > array

productSpecCharacteristicValue
optional

< ProductSpecCharacteristicValue > array

regex
optional

A rule or principle represented in regular expression used to derive the value of a characteristic value

string

validFor
optional

The period for which the productSpecCharacteristic is valid

valueType
optional

A kind of value that the characteristic can take on, such as numeric, text and so forth

string

4.41. ProductSpecCharacteristicValue

A number or text that can be assigned to a ProductSpecCharacteristic.

Name

Description

Schema

@schemaLocation
optional

Hyperlink reference to schema describing this object

string

@type
optional

The class type of the characteristic value

string

id
optional

Identifier

string

isDefault
optional

Not Sent

boolean

rangeInterval
optional

Not Sent

string

regex
optional

Not Sent

string

unitOfMeasure
optional

Could be minutes, GB…

string

validFor
optional

Not Sent

value
optional

The value of characteristic.The type of value is determined by ‘valueType’ characteristic.

string

valueFrom
optional

Not Sent

string

valueTo
optional

Not Sent

string

valueType
optional

A kind of value that the characteristic can take on, such as numeric, string, boolean.

string

4.42. ProductSpecType

Product Specification type.

Name

Description

Schema

description
required

Description of the Product Spec Type.

string

id
required

Identifier of the Product Spec Type.

string

4.43. ProductSpecification

A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.

Name

Description

Schema

@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

brand
optional

The manufacturer or trademark of the specification

string

bundledProductSpecification
optional

A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.

< BundledProductSpecification > array

description
optional

A narrative that explains in detail what the product specification is

string

externalIdentifier
optional

< ExternalIdentifier > array

href
optional

Reference of the product specification

string

id
optional

Unique identifier of the product specification

string

isBundle
optional

isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true).

boolean

lastUpdate
optional

Date and time of the last update

string(date-time)

lifecycleStatus
optional

Used to indicate the current lifecycle status

string

name
optional

Name of the product specification

string

productNumber
optional

An identification number assigned to uniquely identity the specification

string

productSpecCharacteristic
optional

< ProductSpecCharacteristic > array

productSpecType
optional

Represents the product specification type

< ProductSpecType > array

serviceSpecification
optional

ServiceSpecification(s) required to realize a ProductSpecification.

< ServiceSpecificationRef > array

usageSpecification
optional

The Product Usage Specification which describes the types of Usage events generated by offerings with this Product Specification

UsageSpecificationRef

validFor
optional

The period for which the product specification is valid

version
optional

Version of the product specification

string

4.44. ProductSpecificationRef

Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.

Name

Description

Schema

@referredType
optional

class type of referred Product Specification

string

href
optional

Reference of the product specification.(Not supported yet)

string

id
optional

Unique identifier of the product specification

string

name
optional

Name of the product specification

string

version
optional

Version of the product specification API (Not supported yet)

string

4.45. ProductTerm

This represent a commitment with a duration

Name

Description

Schema

@type
optional

Indicate the class (type) of the product term

string

description
optional

Description of the commitment term

string

duration
optional

Quantity

name
optional

Name of the commitment term

string

validFor
optional

4.46. Quantity

Description of a quantity like for the Duration attribute

Name

Description

Schema

amount
required

A value for the quantity

number(float)

units
required

A unit associated with the quantity (for example months)

string

4.47. RelatedPartyRef

RelatedParty reference. A related party defines party or party role linked to a specific entity.

Name

Description

Schema

@referredType
optional

The class type of referred party/party role reference

string

href
optional

Reference of the related party, could be a party reference or a party role reference

string

id
optional

Unique identifier of a related party

string

name
optional

Name of the related party

string

role
optional

Role of the related party.

string

validFor
optional

Validity period of the related party

4.48. RelatedProductOrderItem

RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.

Name

Description

Schema

@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

4.49. ResourceCandidateRef

ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.

Name

Description

Schema

@referredType
optional

The Class type of referred Resource Candidate

string

href
optional

Reference of the resource candidate

string

id
optional

Unique identifier of the resource candidate

string

name
optional

Name of the resource candidate

string

version
optional

Version of the resource candidate

string

4.50. ResourceRef

Name

Description

Schema

@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

4.51. SLARef

ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.

Name

Description

Schema

@referredType
optional

class type of referred Service Level Agreement

string

href
optional

Reference of the service level agreement

string

id
optional

Unique identifier of service level agreement

string

name
optional

Name of the service level agreement

string

4.52. ServiceCandidateRef

ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.

Name

Description

Schema

@referredType
optional

The Class type of referred Service Candidate

string

href
optional

Unique reference of the service candidate

string

id
optional

Unique identifier of the service candidate

string

name
optional

Name of the service candidate

string

version
optional

Version of the service candidate

string

4.53. ServiceRef

Service reference, for when Service is used by other entities

Name

Description

Schema

@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

4.54. ServiceSpecificationRef

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.

Name

Description

Schema

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

the class type of associated service specification

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

externalIdentifier
optional

< ExternalIdentifier > array

href
optional

Reference of the serviceSpecification

string

id
required

Unique identifier of the service specification

string

name
optional

Name of the requiredServiceSpecification

string

targetServiceSchema
optional

A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.

TargetServiceSchema

version
optional

Service specification version

string

4.55. StackTraceElement

Name

Schema

classLoaderName
optional

string

className
optional

string

fileName
optional

string

lineNumber
optional

integer(int32)

methodName
optional

string

moduleName
optional

string

moduleVersion
optional

string

nativeMethod
optional

boolean

4.56. TargetServiceSchema

The reference object to the schema and type of target service which is described by service specification

Name

Description

Schema

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
required

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

string

@type
required

Class type of the target service

string

4.57. Tax

An amount of money levied on the price of a Product by a legislative body.

Name

Description

Schema

taxAmount
optional

tax amount

taxCategory
optional

A categorization of the tax rate.