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.
This repository contains the MEF LSO Sonata SDK. It includes API definitions for the following functional areas:
Product Offering Qualification Management
It also provides Product Schemas for:
Basic Internet Access
Advanced Internet Access
High-level release notes
Following APIs and their respective Developer Guides have been published as MEF Standards:
MEF 87 - LSO Cantata and LSO Sonata Product Offering Qualification API - Developer Guide
MEF 115 - LSO Cantata and LSO Sonata Quote Management API - Developer Guide
MEF 116 - LSO Cantata and LSO Sonata Product Inventory API - Developer Guide
MEF 121 - LSO Cantata and LSO Sonata Address Management API - Developer Guide
MEF 122 - LSO Cantata and LSO Sonata Site Management API - Developer Guide
All APIs have been reviewed and updated to follow their respective Business Requirements & Use Cases and Developer Guides documents
MEF W134 - Invoice Business Requirements and Use Cases
MEF W137 - LSO Cantata and LSO Sonata Appointment Management API - Developer Guide
MEF W139 - Internet Access Product Schemas and Developer Guide
generated/security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.
NOTE: Please note the Readme files in particular productApi directories to see detailed release notes per API.
The API files contained in this SDK are evolving and subject to change. They are based on documents that are either ratified standards or draft standards that have not yet completed the review cycles and approvals necessary to achieve the status as a MEF standard. MEF is making these publicly available at this time to invite wider industry review.
The maturity per functionality presents as follows:
Address Validation, Site Query:
MEF 79 - Published Standard
*MEF 79.0.2 - Published Standard
*MEF W121 - Address Management - Published Standard
*MEF W122 - Site Management - Published Standard
Product Offering Qualification:
MEF 79 - Published Standard
MEF 79.0.1 - Published Standard
*MEF W87 - Published Standard
*MEF 80 - Published Standard
*MEF W115: - Published Standard
*MEF W57.2 - work in progress, Draft Release 4
*MEF W123 - work in progress - ready for CfC#3
MEF 81, MEF 81.0.1 - Published Standard
*MEF W116 - Published Standard
*MEF W113 - work in progress, Draft Release 3
*MEF W124 - Trouble Ticket - work in progress - ready for CfC#3
*MEF W137 - Appointment - work in progress - ready for CfC#1
*MEF W106 - Access E-Line - work in progress, CfC#2 reviewed
*MEF W125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - work in progress, CfC#1 reviewed
*MEF W139 - Basic and Advanced Internet Access - work in progress - ready for CfC#1
(*) is used to mark item that changes their maturity comparing to previous release.
For details on the maturity map and the roadmap for future releases please refer to LSO Sonata SDK Home Page on the MEF WIKI.
This SDK contains the following items:
COPYRIGHT - Copyright 2022 MEF Forum
LICENSE - Contains a copy of the Apache 2.0 license
README - This file
productApi - Definitions of the API are found in this directory
inventory - Contains the API definitions necessary for inter-carrier retrieval of Product Inventory
order - Contains the API definitions for inter-carrier service ordering capability
quote - Contains the API definitions for inter-carrier service quotation capability
serviceability - Contains the APIs that allow the Service Provider or Buyer to perform:
address - Retrieve Address information including exact formats for Addresses known to the Seller
offeringQualification - Determine whether it is feasible for the Seller to deliver a particular Product with a given configuration to a particular geographic location if applicable.
site - Retrieve Service Site information including exact formats for Service Sites known to the Seller
troubleTicket - Create and manage Trouble Tickets
workforce - Manage Appointment and Work Orders
documentation - All related standards and Developer Guides
productApi - API related documentation - Developer Guides
ip - Basic and Advanced Internet Access product schemas
generated/staticBinding - contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with Product Specifications. The Address, Site and Trouble Ticket APIs are not included as they do not carry product information.
full - contains static binding of all available product schemas
carrierEthernet - contains static binding of only CarrierEthernet products