-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathswagger-current.yml
1342 lines (1303 loc) · 40.2 KB
/
swagger-current.yml
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: ONS Contact Centre API
version: "5.11.18-oas3"
description: |
Specification for the ONS Census Contact Centre / Assisted Digital service.
This reflects the release candidate that will next be promoted into the integration environment.
Version | Change
------- | ----------------------------------------------------------------
5.11.18 | Postcode query rejects BFPO postcodes
5.11.17 | postalfulfilment title, forename and surname max characters changes (20,35,35)
5.10.16 | title no longer mandatory for an individual fulfilment postal request
5.10.15 | updated maximum values of offset and limit for /addresses/postcode endpoint
5.10.14 | updated the EstabType enum
5.10.13 | removed support for 'unknown' from /cases/refusal. Also, the
| caseId in the request body can no longer be null.
5.10.12 | unrestricted integer agentId
5.10.11 | removed tele num and notes from /cases/refusal
- | added isHouseholder to /cases/refusal
- | callId optional for /cases/refusal
5.10.10 | PUT /cases/{caseId} address fields reduced
5.10.9 | uprn now 13 not 12 digits
5.10.8 | AD location len 8 -> 4
- | 202 response added to launch endpoint
5.10.7 | ceOrgName added to Case response
- | added uprn to POST /cases request
- | added estabType to POST /cases request
- | required fields for POST /cases revised
5.10.6 | missing callId added to refusal request
- | enums refactored into the schema
5.10.5 | /cases/{caseId}/invalidate added
- | NA addressType added to GET /address/* endpoint response
security:
- basicAuth: []
tags:
- name: routes
paths:
/addresses:
get:
operationId: addressQuery
tags:
- CONTACT_CENTRE
- ASSISTED_DIGITAL
summary: Search for an address.
description: >-
Returns a ranked list of addresses matching the search query in the
specified format.
parameters:
- in: query
name: input
required: true
description: >-
Specifies the address search string (e.g. 'Segensworth Road,
Titchfield, PO15 5RR').
schema:
type: string
maximum: 250
default: 0
- in: query
name: offset
required: false
description: 'Specifies the offset from zero, used for pagination.'
schema:
type: integer
minimum: 0
maximum: 250
default: 0
- in: query
name: limit
required: false
description: Specifies the number of addresses to return.
schema:
type: integer
minimum: 0
maximum: 100
default: 100
responses:
'200':
description: Success. A json return of matched addresses.
content:
application/json:
schema:
$ref: >-
#/components/schemas/AddressQueryResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: >-
Unauthorised. The API key provided with the request is invalid.
'429':
description: >-
Server too busy. The Address Index API is experiencing exceptional
load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/addresses/postcode:
get:
operationId: postcodeQuery
tags:
- CONTACT_CENTRE
- ASSISTED_DIGITAL
summary: Search for an address by postcode.
description: >-
Returns a alpha-numeric ordered list of addresses matching the postcode
query.
parameters:
- $ref: '#/components/parameters/POSTCODE_REQUEST'
- in: query
name: offset
required: false
description: 'Specifies the offset from zero, used for pagination.'
schema:
type: integer
minimum: 0
maximum: 5000
default: 0
- in: query
name: limit
required: false
description: Specifies the number of addresses to return.
schema:
type: integer
minimum: 0
maximum: 5000
default: 100
responses:
'200':
description: Success. A json return of matched addresses.
content:
application/json:
schema:
$ref: >-
#/components/schemas/AddressQueryResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: >-
Server too busy. The Address Index API is experiencing exceptional
load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases:
post:
operationId: caseCreation
tags:
- CONTACT_CENTRE
summary: Create a case for an address not found through the address search
description: >-
When an address cannot be found in search, this operation will result in a new case being created for the address
responses:
'200':
description: Success. Confirmation.
content:
application/json:
schema:
$ref: >-
#/components/schemas/CaseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewCaseRequestDTO'
description: object detailing an until now unknown address for a case
/cases/{caseId}/invalidate:
post:
operationId: invalidateCase
tags:
- CONTACT_CENTRE
summary: Invalidates a case due to address status change
description: >-
Returns standard confirmation
parameters:
- in: path
name: caseId
required: true
description: The id of the case being modified
schema:
type: string
responses:
'200':
description: Success. Confirmation.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/InvalidateCaseRequestDTO
description: object detailing status change of case
/cases/uprn/{uprn}:
get:
operationId: caseByUprnQuery
tags:
- CONTACT_CENTRE
- ASSISTED_DIGITAL
summary: Search for a case by address uprn.
description: >-
Returns a case
parameters:
- in: path
name: uprn
required: true
description: 'Lookup a case by the UPRN '
schema:
type: string
pattern: '^\d{1,13}$'
- in: query
name: caseEvents
description: true if case events are additionally required
schema:
type: boolean
responses:
'200':
description: Success. A json object return of matched case.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/CaseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'403':
description: Forbidden. The case exists, but it's not being returned as it's not a household case.
'404':
description: Not found. A case doesn't exist for the supplied uprn.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases/ccs/postcode/{postcode}:
get:
operationId: ccsCaseByPostcodeQuery
tags:
- CONTACT_CENTRE
summary: Search for a CCS case by address postcode.
description: >-
Returns a list of cases
parameters:
- $ref: '#/components/parameters/POSTCODE_PATH'
- in: query
name: caseEvents
description: true if case events are additionally required
schema:
type: boolean
responses:
'200':
description: Success. A json array of matched cases.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/CaseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'403':
description: Forbidden. The case exists, but it's not being returned as it's not a household case.
'404':
description: Not found. A case doesn't exist for the supplied uprn.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases/{caseId}:
put:
operationId: caseUpdate
tags:
- CONTACT_CENTRE
summary: Update the address details of a case or change it's estab type
description: >-
Update the address details for a known case and/or report a change of estab type
MUST contain the original case data retrieved from one of the GET /cases endpoints
with relevant amendments applied.
parameters:
- in: path
name: caseId
required: true
description: The id of the case being modified
schema:
type: string
responses:
'200':
description: Success. Confirmation.
content:
application/json:
schema:
$ref: >-
#/components/schemas/CaseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyCaseRequestDTO'
description: object detailing a change to the details of a case
get:
operationId: caseByIdQuery
tags:
- CONTACT_CENTRE
summary: Search for a case by its Id.
description: >-
Returns a case
parameters:
- in: path
name: caseId
required: true
description: 'Lookup a case by the case uuid '
schema:
type: string
- in: query
name: caseEvents
description: true if case events are additionally required
schema:
type: boolean
responses:
'200':
description: Success. A json object return of matched case.
content:
application/json:
schema:
$ref: >-
#/components/schemas/CaseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'403':
description: Forbidden. The case exists, but it's being not returned as it's not a household case.
'404':
description: Not found. A case doesn't exist for the supplied caseId.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases/ref/{reference}:
get:
operationId: caseByReferenceQuery
tags:
- CONTACT_CENTRE
summary: Search for a case by its reference.
description: >-
Returns a case by the case reference if available.
parameters:
- in: path
name: reference
required: true
description: Case reference e.g 123000001
schema:
type: integer
format: int64
- in: query
name: caseEvents
description: true if case events are additionally required
schema:
type: boolean
responses:
'200':
description: Success. A json object return of matched case.
content:
application/json:
schema:
$ref: >-
#/components/schemas/CaseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'403':
description: Forbidden. The case exists, but it's not being returned as it's not a household case.
'404':
description: Not found. A case doesn't exist for the supplied uprn.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases/{caseId}/launch:
get:
operationId: LaunchByCaseIdQuery
tags:
- CONTACT_CENTRE
summary: Obtain an EQ launch URL and token for a case.
description: >-
Returns an EQ launch URL for the case
parameters:
- in: path
name: caseId
required: true
description: Obtain an EQ survey launch URL by caseID
schema:
type: string
- in: query
name: agentId
required: true
description: employee identifier
schema:
$ref: '#/components/schemas/AGENT_ID_CONST'
- in: query
name: individual
required: true
description: the launch of an individual questionnaire is required
schema:
type: boolean
responses:
'200':
description: Success. A json object return containing a launch url with token.
content:
application/json:
schema:
properties:
url:
type: string
'202':
description: >-
The operation cannot be performed at this point in time. Try again later.
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases/{caseId}/uac:
get:
operationId: GetUACForCase
tags:
- ASSISTED_DIGITAL
summary: Obtain a UAC for a case.
description: >-
Returns a UAC for the case
parameters:
- in: path
name: caseId
required: true
description: Obtain a UAC for a caseEQ survey launch URL by caseID
schema:
type: string
- in: query
name: adLocationId
required: true
description: Assisted Digital Location Identifier
schema:
type: string
pattern: '^\d{1,4}$'
- in: query
name: individual
required: true
description: the UAC for an individual questionnaire is required
schema:
type: boolean
responses:
'200':
description: Success. A json object return containing a single use UAC.
content:
application/json:
schema:
$ref: >-
#/components/schemas/UACResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases/{caseId}/fulfilment/post:
post:
operationId: postFulfilment
tags:
- CONTACT_CENTRE
summary: Request a fulfilment for a Case
description: >-
Request a fulfilment for a Case.
If the fulfilment code is for an individual then the request will be rejected as a bad
request if any of the following fields are not provided in the request body:
'forename' or 'surname'.
parameters:
- in: path
name: caseId
description: The Case UUID
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success. Confirmation.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/PostalFulfilmentRequestDTO
description: object detailing fulfilment request
/cases/{caseId}/fulfilment/sms:
post:
operationId: smsFulfilment
tags:
- CONTACT_CENTRE
summary: Request a fulfilment for a Case
description: >-
Requests a fulfilment for a case
parameters:
- in: path
name: caseId
description: The Case UUID
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success. Confirmation.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/SMSFulfilmentRequestDTO
description: object detailing fulfilment request
/fulfilments:
get:
operationId: fulfilments
tags:
- CONTACT_CENTRE
summary: Get a list of available fulfilments.
description: >-
Returns a JSON array containing available fulfilments
parameters:
- in: query
name: caseType
required: false
description: Lookup fulfilments by casetype
schema:
$ref: '#/components/schemas/CaseType'
- in: query
name: productGroup
required: false
description: Lookup fulfilments by product group
schema:
type: string
enum:
- QUESTIONNAIRE
- CONTINUATION
- LARGE_PRINT
- EASY_PRINT
- UAC
- TRANSLATION
- in: query
name: deliveryChannel
required: false
description: Lookup fulfilments by delivery channel
schema:
$ref: '#/components/schemas/DeliveryChannel'
- in: query
name: region
required: false
description: 'Lookup fulfilments by region e.g. England (E), Wales (W), Northern Ireland (N)'
schema:
$ref: '#/components/schemas/Region'
- in: query
name: individual
required: false
description: 'Lookup fulfilments suitable for an individual (true) or not (false)'
schema:
type: boolean
responses:
'200':
description: Success. A json object return of fulfilment options.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/FulfilmentDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
/cases/{caseId}/refusal:
post:
operationId: refusals
tags:
- CONTACT_CENTRE
summary: Log when someone is unable/unwilling to complete a response
description: >-
Logs a refusal against a Case.
Address fields are optional, these are only required in the instance where the API is down and the contact centre operative needs to record the address fields due to Case lookup not being available.
parameters:
- in: path
name: caseId
description: The Case UUID
required: true
schema:
type: string
responses:
'200':
description: Success. Confirmation.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised. The API key provided with the request is invalid.
'429':
description: Server too busy. The ONS API is experiencing exceptional load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/RefusalRequestDTO
description: object detailing refusal
/version:
get:
operationId: versionQuery
tags:
- routes
summary: Get version information.
description: Returns version information for the service api
responses:
'200':
description: Success. A json return of version information.
content:
application/json:
schema:
$ref: >-
#/components/schemas/VersionResponseDTO
'400':
description: >-
Bad request. Indicates an issue with the request. Further details
are provided in the response.
'401':
description: Unauthorised.
'429':
description: >-
Server too busy. The server is experiencing exceptional
load.
'500':
description: >-
Internal server error. Failed to process the request due to an
internal error.
components:
parameters:
POSTCODE_REQUEST:
in: query
name: postcode
required: true
schema:
$ref: '#/components/schemas/POSTCODE_CONST'
POSTCODE_PATH:
in: path
name: postcode
required: true
schema:
$ref: '#/components/schemas/POSTCODE_CONST'
CallIdentifier:
name: X-CALL-ID
description: >-
a unique call identifier that can be used to cross reference an API call
to a contact centre call, MUST NOT be personal info e.g. phonenumber
in: header
required: true
schema:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
apiKey:
type: apiKey
in: header
name: X-API-Key
appId:
type: apiKey
in: header
name: X-APP-ID
schemas:
CaseRequestDTO:
type: object
properties:
caseType:
$ref: '#/components/schemas/CaseType'
addressLine1:
type: string
maxLength: 60
description: updated address line1
addressLine2:
type: string
maxLength: 60
description: updated address line2
addressLine3:
type: string
maxLength: 60
description: updated address line3
ceOrgName:
type: string
maxLength: 60
description: CE Organisation name. If not known then can be null or empty.
ceUsualResidents:
type: integer
description: CE number of usual residents. Must be a positive value for CE cases
estabType:
$ref: '#/components/schemas/EstabType'
description: 'the reported type of an address'
dateTime:
type: string
format: datetime
description: The request date time stamp
ModifyCaseRequestDTO:
allOf:
- $ref: '#/components/schemas/CaseRequestDTO'
- type: object
properties:
caseId:
type: string
format: uuid
description: CaseId of case to modify
required:
- caseId
- caseType
- estabType
- addressLine1
- dateTime
NewCaseRequestDTO:
allOf:
- $ref: '#/components/schemas/CaseRequestDTO'
- type: object
properties:
uprn:
type: string
pattern: '^\d{1,13}$'
description: The address UPRN if known, or null if not known.
region:
$ref: '#/components/schemas/Region'
postcode:
$ref: '#/components/schemas/POSTCODE_CONST'
townName:
type: string
maxLength: 30
description: The post town of the address
required:
- caseType
- estabType
- region
- addressLine1
- townName
- postcode
- dateTime
InvalidateCaseRequestDTO:
properties:
caseId:
type: string
format: uuid
description: CaseId of case to modify
notes:
type: string
maxLength: 512
description: Textual context regarding the modification
status:
type: string
enum:
- SPLIT_ADDRESS
- MERGED
- DUPLICATE
- DOES_NOT_EXIST
- DERELICT
- DEMOLISHED
- NON_RESIDENTIAL
- UNDER_CONSTRUCTION
description: 'the reported status of an address'
dateTime:
type: string
format: datetime
description: The request date time stamp
required:
- status
- caseId
- dateTime
PostalFulfilmentRequestDTO:
properties:
caseId:
type: string
format: uuid
description: CaseId to request fulfilment for.
title:
type: string
maxLength: 20
description: the title of the person requesting fulfilment
forename:
type: string
maxLength: 35
description: the forename of the person requesting fulfilment
surname:
type: string
maxLength: 35
description: the surname of the person requesting fulfilment
fulfilmentCode:
type: string
description: the fulfilment code for the fulfilment
dateTime:
type: string
format: datetime
description: The request date time stamp
required:
- caseId
- fulfilmentCode
- dateTime
SMSFulfilmentRequestDTO:
properties:
caseId:
type: string
format: uuid
description: CaseId to request fulfilment for.
telNo:
type: string
pattern: '^447[0-9]{9}$'
fulfilmentCode:
type: string
description: the fulfilment code for the fulfilment
dateTime:
type: string
format: datetime
description: The request date time stamp
required:
- caseId
- telNo
- fulfilmentCode
- dateTime
RefusalRequestDTO:
properties:
caseId:
type: string
format: uuid
description: CaseId to log refusal against
agentId:
$ref: '#/components/schemas/AGENT_ID_CONST'
reason:
type: string
enum:
- EXTRAORDINARY
- HARD