nhs-notify-web-cms/docs/events/schemas/supplier-status/v1.json at 77d10e775bd427795a05d21630df823a1a6b194d · NHSDigital/nhs-notify-web-cms · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
{
  "$schema": "https://notify.nhs.uk/events/schemas/supplier-status/v1.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID for this event"
    },
    "source": {
      "type": "string",
      "description": "Source of the event"
    },
    "specversion": {
      "type": "string",
      "description": "Version of the event"
    },
    "type": {
      "type": "string",
      "description": "Type of event"
    },
    "plane": {
      "type": "string",
      "enum": ["data", "control"],
      "description": "Identification for target event"
    },
    "subject": {
      "type": "string",
      "format": "uuid",
      "description": "Original item plan ID"
    },
    "time": {
      "type": "string",
      "description": "Time the event was generated"
    },
    "datacontenttype": {
      "type": "string",
      "description": "Always application/json"
    },
    "dataschema": {
      "type": "string",
      "description": "Schema for this event"
    },
    "dataschemaversion": {
      "type": "string",
      "description": "Version of the schema"
    },
    "data": {
      "type": "object",
      "properties": {
        "nhsNumber": {
          "type": "string",
          "description": "Patient NHS number"
        },
        "delayedFallback": {
          "type": "boolean",
          "description": "Whether or not delayed fallback is enabled"
        },
        "sendingGroupId": {
          "type": "string",
          "description": "Sending group ID"
        },
        "clientId": {
          "type": "string",
          "description": "Client ID for the original message"
        },
        "campaignId": {
          "type": "string",
          "description": "Campaign ID for the original message"
        },
        "billingReference": {
          "type": "string",
          "description": "Billing reference from the original message"
        },
        "supplierStatus": {
          "type": "string",
          "description": "New supplier status"
        },
        "previousSupplierStatus": {
          "type": "string",
          "description": "Previous supplier status"
        },
        "requestItemId": {
          "type": "string",
          "description": "Request Item ID for the message that received a callback"
        },
        "requestItemPlanId": {
          "type": "string",
          "description": "Request Item Plan ID for the plan that received a callback"
        }
      },
      "required": [
        "nhsNumber",
        "delayedFallback",
        "sendingGroupId",
        "clientId",
        "campaignId",
        "supplierStatus",
        "previousSupplierStatus",
        "requestItemId",
        "requestItemPlanId"
      ]
    }
  },
  "required": [
    "id",
    "source",
    "specversion",
    "type",
    "plane",
    "subject",
    "time",
    "datacontenttype",
    "dataschema",
    "dataschemaversion",
    "data"
  ]
}