BitstreamAccessProduct

Extends: Product

Bitstream access product

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	Example
`@type`	Yes	No	`String`	When sub-classing, this defines the sub-class Extensible name
`@baseType`	No	No	`String`	When sub-classing, this defines the super-class
`@schemaLocation`	No	No	`String`	A URI to a JSON-Schema file that defines additional attributes and relationships
`id`	No	No	`String`	Unique identifier	2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
`href`	No	No	`URI`	Hyperlink reference	https://api.example.org/resource/id
`creationDate`	No	No	`DateTime`	Date and time when the product was created	2023-01-01T08:00:00+01:00
`description`	No	No	`String`	Is the description of the product. It could be copied from the description of the Product Offering.	Lorem ipsum dolor
`name`	No	No	`String`	Name of the product. It could be the same as the name of the product offering	Acme ludicrous speed fiber line
`orderDate`	No	No	`DateTime`	Is the date when the product was ordered	2023-01-01T08:00:00+01:00
`startDate`	No	No	`DateTime`	Is the date from which the product starts	2023-01-01T08:00:00+01:00
`terminationDate`	No	No	`DateTime`	Is the date when the product was terminated	2023-01-01T08:00:00+01:00
`relatedPlace`	No	No	`array` of RelatedPlaceRefOrValue	Related place	[]
`product`	No	No	`array` of ProductRefOrValue	Product	[]
`productCharacteristic`	No	No	`array` of Characteristic	Product characteristic	[]
`productOffering`	No	No	ProductOfferingRefOrValue
`productRelationship`	No	No	`array` of ProductRelationship	Product relationship	[]
`productSpecification`	No	No	ProductSpecificationRef
`relatedParty`	No	No	`array` of RelatedPartyOrPartyRole		[]
`status`	No	No	`ProductStatusType`
`accessTechnology`	No	No	`String`	Defines the type of connectivity (e.g. FTTH, FTTB, FTTC, HFC, Coax, TAL, OAL)	FTTH
`accessProtocol`	No	No	`String`	Defines the type and technology of the access (e.g. Ethernet, P2P, GPON, XGS-PON, VDSL, GFAST-CuDa., GFAST-Coax, DOCSIS, ADSL, SDSL, …)	VDSL
`upstreamNominalBandwidth`	No	No	Quantity	Defines the upstream access bandwidth (e.g. 100 Mbit/s , 1 Gbit/s, 100 kbit/s)
`downstreamNominalBandwidth`	No	No	Quantity	Defines the downstream access bandwidth (e.g. 400 Mbit/s , 1 Gbit/s )
`trafficHandOver`	No	No	`String`	Defines how the traffic is handed over to the reseller (e.g. L2, L3, LT)	L2
`trafficAggregation`	No	No	`String`	Defines the aggregation provided by the supplier hand over close to customer, in a region or one central hand over for the complete country (e.g. local, regional, national)	local
`networkTerminationUnitType`	No	No	`String`	Defines the type of the access termination (e.g. withOnt, withoutOnt)	withOnt
`uniConnectorType`	No	No	`String`	Defines the interface of the access termination (e.g. TAE, RJ45, E2000, LC-APC, MMD (Multi Media Dose → Koaxialdose, F-Stecker) …)	RJ45
`reversePowering`	No	No	`String`	Defines if the DSLAM needs to be reverse powered (e.g. yes, no)	yes
`leadTime`	No	No	Duration	Defines the typical lead time for provisioning an access
`lineID`	No	No	`String`	Defines the identifier of the access line. If ProductId is not known for change orders, the contract number of the product to be changed / terminated can be entered here by the buyer
`virtualAccessLineId`	No	No	`String`	Line-Identifier for the end customer
`enni`	No	No	`String`	Identifies the point of traffic interconnection external network to network interconnection (e.g. value or location of A10NSP)
`enniPort`	No	No	`String`	Defines the configured port	n/a
`cvlan`	No	No	`String`	Defines the configured C-VLAN	n/a
`svlan`	No	No	`String`	Defines the configured S-VLAN
`networkTerminationUnitLocation`	No	No	`String`	Describes the location of the network termination (e.g. describes the position of TAE/GF-TA or ONT)
`homeId`	No	No	`String`	Identifies the GF-TA unit at the end user’s premise.	a12d5a4545
`ontSerialNumber`	No	No	`String`	Serial number of the ONT	1515515155115
`trafficLimitationUpstream`	No	No	Quantity	Defines the traffic/Speedlimit of bandwith
`trafficLimitationDownstream`	No	No	Quantity	Defines the traffic/Speedlimit of bandwith
`singleContractIdExistingProduct`	No	No	`String`	If ProductId is not known for change orders, the contract number of the product to be changed / canceled can be entered here	3072576895

@type

Yes

String

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

@baseType

String

When sub-classing, this defines the super-class

@schemaLocation

String

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

id

String

Unique identifier

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

URI

Hyperlink reference

https://api.example.org/resource/id

creationDate

DateTime

Date and time when the product was created

2023-01-01T08:00:00+01:00

description

String

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

Lorem ipsum dolor

name

String

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

Acme ludicrous speed fiber line

orderDate

DateTime

Is the date when the product was ordered

2023-01-01T08:00:00+01:00

startDate

DateTime

Is the date from which the product starts

2023-01-01T08:00:00+01:00

terminationDate

DateTime

Is the date when the product was terminated

2023-01-01T08:00:00+01:00

relatedPlace

array of RelatedPlaceRefOrValue

Related place

[]

product

array of ProductRefOrValue

Product

[]

productCharacteristic

array of Characteristic

Product characteristic

[]

productOffering

ProductOfferingRefOrValue

productRelationship

array of ProductRelationship

Product relationship

[]

productSpecification

ProductSpecificationRef

relatedParty

array of RelatedPartyOrPartyRole

[]

status

ProductStatusType

accessTechnology

String

Defines the type of connectivity (e.g. FTTH, FTTB, FTTC, HFC, Coax, TAL, OAL)

FTTH

accessProtocol

String

Defines the type and technology of the access (e.g. Ethernet, P2P, GPON, XGS-PON, VDSL, GFAST-CuDa., GFAST-Coax, DOCSIS, ADSL, SDSL, …)

VDSL

upstreamNominalBandwidth

Quantity

Defines the upstream access bandwidth (e.g. 100 Mbit/s , 1 Gbit/s, 100 kbit/s)

downstreamNominalBandwidth

Quantity

Defines the downstream access bandwidth (e.g. 400 Mbit/s , 1 Gbit/s )

trafficHandOver

String

Defines how the traffic is handed over to the reseller (e.g. L2, L3, LT)

trafficAggregation

String

Defines the aggregation provided by the supplier hand over close to customer, in a region or one central hand over for the complete country (e.g. local, regional, national)

local

networkTerminationUnitType

String

Defines the type of the access termination (e.g. withOnt, withoutOnt)

withOnt

uniConnectorType

String

Defines the interface of the access termination (e.g. TAE, RJ45, E2000, LC-APC, MMD (Multi Media Dose → Koaxialdose, F-Stecker) …)

RJ45

reversePowering

String

Defines if the DSLAM needs to be reverse powered (e.g. yes, no)

yes

leadTime

Duration

Defines the typical lead time for provisioning an access

lineID

String

Defines the identifier of the access line. If ProductId is not known for change orders, the contract number of the product to be changed / terminated can be entered here by the buyer

virtualAccessLineId

String

Line-Identifier for the end customer

enni

String

Identifies the point of traffic interconnection external network to network interconnection (e.g. value or location of A10NSP)

enniPort

String

Defines the configured port

n/a

cvlan

String

Defines the configured C-VLAN

n/a

svlan

String

Defines the configured S-VLAN

networkTerminationUnitLocation

String

Describes the location of the network termination (e.g. describes the position of TAE/GF-TA or ONT)

homeId

String

Identifies the GF-TA unit at the end user’s premise.

a12d5a4545

ontSerialNumber

String

Serial number of the ONT

1515515155115

trafficLimitationUpstream

Quantity

Defines the traffic/Speedlimit of bandwith

trafficLimitationDownstream

Quantity

Defines the traffic/Speedlimit of bandwith

singleContractIdExistingProduct

String

If ProductId is not known for change orders, the contract number of the product to be changed / canceled can be entered here

3072576895