Versions Compared

Old Version 25

changes.mady.by.user Tom Dickson

Saved on

compared with

New Version 26

changes.mady.by.user Mariusz Szypula

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
bgColorwhite

LSO Sonata SDK (Software Developer Kit) is the complete set of deliverables developed in by the MEF CTO in order to

  1. Enable market adoption of experimental and published LSO Sonata APIs and to LSO Sonata APIs in the current release of LSO Sonata SDK.
  2. Support of MEF's development of LSO Sonata Interface Profile Specifications.
Panel
titleColorred
titleAccess

Each release is made available on GitHub. For full details see MEFGit / LSO SDK

  1. 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


Panel

Image Added

Source: LSO Sonata Graphics


Release 3

Version number: R3

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

Date available 2019-06-21

This repository contains the MEF LSO Sonata SDK. It

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)

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

Release 2

Version number: R2

SDK Repository

Core (public):

Location:

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

R2

Date available: 2/28/2018

r4

SDK Contents

The

This

SDK contains the following items:

  • COPYRIGHT - Copyright
2018
  • 2019 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
Experimental - SDK content that does not have associated published MEF Interface Profile Specifications
  • 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

  • api/R1/address - Contains the API definitions for Inter-carrier address validation service.

  • api/R1/productOfferingQualification - Contains the API definitions for inter-carrier product offering qualification service.

    • api/R1/site
      • - Contains the API definitions necessary for inter-carrier
    site validation service.api/R1/productOrder - deprecated
      • retrieval of Product Inventory
      • Quote - Contains the API definitions for inter-carrier service
    ordering capability. These APIs are now superseded by the newer product order apis under the folder api/R2/productOrder.
      • quotation capability
      • Serviceability
    api/R2/event
      • - Contains the API definitions
    for a buyer to receive subscribed notifications from a seller.

  • api/R2/productInventory - Contains API definitions for Service Provider's (Buyer) operational support system to retrieve from a Partner's (Seller) Inventory management system for a set of product instances based upon a filter of product inventory attributes, or a specific product instance based upon a product identifier.

      • 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
    api/R2/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.

    Panel
    titleLatest Releases

    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

    Multiexcerpt
    MultiExcerptNameLSO Sonata SDK R1


    Panel

    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

  • api/R2/troubleTicket - Contains the API definitions for a Service Provider's system to create and manage trouble tickets with a Partner's system.

  • api/PlaceDescription - Contains reference JSON schemas for place description.

  • api/ProductSpecDescription - Contains reference JSON schemas for product specification description.

  • examples - Contains example code that can be exercised via the associated postman collection to see the following APIs in action.Please note that the API definitions used in the example are from Sonata SDK Release R1 to be found under the api/R1 directory. We welcome contributions to enhance the example to include additional Sonata APIs under api/R1 and api/R2. To learn more please write to Daniel Bar-Lev.

    • POST /addressValidation

    • POST /productOfferingQualification

    • POST /productOrder

    • GET /productOrder
  • Published - SDK content that does have associated MEF Interface Profile Specifications
    • None

    • Release 1

    Version number: R1

    Location: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/v2017R1.1

    Date available: 8/25/2017

    This SDK contains the following items:

  • COPYRIGHT - Copyright 2017 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • Experimental Folder - SDK content that does not yet have associated published MEF Interface Profile Specifications
    • api/address – Contains the API definitions for Inter-carrier address validation service
    • api/productOfferingQualification - Contains the API definitions for inter-carrier product offering qualification service
    • api/site - Contains the API definitions for inter-carrier site validation service
    • api/productOrder - Contains the API definitions for inter-carrier service ordering capability
    • tutorial – Contains example code that demonstrates how a dummy client can use a portal to perform address validation for a service, check specific service availability at that address and finally place the service order.Please note that the API definitions used in the tutorial are an older version and do not match the API definitions under the ‘api’ directory. We welcome your contributions to enhance the example code to use the api definitions under the ‘api’ directory.
      • tutorial/client – Contains the code for dummy client
      • tutorial/server – Contains the code for dummy server
    • Published Folder - SDK content for that does have associated MEF Interface Profile SpecificationsNone



    Panel
    titleStatus

    Status
    colourGreen
    titlePUBLIC


    Panel
    titleSource(s) and Reference(s)

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


    Panel
    bgColorwhite
    titleContributor(s)

    Daniel Bar-Lev