Wholesale fulfillment

FttH address service (UC)

version date state start date end date remarks schemas
2.10.0 2024-07-16 proposed t.b.d. - Added fields contractOfAllowanceNeeded and houseOwnerContactRequired to houses endpoint
uc-address-v2.10.0.yaml (View)
2.9.0 2023-10-19 final November 2023 - Added optional extendedProjectType parameter to /projects
Added optional extendedProjectType parameter to /projects/{projectNumber}
Added optional odfPosition to Fiber
Added optional deliveryStatus to PassiveConnection
Added campaign interfaces (internal only)
uc-address-v2.9.0.yaml (View)
2.6.1 2022-08-12 final September 2022 - Added optional ControlGroup to Feasibility and FeasibilityNew
Added optional IsCustomerRejectAdditionalCosts and ChosenUnitNumberForOrder to FeasibilityResult
Added optional OrdersAllowed to Project
Removed non-existing parameters for HouseSimple that were marked as required
uc-address-v2.6.1.yaml (View)
2.5.1 2022-08-04 final 2022-08-04 - Added optional cityId parameter to /address_search/streets
Added optional X-DG-ISP-Code parameter to /projects/{projectNumber}
uc-address-v2.5.1.yaml (View)
2.5.0 2022-05-11 final 2022-05-11 - Added optional cityId parameter to /address_search/streets
Added optional X-DG-ISP-Code parameter to /address_search/houses
uc-address-v2.5.0.yaml (View)
2.4.0 2021-11-04 final 2021-11-10 - Booked product in reservation uc-address-v2.4.0.yaml (View)
2.2 2021-02-19 final 2021-02-19 2021-11-10 passive connection info in sync
uc-address-v2.2.0.yaml (View)
2.1 2020-10-29 deprecated 2020-11-01 2Q2021 Added feasibility
Expand project information
Added project communication responsibles
Removed deprecated methods
uc-address-v2.1.0.yaml (View)
2.0 2020-04-16

2020-04-16

2020-03-12


2020-02-01
deprecated 2020-05-01 2Q2021 Added project statusses
Security definition fixed

Sync improvements / bug fixing

Address sync functionality added
uc-address-v2.0.3.yaml (View)

uc-address-v2.0.2.yaml (View)

uc-address-v2.0.1.yaml (View)


uc-address-v2.0.0.yaml (View)
1.0 2019-09-01 discontinued 2019-09-01 2Q2020 Initial version. uc-address-v1.0.1.yaml (View)
uc-address-v1.0.0.yaml

FttH order (Camel)

version date state start date end date remarks schemas
2.1 2024-03-20 draft May 2024 - Added request houseOwnerChangeOrder
Added object houseOwnerContact
For Contract of Allowance
ftth-v2.1.wsdl
ftth-v2.1.xsd

2.0 2022-11-14 final November 2022 - Replaced 3 versions of getOrderInfo call to one new request getOrderInformation
Added extra date fields to getOrderInformation call
ftth-2.0.wsdl
ftth-2.0.xsd

1.7 2022-05-17 final April 2022 - Added request getOrderInfoV3
Added request migrateOrder
Added request changeMigrateOrder
Added request acceptMigrateOrder
Added order subType field to getOrderInfoV3 response
ftth-1.7.wsdl
ftth-1.7.xsd

1.6 2022-04-05 final December 2021 - Added request updateSerialNumber
Added request cancelOrder
Added request resumeOrder
ftth-1.6.wsdl
ftth-1.6.xsd

1.5 2021-07-20 final July 2020 2021-11-23 Added request getConnectionActivationCode
Added request resetConnectionActivationCode
ftth-1.5.wsdl
ftth-1.5.xsd

1.4 2020-01-01 final 2020-03-20 - Ordering without Unit.
ftth-1.4.wsdl
ftth-1.4.xsd
Fulfillment application FttH V142.pdf
Fulfillment application FttH V141.pdf
ftth-order-samples.zip

1.3 2018-11-01 final February 2019 2020-03-20 Added ontId.
ftth-1.3.wsdl
ftth-1.3.xsd
pdf

1.2 - discontinued never never Discontinued.
ftth-1.2.wsdl

1.1 June 2017 final June 2017 February 2019 December 2017: Added checks to length of fields.
December 2017: Network type and hold code .
June 2017: optimized point to point.
ftth-1.1.wsdl
ftth-1.1.xsd
pdf

1.0 January 2014 final < 2014-01-01 June 2017 Initial version.
ftth-1.0.wsdl
ftth-1.0.xsd
pdf


FttH order update

version date state start date end date remarks schemas
1.2 July 2023 final July 2023 - Added new Operation: 'notifyMigrate'
Donor info on ISP-Wechsel
order-update-1.2.wsdl
order-update-1.2.xsd

1.1 Januar 2022 final February 2022 - Interface updated. Added new operation 'notify_hold_waiting_on_isp'
order-update-1.1.wsdl
order-update-1.1.xsd

1.0 Januar 2014 deprecated < 2014-01-01 February 2022 Initial version.
orderupdate-1.0.wsdl
ftth-order-update-samples.zip


FttH diagnostic

version date state start date end date remarks schemas
1.0 September 2019 final < 2019-09-01 - Initial version.
pdf
ftth-diagnostic-samples.zip




Passive Order Management

GF-TAL

version date state start date end date remarks schemas
2.5.1 2024-09-19 final Expected go-live October 2024 - * Added new PATCH for NT SWAP
Download
View
2.5.0 2024-09-16 final Replaced by new version - * Added new PATCH for NT SWAP
Download
View
2.4.0 2024-03-11 final Expected go-live March 2024 - * Added PreCabled to ActiveEquipmentEndpoint
* Added Frame, Tray, PortNumber to OdfEndpoint
Download
View
2.3.1 2024-01-30 final Expected go-live March 2024 - Compared to 2.1.1 version:
* Added House Owner information
* Added extended NT information
Download
View
2.1.1 2023-01-25 final March 2023 - Compared to 2.1.0 version:
* Added InfoCodes
Download
View
2.1.0 2022-12-13 discontinued December 2022 - Compared to 1.0.x version:
* Added InfoCodes
* A PUT for an updated ActiveEquipmentEndpoint now uses a full JSON body
* Added call to inform the AO that the Order is put on HOLD and the AO needs to contact the Customer
* Added call to inform DG that the Order (that was on HOLD) can be resumed
* Added call to get the exact Version and Build of the Gftal interface
* Added an optional NtInstallation object when creating a Gftal
* Added an optional ActiveEquipmentEndpoint to a Gftal Release order
* Added optional ActivationAppointment, HouseOrUnitVisitAppointment and HouseOrUnitVisitCompletionDateTime objects that can be returned for a Gftal Order
* Other minor improvements to object definitions
Download
View
2.0.0 2022-08-22 discontinued August 2022 - * Added InfoCodes
* A PUT for an updated ActiveEquipmentEndpoint now uses a full JSON body
* Added call to inform the AO that the Order is put on HOLD and the AO needs to contact the Customer
* Added call to inform DG that the Order (that was on HOLD) can be resumed
* Added call to get the exact Version and Build of the Gftal interface
* Added an optional NtInstallation object when creating a Gftal
* Added an optional ActiveEquipmentEndpoint to a Gftal Release order
* Added an optional HouseOrUnitVisitAppointment object that can be returned for a Gftal Order
* Other minor improvements to object definitions
Download
View
1.0.2.1 2023-01-25 final March 2023 - * Added InfoCodes
Download
View
1.0.2 2020-07-28 final 2020-07-28 - * Added InfoCodes
* A PUT for an updated WishDate now uses a full JSON body
* Gftal now always returns a Location of type LocationWohnEinheitIdBased
* The Location that is returned in an Order will be of type LocationWohnEinheitIdBased when the UnitNumber is known/determined
* Made the HouseNumberExtension field required in LocationWohnEinheitIdBased
* Added an optional IspNew to GftalNew
* Added an optional CivilDate to Order
* Added an optional PreviousCarrierCode to UnitClearingInfo
* Removed intercalation from PersonName
* Updated some example values
* Updated 403 and 428 HTTP response codes
* Renamed ApiResponse to ModelApiResponse
Download
View
1.0.1 2020-05-06 final 2020-05-06 2020-07-27 Changed maximum:16 to maxLength:16 in HouseNumberExtension.
Download
View
1.0.0 2020-05-04 discontinued 2020-05-04 2020-05-05 * Moved some HTTP response codes to Info codes (when an Order is Denied or put on Hold).
* Added ExternalOrderId and WishDate to Gftal release.
* UnitNumber in LocationWohnEinheitIdBased is now required.
* Added UnitClearingInfo.
* Return OdfEndpoint information (if it is available) with the Order info.
* Added GftalStatus CANCELLED and DENIED, and removed FREE.
Download
View
0.9.4 2020-02-25 discontinued 2020-02-25 2020-05-03 Initial version. Download
View



Passive Sales

Sales-service

version date state start date end date remarks schemas
1.0 2020-04-16


2020-03-26
proposed t.b.d. - Security definition fixed

Initial version.
uc-sales-service-v1.0.1.yaml
View

uc-sales-service-v1.0.0.yaml
View



Contractors

Task

version date          state start date    end date remarks schemas
2.7.6 2024-07-12 final September 2024 - Add orderReasonNotConnected (on unit-level) and oltPortType (on task-level) Download
View

task-rest-v2-response-codes-20240712.pdf
2.7.4 2023-11-16 final November 2023 - Change object type for houseTaskInfo for HCHW and HCHUP from houseTaskInfo to unitTaskInfo Download
View

task-rest-v2-response-codes-20230929.pdf
2.7.3 2023-11-09 replaced by newer version November 2023 - Added GponMeasurementInfo, Frame and OltPort Download
View

task-rest-v2-response-codes-20230929.pdf
2.7.2 2023-09-29 replaced by newer version October 2023 - For communicating the NT serial number:
Added updateInstalledNtInfoForTask
Added response codes 716 and 717

For contract of allowance:
Added companyName and customerType
Download
View

task-rest-v2-response-codes-20230929.pdf
2.7.1 2023-07-12 replaced by newer version September 2023 - Removed contractOfAllowanceAvailable boolean from v2.7.0. Download
View

task-rest-v2-response-codes-20230628.pdf
2.7.0 2023-06-28 replaced by newer version - - Updated TaskHVS with a HouseOwner and Contract of Allowance data. Added R25 and R26. Download
View

task-rest-v2-response-codes-20230628.pdf
2.6.0 2023-02-24 final March 2023 - Added extra information on Project level for (automated) Erstbefullung. Added R22, R23 and R24. Download
View

task-rest-v2-response-codes-20230224.pdf
2.5.0 2023-01-16 final February 2023 - Improved TaskType and InfoType discriminator definition
Removed slaDate. Added olaAppointmentDate and olaCompletionDate
Note: olaAppointmentDate and olaCompletionDate are not yet filled for TaskHP, TaskDepatch and TaskHCHW.
Download
View

task-rest-v2-response-codes-20220107.pdf
2.4.0 2022-09-27 final February 2023 - Added discriminator TaskType to GeneralTaskInfo and InfoType to GeneralHouseAndUnitTaskInfo
Download
View

task-rest-v2-response-codes-20220107.pdf
2.3.0 2022-09-27 final October 2022 - Added optional BuildingType to Unit
Download
View

task-rest-v2-response-codes-20220107.pdf
2.2.0 2022-06-09 final July 2022 - Added numberOfUnits to House.
Added NetBuildType BLOWN_FIBER_ETA
Added swissKnife to Project.
Updated email format
Download
View

task-rest-v2-response-codes-20220107.pdf
2.1.0 2022-01-07 final Februari 2022 July 2022 Added UV-NE4 task type Download
View

task-rest-v2-response-codes-20220107.pdf
2.0.2 2021-09-16 final October 2021 Februari 2022 Final version after internal and external reviews. Download
View

task-rest-v2-response-codes-20210901.pdf
2.0.1 2021-01-06 replaced by newer version - - Version after internal and external reviews. Download
View

task-rest-v2-response-codes-20210106.pdf
2.0.0 2020-12-10 replaced by newer version - - Extended version of the Task interface (formerly known as BI REST), that uses explicitly assigned Tasks. Download
View
1.2 2021-03-03 final 2021-03-31 - 2021-07-08 if Username has value activationCode, then Password contains the NT activationCode

2021-03-31 Added TaskDepatch and TaskNT.
Split OdfEndpoint and ActiveEquipmentEndpoint into separate fields.
Some minor improvements.
Download
View

task-rest-v1.2-response-codes.pdf
1.1 2020-04-09 final 2020-10-01 / 2021-03-10 - BI REST: added ActiveOperator and ServiceProvider to the Tasks.
Added endpoint for updating the status of Task.
Download
View

task-rest-v1.1-response-codes.pdf
1.0 2019-08-19 final 2020-01-01 - Initial version of BI REST Download
View



Service Provider

CIM Service

version date          state start date    end date remarks schemas
4.0 2020-12-11 final 1Q2021 - Fix update customer (email-valid)

Fix a few bugs

Initial version of the OpenApi specification based CIM-Service interface
cimrest-v4.0.2.yaml View

cimrest-v4.0.1.yaml View

cimrest-v4.0.0.yaml View



Assurance

Ticket

version date          state start date    end date remarks schemas
2.0.6 2023-04-18 final April 2023 - Added ActivationCode in IndividualTicketPart Download
View
2.0.5 2022-08-22 final February 2022 - Correction in the discriminator mapping of EventType. Download
View
2.0.4 2022-01-31 final February 2022 - Initial version of the OpenApi specification for Assurance Ticket Download
View

assurance-ticket-v2-response-codes-20220406.pdf

assurance-ticket-v2-response-codes-20220131.pdf



Enterprise (General)

SAP-SD/MM service (Server on SAP side)

version date          state start date    end date remarks schemas
SNAPSHOT - - - - - sap-sd_mm-server.yaml View
1.0.10 2021-09-28 final Q4 / 2021 - - sap-sd_mm-server-v1.0.10.yaml View
1.0 2021-01-06 deprecated Q1 / 2021 Q4 / 2021 Adding pop-id and phase 2 changes

Initial version of the interface towards SAP-SD/MM Module

sap-sd_mm-server-v1.0.9.yaml View
sap-sd_mm-server-v1.0.8.yaml View
sap-sd_mm-server-v1.0.7.yaml View
sap-sd_mm-server-v1.0.6.yaml View
sap-sd_mm-server-v1.0.5.yaml View
sap-sd_mm-server-v1.0.4.yaml View
sap-sd_mm-server-v1.0.3.yaml View
sap-sd_mm-server-v1.0.2.yaml View
sap-sd_mm-server-v1.0.1.yaml View
sap-sd_mm-server-v1.0.0.yaml View

Logistic Service Provider


DG To Service Provider

version date          state start date    end date remarks schemas
0.0.7 2022-01-06 test Q4 / 2022 - Initial version of the interface DG to Logistic Service Provider (VCK) dg_to_service-provider.yaml View

Service Provider To DG

version date          state start date    end date remarks schemas
0.0.9 2022-01-06 test Q4 / 2022 - Initial version of the interface Logistic Service Provider (VCK) to DG service-provider_to_dg.yaml View