FileQuarantined Data

2025-01-01 | ๐Ÿ“‘ 219 words | โฑ 3 mins | ๐Ÿงพ History | โœ NHS Notify | ๐Ÿ”‘ NHS Notify

Data payload of the FileQuarantined event

Known Issues / Todo

  • โ›… This page is draft and is subject to rapid change, and may not be fully accurate or complete

FileQuarantined Data

Data payload of the FileQuarantined event

Schema Information

  • Schema ID: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-print-file-quarantined-data.schema.json
  • Schema Version: https://json-schema.org/draft/2020-12/schema
  • Source File: digital-letters/2025-10-draft/data/digital-letters-print-file-quarantined-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

letterUri

Type: unknown

No description available.

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

createdAt

Type: unknown

No description available.

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

Required Fields

  • messageReference
  • senderId
  • letterUri
  • createdAt

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-print-file-quarantined-data.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: FileQuarantined Data
description: Data payload of the FileQuarantined 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
  letterUri:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/print.schema.json#/properties/letterUri
  createdAt:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/print.schema.json#/properties/createdAt
required:
- messageReference
- senderId
- letterUri
- createdAt