HomeRulebook HomeBalancing and Settlement CodeGuidance NotesMsid Api Operational GuidelineMsid Api Operational Guideline V 3 0
CONTENTS
- 1. Executive Summary and Purpose
- 2. Overview
- 3. Authentication and Access
- 3.1 Manual retrieval of security credentials
- 3.2 Automatic retrieval of security Credentials
- 4. Common Parameters and Limits
- 4.1 Common Fields (all endpoints):
- 4.2 API Limits
- 5. Endpoints and Request Structure
- 5.1 Endpoints:
- 5.2 HTTP Method
- 5.3 Required HTTP Headers
- 5.4 Authentication Payload (Mandatory for All Calls)
- 5.5 URL Path Format
- 6. Read API
- 6.1 Purpose
- 6.2 Request Parameters6.3 Retrieval Options
- 6.4 Response Behaviour
- 6.5 Example Requests
- 6.6 Schema Validations – Read API
- 6.7 Business Validations – Read API
- 6.8 Searching for an MSID Pair via URL
- 7. Create API (Insert)
- 7.1 Purpose
- 7.2 Request Parameters
- 7.3 Example Request – Insert
- 7.4 Success Responses
- 7.5 Post-Insert Verification
- 7.6 Schema Validations – Create API
- 7.7 Business Validations – Create API
- 7.8 Object Validations – Create API
- 8 Update API – Effective to Settlement Date (ETD)
- 8.1 PurposeThe Update ETD API changes the Effective to Settlement Date of an existing MSID Pair.Typical use cases:
- 8.2 Request Parameters – Field Definitions
- 8.3 Example Request – Update ETD
- 8.4 Success Response
- 8.5 Schema Validations – Update ETD
- 8.6 Business Validations – Update ETD
- 9 Update API – Consent Information
- 9.1 Purpose
- 9.2 Request Parameters – Field Definitions
- 9.3 Example Request – Update Consent
- 9.4 Success Response
- 9.5 Schema Validations – Update Consent
- 9.6 Business Validations – Update Consent
- 9.7 Update Type Determination
- 10. Error Handling
- 10.1 General HTTP Errors
- 10.2 Custom Endpoint/Parameter Errors
- 11. Support
- 12. FAQ
Elexon MSID API - Operational Guideline - October 2025 V3.0
Effective From Date:28/10/2026
Status:LIVE
Other versions
Download