Disconnection Schema Reference
Headers and Parameters
| Field | Location | Required | Type | Format / Constraints |
|---|---|---|---|---|
X-API-KEY | Header | Yes | string | UUID format |
X-IDEMPOTENCY-KEY | Header | Yes | string | Non-empty string |
X-TEST-MODE | Header | No | string | Optional; "true" enables test mode |
mpid | Path | Yes | string | Supplier MPID |
Request Schema
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
mpan_core | Yes | integer | Exactly 13 digits, numeric |
disconnection_type | Yes | string(enum) | One of A, P, U |
additional_information | No | string or null | Max 200 chars |
appointment_date | No | string or null | Format YYYYMMDD; cannot be in the past |
earliest_appointment_time | No | string or null | Format HHMMSS; numeric and valid 24-hour time |
latest_appointment_time | No | string or null | Format HHMMSS; numeric, valid 24-hour time, and must be greater than or equal to earliest_appointment_time when both are supplied |
Additional validation notes:
- Unknown fields are not explicitly rejected on this endpoint.
Response Schema
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
request_id | Yes | string | UUID |
request_type | Yes | string | Process type name |
request_status | Yes | string(enum) | Pending, Success, Failed |
description | No | string or null | Optional process description |
created_at | Yes | string(datetime) | ISO 8601 datetime |
last_updated_at | Yes | string(datetime) | ISO 8601 datetime |
mpan_core | Yes | integer | MPAN core |