Changelog

All notable changes to the Engagifii Events API will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

• New endpoint for bulk event import
• Webhook support for real-time notifications
• GraphQL endpoint (beta)

Changed

• Improved performance for registration list endpoint
• Enhanced error messages with more context

Deprecated

• Legacy authentication method (to be removed in v2.0)

Security

• Updated OAuth token validation
• Enhanced rate limiting algorithms

---

[1.0.0] - 2024-01-15

Added

Core Features

• Complete event management API with CRUD operations
• Member and exhibitor registration system
• Booth configuration and assignment management
• Event bundle creation and management
• Activity and session scheduling
• Multi-tenant support with tenant isolation
• OAuth 2.0 authentication via IdentityServer4

Event Management

• POST /api/1.0/event/list - List events with filtering and pagination
• GET /api/1.0/event/{id} - Get detailed event information
• POST /api/1.0/event/save - Create or update events
• POST /api/1.0/event/CheckEventName - Check name availability
• POST /api/1.0/event/publish - Publish events to web/mobile
• Event visibility and observer pattern implementation

Registration System

• POST /api/1.0/event/registration/save - Create registrations
• POST /api/1.0/event/registration/GetEventRegistrations - List registrations
• GET /api/1.0/event/registration/GetById/{id} - Get registration details
• POST /api/1.0/event/registration/ApproveRequest - Process approvals
• Multi-step approval workflow support
• Group registration capabilities
• Registration modification tracking

Exhibitor & Booth Management

• POST /api/1.0/event/boothconfiguration/GetAllBoothconfigurations - List booth configurations
• POST /api/1.0/event/boothconfiguration/boothAvailable - Check booth availability
• POST /api/1.0/event/boothconfiguration/submitPreference - Submit booth preferences
• Booth staff management endpoints
• Pre-assignment and direct purchase support

Bundle Management

• POST /api/1.0/eventBundle/list - List event bundles
• POST /api/1.0/eventBundle/CreateInlineBundle - Create custom bundles
• GET /api/1.0/eventBundle/GetBundleDetails/{id} - Get bundle details
• Bundle visibility rules and observer patterns
• Bundle item configuration management

Supporting Features

• Venue and room management
• Speaker management and assignment
• Organization hierarchy support
• Invoice and payment integration
• File upload and management
• User preference management
• Email notification scheduling

Security

• Bearer token authentication
• Tenant isolation via headers
• Role-based access control
• API versioning support
• Rate limiting implementation

Documentation

• Comprehensive API documentation
• OpenAPI/Swagger specification
• Postman collection
• Integration examples in multiple languages

---

Migration Guide

Migrating to v1.0.0

Authentication Changes

Previous versions may have used different authentication methods. Update your client:

Before:

X-API-Key: your-api-key

After:

Authorization: Bearer {oauth_token}
api-version: 1.0
tenant-code: {your_tenant_code}

Endpoint Changes

All endpoints now require API version in the path:

• Old: /api/event/list
• New: /api/1.0/event/list

Response Format Changes

Responses now use consistent wrapper:

{
  "data": [...],
  "totalCount": 100,
  "pageNumber": 1,
  "pageSize": 10
}

---

Version History

Version	Release Date	Status	Notes
1.0.0	2024-01-15	Current	Production release
0.9.0	2023-12-01	Beta	Feature complete beta
0.8.0	2023-10-15	Beta	Exhibitor features added
0.7.0	2023-09-01	Beta	Bundle management added
0.6.0	2023-07-15	Alpha	Registration system
0.5.0	2023-06-01	Alpha	Basic event CRUD

---

Deprecation Policy

• Features are marked as deprecated at least 6 months before removal
• Deprecated features continue to work but trigger warning headers
• Migration guides provided for all breaking changes
• Major version increments for breaking changes only

Currently Deprecated

None at this time.

Deprecation Schedule

Feature	Deprecated	Removal Date	Alternative
-	-	-	-

---

API Versioning

The API uses header-based versioning:

api-version: 1.0

Supported Versions

Version	Status	Support Until
1.0	Active	TBD

Version Lifecycle

1. Active: Fully supported, new features added
2. Maintenance: Security and critical fixes only
3. Deprecated: Still functional but migration recommended
4. End of Life: No longer available

---

Breaking Changes

Definition

A breaking change is any change that requires client code modification:

• Removing endpoints
• Removing or renaming required fields
• Changing authentication methods
• Modifying response structure
• Changing field data types

Non-Breaking Changes

These changes don't require client updates:

• Adding new endpoints
• Adding optional fields
• Adding response fields
• Performance improvements
• Bug fixes

---

Feature Roadmap

Q2 2024

• [ ] Webhook support for real-time updates
• [ ] Bulk import/export capabilities
• [ ] Advanced analytics API

Q3 2024

• [ ] GraphQL endpoint
• [ ] WebSocket support for live updates
• [ ] Mobile SDK release

Q4 2024

• [ ] AI-powered event recommendations
• [ ] Virtual event support
• [ ] Payment gateway integration

---

Support

For questions about changes or migration:

• Email: api-support@engagifii.com
• Documentation: https://developers.engagifii.com
• Status: https://status.engagifii.com

---

Contributing

To report issues or suggest changes:

1. Check existing issues
2. Submit detailed bug report or feature request
3. Include API version and trace IDs
4. Provide minimal reproduction steps

---

License

Copyright (c) 2024 Engagifii. All rights reserved.

Use of this API is subject to the Engagifii API Terms of Service.