WSG Model - Service Availability Qualification SAQ - v39.0.0

Operations

Input message	Output message
srvQualifByNumberRequest	srvQualifByNumberResponse

Input message	Output message
srvQualifByAddressRequest	srvQualifByAddressResponse

Input message	Output message
srvQualifByLocationIdRequest	srvQualifByLocationIdResponse

Input message	Output message
srvQualifByLlidRequest	srvQualifByLlidResponse

Input message	Output message
srvQualifByStartPointRequest	srvQualifByStartPointResponse

Input message	Output message
srvQualifBySocketRequest	srvQualifBySocketResponse

Input message	Output message
srvQualifByBindingIdRequest	srvQualifByBindingIdResponse

Messages

Element	Type	Occ	Comment
parameters	srvQualifByNumber	1..1

Element	Type	Occ	Comment
parameters	srvQualifByNumberResponse	1..1

Element	Type	Occ	Comment
parameters	srvQualifByAddress	1..1

Element	Type	Occ	Comment
parameters	srvQualifByAddressResponse	1..1

Element	Type	Occ	Comment
parameters	srvQualifByLocationId	1..1

Element	Type	Occ	Comment
parameters	srvQualifByLocationIdResponse	1..1

Element	Type	Occ	Comment
parameters	srvQualifByLlid	1..1

Element	Type	Occ	Comment
parameters	srvQualifByLlidResponse	1..1

Element	Type	Occ	Comment
parameters	srvQualifByStartPoint	1..1

Element	Type	Occ	Comment
parameters	srvQualifByStartPointResponse	1..1

Element	Type	Occ	Comment
parameters	srvQualifBySocket	1..1

Element	Type	Occ	Comment
parameters	srvQualifBySocketResponse	1..1

Element	Type	Occ	Comment
parameters	srvQualifByBindingId	1..1

Element	Type	Occ	Comment
parameters	srvQualifByBindingIdResponse	1..1

Root elements

srvQualifByNumber

Description: Get information on possible broadband connections to a given destination by DN/VN/NSN.

Element	Type	Occ	Comment
request	srvQualifByNumberType	1..1	Get information on possible broadband connections to a given destination by DN/VN/NSN.

srvQualifByNumberResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByAddress

Description: Get information on possible broadband connections to a given destination by address.

Element	Type	Occ	Comment
request	srvQualifByAddressType	1..1	Get information on possible broadband connections to a given destination by address.

srvQualifByAddressResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByLocationId

Description: Get information on possible broadband connections to a given destination by Location Id.

Element	Type	Occ	Comment
request	srvQualifByLocationIdType	1..1	Get information on possible broadband connections to a given destination by location.

srvQualifByLocationIdResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByLlid

Description: Get information on possible broadband connections to a given destination by LLID.

Element	Type	Occ	Comment
request	srvQualifByLlIdType	1..1	Get information on possible broadband connections to a given destination by LLID.

srvQualifByLlidResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByStartPoint

Description: Get information on possible broadband connections to a given destination by start point.

Element	Type	Occ	Comment
request	srvQualifByStartPointType	1..1	Get information on possible broadband connections to a given destination by start point.

srvQualifByStartPointResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifBySocket

Description: Get information on possible broadband connections to a given destination by Socket Id.

Element	Type	Occ	Comment
request	srvQualifBySocketType	1..1	Get information on possible broadband connections to a given destination by socket ID (and opt. by PlugNr).

srvQualifBySocketResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByBindingId

Description: Get information on possible broadband connections to a given destination by bindingId.

Element	Type	Occ	Comment
request	srvQualifByBindingIdType	1..1	Get information on possible broadband connections to a given destination by binding ID (accesssId).

srvQualifByBindingIdResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

Types

srvQualifByNumber

Description: Get information on possible broadband connections to a given destination by DN/VN/NSN.

Element	Type	Occ	Comment
request	srvQualifByNumberType	1..1	Get information on possible broadband connections to a given destination by DN/VN/NSN.

srvQualifByNumberResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByAddress

Description: Get information on possible broadband connections to a given destination by address.

Element	Type	Occ	Comment
request	srvQualifByAddressType	1..1	Get information on possible broadband connections to a given destination by address.

srvQualifByAddressResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByLocationId

Description: Get information on possible broadband connections to a given destination by Location Id.

Element	Type	Occ	Comment
request	srvQualifByLocationIdType	1..1	Get information on possible broadband connections to a given destination by location.

srvQualifByLocationIdResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByLlid

Description: Get information on possible broadband connections to a given destination by LLID.

Element	Type	Occ	Comment
request	srvQualifByLlIdType	1..1	Get information on possible broadband connections to a given destination by LLID.

srvQualifByLlidResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByStartPoint

Description: Get information on possible broadband connections to a given destination by start point.

Element	Type	Occ	Comment
request	srvQualifByStartPointType	1..1	Get information on possible broadband connections to a given destination by start point.

srvQualifByStartPointResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifBySocket

Description: Get information on possible broadband connections to a given destination by Socket Id.

Element	Type	Occ	Comment
request	srvQualifBySocketType	1..1	Get information on possible broadband connections to a given destination by socket ID (and opt. by PlugNr).

srvQualifBySocketResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

srvQualifByBindingId

Description: Get information on possible broadband connections to a given destination by bindingId.

Element	Type	Occ	Comment
request	srvQualifByBindingIdType	1..1	Get information on possible broadband connections to a given destination by binding ID (accesssId).

srvQualifByBindingIdResponse

Element	Type	Occ	Comment
response	qualifAcknowledgeType	1..1	The acknowledge message returned after processing an qualification request.

Element	Type	Occ	Comment
bindingId	xs:string (maxLength:15)	1..1	The binding id (e.g. AC1.222.333.444).

fulfillmentTimeSlot

Description: A list of fulfillment time slots

Used by: plugType, qualifHistoryReqDataType, qualifAnswer

Element	Type	Occ	Comment
fulfillmentTimeSlotQualifIndex	xs:long (totalDigits:10)	1..1	The index identifying a profile within a qualification response.
fulfillmentTimeSlotStart	xs:dateTime	1..1	Start Date Time of the Fullfillment Time Slot
fulfillmentTimeSlotEnd	xs:dateTime	0..1	End Date Time of the Fullfillment Time Slot

qualifHistoryReqDataType

Description: The qualification request from the history

Used by: getQualifHistoryAckType

Element

Type

Occ

Comment

qualifNr

xs:long (totalDigits:10)

1..1

The qualification ID.

qualifIndex

xs:long (totalDigits:10)

0..1

The index identifying a profile within a qualification response.

fulfillmentTimeSlot

0..1

ispId

xs:int (totalDigits:6)

1..1

An ISP ID.

contrEleId

xs:int (totalDigits:3)

1..n

[LOV-ID: 0320] A contract element ID.

bbType

xs:int (totalDigits:3)

0..n

[LOV-ID: 0276] The BB type.

dnType

xs:int (totalDigits:3)

0..1

[LOV-ID: 0109] The DN type.

- choice:

Element	Type	Occ	Comment
dnVnNsn	xs:string (pattern:0[1-9]\d{8})	1..1	A DN/VN/NSN phone number.
llId	xs:string (minLength:1, maxLength:13)	1..1	The local loop ID.
startPoint	startPointRequestType	1..1	start point request parameters
address	subjectAddressType	1..1	A subject's postal address.
bindingId	xs:string (maxLength:15)	1..1	The binding id (e.g. AC1.222.333.444).
locationId	xs:int	1..1	A location id (GAIA ID)

1..1

qualifExtRef

xs:string (minLength:1, maxLength:80)

0..1

An external reference (assigned by the ISP) for identification of the qualification request.

customerWishDate

xs:date

0..1

The customer wish date.

synchWithVoice

xs:boolean

0..1

Synchronize with voice.

lineState

xs:int (totalDigits:3)

0..1

[LOV-ID: 1052] The copper line state.

newLoop

xs:boolean

0..1

Qualify for a new loop.

sfSlaId

xs:int (totalDigits:3)

0..1

[LOV-ID: 0282] The service fulfillment SLA ID.

hasOnp

xs:boolean

0..1

Has Operator Number Portabilty

businessType

xs:int (totalDigits:3)

0..1

[LOV-ID: 1301] 1=New; 2=Relocation; 3=ProductChange; 4=NewOnActive; 5=IspChange ...

returnSpeedAtNok

xs:boolean

0..1

If true speed profiles will be mapped also in case of Copper/Space Shortage

appointment

appointmentType

0..1

An Appointment

customerLocationId

xs:int

0..1

Top

dslamTypeAllowed

Description: DSLAM Type(s) which are supported from the cpe - only current Technolgoie is in focus

Used by: cpeInfo

Element	Type	Occ	Comment
technology	xs:int (totalDigits:3)	1..1
dslamType	xs:int (totalDigits:3)	0..n	[LOV-ID: 1064]: DSLAM Type.

capability

Used by: cpeInfo

Element	Type	Occ	Comment
technologyType	xs:int (totalDigits:3)	1..1	[LOV-ID: 9025] LOV_TECHNOLOGY_TYPE (1 = VDSL; 2 = VDSL vectoring; 3 = G.FAST)
capabilityOverall	xs:int (totalDigits:3)	1..1	[LOV-ID: 9009] LOV_CPE_CAPABILITY_OVERALL (former LOV_VECTORING_CAPABILITY) (1 = Capable; 2 = Friendly; 3 = Forced Friendly; 4 = Disturber....)
capabilityHardware	xs:int (totalDigits:3)	1..1	[LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed)
capabilityFirmware	xs:int (totalDigits:3)	1..1	[LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed)

cpeInfo

Description: Information about the CPE.

Used by: qualifHistoryResDataType, qualifAnswer

Element	Type	Occ	Comment
cpeName	xs:string (maxLength:100)	1..1	CPE (Customer Modem) Name
dslamTypeAllowed	dslamTypeAllowed	0..n	DSLAM Type(s) which are supported from the cpe - only current Technolgoie is in focus
capability	capability	0..n	CPE Capability, used in case of VDSL2 qualification to shows the TechnologyType (VDSL2 Legacy, Vectoring, g.fast) capability. [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE (1 = VDSL; 2 = VDSL vectoring; 3 = G.FAST) [LOV-ID: 9009] LOV_CPE_CAPABILITY_OVERALL (former LOV_VECTORING_CAPABILITY) (1 = Capable; 2 = Friendly; 3 = Forced Friendly; 4 = Disturber....) [LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed) [LOV-ID: 1350] LOV_CPE_CAPABILITY Does this CPE Hardware or Firmware support the declared TechnologyType? (0 = no;1 = yes; 2 = yes, but SFP needed)
comment	xs:string (minLength:1, maxLength:256)	0..1	A comment.

siteDevelopment

Description: site development information, quantiy of basic connectivities and utilized units

Used by: qualifHistoryResDataType, qualifAnswer

Element	Type	Occ	Comment
fullyDeveloped	xs:boolean	1..1	indicates if the site is fully developed
nrOfBasicConnectivities	xs:int	0..1	Nr of basic connectivites
nrOfUtilisationUnits	xs:int	0..1	Nr of utilisation units
nrOfLinesTotal	xs:int	0..1	total number of lines (cable pairs)
nrOfLinesUsable	xs:int	0..1	number of free lines (cable pairs)

qualifHistoryResDataType

Description: The qualification response from the history

Used by: getQualifHistoryAckType

Element

Type

Occ

Comment

qualifNr

xs:long (totalDigits:10)

0..1

The qualification ID.

dnStnr

xs:string (pattern:0[1-9]\d{8})

0..1

The DN "Stammnummer".

llId

xs:string (minLength:1, maxLength:13)

0..1

The local loop ID.

serviceProfile

xs:int (totalDigits:3)

0..1

[LOV-ID: 1010] A speed profile number.

availableServiceProfiles

Element	Type	Occ	Comment
nr	xs:int (totalDigits:3)	1..n	[LOV-ID: 1010] A speed profile number.

0..1

dnType

xs:int (totalDigits:3)

0..1

[LOV-ID: 0109] The DN type.

endPoint

endPointType

0..1

An end point (consisting of a DN office and a BB device location) and port information.

jumperAction

xs:boolean

0..1

Ueberfuehrungsrelevant (true/false).

socketId

xs:string (minLength:13, maxLength:19)

0..1

plugNr

xs:int (totalDigits:3)

0..1

messageIdLqs

xs:string (pattern:[\dA-Z]{3})

0..1

An error code where '000' indicates 'OK'.

messageIdQualif

xs:string (pattern:[\dA-Z]{3})

0..1

An error code where '000' indicates 'OK'.

reasonComment

xs:string (minLength:1, maxLength:256)

0..1

Some additional textual description for the reason.

cpeInfo

0..1

Information about the CPE.

nrOfWires

xs:int (totalDigits:2)

0..1

The number of wires (only copper).

technologyType

xs:int (totalDigits:3)

0..1

[LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST

vectorized

xs:boolean

0..1

true if line is currently vectorized

siteDevelopment

0..1

site development information, quantiy of basic connectivities and utilized units

psdClass

xs:int (totalDigits:3)

0..1

[LOV-ID: 1061] LOV_BB_PSD_CLASS

interleaveMode

xs:int (totalDigits:3)

0..1

[LOV-ID: 1008] LOV_INTERLEAVE_MODE

Top

equippedDateHistory

Description: Equipped Date History: list the last 3 changes (if there are some)

Used by: plannedEndPoint

Element	Type	Occ	Comment
sortNr	xs:int	1..1	Sort number: 1 (nearest) ... 3 (oldest)
changeDate	xs:string (pattern:2[0-9]{3}((-[01][0-9])?)((-[0-3][0-9])?))	1..1
eventType	xs:int (totalDigits:3)	1..1	[LOV-ID: 1324] LOV_EQUIPPED_DATE_EVENT_TYPE 1=TargetDateChange; 2=ValidityClassException
from	xs:string (maxLength:10)	1..1	If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98
to	xs:string (maxLength:10)	1..1	If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98
changeReasonId	xs:int	1..1	Example: [1] Technology change; [2] Port shortage; [3] Missing material; [4] Veto major customer;[5] Veto municipality; [6] Management re-priorisation; [7] Acquisition delay; [8] Construction delay; [9] Changed in the planning phase; [10] Changed in the construction phase; [11] Changed by cooperation partner
changeReasonDescription	xs:string (maxLength:100)	1..1

plannedEndPoint

Used by: qualifAnswer

Extension of: endPointBaseType

Element	Type	Occ	Comment
equippedDate	xs:string (pattern:2[0-9]{3}(-[01][0-9](-[0-3][0-9])?)?)	1..1	Equipped date and target date are synonyms. Customers are able to order the service at this date.
equippedDateQuality	xs:int (totalDigits:2)	1..1	Equipped date quality and quality class are synonyms.
equippedDateComment	xs:string	1..1	The equippedDate embedded in a comment string
equippedDateHistory	equippedDateHistory	0..n	Equipped Date History: list the last 3 changes (if there are some) Sort number: 1 (nearest) ... 3 (oldest) [LOV-ID: 1324] LOV_EQUIPPED_DATE_EVENT_TYPE 1=TargetDateChange; 2=ValidityClassException If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98 If EventType = 1 - TargetDateChange: Then the format is:2[0-9]{3}((-[01][0-9]))((-[0-3][0-9])); If EventType = 2 - ValidityClassException: Then the format is: string max length 5, example: from: GK4 to: GK98 Example: [1] Technology change; [2] Port shortage; [3] Missing material; [4] Veto major customer;[5] Veto municipality; [6] Management re-priorisation; [7] Acquisition delay; [8] Construction delay; [9] Changed in the planning phase; [10] Changed in the construction phase; [11] Changed by cooperation partner
plannedSpeed	duplexSpeedType	1..1	The planned bitrate (up/down).
extensionCategory	xs:int (totalDigits:3)	1..1	[LOV-ID: 9023] LOV_EXTENSION_CATEGORY: Ausbau Kategorie: 1 = PUS Neubau; 2 = FTTS/B Neubau; 3 = Vectoring Ausbau/Aktivierung

subjectAddressType

Description: A subject's postal address.

Used by: qualifHistoryReqDataType

Extended by: subjectAddressEnhancedType, contactAddressType

Extension of: addressType

Top

potential

Description: Description of Potential

Used by: reasonOfPotential

Element	Type	Occ	Comment
potentialCode	xs:int (minInclusive:-9999, maxInclusive:9999)	1..1	Potential Code negative value: reason why the maximum speed is lower then the current access profile. -1000: Pending downgrooming without service impact -1001: Pending downgrooming with service impact -1100: Pending devloc change (lengthing order) -1200: The profile is set manually -1300: -1400: The access is unstable -1501: ICA problem - impact on stability: BridgeTap -1502: ICA problem - impact on stability: Degraded Contact -1503: ICA problem - impact on speed: Missing Splitter -1504: ICA problem - impact on stability: Missing Splitter on alarm system (Business Decision) -1505: ICA problem - impact on stability: External Interference detected -1506: ICA problem - impact on stability: Intermittent contact -1507: ICA problem - impact on stability: Loop unbalanced -1508: ICA problem - impact on stability: Untwisted in-house wiring -1509: ICA problem - impact on stability: Time varying noise (crosstalk and RFI) -1510: ICA problem - impact on stability: CPE interoperability problem -1511: ICA problem - impact on stability: Black-listed CPE -1517: ICA problem - impact on stability: Abnormal crosstalk -1518: ICA problem - impact on stability: Defect switched power supply -1519: ICA problem - impact on speed: BridgeTap on overhead line -1600: Stability reached with downgrade positive value: reason why the maximum speed is higher then the current acccess profile 1000: outstanding upgrooming 1100: pending devloc change (short order) 1200: the profile is set manually 1300: Old CPE hardware 1301: CPE hardware doesnt support Vectoring. 1302: CPE firmware doesnt support Vectoring
potentialDescription	xs:string (minLength:1, maxLength:256)	1..1	Potential Description

reasonOfPotential

Description: Reason of Potential - why is the Current Access Speed lower then the maximum

Used by: qualifAnswer

Element	Type	Occ	Comment
potential	potential	1..n	Description of Potential Potential Code negative value: reason why the maximum speed is lower then the current access profile. -1000: Pending downgrooming without service impact -1001: Pending downgrooming with service impact -1100: Pending devloc change (lengthing order) -1200: The profile is set manually -1300: -1400: The access is unstable -1501: ICA problem - impact on stability: BridgeTap -1502: ICA problem - impact on stability: Degraded Contact -1503: ICA problem - impact on speed: Missing Splitter -1504: ICA problem - impact on stability: Missing Splitter on alarm system (Business Decision) -1505: ICA problem - impact on stability: External Interference detected -1506: ICA problem - impact on stability: Intermittent contact -1507: ICA problem - impact on stability: Loop unbalanced -1508: ICA problem - impact on stability: Untwisted in-house wiring -1509: ICA problem - impact on stability: Time varying noise (crosstalk and RFI) -1510: ICA problem - impact on stability: CPE interoperability problem -1511: ICA problem - impact on stability: Black-listed CPE -1517: ICA problem - impact on stability: Abnormal crosstalk -1518: ICA problem - impact on stability: Defect switched power supply -1519: ICA problem - impact on speed: BridgeTap on overhead line -1600: Stability reached with downgrade positive value: reason why the maximum speed is higher then the current acccess profile 1000: outstanding upgrooming 1100: pending devloc change (short order) 1200: the profile is set manually 1300: Old CPE hardware 1301: CPE hardware doesnt support Vectoring. 1302: CPE firmware doesnt support Vectoring Potential Code negative value: reason why the maximum speed is lower then the current access profile. -1000: Pending downgrooming without service impact -1001: Pending downgrooming with service impact -1100: Pending devloc change (lengthing order) -1200: The profile is set manually -1300: -1400: The access is unstable -1501: ICA problem - impact on stability: BridgeTap -1502: ICA problem - impact on stability: Degraded Contact -1503: ICA problem - impact on speed: Missing Splitter -1504: ICA problem - impact on stability: Missing Splitter on alarm system (Business Decision) -1505: ICA problem - impact on stability: External Interference detected -1506: ICA problem - impact on stability: Intermittent contact -1507: ICA problem - impact on stability: Loop unbalanced -1508: ICA problem - impact on stability: Untwisted in-house wiring -1509: ICA problem - impact on stability: Time varying noise (crosstalk and RFI) -1510: ICA problem - impact on stability: CPE interoperability problem -1511: ICA problem - impact on stability: Black-listed CPE -1517: ICA problem - impact on stability: Abnormal crosstalk -1518: ICA problem - impact on stability: Defect switched power supply -1519: ICA problem - impact on speed: BridgeTap on overhead line -1600: Stability reached with downgrade positive value: reason why the maximum speed is higher then the current acccess profile 1000: outstanding upgrooming 1100: pending devloc change (short order) 1200: the profile is set manually 1300: Old CPE hardware 1301: CPE hardware doesnt support Vectoring. 1302: CPE firmware doesnt support Vectoring Potential Description

qualifAnswer

Description: Represents a (per start point) answerblock as part of the qualification result.

Used by: qualificationResult

Element Type Occ Comment

qualiResultState xs:string (Enumeration: ok, ok_stao, planned, nok) 0..1 State of the Qualification Result.

qualiResultDetail qualiResultDetailType 0..n

endPoint endPointType 0..1 An end point (consisting of a DN office and a BB device location) and port information.

plannedEndPoint plannedEndPoint 0..1 A planned end point (plannedEndpoint wird abgefuellt, wenn bekannt ist, dass der Startpunkt in Zukunft von einem neuen Breitbandziel bedient wird.).

cpeInfo cpeInfo 0..1 Information about the CPE.

maxAccessSpeed speedProfileType 0..1 The speed profile identifying the maximum possible access speed.

averageFlag xs:int (totalDigits:3) 0..1 [LOV-ID: 1050] The average flag marking the average answer within a multi-answer qualif response (0=The non-average qualif answer; 1=The average qualif answer (strict address qualif); 2=The average qualif answer (fuzzy address qualif)).

nrOfWires xs:int (totalDigits:2) 0..1 The number of wires (only copper).

billingZone xs:int (totalDigits:3) 0..1 [LOV-ID: 1503] The billing zone.

fulfillmentTimeSlot fulfillmentTimeSlot 0..n A list of fulfillment time slots

startPoint startPointType 0..1

address addressType 0..1 The address associated with this start point.

resourceAvailability

Element	Type	Occ	Comment
available	xs:boolean	1..1	true if the resource is available, else false.
resourceType	xs:int (totalDigits:3)	1..1	[LOV-ID: 1055] Resource Type (1 = Port; 2 = Copper, 3 = WARP Port).
upgradePlanDateTime	xs:dateTime	0..1	The planned upgrade time if resource unavailable.

0..n

A list of resource availability statements. true if the resource is available, else false. The planned upgrade time if resource unavailable.

qualifProfile qualifProfileType 0..n Represents a speed profile making up a part of a qualification result.

currentDnType xs:int (totalDigits:3) 0..1 [LOV-ID: 0109] The current DnType

currentAccessSpeed speedProfileType 0..1 The current access speed profile

llId xs:string (minLength:1, maxLength:13) 0..1 The local loop ID.

llDate llDateType 0..1 Local Loop Date

jumperAction xs:boolean 0..1 Ueberfuehrungsrelevant (true/false).

bbrRecommendation xs:int (totalDigits:3) 0..1 [LOV-ID: 1051] Broadband ready recommendation of Field Service (FS) Installation: 0 = na (it is not possible to give a self install recommendation); 1 = BBR necessary (no self install recommended); 2 = no BBR necessary (selfinstall possible); 3 = no BBR necessary (selfinstall possible); 4 = BBR necessary (no self install recommended); 5 = BBR Socket installed;

potentialAvailable xs:int (totalDigits:1) 0..1 [LOV-ID 1054] Potential available that after a BBR an upgrooming could be started - so the access speed will may be higher and the quality will not be worse.

reasonOfPotential reasonOfPotential 0..1 Reason of Potential - why is the Current Access Speed lower then the maximum

technologyType xs:int (totalDigits:3) 0..1 [LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST

lineState xs:int (totalDigits:3) 0..1 [LOV-ID: 1052] The copper line state.

vectorized xs:boolean 0..1 true if line is currently vectorized

siteDevelopment siteDevelopment 0..1 site development information, quantiy of basic connectivities and utilized units

swisscomReady xs:boolean 0..1 Flag indicating if the line is currently swisscom ready, means a All-IP access is provisioned

psdClass xs:int (totalDigits:3) 0..1 [LOV-ID: 1061] LOV_BB_PSD_CLASS

interleaveMode xs:int (totalDigits:3) 0..1 [LOV-ID: 1008] LOV_INTERLEAVE_MODE

availableTechnologyType

Used by: endPointType

Element	Type	Occ	Comment
technologyType	xs:int (totalDigits:3)	1..n	[LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST

bbPortInfoType

Used by: bbPortInfo

Element	Type	Occ	Comment
dslamName	xs:string (maxLength:30)	0..1	name of the DSLAM (e.g.: ipc-aar730-s-vd-05)
dslamType	xs:int (totalDigits:3)	0..1	[LOV-ID: 1064]: DSLAM Type.
bbPortNr	xs:string (minLength:1, maxLength:15)	0..4	Splitter Port
bbAdslEmulated	xs:int (totalDigits:3)	0..1	[LOV-ID: 0401]: ADSL emulated flag.
bbPortLineType	xs:int (totalDigits:3)	0..1	[LOV-ID: 1353] bb Port Line Type
vendor	xs:string (maxLength:32)	0..1	The vendor of the DSLAM

Top

endPointBaseType

Description: An end point (consisting of a DN office and a BB device location).

Used by: fiberQualifAnswer

Extended by: endPointType, plannedEndPoint

Element	Type	Occ	Comment
taxRegion	xs:int (totalDigits:3)	0..1	[LOV-ID: 1504] The tax region part of a start- or end-point (e.g. "62").
accessNet	xs:string (minLength:1, maxLength:5)	0..1	The access net part of a start- or end-point (e.g. "ALL").
site	xs:string (maxLength:4)	0..1	Site of the Broad Band Device Location.
siteCategory	xs:int (totalDigits:3)	0..1	[LOV-ID: 9008] The site categorization.
bbDeviceLocation	xs:string (minLength:1, maxLength:20)	0..1	The broad band device location. (e.g. "AES")

Top

oldConnectionType

Used by: plugType

Element	Type	Occ	Comment
basisContrEleId	xs:int (totalDigits:3)	1..1
ispId	xs:int (totalDigits:6)	0..1
patchType	xs:int (totalDigits:3)	0..1	[LOV-ID: 1334] LOV_ALO_PATCH_TYPE: Type of the cross connection (V1, V1+, V2)

Top

fiberQualifProfileType

Description: Represents a fiber speed profile making up a part of a qualification result.

Used by: plugType

Element	Type	Occ	Comment
qualifIndex	xs:long (totalDigits:10)	0..1	The index identifying a profile within a qualification response.
usedAccessSpeed	speedProfileType	0..1	A speed profile type.
serviceSpeed	speedProfileType	1..1	A speed profile type.
effectiveSpeed	duplexSpeedType	0..1	The effective speed/virtual profile.

Top

plugType

Description: A plug on a Optical Termination Outlet OTO or Fiber Dose FD

Used by: socketType

Element	Type	Occ	Comment
plugNr	xs:int (totalDigits:3)	1..1	A plug number (1..4).
fiberLineState	xs:int (totalDigits:3)	0..1	[LOV_FIBER_LINE_STATE] The state for the whole fiber line
otoState	xs:int (totalDigits:3)	0..1	[LOV_FIBER_LINE_STATE] The state of the OTO (optical termination outlet)
availabilityDate	xs:date	0..1
remark	xs:string	0..1	a remark
isActive	xs:boolean	0..1	true if a service is active on this line
activeConnectionInfo	oldConnectionType	0..1	only set in case of isActive=true
maxAccessSpeed	speedProfileType	0..1	access profiles
qualifProfile	fiberQualifProfileType	0..n	qualification profiles
jumperAction	xs:boolean	0..1	Ueberfuehrungsrelevant (true/false).
fulfillmentTimeSlot	fulfillmentTimeSlot	0..n	A list of fulfillment time slots
portState	xs:int (totalDigits:3)	0..1	[LOV-ID: 1111] The state of the port 1 = Connected 2 = Available 3 = Planned
portAvailabilityDate	xs:dateTime	0..1	Port availability date

Top

socketType

Description: Socket (Fiber)

Used by: fiberQualifAnswer

Element	Type	Occ	Comment
flatId	xs:string (maxLength:6 false)	0..1	A flat id (e.g. 02.01).
flatMemo	xs:string (maxLength:64)	0..1
socketId	xs:string (minLength:13, maxLength:19)	1..1
cooperationId	xs:string (maxLength:100)	0..1	A cooperation id (e.g. FreeFormText).
fiberLineState	xs:int (totalDigits:3)	0..1	State of fiber line. Populated here, if no plug exists, else under plug
otoState	xs:int (totalDigits:3)	0..1	The state of the OTO (optical termination outlet). Populated here, if no plug exists, else under plug
firstInHouse	xs:boolean	0..1	Is this the first socket in the house?
availabilityDate	xs:date	0..1
plug	plugType	0..n	A list of plugs

Top

fioAppointmentTimeSlotType

Description: A FIO Appointment time slot

Used by: fioAppointmentTimeSlots

Element	Type	Occ	Comment
timeSlotId	xs:string (maxLength:40)	1..1
start	xs:dateTime	1..1	the beginning
end	xs:dateTime	1..1	latest end
duration	xs:int	1..1	the expected duration in minutes
rank	xs:int	1..1	Preference by the system (ascending sort order)

Top

fioAppointmentTimeSlots

Description: inhouse installation appointments time slots

Used by: fiberQualifAnswer

Element	Type	Occ	Comment
timeSlots	fioAppointmentTimeSlotType	1..n	A FIO Appointment time slot the beginning latest end the expected duration in minutes Preference by the system (ascending sort order)

availability

Used by: fiberQualifAnswer

Element	Type	Occ	Comment
availabilityDate	xs:date	0..1	Availability date and target date are synonyms. Customers are able to order the service at this date.
validityClass	xs:string (minLength:1, maxLength:12)	1..1	Validity class and quality class are synonyms. Possible values are: "GK1", "GK2", "GK3", "GK4", "GK5", "GK98", "GK99"
reason	xs:string (minLength:1, maxLength:256)	0..1

events

Used by: fiberQualifAnswer

Element

Type

Occ

Comment

event

Element	Type	Occ	Comment
eventType	xs:string (maxLength:32)	1..1	possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve"
sequenceNumber	xs:int	1..1
eventTimeStamp	xs:dateTime	1..1
from	xs:string (maxLength:10)	0..1
to	xs:string (maxLength:10)	0..1
eventReason	xs:string (maxLength:100)	0..1

1..n

possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve"

fiberQualifAnswer

Description: Represents a fiber qualification answer.

Used by: qualificationResult

Element Type Occ Comment

qualiResultState xs:string (Enumeration: ok, ok_stao, planned, nok) 1..1 State of the Qualification Result.

qualiResultDetail qualiResultDetailType 0..n

endPoint endPointBaseType 0..1 An end point (consisting of a DN office and a BB device location).

address addressType 0..1 The address associated with this start point.

locationId xs:int 0..1

socket socketType 0..n List of sockets

fioAppointmentTimeSlots fioAppointmentTimeSlots 0..1 inhouse installation appointments time slots

bep

Element	Type	Occ	Comment
locationId	xs:int	1..1	A location id.
bepState	xs:int (totalDigits:3)	0..1	The BEP State (connected, available, planned or not connected)
availability	availability	0..1	Validity class and quality class are synonyms. Possible values are: "GK1", "GK2", "GK3", "GK4", "GK5", "GK98", "GK99"
inHouseAllowed	xs:boolean	1..1	In house installation allowed
firstInHouse	xs:boolean	1..1
maxAccessSpeedKbps	xs:int	1..n
initialMountingShaftCapacity	xs:string (maxLength:32)	1..1	possible values are: "available", "not available", "not checked"
bepBuilder	xs:string (maxLength:8)	0..1	possible values are: "SCS", "KOPA"
siteCategory	xs:string (maxLength:32)	0..1	possible values are: "standard", "remote_fan_fibre_spot"
events	events	0..1	possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve"
address	addressType	0..1	An (geographical) address entity.

0..n

Building Entry Point The BEP State (connected, available, planned or not connected) possible values are: "available", "not available", "not checked" possible values are: "SCS", "KOPA" possible values are: "standard", "remote_fan_fibre_spot"

qualificationResult

Description: Represents a technology (bbType) specific quali response.

Used by: qualifAcknowledgeType

Element

Type

Occ

Comment

contrEleId

xs:int (totalDigits:3)

0..n

[LOV-ID: 0320] A contract element ID.

bbType

xs:int (totalDigits:3)

0..1

[LOV-ID: 0276] The BB type.

dnType

xs:int (totalDigits:3)

0..1

[LOV-ID: 0109] The DN type.

qualifNr

xs:long (totalDigits:10)

0..1

lineState

xs:int (totalDigits:3)

0..1

[LOV-ID: 1052] The copper line state.

- choice:

Element	Type	Occ	Comment
qualifAnswer	qualifAnswer	1..n
fiberQualifAnswer	fiberQualifAnswer	1..n

1..1

subjectAddressNameType

Description: Person or company name.

Used by: subjectAddressEnhancedType

Top

startPointRequestType

Description: start point request parameters

Used by: srvQualifByStartPointType, qualifHistoryReqDataType

Element	Type	Occ	Comment
taxRegion	xs:int (totalDigits:3)	1..1	[LOV-ID: 1504] The tax region part of a start- or end-point (e.g. "62").
accessNet	xs:string (minLength:1, maxLength:5)	1..1	The access net part of a start- or end-point (e.g. "ALL").
unitType	xs:int (totalDigits:3)	1..1	The type of unit for UP.
unitNumber	xs:int (totalDigits:6)	1..1	The number of unit for UP.
sse	xs:int (totalDigits:2)	1..1	The 'sse' for UP.
contactType	xs:int (totalDigits:3)	0..1	[LOV-ID: 0115] The type of contact for UP.
contactNr	xs:int (totalDigits:6)	0..1	The contact number for UP.

Top

Element	Type	Occ	Comment
street	xs:string (minLength:1, maxLength:30)	0..1	The street name of an address.
houseNr	xs:string (minLength:1, maxLength:12)	0..1	The house number of an address.
building	xs:string (minLength:1, maxLength:30)	0..1	The building infomation of an address.
zip	xs:int (minInclusive:1000, maxInclusive:999999)	0..1	The zip of an address.
city	xs:string (minLength:1, maxLength:25)	0..1	The city of an address.
additionalCity	xs:string (minLength:1, maxLength:25)	0..1	The additional city information of an address.

Element	Type	Occ	Comment
appointmentId	xs:long (totalDigits:10)	1..1	Appointment ID referencing an existing agreement.
appointmentDateTime	xs:dateTime	1..1	Date and Time of an Appointment
appointmentEndDateTime	xs:dateTime	0..1	End Date and Time of an Appointment

Element	Type	Occ	Comment
qualifLogId	xs:long (totalDigits:10)	1..1	Qualification Log Id
transDateTime	xs:dateTime	1..1	The transition date/time.
orderNr	xs:string (pattern:[1-9]\d{25})	0..1	The order ID.
groupId	xs:long (totalDigits:10)	0..1	A group Id of a TDM message.
qualifHistoryRequest	qualifHistoryReqDataType	1..1	The qualification request from the history selected time slot
qualifHistoryResponse	qualifHistoryResDataType	1..1	The qualification response from the history

Element	Type	Occ	Comment
success	xs:boolean	1..1	The result code for the transaction ("true" if request was successful, "false" otherwise).
reason	xs:string (pattern:[\dA-Z]{3})	0..1	A 3-letter error code (aka messageId) where "000" means "ok".
reasonComment	xs:string (minLength:1, maxLength:256)	0..1	Some additional textual description for the reason.
operationLogId	xs:long	0..1	reference to this operation call. Can be used in clarification tickets

Element	Type	Occ	Comment
resultCode	xs:string (minLength:1, maxLength:4)	1..1	Qualification Result Code
resultComment	xs:string (minLength:1, maxLength:256)	1..1	Some additional textual description for the result.

Element	Type	Occ	Comment
up	xs:int	1..1	Upload speed in kbit/sec.
down	xs:int	1..1	Download speed in kbit/sec.

Element	Type	Occ	Comment
speedProfileNr	xs:int (totalDigits:3)	1..1	[LOV-ID: 1010] A speed profile number.
description	xs:string (minLength:1, maxLength:60)	0..1
max	duplexSpeedType	0..1	A upstream/downstream speed pair. Upload speed in kbit/sec. Download speed in kbit/sec.
min	duplexSpeedType	0..1	A upstream/downstream speed pair. Upload speed in kbit/sec. Download speed in kbit/sec.
technologyType	xs:int (totalDigits:3)	0..1	[LOV-ID: 9025] LOV_TECHNOLOGY_TYPE: Which standard was uesd for bitrate calculation: 1 = VDSL2; 2 = VDSL Vectoring; 3 = G.FAST

Element	Type	Occ	Comment
firstName	xs:string (minLength:1, maxLength:30)	0..1	A subject's first name.
lastName	xs:string (minLength:1, maxLength:30)	0..1	A subject's last name.
language	xs:string	0..1	ISO 639-1 (Codes for the representation of names of languages) (de = german; fr = french; it = italian)
eMail	xs:string (minLength:5, maxLength:100)	0..1	An E-Mail address (a.b@x.com)
phone	xs:string (pattern:(\+)?([0-9]){7,15})	0..1	phone number
phone2	xs:string (pattern:(\+)?([0-9]){7,15})	0..1	Second phone number
comment	xs:string (minLength:1, maxLength:256)	0..1	a comment to this address Informations