logoOPG Event Store

correspondent-updated
v0.0.1

The correspondent details for the LPA have been updated.

Context

The donor has entered, edited, or removed the details for a correspondent on their LPA.

Trigger

When the donor:

  • enters details for a correspondent
  • says they don't want a correspondent after previously entering details for one

Effect

Sirius provides this data to caseworkers so that they can correctly address correspondence.

Consumer / Producer Diagram

Open in Visualiser →

Examples

1{
2  "uid": "M-1234-5678-9012",
3  "actorUID": "3d488adc-3254-4b28-a291-9e84b621a5fa",
4  "firstNames": "John",
5  "lastName": "Smith",
6  "email": "john@example.com",
7  "phone": "07700900000"
8}
9
correspondent-updated Schema (json)
{
  "$id": "https://opg.service.justice.gov.uk/opg.poas.makeregister/correspondent-updated.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "opg.poas.makeregister/correspondent-updated",
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "description": "The UID of the LPA",
      "pattern": "^M(-[A-Z0-9]{4}){3}$"
    },
    "actorUID": {
      "type": "string",
      "description": "The UID of the correspondent",
      "pattern": "^([a-z0-9]{8}-)([a-z0-9]{4}-){3}([a-z0-9]{12})$"
    },
    "firstNames": {
      "type": "string",
      "description": "The correspondent's first name(s) including any middle names"
    },
    "lastName": {
      "type": "string",
      "description": "The correspondent's last name"
    },
    "email": {
      "type": "string",
      "description": "The correspondent's email address"
    },
    "phone": {
      "type": "string",
      "description": "The correspondent's phone number"
    },
    "address": {
      "type": "object",
      "description": "The correspondent's address",
      "properties": {
        "line1": {
          "type": "string"
        },
        "line2": {
          "type": "string"
        },
        "line3": {
          "type": "string"
        },
        "town": {
          "type": "string"
        },
        "postcode": {
          "type": "string",
          "pattern": "^[A-Z0-9 ]{1,9}$"
        },
        "country": {
          "type": "string",
          "description": "2-digit ISO 3166-1 country code per FCDO definitions: https://www.gov.uk/government/publications/geographical-names-and-information",
          "pattern": "^[A-Z]{2}$"
        }
      },
      "required": ["line1", "town", "country"]
    }
  },
  "required": ["uid"]
}
Edit this pageLast updated on 2024/12/18