👥 Interested Party and Level of Commitment, Pioneer Companies

Note:  Membership is open to any company who is a member of ARA or CIECA.

Note:  Sublet items, where parts are considered as sublet, will be addressed at a later date (i.e., services, auto glass, etc.).

Note:   Use of the CIECA standard requires the user to be a CIECA member.  Membership is not required for the purchase and use of products that contain the CIECA products.

📜 History

CIECA has been working to provide an API solution for many years. In the 2020R1 Release, CIECA provided members with JSON messages that were build over the current XML schemas. This did provide JSON messages, however, it reproduced the complexity and the size of the XML messages.

The industry expects API solutions to be flexible, simple and small. To meet the industry expectations, CIECA’s Architecture Committee introduced an API project to build new API standards with the open API framework in mind and not duplicating the current XML complexity.

🏆 Objective

To create new API standards that CIECA members can easily implement with other partners in the industry.

☑ Benefits to Industry Segment

The following is a list of possible industry benefits:

• Support CIECA members to use Open API solution.

• An accurate and efficient process for handling data for different Business Use Cases, which will prevent maintenance of numerous solutions to handle one Use Case.

• Improved accuracy and efficiency through an understanding and use of industry standards.

• Simplification of implementing standards. Fresh start to JSON that is not built over the existing JSON and XML messages.

• Reduced latency of exchanging messages.

• New JSON messages will support modern tools and specifications.

• Greater segmentation of messages to enhance data privacy.

  • Benefit is to have option to use security allowed in the open API framework.

• The Current BMS XML is large and complicated, the JSON messages will be smaller and simpler.

🗺 Process Flow Charts

🎯 Deliverables

CAPIS - CIECA API Standards

• Guidelines for API/JSON messages for other committees to follow

  • formalized http verbs

  • use standardized data types in JavaScript

  • flexible implementation of Use Cases

  • what drives non standards messages and a way to provide solution

• CAPIS(CIECA API Standards) Documentation

  • Use Cases - An IG Appendix C to provide business use cases for system developers

  • Flow Charts

  • An Implementation Guide (IG) to define the business information

• Data Standards

• JSON Messages

  • Test Instances

  • Schema

💼 Resource Requirements

Staff  

Staff times for project support are included with CIECA membership for approved projects.  Staff time will include project management assistance as well as technical assistance.

Volunteer Time:

Business volunteers will be needed to identify business requirements of the message contents.  Representation from multiple areas of the business segment will make the message development more complete and better serve the entire industry.  Business volunteers will also be needed for the development of the Implementation Guides.

Technical volunteers will be needed to complete the translation of business needs to the BMS representation of those business needs and work with Architecture in this integration.  Assistance will be made available from members of Architecture.

🗓 Releases

📈 Impact

🔗 Other Documents