MessageRequestRejected Data

Data payload of the MessageRequestRejected event

Known Issues / Todo

⛅ This page is draft and is subject to rapid change, and may not be fully accurate or complete

Full Screen

MessageRequestRejected Data

Data payload of the MessageRequestRejected event

Schema Information

Schema ID: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-rejected-data.schema.json
Schema Version: https://json-schema.org/draft/2020-12/schema
Source File: digital-letters/2025-10-draft/data/digital-letters-message-request-rejected-data.schema.yaml

Properties

`messageReference`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageReference

`senderId`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId

`messageUri`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageUri

`failureCode`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/core.schema.json#/properties/failureCode

`reasonCode`

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/print.schema.json#/properties/reasonCode

`reasonText`

Type: string

Human-readable description of the failure reason for reporting (from Core API)

Required Fields

messageReference
senderId
messageUri
failureCode
reasonCode
reasonText

Additional Properties

Additional properties are not allowed.

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-rejected-data.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: MessageRequestRejected Data
description: Data payload of the MessageRequestRejected event
type: object
additionalProperties: false
properties:
  messageReference:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageReference
  senderId:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId
  messageUri:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/messageUri
  failureCode:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/core.schema.json#/properties/failureCode
  reasonCode:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/print.schema.json#/properties/reasonCode
  reasonText:
    type: string
    description: Human-readable description of the failure reason for reporting (from
      Core API)
required:
- messageReference
- senderId
- messageUri
- failureCode
- reasonCode
- reasonText