LSO Sonata SDK is the complete set of deliverables developed by the CTO in order to

  1. Enable market adoption of LSO Sonata APIs in the current release of LSO Sonata SDK.
  2. Support of development of additional features for the upcoming release of LSO Sonata SDK.

The current release of LSO Sonata SDK is R4 and is available on GitHub (see Latest Releases section for details).

The upcoming releases of LSO Sonata SDK are: R5 which is planned for May 8th, 2020 and R6 which is planned for Nov 6th, 2020.

Any MEF member can participate in the development of each new release of LSO Sonata SDK:

  • Contact the LSO Developer Community Manager (Mariusz Szypula) either via GitHub or by email to let him know of your interest and to ask questions

Latest Release

LSO Sonata SDK Release 4

Version: R4

This SDK release aligns the API schemas and definitions for Serviceability (Address Validation, Site Queries, Product Offering Qualification) and Product Inventory to the latest versions of MEF 79 and MEF 81 Draft Standards. In addition, the API schemas and definitions for Product Order are aligned with the new version of other Sonata APIs. The latest versions of MEF 79 and MEF 81 Draft Standards are included.

MEF LSO Sonata SDK core includes API definitions for the following functional areas:

  • Serviceability (Address, Service Site, and Product Offering Qualification Management)
  • Product Quote
  • Product Order
  • Product Inventory

It also holds Payload Descriptions for the following structures that are used with these APIs

  • JSON representations for Product Spec descriptions (initially for MEF Access E-Line services)
  • JSON representations for the UNI attributes (sourced from MEF 57.1)

SDK Repository

Core (public):

https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r4

SDK Contents

The SDK contains the following items:

  • COPYRIGHT - Copyright 2019 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • payload_description - Common descriptors are found in this directory
    • ProductSpecDescription – Contains reference JSON schemas for product specification description.
  • api - Definitions of the API are found in this directory
    • Inventory - Contains the API definitions necessary for inter-carrier retrieval of Product Inventory
    • Quote - Contains the API definitions for inter-carrier service quotation capability
    • Serviceability - Contains the API definitions that allow the Service Provider, or Buyer to:
      • Retrieve Address information including exact formats for Addresses known to the Seller
      • Retrieve Service Site information including exact formats for Service Sites known to the Seller
      • Determine whether it is feasible for the Seller to deliver a particular Product with a given configuration to a particular geographic location if applicable.
    • ProductOrder - Contains the API definitions for inter-carrier service ordering capability.
  • documentation - This contains the draft standards of the Business Requirements and Use Cases for
    • Address, Service Site, and Product Offering Qualification Management (MEF 79 Draft (R3))
    • Product Order Management (MEF 80 Draft (R2))
    • Product Inventory Management (MEF 81 Draft (R3))

SDK License

The MEF LSO Sonata SDK is released under the Apache 2.0 license.

API versions in SDK releases

LSO Sonata SDK Release 4

Version: R4

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r4

API release notes: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/blob/r4/api/R4%20release%20notes.txt

API versions:

  • Serviceability

    • GeographicAddressManagement - 3.0.0

    • GeographicSiteManagement - 3.0.0

    • ProductOfferingQualificationManagement - 3.0.1

    • ProductOfferingQualificationNotification - 3.0.0

  • Product Quote

    • QuoteManagement - 2.0.0

    • QuoteNotification - 1.0.0

  • Product Order

    • ProductOrderManagement - 3.0.0

    • ProductOrderNotification - 3.0.0

  • Product Inventory

    • ProductInventoryManagement - 3.0.0

LSO Sonata SDK Release 3

Version: R3

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r3

API release notes: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/blob/r3/api/R3%20release%20notes.txt

API versions:

  • Serviceability

    • GeographicAddressManagement - 2.0.0

    • GeographicSiteManagement - 2.0.0

    • ProductOfferingQualificationManagement - 2.0.0

    • ProductOfferingQualificationNotification - 1.0.0

  • Product Quote

    • QuoteManagement - 2.0.0

    • QuoteNotification - 1.0.0

  • Product Order

    • ProductOrderManagement - 2.0.0

    • ProductOrderNotification - 1.0.0

  • Product Inventory

    • ProductInventoryManagement - 2.0.0

LSO Sonata Developer's Preview

Version: 2018-dev-preview

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/2018-dev-preview

API versions:

  • Serviceability

    • GeographicAddressManagement - 1.0.0

    • GeographicSiteManagement - 1.0.0

    • ProductOfferingQualificationManagement - 1.0.0

    • ProductOfferingQualificationNotification - 1.0.0

  • Product Quote

    • QuoteManagement - 1.0.0

    • QuoteNotification - 1.0.0

  • Product Order

    • ProductOrderManagement - 1.0.0

    • ProductOrderNotification - 1.0.0

  • Product Inventory

    • ProductInventoryManagement - 1.0.0

Reference Implementations
  1. Example implementation of MEF LSO Sonata APIs on Buyer side provided by Amdocs. This example code is part of the solution between a Tier1 North American operator, Amdocs and a UK provider that was put into production in April 2019.

    https://github.com/MEF-GIT/Example-LSO-Sonata-Buyer-Implementation (MEF Members only)

This example LSO Sonata implementation does not provide an executable or runnable project and it is based on the older APIs version.

Engagement Opportunities

  1. Development and use of the MEF 3.0 Developer Workshop
  2. Requirements for future releases of LSO Sonata
  3. Information on how they integrate LSO Sonata into OSS/BSS systems, and information on how to manage versions of the APIs
  4. Scoring of consumability of each release
  5. Inclusion of LSO Sonata as a requirement in RFIs to partners
  6. Active marketing of LSO Sonata releases
  7. Assessment of testing/certification solutions around LSO Sonata


Status

PUBLIC

LSO Developer Community Manager
LSO Sonata SDK @ GitHub

Core (public):

https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK

Extensions (MEF Members only):

https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK-extended

If you are a MEF Member, update your wiki profile with your GitHub account name. Access to the LSO Sonata SDK Extensions repository is periodically updated with provided GitHub accounts. Additionally contact the LSO Developer Community Manager to request the immediate access.

Core Contributors

Ludovic Robert

Fahim Sabir

Dhurvas (Siva) Sivakumar


Are you a core contributor to this LSO SDK but not mentioned here? Please let the LSO SDK Community Manager know and we will add you!

Useful Resources