MEF-LSO-Sonata-SDK - Billie Release
Theme: Ordering and Inventory
Download Link
Download the entire repository by clicking here
Introduction
This repository contains the MEF LSO Sonata SDK. It includes API definitions
for the following functional areas:
- Serviceability
- Address
- Site Retrieval
- Product Offering Qualification Management
- Product Quote
- Product Order
- Product Inventory
- Trouble Ticket
It also provides Product Schemas for:
- Access E-Line
- EPL
- EPLAN
- EPTREE
- EVPL
- EVPLAN
- EVPTREE
High-level release notes
The theme of this release is Ordering and Inventory: it delivers full
coverage of Business Requirements, API and API Developer Guides for all above
mentioned Sonata API functions.
- All APIs have been reviewed and updated to follow their respective Business
Requirements & Use Cases and Developer Guides documents - All API definitions are provided in OAS 3.0 standard.
- New documents:
- MEF W116 - LSO Cantata and LSO Sonata Product Inventory API - Developer
Guide - MEF W123 - LSO Cantata and LSO Sonata Product Order Management API -
Developer Guide - MEF W124 - LSO Sonata Trouble Ticketing API - Developer Guide
- MEF W125 - LSO Cantata and LSO Sonata Product Specification - Subscriber
Ethernet - Schema Guide
- MEF W116 - LSO Cantata and LSO Sonata Product Inventory API - Developer
NOTE: Please note the Readme files in particular directories that provide
more detailed information about corresponding functionalities.
Maturity Level
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:
- Business Requirements
- MEF 79 - Published Standard
- MEF 79.0.2 - Draft Release 2, Letter Ballot pending
- Developer Guide/API
- MEF W121 - LSO Sonata Address Management API - Developer Guide - work in progress - CfC#1 resolved
- MEF W122 - LSO Sonata Site Management API - Developer Guide - work in progress - CfC#1 resolved
- Business Requirements
- Product Offering Qualification:
- Business Requirements
- MEF 79 - Published Standard
- MEF 79.0.1 - Published Standard
- Developer Guide/API - MEF W87 - work in progress - Draft Standard (R1), Ready for CfC#4
- Business Requirements
- Quote:
- Business Requirements - MEF W80 - Draft Release 6, Letter Ballot pending
- Developer Guide/API- MEF W115 - LSO Sonata Quote Management API - Developer
Guide - work in progress, CfC#1 reviewed
- Order:
- Business Requirements - MEF 57.2 - Draft Release 2
- Developer Guide/API - work in progress - ready fo CfC#1
- Inventory:
- Business Requirements - MEF 81, MEF 81.0.1 Published Standard
- Developer Guide/API - work in progress - ready fo CfC#1
- Product Specifications:
- Access E-Line - MEF W106 work in progress, CfC#2 resolved
- EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE - work in progress
- Access E-Line - MEF W106 work in progress, CfC#2 resolved
Contents
This SDK contains the following items:
COPYRIGHT
- Copyright 2020 MEF ForumLICENSE
- Contains a copy of the Apache 2.0 licenseREADME
- This fileproductApi
- Definitions of the API are found in this directoryinventory
- Contains the API definitions necessary for inter-carrier
retrieval of Product Inventoryorder
- Contains the API definitions for inter-carrier service ordering
capability.quote
- Contains the API definitions for inter-carrier service quotation
capabilityserviceability
- Contains the APIs that allow the Service Provider or
Buyer to perform:address
- Retrieve Address information including exact formats for
Addresses known to the SellerofferingQualification
- 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
documentation
- All related standards and Developer Guides.productApi
- API related documentation - Developer Guidesinventory
- MEF W116 Developer Guideorder
- MEF W123 Developer Guidequote
- MEF W115 Developer Guideserviceability/address
- MEF W121 Developer Guideserviceability/offeringQualification
- MEF W87 Developer Guideserviceability/site
- MEF W122 Developer GuidetroubleTicket
- MEF W124 Developer Guide
productSchema
- product related documentationcarrierEthernet
- MEF W106 and MEF W125 Product Schema Guides
supportingStandards
- The rest of documents and standards.
ProductSchema
- Product Specification schemas for:carrierEthernet
- Carrier Ethernet product Schemassonata/carrierEthernet/accessELine
- Access E-Line
generated/staticBinding/full
- contains automatically generated, not
normative static bindings of envelope APIs with Product Specification
payloads.
Issues, Questions, and Feedback
Issues should be reported with the use of GitHub issues. Questions and feedback
should be asked either at
Sonata SDK Community
or directly to community_manager@mef.net.
NOTE: All artifacts included in this repository have line numbers. When
referring to specific content in any of these artifacts, please quote the line
numbers to which you are referring.
The MEF LSO Sonata SDK is released under the Apache 2.0 license.
BR&UC - Business Requirements & Use Cases
Underlined item indicates a release deliverable that is a delta from the previous SDK release.
Published standard | Draft standard (or at least 1 CfC resolved) | Work in progress |
---|
LSO Sonata SDK Billie (Production)
Git Tag: billie
Date: 3rd June 2021
Function | BR&UC | LSO Sonata API | Product specification | Blended envelope + payload (OAS 3.0) | Tooling | ||
---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | ||||
Address Validation | MEF 79 MEF 79.0.2 (Draft Standard R2) | MEF 121 (CfC#1 resolved) | geographicAddressManagement (7.0.0-RC) | N/A | N/A | ||
Site Query | MEF 79 | MEF 122 (CfC#1 resolved) | geographicSiteManagement (7.0.0-RC) | N/A | N/A | ||
Product Offering Qualification (POQ) | MEF 79 MEF 79.0.1 | MEF 87 (CfC#3 resolved) | productOfferingQualificationManagement (7.0.0-RC) productOfferingQualificationNotification (7.0.0-RC) | MEF 106 (CfC#2 resolved) MEF W125 (working draft) | Access E-Line Subscriber Ethernet | SonataBlendingTool | |
Quoting | MEF 80 (Draft Standard R6) | MEF W115 (CfC#1 resolved) | quoteManagement (7.0.0-RC) quoteNotification (7.0.0-RC) | MEF 106 (CfC#2 resolved) MEF W125 (working draft) | Access E-Line Subscriber Ethernet | ||
Product Inventory | MEF 81 MEF 81.0.1 | MEF W116 (CfC#1 working draft) | productInventoryManagement (7.0.0-RC) | MEF 106 (CfC#2 resolved) MEF W125 (working draft) | Access E-Line Subscriber Ethernet | ||
Product Order | MEF W57.2 (Draft Standard R2) | MEF W123 (CfC#1 working draft) | productOrderManagement (7.0.0-RC) productOrderNotification (7.0.0-RC) | MEF 106 (CfC#2 resolved) MEF W125 (working draft) | Access E-Line Subscriber Ethernet | ||
Trouble Ticketing | MEF W113 (Draft Standard R1) | MEF W124 (working-draft, CfC#1 ready) | troubleTicketManagement (1.0.0-RC) troubleTicketNotification (1.0.0-RC) | ||||
Billing | |||||||
Test Requirements | MEF W92.1 (Draft Standard R1) |
Release Billie Deliverables
Bolded Deliverables are part of the release's theme: "Ordering"
Deliverable | Maturity | Comment |
---|---|---|
MEF W57.2 Order BR&UC | Draft Standard (R2) | |
MEF W116 Inventory DevGuide+API | Working Draft (CfC#1) | |
MEF 123 Order DevGuide+API | Working Draft (CfC#1) | |
MEF W106 Access E-Line | CfC#2 resolved | |
MEF W125 - Subscriber Ethernet Schemas and Product Schema Guide | Working Draft (CfC#1) | EPL, EVPL, EP-LAN, EVP-LAN, EP-TREE, EVP-TREE Subscriber UNI |
MEF 79.0.2 79 Address amendment | Draft Standard (R2), (LB pending) | |
MEF 80 Quote BR&UC | Draft Standard (R6), (LB pending) | |
MEF 115 Quote DevGuide+API | CfC#1 resolved | lots of changes in MEF 80 |
MEF 87 POQ DevGuide + API | CfC#3 resolved | |
MEF 121 Address Dev Guide + API | Working Draft (CfC#1) | |
MEF 122 Site Dev Guide + API | Working Draft (CfC#1) | |
MEF W113 Trouble Ticketing | Draft Standard (R1) | |
MEF W124 Sonata API & Developer Guide - Trouble Ticketing | Working Draft (CfC#1) | |
MEF W92.1: LSO Sonata Test Requirements | Draft Standard (R1) |
LSO Sonata SDK Celine (Planned: November 2021)
Function | BR&UC | LSO Sonata API | Product specification | Blended envelope + payload (OAS 3.0) | Tooling | ||
---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | ||||
Address Validation | MEF 79 MEF 79.0.2 | MEF 121 | GeographicAddressManagement | N/A | N/A | ||
Site Query | MEF 79 | MEF 122 | GeographicSiteManagement | N/A | N/A | ||
Product Offering Qualification (POQ) | MEF 79 MEF 79.0.1 | MEF 87 | ProductOfferingQualificationManagement ProductOfferingQualificationNotification | MEF 106 MEF 125 | Access E-Line Subscriber Ethernet | SonataBlendingTool | |
Quoting | MEF 80 | MEF 115 | QuoteManagement QuoteNotification | MEF 106 MEF 125 | Access E-Line Subscriber Ethernet | ||
Product Inventory | MEF 81 MEF 81.0.1 | MEF W116 | ProductInventoryManagement | MEF 106 MEF 125 | Access E-Line Subscriber Ethernet | ||
Product Order | MEF W57.2 | MEF W123 Draft Standard (R1) | ProductOrderManagement ProductOrderNotification | MEF 106 MEF 125 | Access E-Line Subscriber Ethernet | ||
Trouble Ticketing | MEF 113 | MEF W124 Draft Standard (R1) | |||||
Billing | |||||||
Menu-driven POQ and Quote | MEF 110 | ||||||
Test Requirements | MEF W92.1 Draft Standard (R2) |
Release Celine Deliverables
Deliverable | Maturity |
---|---|
MEF W57.2 Order BR&UC | Standard |
MEF W110 Menu-driven POQ, Quote BR&UC | Standard |
MEF W116 Inventory DevGuide+API | CfC#1 resolved |
MEF 123 Order DevGuide+API | CfC#1 resolved |
MEF W125 - Subscriber Ethernet Schemas and Product Schema Guide | Standard |
MEF 121 Address Dev Guide + API | CfC#2 resolved |
MEF 122 Site Dev Guide + API | CfC#2 resolved |
MEF W113 Trouble Ticketing | Standard |
MEF W124 Sonata API & Developer Guide - Trouble Ticketing | CfC#1 resolved |
MEF W92.1: LSO Sonata Test Requirements | Draft Standard (R2) |
LSO Sonata SDK Aretha
Git Tag: aretha
Date: 22nd December 2020
Function | BR&UC | LSO Sonata API | Product specification | Blended envelope + payload (OAS 3.0) | Tooling | ||
---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | ||||
Address Validation | MEF 79 MEF 79.0.2 (Draft Standard R1) | MEF 121 (working-draft, CfC#1 ready) | GeographicAddressManagement - 6.0.0-RC | N/A | N/A | ||
Site Query | MEF 79 | MEF 122 (working-draft, CfC#1 ready) | GeographicSiteManagement - 6.0.0-RC | N/A | N/A | ||
Product Offering Qualification (POQ) | MEF 79 MEF 79.0.1 | MEF 87 (working-draft, CfC#3 ready) | ProductOfferingQualificationManagement - 6.0.0-RC ProductOfferingQualificationNotification - 6.0.0-RC | MEF W106 (CfC#1 working-draft) | Access E-Line EPL | SonataBlendingTool | |
Quoting | MEF 80 (Draft Standard R5) | MEF W115 (working-draft, CfC#2 ready) | QuoteManagement - 6.0.0-RC QuoteNotification - 6.0.0-RC | MEF W106 (CfC#1 working-draft) | Access E-Line EPL | ||
Product Inventory | MEF 81 MEF 81.0.1 | ProductInventoryManagement - 6.0.0-RC | MEF W106 (CfC#1 working-draft) | Access E-Line EPL | |||
Product Order | MEF W57.2 (Draft Standard R2) | ProductOrderManagement - 6.0.0-RC ProductOrderNotification - 6.0.0-RC | MEF W106 (CfC#1 working-draft) | Access E-Line | |||
Trouble Ticketing | |||||||
Billing | |||||||
Test Requirements | MEF W92.1 | ||||||
Menu-driven POQ and Quote |
Release Aretha Deliverables
Bolded Deliverables are part of the release's theme "Pre-order"
Deliverable | Maturity | Leader | Comment |
---|---|---|---|
MEF 79.0.1 79 POQ amendment | Published Standard | ||
MEF 79.0.2 79 Address amendment | Draft Standard R1 | ||
MEF 80 Quote BR&UC | Draft Standard R5 | ||
MEF W115 Quote DevGuide+API | Working Draft (70% CfC#1 reviewed, ready for CfC#2) | ||
MEF W87 POQ DevGuide+API | Working Draft (CfC#2 reviewed, ready for CfC#3) | ||
MEF W106 Access E-Line | Working Draft (CfC#1 reviewed, ready for CfC#2) | ||
MEF 121 Address Dev Guide + API | Working Draft (incl. 79.0.2) (ready for CfC#1) | ||
MEF 122 Site Dev Guide + API | Working Draft (ready for CfC#1) | ||
Order API | Working Draft updated to 57.2 Draft Standard (R2) (basic scope) | Basic scope = Create, Cancel, Get, List of Product Order | |
MEF W57.2 Order BR&UC | Draft Standard R2 (basic scope) | Basic scope = Create, Cancel, Get, List of Product Order The Amend, Charge etc. will be part of Billie release. | |
EPL Product Schema | Working draft | Just product specification, without the documentation | |
MEF W92.1: LSO Sonata Test Requirements | Working draft |
LSO Sonata SDK Release Candidate 5 (hotfix 1)
Git tag: RC5.1
Date: 16th September 2020
SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/rc5.1
Function | BR&UC | LSO Sonata API | Product specification | Blended envelope + payload (OAS 3.0) | Postman scripts | Tooling | ||
---|---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | |||||
Address Validation | MEF 79 MEF W79.0.1 | geographicAddressManagement.api.yaml v5.0.0-RC2 | N/A | N/A | N/A | |||
Site Query | MEF 79 MEF W79.0.1 | geographicSiteManagement.api.yaml v5.0.0-RC | N/A | N/A | N/A | |||
Product Offering Qualification (POQ) | MEF 79 MEF W79.0.1 | MEF W87 (working-draft) | productOfferingQualificationManagement.api.yaml v5.0.0-RC2 productOfferingQualificationNotification.api.yaml v5.0.0-RC2 | MEF W106 (working-draft) | Access E-Line | |||
Quoting | MEF W80 Draft (R4) | quoteManagement.api.yaml v5.0.0-RC2 quoteNotification.api.yaml v5.0.0-RC2 | MEF W106 (working-draft) | Access E-Line | ||||
Product Inventory | MEF 81 MEF 81.0.1 | productInventoryManagement.api.yaml v5.0.0-RC | MEF W106 (working-draft) | Access E-Line | ||||
Product Order | MEF 57.1 | productOrderManagement.api.yaml v5.0.0-RC2 productOrderNotification.api.yaml v5.0.0-RC2 | MEF W106 (working-draft) | Access E-Line | ||||
Trouble Ticketing | ||||||||
Billing |
Release Candidate 5.1 Deliverables
Deliverable | Description |
---|---|
geographicAddressManagement.api.yaml v5.0.0-RC2 productOfferingQualificationManagement.api.yaml v5.0.0-RC2 productOfferingQualificationNotification.api.yaml v5.0.0-RC2 productOrderManagement.api.yaml v5.0.0-RC2 productOrderNotification.api.yaml v5.0.0-RC2 | bugfix and consistency fixes |
quoteManagement.api.yaml v5.0.0-RC2 quoteNotification.api.yaml v5.0.0-RC2 | bugfix and consistency fixes update to latest version of MEF 80 |
LSO Sonata SDK Release Candidate 5
Git tag: RC5
Date: 31st July 2020
SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/rc5
Function | BR&UC | LSO Sonata API | Product specification | Blended envelope + payload (OAS 3.0) | Postman scripts | Tooling | ||
---|---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Requirements | JSON Schema | |||||
Address Validation | MEF 79 MEF W79.0.1 | geographicAddressManagement.api.yaml v5.0.0-RC | N/A | N/A | N/A | |||
Site Query | MEF 79 MEF W79.0.1 | geographicSiteManagement.api.yaml v5.0.0-RC | N/A | N/A | N/A | |||
Product Offering Qualification (POQ) | MEF 79 MEF W79.0.1 | MEF W87 (working-draft) | MEF W106 (working-draft) | Access E-Line | ||||
Quoting | MEF W80 Draft (R3) | quoteManagement.api.yaml v5.0.0-RC quoteNotification.api.yaml v5.0.0-RC | MEF W106 (working-draft) | Access E-Line | ||||
Product Inventory | MEF 81 MEF 81.0.1 | productInventoryManagement.api.yaml v5.0.0-RC | MEF W106 (working-draft) | Access E-Line | ||||
Product Order | MEF 57.1 | productOrderManagement.api.yaml v5.0.0-RC productOrderNotification.api.yaml v5.0.0-RC | MEF W106 (working-draft) | Access E-Line | ||||
Trouble Ticketing | ||||||||
Billing |
Release Candidate 5 Deliverables
Deliverable | Description |
---|---|
MEF 79 | Draft #3 => Standard |
MEF W79.0.1 | New, Draft (R1) |
MEF W80 | Draft (R2) => Draft (R7) |
MEF 81 | Draft (R3) => Standard |
MEF 81.0.1 | New, Standard |
MEF W87 (Developer Guide + API Specs) | New, Working-draft |
MEF W106 Access E-Line - Product specification | New, Started CfC#1 |
Site, Quote, Inventory, Order API Swagger Specs | Update to introduce:
|
SonataBlendingTool | New |
LSO Sonata SDK Release 4
Git tag: R4
Date: Nov 2019
SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r4
Function | BR&UC | LSO Sonata API | Product specs | Postman scripts | Tooling | Example code | ||
---|---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Spec | JSON | |||||
Address Validation | MEF 79 Draft (R3) | GeographicAddressManagement - v3.0.0 | N/A | N/A | ||||
Site Query | MEF 79 Draft (R3) | GeographicSiteManagement - v3.0.0 | N/A | N/A | ||||
Product Offering Qualification (POQ) | MEF 79 Draft (R3) | ProductOfferingQualificationManagement - v3.0.1 ProductOfferingQualificationNotification - v3.0.0 | ||||||
Quoting | MEF 80 Draft (R2) | QuoteManagement - v2.0.0 QuoteNotification - v1.0.0 | ||||||
Product Inventory | MEF 81 Draft (R3) | ProductInventoryManagement - v3.0.0 | ||||||
Product Order | MEF 57.1 | ProductOrderManagement - v3.0.0 ProductOrderNotification - v3.0.0 | Access E-Line UNI | |||||
Trouble Ticketing | ||||||||
Billing |
LSO Sonata SDK Release 3
Git tag: R3
Date: Jun 2019
SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r3
Function | BR&UC | IIS | Product specs | Postman scripts | Tooling | Example code | ||
---|---|---|---|---|---|---|---|---|
Spec | Swagger specs | Spec | JSON | |||||
Address Validation | MEF 79 Draft (R2) | GeographicAddressManagement - v2.0.0 | N/A | N/A | ||||
MEF 79 Draft (R2) | GeographicSiteManagement - v2.0.0 | N/A | N/A | |||||
Product Offering Qualification (POQ) | MEF 79 Draft (R2) | ProductOfferingQualificationManagement - v2.0.0 ProductOfferingQualificationNotification - v1.0.0 | ||||||
Quoting | MEF 80 Draft (R2) | QuoteManagement - v2.0.0 QuoteNotification - v1.0.0 | ||||||
Product Inventory | MEF 81 Draft (R2) | ProductInventoryManagement - v2.0.0 | ||||||
Product Order | MEF 57.1 | ProductOrderManagement - v2.0.0 ProductOrderNotification - v1.0.0 | Access E-Line UNI | |||||
Trouble Ticketing | ||||||||
Billing |
- 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
- Development and use of the MEF 3.0 Developer Workshop
- Requirements for future releases of LSO Sonata
- Information on how they integrate LSO Sonata into OSS/BSS systems, and information on how to manage versions of the APIs
- Scoring of consumability of each release
- Inclusion of LSO Sonata as a requirement in RFIs to partners
- Active marketing of LSO Sonata releases
- Assessment of testing/certification solutions around LSO Sonata