Description: This operation gives an overview about the infrastructure for a requested location
| Input message | Output message |
|---|---|
| checkInfrastructureRequest | checkInfrastructureResponse |
| Element | Type | Occ | Comment | parameters | checkInfrastructureResponse | 1..1 |
|---|
| Element | Type | Comment | checkInfrastructureRequest | checkInfrastructureRequestType |
|---|
| Element | Type | Comment | checkInfrastructureResponse | checkInfrastructureResponseType |
|---|
Description: Address entity
Used by: bepType, copperAnswerType, fttoAnswerType, address, location
| Element | Type | Occ | Comment |
|---|---|---|---|
| street | xsd:string (minLength:1, maxLength:32) | 0..1 | A street name. |
| houseNr | xsd:string (minLength:1, maxLength:32) | 0..1 | A house number. |
| building | xsd:string (minLength:1, maxLength:32) | 0..1 | A house- or building-description or an additional information (for example 'Hinter dem Wald') |
| zip | xsd:int (minInclusive:1000, maxInclusive:999999) | 0..1 | A zip code. |
| city | xsd:string (minLength:1, maxLength:32) | 0..1 | A city name. |
| locationId | xsd:int | 0..1 | A location id; Also called GAIA-ID |
Description: Request for an overview about the fiber line infrastructure
Used by: checkInfrastructureRequest
| Element | Type | Occ | Comment |
|---|---|---|---|
| ispId | xsd:int (minInclusive:100000, maxInclusive:999999) | 1..1 | ID of the ISP |
| extRef | xsd:string (minLength:1, maxLength:100) | 0..1 | An exernal reference for correlation |
| address | addressType | 1..1 | |
| checkCopper | xsd:boolean | 0..1 | |
| checkFtth | xsd:boolean | 0..1 | |
| checkFtto | xsd:boolean | 0..1 | |
| doAddressValidation | xsd:boolean | 0..1 |
Description: The result of the service qualification
Used by: checkInfrastructureResponse
Extension of: ackType
| Element | Type | Occ | Comment |
|---|---|---|---|
| resultState | xsd:int | 1..1 | Possible values: 0=ok; 1=no location found; 2=more than one location found; 3=too many locations found |
| resultStateComment | xsd:string (minLength:1, maxLength:256) | 0..1 | Some additional textual description for the resultState. |
| location | addressType | 0..n | |
| copperAnswer | copperAnswerType | 0..n | |
| fttoAnswer | fttoAnswerType | 0..n | |
| ftthAnswer | ftthAnswerType | 0..n |
Description: The generic acknowledge response type.
Extended by: checkInfrastructureResponseType
| Element | Type | Occ | Comment |
|---|---|---|---|
| success | xsd:boolean | 1..1 | The result code for the transaction ("true" if request was successful, "false" otherwise). |
| reason | xsd:string (pattern:[\dA-Z]{3}) | 0..1 | A 3-letter error code (aka messageId) where "000" means "ok". |
| reasonComment | xsd:string (minLength:1, maxLength:256) | 0..1 | Some additional textual description for the reason. |
Description: Start Point
Used by: copperAnswerType, fttoAnswerType
| Element | Type | Occ | Comment |
|---|---|---|---|
| taxRegion | xsd:int | 1..1 | Tax Region (ISLK: RK Nr) |
| accessNet | xsd:string (minLength:1, maxLength:5) | 1..1 | Access Net (ISLK: AN kurz) |
| unitType | xsd:int | 1..1 | Unit Type (ISLK: BG Art), example: 3 (UP) |
| unitNumber | xsd:int | 1..1 | |
| unitName | xsd:string (minLength:1, maxLength:32) | 1..1 | Unit Name (ISLK BG Name), example: Optonet |
| unitKind | xsd:string (minLength:1, maxLength:32) | 1..1 | Unit kind (ISLK: BG Type), example: ET20 |
| sseKind | xsd:string (minLength:1, maxLength:32) | 1..1 | SSE kind (ISLK: SSE Type), example: ET20 |
| sse | xsd:int | 1..1 | SSE Number (ISLK: SSE Nr), example: 1 |
| yCoordinate | xsd:int | 0..1 | Schweizer Landeskoordinaten (YCoordinate=W-E-Axis; Bern y=600000) |
| xCoordinate | xsd:int | 0..1 | Schweizer Landeskoordinaten (XCoordinate=S-N-Axis (Bern x=200000) |
| address | addressType | 0..1 |
|
| locationDetails | xsd:string (minLength:1, maxLength:256) | 0..1 | Additional Information |
| comment | xsd:string (minLength:1, maxLength:400) | 0..1 | Comment |
Description: Equipped Date History: list the last 3 changes (if there are some)
Used by: plannedEndPointType
| Element | Type | Occ | Comment |
|---|---|---|---|
| sortNr | xsd:int | 1..1 | 1 (nearest) ... 3 (oldest) |
| changeDate | xsd:string (minLength:1, maxLength:10) | 1..1 | Pattern: 2[0-9]{3}((-[01][0-9])?)((-[0-3][0-9])?) |
| eventType | xsd:int | 1..1 | 1=TargetDateChange; 2=ValidityClassException |
| from | xsd:string (minLength:1, 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 | xsd:string (minLength:1, 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 | xsd: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 | xsd:string (minLength:1, maxLength:100) | 1..1 |
Description: planned End Point (Central Office)
Used by: copperAnswerType
Extension of: endPointType
| Element | Type | Occ | Comment |
|---|---|---|---|
| equippedDate | xsd:string (minLength:1, maxLength:10) | 1..1 | Equipped date and target date are synonyms. Customers are able to order the service at this date. |
| equippedDateQuality | xsd:int | 1..1 | Equipped date quality and quality class are synonyms. |
| equippedDateDescription | xsd:string (minLength:1, maxLength:100) | 1..1 | The Description of the equippedDate and it's quality. |
| extensionCategory | xsd:int | 1..1 | Ausbau Kategorie |
| plannedBitrate | bitrateType | 1..1 | Planned Maximum Bitrate |
| equippedDateHistory | equippedDateHistoryType | 0..n | Equipped Date History: list the last 3 changes (if there are some) 1 (nearest) ... 3 (oldest) Pattern: 2[0-9]{3}((-[01][0-9])?)((-[0-3][0-9])?) 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 |
Description: End Point (Central Office)
Used by: copperAnswerType, fttoAnswerType, ftthAnswerType
Extended by: plannedEndPointType
| Element | Type | Occ | Comment |
|---|---|---|---|
| taxRegion | xsd:int | 1..1 | Tax Region (ISLK: RK Nr) |
| accessNet | xsd:string (minLength:1, maxLength:5) | 1..1 | Access Net (ISLK: AN kurz) |
| bbDeviceLocation | xsd:string (minLength:1, maxLength:5) | 1..1 | Broad Band Device Location |
| siteCategory | xsd:int | 0..1 |
Used by: copperAnswerType, plannedEndPointType
| Element | Type | Occ | Comment |
|---|---|---|---|
| up | xsd:int | 1..1 | Upstream |
| down | xsd:int | 1..1 | Downstream |
Description: a copper infrastructure answer
Used by: copperAnswer
| Element | Type | Occ | Comment |
|---|---|---|---|
| answerState | xsd:string (Enumeration: ok, ok_stao, planned, no_bep, no_oto, nok)
|
1..1 | Possible values: ok, ok_stao, nok |
| answerStateComment | xsd:string (minLength:1, maxLength:256) | 0..1 | Additional comment to the answerState |
| qualifiedTechnology | xsd:string (minLength:1, maxLength:32) | 0..1 | |
| testedNumber | xsd:string (minLength:1, maxLength:32) | 0..1 | |
| address | addressType | 0..1 | UP Address |
| startPoint | startPointType | 0..1 | UP Start Point |
| endPoint | endPointType | 0..1 | End Point (Central Office) Tax Region (ISLK: RK Nr) Access Net (ISLK: AN kurz) Broad Band Device Location |
| plannedEndPoint | plannedEndPointType | 0..1 | planned End Point (Central Office) Equipped date and target date are synonyms. Customers are able to order the service at this date. Equipped date quality and quality class are synonyms. The Description of the equippedDate and it's quality. Ausbau Kategorie Planned Maximum Bitrate |
| numberOfFreeLines | xsd:int | 0..1 | |
| lineLength | xsd:int | 0..1 | |
| calculatedBitrate | bitrateType | 0..1 | Calculated Bitrate |
| copperMinimal | xsd:boolean | 0..1 | Only limited copper available at this location? |
Used by: accessInfoType
| Element | Type | Occ | Comment | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| pathElement |
|
1..n | Element Index, sort of element, start with 1 at customer site Element Name, for example: OMD Zullwil Kirchweg 142 |
Used by: fttoAnswerType
| Element | Type | Occ | Comment |
|---|---|---|---|
| numberOfFreeLines | xsd:int | 0..1 | Number of free lines |
| lineLength | xsd:int | 0..1 | Line length in meter |
| pathDetail | pathDetailType | 0..1 | Path information about the local loop |
Description: a FTTO infrastructure answer
Used by: fttoAnswer
| Element | Type | Occ | Comment |
|---|---|---|---|
| answerState | xsd:string (Enumeration: ok, ok_stao, planned, no_bep, no_oto, nok)
|
1..1 | Possible values: ok, ok_stao, nok |
| answerStateComment | xsd:string (minLength:1, maxLength:256) | 0..1 | Additional comment to the answerState |
| address | addressType | 0..1 | BSO Address (Customer Location) |
| startPoint | startPointType | 0..1 | OP Start Point |
| endPoint | endPointType | 0..1 | End Point (Central Office) Tax Region (ISLK: RK Nr) Access Net (ISLK: AN kurz) Broad Band Device Location |
| accessInfo | accessInfoType | 0..1 | Number of free lines Line length in meter Path information about the local loop |
Description: optical termination outlet
Used by: otoType
| Element | Type | Occ | Comment |
|---|---|---|---|
| plugNr | xsd:int | 1..1 | A plug number (1..4). |
| fiberLineBusinessState | xsd:int | 1..1 | 14 - Fiber.Ready-LSG; 13 - Fiber.Ready-ALO; 12 - Fiber.Ready-Kopa; 11 - OTO.Assigned-Parallel, 10 - OTO.Assigned-Sequential, 9 - Fibre.Ready, 8 - OTO-Ready, 7 - OTO.Planned, 6 - OTO.Planned, 5 - OTO.Only |
| fiberLineState | xsd:int | 1..1 | The state of the whole line [LOV-ID: 1062] 1 = CONNECTED; 2 =AVAILABLE; 3 = PLANNED; 4 = NOT_CONNECTED; 6 = CONNECTED COPA; 7 = CONNECTED ALO; 8 = CONNECTED LSG |
| otoState | xsd:int | 1..1 | The state of the OTO (optical telecomunications outlet) [LOV-ID: 1062] 1 = CONNECTED; 2 =AVAILABLE; 3 = PLANNED; 4 = NOT_CONNECTED; 5 = NO IN HOUSE INSTALLATION |
| physicalOwnershipInhouse | xsd:int | 1..1 | CoPa-Id of the Owner of the physical line |
| rightOfUse | xsd:int | 1..1 | CoPa-Id of the Cooperation partner who has the rigth to use the fiber |
| bindingId | xsd:string (maxLength:15) | 0..1 | The binding id (e.g. AC1.222.333.444). |
Description: optical termination outlet
Used by: ftthAnswerType
| Element | Type | Occ | Comment |
|---|---|---|---|
| otoId | xsd:string (minLength:1, maxLength:32) | 1..1 | An OTO ID (e.g. A.123.456.789). |
| cooperationId | xsd:string (minLength:1, maxLength:100) | 0..1 | cooperation id or partner label |
| plug | plugType | 0..n | A list of plugs |
| flatId | xsd:string (minLength:1, maxLength:10) | 0..1 | A flat id (e.g. 02.01). |
| flatMemo | xsd:string (minLength:1, maxLength:64) | 0..1 |
Description: Building entry point
Used by: ftthAnswerType
| Element | Type | Occ | Comment | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| fiberLineBusinessState | xsd:int | 1..1 | Business State of line: 2 - BEP.Planned; 3 - BEP.Planned; 4 - BEP.Ready | ||||||||||||||||||||||||||||
| bepState | xsd:int | 1..1 | The state of the BEP [LOV-ID: 1062] 1 = CONNECTED; 3 = PLANNED; 4 = NOT_CONNECTED | ||||||||||||||||||||||||||||
| availability |
|
0..1 | Availability date and target date are synonyms. Customers are able to order the service at this date. Validity class and quality class are synonyms. Possible values are: "GK1", "GK2", "GK3", "GK4", "GK5", "GK98", "GK99" | ||||||||||||||||||||||||||||
| inHouseAllowed | xsd:boolean | 1..1 | |||||||||||||||||||||||||||||
| firstInHouse | xsd:boolean | 1..1 | |||||||||||||||||||||||||||||
| maxAccessSpeedKbps | xsd:int | 1..n | |||||||||||||||||||||||||||||
| initialMountingShaftCapacity | xsd:string (minLength:1, maxLength:32) | 1..1 | possible values are: "available", "not available", "not checked" | ||||||||||||||||||||||||||||
| bepBuilder | xsd:string (minLength:1, maxLength:10) | 0..1 | possible values are: "SCS", "KOPA" | ||||||||||||||||||||||||||||
| siteCategory | xsd:string (minLength:1, maxLength:32) | 0..1 | possible values are: "standard", "remote_fan_fibre_spot" | ||||||||||||||||||||||||||||
| address | addressType | 0..1 | BEP Address | ||||||||||||||||||||||||||||
| event |
|
0..n | possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve" |
Description: a FTTH infrastructure answer
Used by: ftthAnswer
| Element | Type | Occ | Comment |
|---|---|---|---|
| answerState | xsd:string (Enumeration: ok, ok_stao, planned, no_bep, no_oto, nok)
|
1..1 | Possible values: ok, no_bep, no_oto, nok |
| answerStateComment | xsd:string (minLength:1, maxLength:256) | 0..1 | Additional comment to the answerState |
| numberOfOtos | xsd:int | 1..1 | |
| hasOtoAssigned | xsd:boolean | 0..1 | |
| oto | otoType | 0..n | optical termination outlet An OTO ID (e.g. A.123.456.789). cooperation id or partner label A list of plugs A flat id (e.g. 02.01). |
| bep | bepType | 0..n | Building entry point Business State of line: 2 - BEP.Planned; 3 - BEP.Planned; 4 - BEP.Ready The state of the BEP [LOV-ID: 1062] 1 = CONNECTED; 3 = PLANNED; 4 = NOT_CONNECTED Availability date and target date are synonyms. Customers are able to order the service at this date. Validity class and quality class are synonyms. Possible values are: "GK1", "GK2", "GK3", "GK4", "GK5", "GK98", "GK99" possible values are: "available", "not available", "not checked" possible values are: "SCS", "KOPA" possible values are: "standard", "remote_fan_fibre_spot" BEP Address possible values are: "1 - TargetDateChange", "2 - ValidityClassException", "99 - Reserve" |
| endPoint | endPointType | 0..1 | End Point (Central Office) Tax Region (ISLK: RK Nr) Access Net (ISLK: AN kurz) Broad Band Device Location |