History

v2.0.2
  • Some changes in examples
v2.0.1
  • Replace existing installationInstruction and installationContact after InflightChangeProductOrder (product-order-2b-attribute-value-change-event-installation-instruction).
  • Added validation for "location_a_owner_type" to JSON Schema.
  • Links within PlantUML diagrams adapted for Confluence.
  • Added versions.txt to keep track of all published API versions.
  • Updated BPMN file locations and removed SVGs.
v2.0.0
  • Update spec to OpenAPI version 3.1.0

  • The API supports processes for "Glasfaserausbau" (fiber-optic expansion)

    • Orders can be submitted for fiber optic connections that have yet to be built.

    • Two variants are supported:

      • One order for the whole process, which is used in the S/PRI interface:
        Order category "connectivityWithActivation".

      In addition, there is the "connectivityNoActivation" category for orders without activation of the connection (if a seller supports this).

      A product specification which corresponds to the "connectivityNoActivation" category will be provided in a following version.

      • Two consecutive orders, which are used in the WITA interface:

        • One order in the category "notConnected"
        • One order in the category "new"

    • A new ProductOrderStateType "readyForActivation" is added.

      • Indicates that the "notConnected" Order was successful and the following order needs to be posted.

    • Examples and diagrams have been added for each of the two variants

  • The TaskResources for changing ongoing orders were restructured:

    • The TaskResource InflightChangeProductOrder replaces the taskResources:

      • AmendProductOrder
      • AddProductOrderInformation
      • CloseProductOrder
      • RespondProviderChange

    • A category within this TaskResource indicates which type of action should be performed:

      • add – add information, e.g. a note or a related party
      • activate – activate a Product Order of the category "connectivityWithActivation"
      • amend – add an optional product
      • close – close the Product Order
      • respondProviderChange – provide a response to a Product Order of the category "terminationProviderChange"
      • reschedule – reschedule the Product Order

    • The TaskResource "cancelProductOder" remains unchanged

    • The relevant examples and diagrams have been updated

  • A new product specification StandaloneFieldService ist added

  • CTK modularized and restructured, files renamed, support for validation of Events and TaskEntities added
  • DemoServer updated to include validation using CTK for supported objects
  • The campaignIdentifier is changed to an array of strings, according to the current WITA OSS

  • The JeopardyAlert “rescheduleReminder” is renamed to “reminder”

  • In the examples, the first line references a schema to enable checking against the ConformanceProfile.
    In real-world operation, a reference to a schema is not required.

v1.1.1 Rerelease
  • documentation restructured for better version support
  • no content changes
v1.1.1 (293)
  • fixed links to examples on main page
  • naming fixes in diagrams
  • diagrams for provider changes "FailedOnSwitchDay" added

Known issues

example product-order-termination-pv-0.json is not validated correctly.
the ctk schema incorrectly expects a relatedParty.
schema will be fixed.

v1.1.0 (281)

  • the following attributes have been removed from the API and all affected examples:

    • CancelProductOrder.cancellationReason
    • CancelProductOrder_FVO.cancellationReason
    • RescheduleProductOrder.rescheduleReason
    • RescheduleProductOrder_FVO.rescheduleReason
    • AmendProductOrder.amendReason
    • AmendProductOrder_FVO.amendReason

  • operations POST /hub and DELETE /hub/{id} including related objects have been removed

  • attribute ProductOrder.productOrderItem.billingAccount has been removed, example data updated

  • attribute ExternalIdentifier.href removed

  • the following attributes have been renamed:

    • ProductOrder.stateChangeReason → stateChangeMessage
    • TaskEntity.stateChangeReason → stateChangeMessage
    • StateChange.stateChangeReason → stateChangeMessage
    • RespondProviderChange.responseReason → responseMessage
    • RespondProviderChange_FVO.responseReason → responseMessage
    • CloseProductOrder.closeReason → closeMessage
    • CloseProductOrder_FVO.closeReason → closeMessage
    • ProviderChangeInfo.responseReason → responseMessage

  • enum value TaskStateType.terminatedWithError removed

  • multiple fixes for ctk schema and sample payload

  • multiple fixes in examples
  • some obsolete examples have been removed
  • some examples have been added (e.g. for OrderManagementSellerContact)
  • updates in FIT_622_ProductOrder_Struktur.xlsx
v1.0.4 (245)
  • version history added
  • fix typo in example product-order-cpo2-state-change-event-cancelled
  • multiple provider change diagram updates
  • change/rename externalIdentifierType "ProductOrder" to "externalOrderId" in all affected examples
  • versioning in API definition files updated
v1.0.3 (221)
  • fix links to "Arbeitshandbuch" in navigation, content and diagrams
  • updates for ProductOrderItem and OAL in FIT_622_ProductOrder_Struktur.xlsx
  • multiple fixes for ctk schema and sample payload
v1.0.2 (204)
  • fix description for AddProductOrderInformation and AmendProductOrder in main API description

  • fixes and clean-up in ProductOrder structure description file

  • update in example product-order-termination-pv-provider-change-unknown-product-id-spri-0

    • related party added
    • agreement for provider change added

  • multiple fixes for ctk schema and sample payload

v1.0.1 (199)
  • role "locationPoP" renamed to "locationPop" in examples
  • characteristics for national_destination_code and local_exchange_area changed from integer to string in examples

  • category "terminationByProviderChange" renamed to "terminationProviderChange" in examples

  • update in example product-order-termination-pv-provider-change-0

    • agreement for provider change added
    • product id and href fixed

  • update in example product-order-fttc-0-create

    • related party fixed

  • categories updated in diagram UC_KUE-LE

  • multiple fixes for ctk schema and sample payload
v1.0.0 (191)
  • initial release