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

  1. Enable market adoption of experimental and published LSO Sonata APIs and to
  2. Support of MEF's development of LSO Sonata Interface Profile Specifications.
Access

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

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

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

Date available: 2/28/2018

This SDK contains the following items:

  • COPYRIGHT - Copyright 2018 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
    • 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 for inter-carrier site validation service.

    • api/R1/productOrder - deprecated - 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.

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

    • api/R2/productOrder - Contains the API definitions for inter-carrier service ordering capability.

    • 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 Specifications
    • None
Status

PUBLIC

Contributor(s)