Skip to content

Releases: MEF-GIT/MEF-LSO-Sonata-SDK

MEF-LSO-Sonata-SDK - Irene Release

16 Jan 13:27
Compare
Choose a tag to compare

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:

  • Product Catalog
  • Serviceability
    • Address Validation
    • Site Retrieval
    • Product Offering Qualification Management
  • Product Offering Availability and Pricing Discovery
  • Product Quote
  • Product Order
  • Product Inventory
  • Trouble Ticket
    • Appointment
    • Work Order

It also provides Product Schemas for:

  • Access E-Line
  • Subscriber Carrier Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE)
  • Internet Access

High-level release notes

No new APIs were introduced.

There is a major change in Geographic Address model, introduced by MEF 150. It
is implemented consistently across all the APIs.

There are also changes and fixes to some patterns:

  • Revised, fully specialized Event model.
  • State change events now carry the value of the new state
  • buyerId and sellerId in notification now carried via query params
    (consistent with seller side API)

There are the following document maturity changes:

  • Updated documents:

    • MEF 110 Product Offering Availability and Pricing Discovery - Business
      Requirements and Use Cases
    • MEF W142 - LSO Cantata and LSO Sonata Product Catalog API & Developer Guide
    • MEF W160 - LSO Cantata and LSO Sonata Product Offering Availability and
      Pricing Discovery API - Developer Guide
  • New Documents:

    • MEF 57.2.1 Draft Release 1 Amendment to MEF 57.2: Product Order Management
      Business Requirements and Use Cases
    • MEF 79.1 Draft Release 1 Product Offering Qualification Management Business
      Requirements and Use Cases
    • MEF 80.0.1 Draft Release 1 Amendment to MEF 80: Quote Management
      Requirements and Use Cases
    • MEF 110 Draft Release 4 Product Offering Availability and Pricing
      Discovery - Business Requirements and Use Cases
    • MEF 127.1 - LSO Cantata and LSO Sonata Product Catalog - Business
      Requirements and Use Cases
    • MEF 150 Draft Release 1 Installation Place and Service Site Management
      Business Requirements and Use Cases
    • MEF W87.1 - LSO Cantata and LSO Sonata Product Offering Qualification API -
      Developer Guide
    • MEF W115.1 - LSO Cantata and LSO Sonata Quote Management API - Developer
      Guide
    • MEF W116.1- LSO Cantata and LSO Sonata Product Inventory API - Developer
      Guide
    • MEF W121.1 - LSO Cantata and LSO Sonata Address Management API - Developer
      Guide
    • MEF W122.1 - LSO Cantata and LSO Sonata Site Management API - Developer
      Guide
    • MEF W123.1 - LSO Cantata and LSO Sonata Product Ordering Management API -
      Developer Guide
    • MEF W124.1 - LSO Cantata and LSO Sonata Trouble Ticket and Incident
      Management API - Developer Guide
    • MEF W137.1 - LSO Cantata and LSO Sonata Appointment and Work Order
      Management API - Developer Guide
    • MEF W141.1 - LSO Cantata and LSO Sonata Billing Management API - Developer
      Guide
  • Superseded Documents:

    • MEF 79 - Address, Service Site, and Product Offering Qualification Management Requirements and Use Cases
    • MEF 79.0.1 - Amendment to MEF 79: Address, Service Site, and Product Offering Qualification Management Requirements and Use Cases
    • MEF 79.0.2 - Amendment to MEF 79: Address Validation
    • MEF 127 - LSO Cantata and LSO Sonata Product Catalog - Business Requirements and Use Cases

The LSO Marketplace offers the possibility to blend the
desired APIs with chosen Products. Thus the APIs blended with all products that
were available in generated/staticBinding are no longer provided.

NOTE: Please note the Readme files in particular productApi directories to
see detailed release notes per API.

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 is presented as follows:

(*) is used to mark an item that changes its maturity compared to the previous
release.

  • Product Catalog:
    • Business Requirements:
      • *MEF 127.1 - Draft Release 1
    • Developer Guide/API:
      • *MEF W142 - work in progress - ready for CfC#3
  • Address Validation, Site Query:
    • Business Requirements:
      • *MEF 150 - Draft Release 1
    • Developer Guide/API:
      • *MEF W121.1 - Address Management - work in progress - CfC#1 Resolved. Ready for LB
      • *MEF W122.1 - Site Management - work in progress - CfC#1 Resolved. Ready for LB
  • Product Offering Qualification:
    • Business Requirements:
      • *MEF 79.1 - Draft Release 1
    • Developer Guide/API:
      • *MEF W87.1 - work in progress - CfC#1 Resolved. Ready for LB
  • Quote:
    • Business Requirements:
      • MEF 80 - Published Standard
      • *MEF 80.0.1 - Draft Release 1
    • Developer Guide/API:
      • *MEF W115.1 - work in progress - ready for CfC#1
  • Product Offering Availability and Pricing Discovery:
    • Business Requirements:
      • *MEF 110 - Draft Standard R4
    • Developer Guide/API:
      • *MEF W160: - work in progress - ready for CfC#4
  • Order:
    • Business Requirements:
      • MEF 57.2 - Published Standard
      • *MEF 57.2.1 - Draft Release 1
    • Developer Guide/API:
      • *MEF W123.1 - work in progress - ready for CfC#1
  • Inventory:
    • Business Requirements:
      • MEF 81, MEF 81.0.1 - Published Standard
    • Developer Guide/API
      • *MEF W116.1 - work in progress - ready for CfC#1
  • Trouble Ticket:
    • Business Requirements:
      • MEF 113 - Published Standard
    • Developer Guide/API
      • *MEF W124.1 - Trouble Ticket - work in progress - ready for CfC#1
      • *MEF W137.1 - Appointment - work in progress - ready for CfC#1
  • Billing:
    • Business Requirements:
      • MEF 134 - Published Standard
    • Developer Guide/API
      • *MEF W141 - work in progress - ready for CfC#1
  • Product Specifications:
    • MEF 106 - Access E-Line - Published Standard
    • MEF 125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) -
      Published Standard
    • MEF 125.0.1 - Amendment to Subscriber Ethernet - Published Standard
    • MEF 139 - Basic and Advanced Internet Access - Published Standard
  • Security:
    • MEF 128.1 - Published Standard

For high-level information about the release compatibility and roadmap please
visit: LSO Marketplace

For details on the maturity map and the roadmap for future releases please refer
to LSO Sonata SDK Home Page
on the MEF WIKI.

Contents

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 APIs - yaml files with schemas
  • documentation - All related standards and Developer Guides
    • productApi - API-related documentation - API Developer Guides
    • productSchema - Product-related documentation - Product schema guides
    • supportingStandards - The rest of the documents and standards.
  • ProductSchema - Product Specification schemas
  • generated
    • staticBinding - No longer provided - please visit
      LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the
      security profiles as required by MEF 128.1. Provided for evaluation.

Issues, Questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback
should be asked either at
Sonata SDK Discussions
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.

Copyright

© MEF Forum 2025. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use
by any recipient and is believed to be accurate as of its publication date. Such
information is subject to change without notice and MEF Forum (MEF) is not
responsible for any errors. MEF does not assume responsibility to update or
correct any information in this publication. No representation or warranty,
expressed or implied, is made by MEF concerning the completeness, accuracy, or
applicability of any information contained herein and no liability of any kind
shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by
the recipient or user of this document. MEF is not responsible or liable for any
modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way
create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright,
trademark or trade secret rights held or claimed by any MEF member which are or
may be associated with the ideas, techniques, concepts or expressions contained
herein; nor

(b) any warranty or representation that any MEF member will announce any
product(s) and/or service(s) related thereto, or if such anno...

Read more

MEF-LSO-Sonata-SDK - Haley Release

20 Jun 08:35
Compare
Choose a tag to compare

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:

  • Product Catalog
  • Serviceability
    • Address Validation
    • Site Retrieval
    • Product Offering Qualification Management
  • Product Offering Availability and Pricing Discovery
  • Product Quote
  • Product Order
  • Product Inventory
  • Trouble Ticket
    • Appointment
    • Work Order

It also provides Product Schemas for:

  • Access E-Line
  • Subscriber Carrier Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE)
  • Internet Access

High-level release notes

No new APIs were introduced.

There are the following document maturity changes:

  • Documents published as MEF Standards:
    • MEF 125.0.1 - Subscriber Ethernet Schemas and Product Schema Guide -
      Amendment (examples)
    • MEF 139 - Internet Access Product Schemas and Developer Guide
    • MEF 127 - LSO Cantata and LSO Sonata Product Catalog - Business
      Requirements and Use Cases
    • MEF 128.1 - LSO API Security Profile
  • The following documents have their Letter Ballots open and will be likely shortly
    published as MEF standards:
    • MEF W110 - Product Offering Availability and Pricing Discovery - Business
      Requirements and Use Cases
  • Updated documents:
    • MEF W160 - LSO Cantata and LSO Sonata Product Offering Availability and
      Pricing Discovery API - Developer Guide

The LSO Marketplace offers the possibility to blend the
desired APIs with chosen Products. Thus the APIs blended with all products that
were available in generated/staticBinding are no longer provided.

NOTE: Please note the Readme files in particular productApi directories to
see detailed release notes per API.

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 is presented as follows:

(*) is used to mark an item that changes its maturity compared to the previous
release.

  • Product Catalog:
    • Business Requirements:
      • *MEF 127 - Published Standard
    • Developer Guide/API:
      • MEF W142 - work in progress - CfC#2 resolved
  • Address Validation, Site Query:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.2 - Published Standard
    • Developer Guide/API:
      • MEF 121 - Address Management - Published Standard
      • MEF 122 - Site Management - Published Standard
  • Product Offering Qualification:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.1 - Published Standard
    • Developer Guide/API:
      • MEF 87 - Published Standard
  • Quote:
    • Business Requirements:
      • MEF 80 - Published Standard
    • Developer Guide/API:
      • MEF 115: - Published Standard
  • Product Offering Availability and Pricing Discovery:
    • Business Requirements:
      • MEF *W110 - Draft Standard R4
    • Developer Guide/API:
      • MEF *W160: - work in progress - ready for CfC#3
  • Order:
    • Business Requirements:
      • MEF 57.2 - Published Standard
    • Developer Guide/API:
      • MEF 123 - Published Standard
  • Inventory:
    • Business Requirements:
      • MEF 81, MEF 81.0.1 - Published Standard
    • Developer Guide/API
      • MEF 116 - Published Standard
  • Trouble Ticket:
    • Business Requirements:
      • MEF 113 - Published Standard
    • Developer Guide/API
      • MEF 124 - Trouble Ticket - Published Standard
      • MEF 137 - Appointment - Published Standard
  • Billing:
    • Business Requirements:
      • MEF 134 - Published Standard
    • Developer Guide/API
      • MEF 141 - Published Standard
  • Product Specifications:
    • MEF 106 - Access E-Line - Published Standard
    • MEF 125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) -
      Published Standard
    • MEF 125.0.1 - Amendment to Subscriber Ethernet - Published Standard
    • MEF 139 - Basic and Advanced Internet Access - Published Standard
  • Security:
    • MEF 128.1 - Published Standard

For high-level information about the release compatibility and roadmap please
visit: LSO Marketplace

For details on the maturity map and the roadmap for future releases please refer
to LSO Sonata SDK Home Page
on the MEF WIKI.

Contents

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 APIs - yaml files with schemas
  • documentation - All related standards and Developer Guides
    • productApi - API-related documentation - API Developer Guides
    • productSchema - Product-related documentation - Product schema guides
    • supportingStandards - The rest of the documents and standards.
  • ProductSchema - Product Specification schemas
  • generated
    • staticBinding - No longer provided - please visit
      LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the
      security profiles as required by MEF 128.1. Provided for evaluation.

Issues, Questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback
should be asked either at
Sonata SDK Discussions
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.

Copyright

© MEF Forum 2024. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use
by any recipient and is believed to be accurate as of its publication date. Such
information is subject to change without notice and MEF Forum (MEF) is not
responsible for any errors. MEF does not assume responsibility to update or
correct any information in this publication. No representation or warranty,
expressed or implied, is made by MEF concerning the completeness, accuracy, or
applicability of any information contained herein and no liability of any kind
shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by
the recipient or user of this document. MEF is not responsible or liable for any
modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way
create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright,
trademark or trade secret rights held or claimed by any MEF member which are or
may be associated with the ideas, techniques, concepts or expressions contained
herein; nor

(b) any warranty or representation that any MEF member will announce any
product(s) and/or service(s) related thereto, or if such announcements are made,
that such announced product(s) and/or service(s) embody any or all of the ideas,
technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of
this document.

Implementation or use of specific MEF standards, specifications, or
recommendations will be voluntary, and no Member shall be obliged to implement
them by virtue of participation in MEF Forum. MEF is a non-profit international
organization to enable the development and worldwide adoption of agile, assured,
and orchestrated network services. MEF does not, expressly or otherwise, endorse
or promote any specific products or services.

MEF-LSO-Sonata-SDK - Grace Release

20 Dec 11:56
Compare
Choose a tag to compare

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:

  • Product Catalog
  • Serviceability
    • Address Validation
    • Site Retrieval
    • Product Offering Qualification Management
  • Product Offering Availability and Pricing Discovery
  • Product Quote
  • Product Order
  • Product Inventory
  • Trouble Ticket
    • Appointment
    • Work Order

It also provides Product Schemas for:

  • Access E-Line
  • Subscriber Carrier Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE)
  • Internet Access

High-level release notes

No new APIs were introduced.

There are the following document maturity changes:

  • Documents published as MEF Standards:
    • MEF 123 - LSO Cantata and LSO Sonata Product Order Management API -
      Developer Guide
    • MEF 124 - LSO Cantata and LSO Sonata Trouble Ticket and Incident Management
      API - Developer Guide
    • MEF 137 - LSO Cantata and LSO Sonata Appointment Management API - Developer
      Guide
    • MEF 134 - Billing and Invoice Business Requirements and Use Cases
    • MEF 106 - LSO Sonata Access E-Line Product Schemas and Developer Guide
  • Following documents have their Letter Ballots open and will be likely shortly
    published as MEF standards:
    • MEF W125.0.1 - Subscriber Ethernet Schemas and Product Schema Guide -
      Amendment (examples)
    • MEF W139 - Internet Access Product Schemas and Developer Guide
    • MEF W141 - LSO Cantata and LSO Sonata Billing Management API - Developer
      Guide
  • Updated documents:
    • MEF W127 - LSO Cantata and LSO Sonata Product Catalog - Business
      Requirements and Use Cases
    • MEF W142 - LSO Cantata and LSO Sonata Product Catalog API & Developer Guide
    • MEF W110 - Product Offering Availability and Pricing Discovery - Business
      Requirements and Use Cases
    • MEF W160 - LSO Cantata and LSO Sonata Product Offering Availability and
      Pricing Discovery API - Developer Guide
    • MEF W128.1 - LSO API Security Profile
  • New documents:
    • MEF 55.1.1 Amendment to MEF 55.1: Reference Architecture and Framework -
      Terminology

The LSO Marketplace offers the possibility to blend the
desired APIs with chosen Products. Thus the APIs blended with all products that
were available in generated/staticBinding are no longer provided.

NOTE: Please note the Readme files in particular productApi directories to
see detailed release notes per API.

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:

(*) is used to mark item that changes their maturity comparing to previous
release.

  • Product Catalog:
    • Business Requirements:
      • *MEF W127 - Draft Standard R2
    • Developer Guide/API:
      • *MEF W142 - work in progress - ready for CfC#2
  • Address Validation, Site Query:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.2 - Published Standard
    • Developer Guide/API:
      • MEF 121 - Address Management - Published Standard
      • MEF 122 - Site Management - Published Standard
  • Product Offering Qualification:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.1 - Published Standard
    • Developer Guide/API:
      • MEF 87 - Published Standard
  • Quote:
    • Business Requirements:
      • MEF 80 - Published Standard
    • Developer Guide/API:
      • MEF 115: - Published Standard
  • Product Offering Availability and Pricing Discovery:
    • Business Requirements:
      • MEF *W110 - Draft Standard R2
    • Developer Guide/API:
      • MEF *W160: - work in progress - ready for CfC#2
  • Order:
    • Business Requirements:
      • MEF 57.2 - Published Standard
    • Developer Guide/API:
      • MEF 123 - Published Standard
  • Inventory:
    • Business Requirements:
      • MEF 81, MEF 81.0.1 - Published Standard
    • Developer Guide/API
      • MEF 116 - Published Standard
  • Trouble Ticket:
    • Business Requirements:
      • MEF 113 - Published Standard
    • Developer Guide/API
      • MEF 124 - Trouble Ticket - Published Standard
      • MEF 137 - Appointment - Published Standard
  • Billing:
    • Business Requirements:
      • MEF 134 - Published Standard
    • Developer Guide/API
      • MEF 141 - Published Standard
  • Product Specifications:
    • MEF 106 - Access E-Line - Published Standard
    • MEF 125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) -
      Published Standard
    • *MEF 125.0.1 - Amendment to Subscriber Ethernet - Published Standard
    • *MEF W139 - Basic and Advanced Internet Access - Letter Ballot
  • Security:
    • MEF 128 - Published Standard
    • *MEF W128.1 - work in progress - Letter Ballot ready

For high level information about the release compatibility and roadmap please
visit: LSO Marketplace

For details on the maturity map and the roadmap for future releases please refer
to LSO Sonata SDK Home Page
on the MEF WIKI.

Contents

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 APIs - yaml files with schemas
  • documentation - All related standards and Developer Guides
    • productApi - API related documentation - API Developer Guides
    • productSchema - Product related documentation - Product schema guides
    • supportingStandards - The rest of the documents and standards.
  • ProductSchema - Product Specification schemas
  • generated
    • staticBinding - No longer provided - please visit
      LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the
      security profiles as required by MEF 128.1. Provided for evaluation.

Issues, Questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback
should be asked either at
Sonata SDK Discussions
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.

Copyright

© MEF Forum 2023. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use
by any recipient and is believed to be accurate as of its publication date. Such
information is subject to change without notice and MEF Forum (MEF) is not
responsible for any errors. MEF does not assume responsibility to update or
correct any information in this publication. No representation or warranty,
expressed or implied, is made by MEF concerning the completeness, accuracy, or
applicability of any information contained herein and no liability of any kind
shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by
the recipient or user of this document. MEF is not responsible or liable for any
modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way
create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright,
trademark or trade secret rights held or claimed by any MEF member which are or
may be associated with the ideas, techniques, concepts or expressions contained
herein; nor

(b) any warranty or representation that any MEF member will announce any
product(s) and/or service(s) related thereto, or if such announcements are made,
that such announced product(s) and/or service(s) embody any or all of the ideas,
technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of
this document.

Implementation or use of specific MEF standards, specifications, or
recommendations will be voluntary, and no Member shall be obliged to implement
them by virtue of participation in MEF Forum. MEF is a non-profit international
organization to enable the development and worldwide adoption of agile, assured,
and orchestrated network services. MEF does not, expressly or otherwise, endorse
or promote any specific products or services.

MEF-LSO-Sonata-SDK - Fergie Release

23 Jun 13:02
Compare
Choose a tag to compare

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:

  • Product Catalog
  • Serviceability
    • Address Validation
    • Site Retrieval
    • Product Offering Qualification Management
  • Product Offering Availability and Pricing Discovery
  • Product Quote
  • Product Order
  • Product Inventory
  • Trouble Ticket
    • Appointment
    • Work Order

It also provides Product Schemas for:

  • Access E-Line
  • Subscriber Carrier Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE)
  • Internet Access

High-level release notes

There are 2 new APIs introduced, together with Business requirements and Use Cases:

  • Product Catalog
  • Product Offering Availability and Pricing Discovery

There are following document maturity changes:

  • Documents published as MEF Standards:
    • MEF 123 - LSO Cantata and LSO Sonata Product Order Management API - Developer Guide
    • MEF 124 - LSO Cantata and LSO Sonata Trouble Ticket and Incident Management API - Developer Guide
    • MEF 137 - LSO Cantata and LSO Sonata Appointment Management API - Developer Guide
    • MEF 134 - Billing and Invoice Business Requirements and Use Cases
    • MEF 106 - LSO Sonata Access E-Line Product Schemas and Developer Guide
    • MEF 125 - LSO Cantata and LSO Sonata - Subscriber Ethernet Product Schemas and Developer Guide
  • Following documents have their Letter Ballots open and will be likely shortly published as MEF standards:
    • MEF W141 - LSO Cantata and LSO Sonata Billing Management API - Developer Guide
  • New documents:
    • MEF W127 - LSO Cantata and LSO Sonata Product Catalog - Business Requirements and Use Cases
    • MEF W142 - LSO Cantata and LSO Sonata Product Catalog API & Developer Guide
    • MEF W110 - Product Offering Availability and Pricing Discovery - Business Requirements and Use Cases
    • MEF W160 - LSO Cantata and LSO Sonata Product Offering Availability and Pricing Discovery API - Developer Guide

The LSO Marketplace offers the possibility to blend the desired APIs with chosen Products. Thus the APIs blended with all products that were available in generated/staticBinding are no longer provided.

NOTE: Please note the Readme files in particular productApi directories to see detailed release notes per API.

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:

(*) is used to mark item that changes their maturity comparing to previous release.

  • Product Catalog:
    • Business Requirements:
      • *MEF W127 - Draft Standard R1
    • Developer Guide/API:
      • *MEF W142 - work in progress - ready for CfC#1
  • Address Validation, Site Query:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.2 - Published Standard
    • Developer Guide/API:
      • MEF 121 - Address Management - Published Standard
      • MEF 122 - Site Management - Published Standard
  • Product Offering Qualification:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.1 - Published Standard
    • Developer Guide/API:
      • MEF 87 - Published Standard
  • Quote:
    • Business Requirements:
      • MEF 80 - Published Standard
    • Developer Guide/API:
      • MEF 115: - Published Standard
  • Product Offering Availability and Pricing Discovery:
  • Business Requirements:
    • MEF *W110 - Draft Standard R1
  • Developer Guide/API:
    • MEF *W160: - work in progress - ready for CfC#1
  • Order:
    • Business Requirements:
      • MEF 57.2 - Published Standard
    • Developer Guide/API:
      • MEF 123 - Published Standard
  • Inventory:
    • Business Requirements:
      • MEF 81, MEF 81.0.1 - Published Standard
    • Developer Guide/API
      • MEF 116 - Published Standard
  • Trouble Ticket:
    • Business Requirements:
      • MEF 113 - Published Standard
    • Developer Guide/API
      • MEF 124 - Trouble Ticket - Published Standard
      • MEF 137 - Appointment - Published Standard
  • Billing:
    • Business Requirements:
      • MEF 134 - Published Standard
    • Developer Guide/API
      • *MEF W141 - Letter Ballot
  • Product Specifications:
    • MEF 106 - Access E-Line - Published Standard
    • MEF 125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - Published Standard
    • *MEF W125.0.1 - Amendment to Subscriber Ethernet - work in progress - ready for CfC#2
    • *MEF W139 - Basic and Advanced Internet Access - work in progress - ready for CfC#3
  • Security:
    • MEF 128 - Published Standard
    • MEF W128.1 - work in progress - ready for CfC#1

For high level information about the release compatibility and roadmap please visit: LSO Marketplace

For details on the maturity map and the roadmap for future releases please refer to LSO Sonata SDK Home Page on the MEF WIKI.

Contents

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 APIs - yaml files with schemas
  • documentation - All related standards and Developer Guides
    • productApi - API related documentation - API Developer Guides
    • productSchema - Product related documentation - Product schema guides
    • supportingStandards - The rest of documents and standards.
  • ProductSchema - Product Specification schemas
  • generated
    • staticBinding - No longer provided - please visit LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.

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.

Copyright

© MEF Forum 2023. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and MEF Forum (MEF) is not responsible for any errors. MEF does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by MEF concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. MEF is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any MEF member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

(b) any warranty or representation that any MEF member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of this document.

Implementation or use of specific MEF standards, specifications, or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in MEF Forum. MEF is a non-profit international organization to enable the development and worldwide adoption of agile, assured, and orchestrated network services. MEF does not, expressly or otherwise, endorse or promote any specific products or services.

MEF-LSO-Sonata-SDK - Ella Release

06 Jan 00:07
Compare
Choose a tag to compare

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
    • Appointment
    • Work Order

It also provides Product Schemas for:

  • Access E-Line
  • Subscriber Carrier Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE)
  • Internet Access

High-level release notes

  • Documents published as MEF Standards:
    • MEF 57.2 - Product Order Management Requirements and Use Cases
    • MEF 113 - Trouble Ticketing Requirements and Use Cases
    • MEF 128 - LSO API Security Profile
  • Following documents have their Letter Ballots open and will be likely shortly published as MEF standards:
    • MEF W123 - LSO Cantata and LSO Sonata Product Order Management API - Developer Guide
    • MEF W124 - LSO Cantata and LSO Sonata Trouble Ticket and Incident Management API - Developer Guide
    • MEF W137 - LSO Cantata and LSO Sonata Appointment Management API - Developer Guide
    • MEF W134 - Billing and Invoice Business Requirements and Use Cases
    • MEF W106 - LSO Sonata Access E-Line Product Schemas and Developer Guide
    • MEF W125 - LSO Cantata and LSO Sonata - Subscriber Ethernet Product Schemas and Developer Guide
  • New documents:
    • MEF W141 - LSO Cantata and LSO Sonata Billing Management API - Developer Guide
    • MEF W125.0.1 - Amendment to MEF 125 LSO Cantata and LSO Sonata - Subscriber Ethernet Product Schemas and Developer Guide

The LSO Marketplace has introduced the possibility to blend the desired APIs with chosen Products. Thus the APIs blended with all products that were available in generated/staticBinding are no longer provided.

NOTE: Please note the Readme files in particular productApi directories to see detailed release notes per API.

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:

(*) is used to mark item that changes their maturity comparing to previous release.

  • Address Validation, Site Query:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.2 - Published Standard
    • Developer Guide/API:
      • MEF 121 - Address Management - Published Standard
      • MEF 122 - Site Management - Published Standard
  • Product Offering Qualification:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.1 - Published Standard
    • Developer Guide/API:
      • MEF 87 - Published Standard
  • Quote:
    • Business Requirements:
      • MEF 80 - Published Standard
    • Developer Guide/API:
      • MEF 115: - Published Standard
  • Order:
    • Business Requirements:
      • *MEF 57.2 - Published Standard
    • Developer Guide/API:
      • *MEF W123 - Letter Ballot
  • Inventory:
    • Business Requirements:
      • MEF 81, MEF 81.0.1 - Published Standard
    • Developer Guide/API
      • MEF 116 - Published Standard
  • Trouble Ticket:
    • Business Requirements:
      • *MEF 113 - Published Standard
    • Developer Guide/API
      • *MEF W124 - Trouble Ticket - Letter Ballot
      • *MEF W137 - Appointment - Letter Ballot
  • Billing:
    • Business Requirements:
      • *MEF W134 - Letter Ballot
    • Developer Guide/API
      • *MEF W141 - work in progress - ready for CfC#1
  • Product Specifications:
    • *MEF W106 - Access E-Line - Letter Ballot
    • *MEF W125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - Letter Ballot
    • *MEF W125.0.1 - Amendment to Subscriber Ethernet - work in progress - ready for CfC#1
    • *MEF W139 - Basic and Advanced Internet Access - work in progress - ready for CfC#2
  • Security:
    • MEF 128 - Published Standard

For details on the maturity map and the roadmap for future releases please refer to LSO Sonata SDK Home Page on the MEF WIKI.

Contents

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 APIs - yaml files with schemas
  • documentation - All related standards and Developer Guides
    • productApi - API related documentation - API Developer Guides
    • productSchema - Product related documentation - Product schema guides
    • supportingStandards - The rest of documents and standards.
  • ProductSchema - Product Specification schemas
  • generated
    • staticBinding - No longer provided - please visit LSO Marketplace to use self-blending possibility.
    • security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.

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.

Copyright

© MEF Forum 2023. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and MEF Forum (MEF) is not responsible for any errors. MEF does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by MEF concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. MEF is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any MEF member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

(b) any warranty or representation that any MEF member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of this document.

Implementation or use of specific MEF standards, specifications, or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in MEF Forum. MEF is a non-profit international organization to enable the development and worldwide adoption of agile, assured, and orchestrated network services. MEF does not, expressly or otherwise, endorse or promote any specific products or services.

MEF-LSO-Sonata-SDK - Dolly Release

08 Jun 16:13
Compare
Choose a tag to compare

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
    • Appointment
    • Work Order

It also provides Product Schemas for:

  • Access E-Line
  • EPL
  • EPLAN
  • EPTREE
  • EVPL
  • EVPLAN
  • EVPTREE
  • 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
  • New 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
  • New artifacts:
    • 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.

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 - Published Standard
    • Developer Guide/API:
      • *MEF W121 - Address Management - Published Standard
      • *MEF W122 - Site Management - Published Standard
  • Product Offering Qualification:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.1 - Published Standard
    • Developer Guide/API:
      • *MEF W87 - Published Standard
  • Quote:
    • Business Requirements:
      • *MEF 80 - Published Standard
    • Developer Guide/API:
      • *MEF W115: - Published Standard
  • Order:
    • Business Requirements:
      • *MEF W57.2 - work in progress, Draft Release 4
    • Developer Guide/API:
      • *MEF W123 - work in progress - ready for CfC#3
  • Inventory:
    • Business Requirements:
      • MEF 81, MEF 81.0.1 - Published Standard
    • Developer Guide/API
      • *MEF W116 - Published Standard
  • Trouble Ticket:
    • Business Requirements:
      • *MEF W113 - work in progress, Draft Release 3
    • Developer Guide/API
      • *MEF W124 - Trouble Ticket - work in progress - ready for CfC#3
      • *MEF W137 - Appointment - work in progress - ready for CfC#1
  • Product Specifications:
    • *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.

Contents

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
      • inventory - MEF 116 Developer Guide
      • order - MEF W123 Developer Guide
      • quote - MEF 115 Developer Guide
      • serviceability/address - MEF 121 Developer Guide
      • serviceability/offeringQualification - MEF 87 Developer Guide
      • serviceability/site - MEF 122 Developer Guide
      • troubleTicket - MEF W124 Developer Guide
      • workforce - MEF W137 Developer Guide
    • productSchema - product related documentation
      • carrierEthernet - MEF W106 and MEF W125 Product Schema Guides
      • ip - MEF W139 Internet Access Product Schema Guide
    • supportingStandards - The rest of documents and standards.
  • ProductSchema - Product Specification schemas for:
    • carrierEthernet - Carrier Ethernet product Schemas
    • 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
    • ip - contains static binding of only IP products

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.

Copyright

© MEF Forum 2022. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and MEF Forum (MEF) is not responsible for any errors. MEF does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by MEF concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. MEF is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any MEF member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

(b) any warranty or representation that any MEF member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of this document.

Implementation or use of specific MEF standards, specifications, or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in MEF Forum. MEF is a non-profit international organization to enable the development and worldwide adoption of agile, assured, and orchestrated network services. MEF does not, expressly or otherwise, endorse or promote any specific products or services.

MEF-LSO-Sonata-SDK - Celine Release

14 Jan 18:07
Compare
Choose a tag to compare

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
  • Basic Internet Access (member contribution)

High-level release notes

  • All APIs have been reviewed and updated to follow their respective Business Requirements & Use Cases and Developer Guides documents
  • New documents:
    • MEF W128 - MEF W128 - Draft Release 1 LSO API Security Profile - Implementer's Guide.pdf
  • New supporting informational documents:
    • Example Dynamic Binding Implementation.pdf
    • LSO Payload Handbook CfC#1.docx

NOTE: Please note the Readme files in particular productApi directories to see detailed release notes per API.

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 - Published Standard
    • Developer Guide/API:
      • *MEF W121 - Address Management - Letter Ballot pending
      • *MEF W122 - Site Management - Letter Ballot pending
  • Product Offering Qualification:
    • Business Requirements:
      • MEF 79 - Published Standard
      • MEF 79.0.1 - Published Standard
    • Developer Guide/API:
      • *MEF W87 - Letter Ballot pending
  • Quote:
    • Business Requirements:
      • *MEF 80 - Letter Ballot pending
    • Developer Guide/API:
      • *MEF W115: - Letter Ballot pending
  • Order:
    • Business Requirements:
      • *MEF W57.2 - work in progress, Draft Release 3
    • Developer Guide/API:
      • *MEF W123 - work in progress - ready for CfC#2
  • Inventory:
    • Business Requirements:
      • MEF 81, MEF 81.0.1 Published Standard
    • Developer Guide/API
      • *MEF W116 - Letter Ballot pending
  • Trouble Ticket:
    • Business Requirements:
      • *MEF W113 - work in progress, Draft Release 2
    • Developer Guide/API
      • *MEF W124 - work in progress - ready for CfC#2
  • Product Specifications:
    • *Access E-Line - MEF W106 work in progress, CfC#2 reviewed
    • *Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - MEF W125 work in progress, CfC#1 reviewed
    • *Basic Internet Access - schemas only (member contribution)

(*) is used to mark items that changed their maturity compared to the previous Billie 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.

Contents

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
  • documentation - All related standards and Developer Guides
    • productApi - API related documentation - Developer Guides
      • inventory - MEF W116 Developer Guide
      • order - MEF W123 Developer Guide
      • quote - MEF W115 Developer Guide
      • serviceability/address - MEF W121 Developer Guide
      • serviceability/offeringQualification - MEF W87 Developer Guide
      • serviceability/site - MEF W122 Developer Guide
      • troubleTicket - MEF W124 Developer Guide
    • productSchema - product related documentation
      • carrierEthernet - MEF W106 and MEF W125 Product Schema Guides
      • ip - a working in progress version of Basic Internet Access product schema
    • supportingStandards - The rest of documents and standards.
  • ProductSchema - Product Specification schemas for:
    • carrierEthernet - Carrier Ethernet 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
    • ip - contains static binding of only IP products

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.

Copyright

© MEF Forum 2022. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and MEF Forum (MEF) is not responsible for any errors. MEF does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by MEF concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. MEF is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any MEF member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

(b) any warranty or representation that any MEF member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of this document.

Implementation or use of specific MEF standards, specifications, or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in MEF Forum. MEF is a non-profit international organization to enable the development and worldwide adoption of agile, assured, and orchestrated network services. MEF does not, expressly or otherwise, endorse or promote any specific products or services.

MEF-LSO-Sonata-SDK - Billie Release

07 Jun 08:33
Compare
Choose a tag to compare
Pre-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. NOTE: Some parts of the release are for MEF Members only.

  • 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 Cantata and LSO Sonata Trouble Ticketing API - Developer Guide
    • MEF W125 - LSO Cantata and LSO Sonata Product Specification - Subscriber Ethernet - Schema Guide

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 reviewed
      • MEF W122 - LSO Sonata Site Management API - Developer Guide - work in
        progress - CfC#1 reviewed
  • 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
  • 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 for CfC#1
  • Inventory:
    • Business Requirements - MEF 81, MEF 81.0.1 Published Standard
    • Developer Guide/API - work in progress - ready for CfC#1
  • Product Specifications:
    • Access E-Line - MEF W106 work in progress, CfC#2 reviewed
    • EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE - work in progress

For details on the maturity map and the roadmap for future releases please refer to LSO Sonata SDK Home Page on the MEF WIKI.

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2021 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
  • documentation - All related standards and Developer Guides.
    • productApi - API related documentation - Developer Guides
      • inventory - MEF W116 Developer Guide
      • order - MEF W123 Developer Guide
      • quote - MEF W115 Developer Guide
      • serviceability/address - MEF W121 Developer Guide
      • serviceability/offeringQualification - MEF W87 Developer Guide
      • serviceability/site - MEF W122 Developer Guide
      • troubleTicket - MEF W124 Developer Guide
    • productSchema - product related documentation
      • carrierEthernet - MEF W106 and MEF W125 Product Schema Guides
    • supportingStandards - The rest of documents and standards.
  • ProductSchema - Product Specification schemas for:
    • carrierEthernet - Carrier Ethernet product Schemas
  • generated/staticBinding/full - contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with all Product Specifications. The Address, Site and Trouble Ticket APIs are not included as they do not carry product information.

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.

Copyright

© MEF Forum 2021. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and MEF Forum (MEF) is not responsible for any errors. MEF does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by MEF concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. MEF is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any MEF member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

(b) any warranty or representation that any MEF member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of this document.

Implementation or use of specific MEF standards, specifications, or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in MEF Forum. MEF is a non-profit international organization to enable the development and worldwide adoption of agile, assured, and orchestrated network services. MEF does not, expressly or otherwise, endorse or promote any specific products or services.

MEF-LSO-Sonata-SDK - Aretha Release

23 Dec 02:05
Compare
Choose a tag to compare
Pre-release

Theme: Pre-Ordering

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, and Product Offering Qualification
    Management)
  • Product Quote
  • Product Order
  • Product Inventory

It also provides Product Specification for Access E-Line (MEF
W106) and EPL product schema.

High-level release notes

The theme of this release is Pre-ordering: it delivers full coverage of
Business Requirements, API and API Developer Guides for Address, Site
Retrieval, and Product Offering Qualification Management.

  • All APIs have been reviewed and updated to follow their respective Business
    Requirements & Use Cases and Developer Guides documents
  • New documents:
    • MEF W115 - LSO Sonata Quote Management API - Developer Guide
    • MEF W121 - LSO Sonata Address Management API - Developer Guide
    • MEF W122 - LSO Sonata Site Management API - Developer Guide
    • MEF W79.0.2 - Amendment to MEF 79: Address Validation, November 2020
    • MEF W92.1: LSO Sonata Test Requirements, December 2020
  • Updated Documents:
    • MEF W106 - LSO Sonata Product Specification - Access E-Line
    • MEF W87 - LSO Sonata Product Offering Qualification API - Developer Guide
    • MEF 80 - Quote Management Requirements and Use Cases
    • MEF 57.2 - Product Order Management Requirements and Use Cases

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 1
    • Developer Guide/API
      • MEF W121 - LSO Sonata Address Management API - Developer Guide - work
        in progress - Ready for CfC#1
      • MEF W122 - LSO Sonata Site Management API - Developer Guide - work in
        progress - Ready for CfC#1
  • Product Offering Qualification:
    • Business Requirements
      • MEF 79 - Published Standard
      • MEF 79.0.1 - Published Standard
    • Developer Guide/API - MEF W87 - work in progress - Ready for CfC#3/RfD
  • Quote:
    • Business Requirements - MEF W80 - Draft Release 5
    • Developer Guide/API- MEF W115 - LSO Sonata Quote Management API - Developer
      Guide - work in progress, ongoing CfC#1 resolution
  • Order:
    • Business Requirements - MEF 57.2 - Draft Release 1
    • Developer Guide - none
    • API - work in progress - updated to match MEF 57.2
  • Inventory:
    • Business Requirements - MEF 81, MEF 81.0.1 Published Standard
    • Developer Guide - none
    • API - work in progress, updated
  • Product Specifications:
    • Access E-Line - MEF W106 work in progress, after CfC#1
    • EPL - work in progress

For details on the maturity map and the roadmap for future releases please refer to
LSO Sonata SDK Home Page on
MEF WIKI.

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2020 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • api - 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
  • doc - All related standards and Developer Guides.
    • cantata-sonata/carrierEthernet/epl - automatically generated
      documentation for EPL Product
    • sonata/carrierEthernet/accessELine - Access E-Line Product Requirements
    • serviceability/offeringQualification - MEF W87 Developer Guide
    • serviceability/address - MEF W121 Developer Guide
    • serviceability/site - MEF W122 Developer Guide
    • quote - MEF W115 Developer Guide
    • standards - The rest of the documents and standards.
    • uml - A collection of UML diagrams generated from all of the API files.
  • spec - Product Specification schemas for:
    • cantata-sonata/carrierEthernet/epl - EPL
    • sonata/carrierEthernet/accessELine - Access E-Line
  • staticBinding - Contains static bindings of envelope APIs with Product
    Specification payloads. It comes in OpenAPI 3.0.

NOTE: Please note the Readme files in particular directories that provide
more detailed information about corresponding functionalities.

All superseded files can be found in the Git history if needed.

Precedents

Any developer intending to use the materials in this repository should first
thoroughly read, review, and understand the following materials:

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.

Copyright

© MEF Forum 2020. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and
use by any recipient and is believed to be accurate as of its publication date.
Such information is subject to change without notice and MEF Forum (MEF) is not
responsible for any errors. MEF does not assume responsibility to update or
correct any information in this publication. No representation or warranty,
expressed or implied, is made by MEF concerning the completeness, accuracy, or
applicability of any information contained herein and no liability of any kind
shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by
the recipient or user of this document. MEF is not responsible or liable for
any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way
create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright,
trademark or trade secret rights held or claimed by any MEF member which are or
may be associated with th...

Read more

MEF LSO Sonata SDK Release Candidate 5 (hotfix 1)

16 Sep 22:30
Compare
Choose a tag to compare

Download Link

Download the entire repository by clicking
here

Overview

This release is a hotfix release to the SDK RC5. It contains fixes to following
list of issues: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/projects/6

It provides consistency alignment between POQ, Quote and Order to use
MEFProductActionType.

It also provides several changes to Quote API introduced by the latest works on
MEF 80 - Quote Management Requirements and Use Cases.

The detailed list of changes:

Address:

  • geographicAddressManagement.api.yaml - v 5.0.0-RC2
    • RelatedPlaceRefOrValue.role - removed

Order:

  • productOrderManagement.api.yaml - v 5.0.0-RC2
    • type OrderItemActionType changed to MEFProductActionType
    • ProductRelationship.name – removed
  • productOrderNotification.api.yaml - v 5.0.0-RC2
    • version update for consistency

POQ:

  • productOfferingQualificationManagement.api.yaml - v 5.0.0-RC2
    • ProductRelationship.name – removed
  • productOfferingQualificationNotification.api.yaml - v 5.0.0-RC2
    • version update for consistency

Quote:

  • quoteManagement.api.yaml - v 5.0.0-RC2
    • getList use case:
      • Quote_Find - introduced to define the response scope
      • Removed fields from query criteria
      • Added Requested Quote Completion Date to filtering criteria
    • Quote:
      • sellerQuoteLevel - renamed to quoteLevel
    • QuoteItem (all):
      • action - changed type to MEFProductActionType (add, modify, delete)
      • place - removed (present within the product)
      • quoteItemLevel - changed to subjectToFeasibilityCheck
      • quoteItemInstallationInterval - changed from TimeInterval to
        Duration
      • requestedQuoteItemInstallationInterval - changed from TimeInterval to
        Duration
    • QuoteItem_Create
      • Removed terminationError
      • MEFQuoteItemStateType - added pending, inProgress.draft
    • ProductRelationship - removed buyerId, name
    • Termination error - removed @type
    • MEFItemTermSeller/Buyer - removed @types
    • Duration.TimeUnit - added calendarMonths to enum
    • TimeInterval - removed
    • Note - added source
    • NoteSource - enum added
    • ProductSpecificationRef.TargetProductSchema - removed
    • Change of pattern in the Cancel or reject Quote case:
      • CancelOrRejectQuote - endpoint removed
      • cancelQuote - endpoint added
      • rejectQuote - endpoint added
      • QuoteOperationData - introduced instead of CancelOrRejectQuote and
        CancelOrRejectQuote_Create
      • MEFCancelOrRejectStateType - removed
      • TaskStateType - removed
  • quoteNotification.api.yaml - v 5.0.0-RC2
    • Removed QuoteLevelChangeNotification
    • Added QuoteItemStateChangeNotification
    • Added quoteItemId in the notification body

Updated Documents:

GitHub Issues Resolved

  • buyerId and sellerId missing in Quote #163
    #163
  • MEFQuoteItem_Create remove terminationError #162
    #162
  • ProductSpecificationRef remove targetProductSchema #161
    #161
  • QuoteItem - unnecessary place attribute #160
    #160
  • MEFQuoteItemStateType missing pending state #159
    #159
  • MEFQuoteItemStateType missing inProgress.draft state #158
    #158
  • Attribute 'role' in globalAddressId in GeographicSite API #157
    #157

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.

Copyright

© MEF Forum 2020. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and
use by any recipient and is believed to be accurate as of its publication date.
Such information is subject to change without notice and MEF Forum (MEF) is not
responsible for any errors. MEF does not assume responsibility to update or
correct any information in this publication. No representation or warranty,
expressed or implied, is made by MEF concerning the completeness, accuracy, or
applicability of any information contained herein and no liability of any kind
shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by
the recipient or user of this document. MEF is not responsible or liable for
any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way
create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright,
trademark or trade secret rights held or claimed by any MEF member which are or
may be associated with the ideas, techniques, concepts or expressions contained
herein; nor

(b) any warranty or representation that any MEF member will announce any
product(s) and/or service(s) related thereto, or if such announcements are
made, that such announced product(s) and/or service(s) embody any or all of the
ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user
of this document.

Implementation or use of specific MEF standards, specifications, or
recommendations will be voluntary, and no Member shall be obliged to implement
them by virtue of participation in MEF Forum. MEF is a non-profit international
organization to enable the development and worldwide adoption of agile,
assured, and orchestrated network services. MEF does not, expressly or
otherwise, endorse or promote any specific products or services.