@ogcio/building-blocks-sdk 0.1.18 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitleaksignore +2 -0
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +18 -0
- package/dist/client/clients/featureFlags/schema.d.ts +205 -63
- package/dist/client/clients/featureFlags/schema.d.ts.map +1 -1
- package/dist/client/clients/messaging/index.d.ts +109 -1960
- package/dist/client/clients/messaging/index.d.ts.map +1 -1
- package/dist/client/clients/messaging/index.js +3 -179
- package/dist/client/clients/messaging/index.js.map +1 -1
- package/dist/client/clients/messaging/schema.d.ts +1689 -3486
- package/dist/client/clients/messaging/schema.d.ts.map +1 -1
- package/dist/client/clients/payments/index.d.ts +93 -7
- package/dist/client/clients/payments/index.d.ts.map +1 -1
- package/dist/client/clients/payments/index.js +11 -0
- package/dist/client/clients/payments/index.js.map +1 -1
- package/dist/client/clients/payments/schema.d.ts +113 -7
- package/dist/client/clients/payments/schema.d.ts.map +1 -1
- package/dist/client/clients/profile/index.d.ts +882 -440
- package/dist/client/clients/profile/index.d.ts.map +1 -1
- package/dist/client/clients/profile/index.js +88 -54
- package/dist/client/clients/profile/index.js.map +1 -1
- package/dist/client/clients/profile/schema.d.ts +1257 -1114
- package/dist/client/clients/profile/schema.d.ts.map +1 -1
- package/dist/clients-configurations/clients-configuration.json +7 -6
- package/package.json +1 -1
- package/src/client/clients/featureFlags/open-api-definition.json +184 -95
- package/src/client/clients/featureFlags/schema.ts +205 -63
- package/src/client/clients/messaging/index.ts +2 -278
- package/src/client/clients/messaging/open-api-definition.json +419 -4558
- package/src/client/clients/messaging/schema.ts +1689 -3486
- package/src/client/clients/payments/index.ts +17 -0
- package/src/client/clients/payments/open-api-definition.json +314 -0
- package/src/client/clients/payments/schema.ts +113 -7
- package/src/client/clients/profile/index.ts +140 -84
- package/src/client/clients/profile/open-api-definition.json +1925 -1343
- package/src/client/clients/profile/schema.ts +1257 -1114
- package/src/clients-configurations/clients-configuration.json +7 -6
|
@@ -1,36 +1,59 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"title": "
|
|
5
|
-
"description": "API for
|
|
6
|
-
"version": "0.1
|
|
4
|
+
"title": "Life Events Profile API",
|
|
5
|
+
"description": "API for Life Events Profile Service",
|
|
6
|
+
"version": "0.0.1"
|
|
7
7
|
},
|
|
8
8
|
"components": {
|
|
9
|
+
"securitySchemes": {
|
|
10
|
+
"bearerAuth": {
|
|
11
|
+
"type": "http",
|
|
12
|
+
"scheme": "bearer",
|
|
13
|
+
"bearerFormat": "JWT"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
9
16
|
"schemas": {}
|
|
10
17
|
},
|
|
11
18
|
"paths": {
|
|
12
|
-
"/
|
|
13
|
-
"get": {
|
|
14
|
-
"responses": {
|
|
15
|
-
"200": {
|
|
16
|
-
"description": "Default Response"
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
}
|
|
20
|
-
},
|
|
21
|
-
"/user-login-wh": {
|
|
22
|
-
"post": {
|
|
23
|
-
"responses": {
|
|
24
|
-
"200": {
|
|
25
|
-
"description": "Default Response"
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
},
|
|
30
|
-
"/api/v1/addresses/": {
|
|
19
|
+
"/api/v1/profiles/": {
|
|
31
20
|
"get": {
|
|
21
|
+
"operationId": "indexProfiles",
|
|
32
22
|
"tags": [
|
|
33
|
-
"
|
|
23
|
+
"Profiles"
|
|
24
|
+
],
|
|
25
|
+
"parameters": [
|
|
26
|
+
{
|
|
27
|
+
"schema": {
|
|
28
|
+
"type": "string"
|
|
29
|
+
},
|
|
30
|
+
"in": "query",
|
|
31
|
+
"name": "search",
|
|
32
|
+
"required": false,
|
|
33
|
+
"description": "If set, the endpoint searches for users whom contain this value in either the public name or the email address"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"schema": {
|
|
37
|
+
"pattern": "^[0-9][0-9]*|undefined$",
|
|
38
|
+
"default": "0",
|
|
39
|
+
"type": "string"
|
|
40
|
+
},
|
|
41
|
+
"in": "query",
|
|
42
|
+
"name": "offset",
|
|
43
|
+
"required": false,
|
|
44
|
+
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"schema": {
|
|
48
|
+
"default": "20",
|
|
49
|
+
"pattern": "^([1-9]|100)|undefined$",
|
|
50
|
+
"type": "string"
|
|
51
|
+
},
|
|
52
|
+
"in": "query",
|
|
53
|
+
"name": "limit",
|
|
54
|
+
"required": false,
|
|
55
|
+
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
56
|
+
}
|
|
34
57
|
],
|
|
35
58
|
"responses": {
|
|
36
59
|
"200": {
|
|
@@ -45,48 +68,44 @@
|
|
|
45
68
|
"items": {
|
|
46
69
|
"type": "object",
|
|
47
70
|
"properties": {
|
|
48
|
-
"
|
|
49
|
-
"type": "string"
|
|
50
|
-
},
|
|
51
|
-
"addressLine1": {
|
|
52
|
-
"type": "string"
|
|
53
|
-
},
|
|
54
|
-
"addressLine2": {
|
|
71
|
+
"id": {
|
|
55
72
|
"type": "string"
|
|
56
73
|
},
|
|
57
|
-
"
|
|
74
|
+
"publicName": {
|
|
58
75
|
"type": "string"
|
|
59
76
|
},
|
|
60
|
-
"
|
|
77
|
+
"email": {
|
|
78
|
+
"format": "email",
|
|
61
79
|
"type": "string"
|
|
62
80
|
},
|
|
63
|
-
"
|
|
81
|
+
"primaryUserId": {
|
|
64
82
|
"type": "string"
|
|
65
83
|
},
|
|
66
|
-
"
|
|
67
|
-
"type": "
|
|
84
|
+
"safeLevel": {
|
|
85
|
+
"type": "number"
|
|
68
86
|
},
|
|
69
|
-
"
|
|
70
|
-
"type": "string"
|
|
87
|
+
"preferredLanguage": {
|
|
88
|
+
"type": "string",
|
|
89
|
+
"enum": [
|
|
90
|
+
"en",
|
|
91
|
+
"ga"
|
|
92
|
+
],
|
|
93
|
+
"default": "en"
|
|
71
94
|
},
|
|
72
|
-
"
|
|
95
|
+
"createdAt": {
|
|
96
|
+
"format": "date-time",
|
|
73
97
|
"type": "string"
|
|
74
98
|
},
|
|
75
|
-
"
|
|
76
|
-
"
|
|
77
|
-
},
|
|
78
|
-
"ownershipStatus": {
|
|
99
|
+
"updatedAt": {
|
|
100
|
+
"format": "date-time",
|
|
79
101
|
"type": "string"
|
|
80
102
|
}
|
|
81
103
|
},
|
|
82
104
|
"required": [
|
|
83
|
-
"
|
|
84
|
-
"
|
|
85
|
-
"
|
|
86
|
-
"
|
|
87
|
-
"county",
|
|
88
|
-
"eirecode",
|
|
89
|
-
"updatedAt"
|
|
105
|
+
"id",
|
|
106
|
+
"publicName",
|
|
107
|
+
"email",
|
|
108
|
+
"primaryUserId"
|
|
90
109
|
]
|
|
91
110
|
}
|
|
92
111
|
},
|
|
@@ -176,7 +195,7 @@
|
|
|
176
195
|
}
|
|
177
196
|
}
|
|
178
197
|
},
|
|
179
|
-
"
|
|
198
|
+
"4XX": {
|
|
180
199
|
"description": "Default Response",
|
|
181
200
|
"content": {
|
|
182
201
|
"application/json": {
|
|
@@ -184,183 +203,59 @@
|
|
|
184
203
|
"type": "object",
|
|
185
204
|
"properties": {
|
|
186
205
|
"code": {
|
|
206
|
+
"description": "Code used to categorize the error",
|
|
187
207
|
"type": "string"
|
|
188
208
|
},
|
|
189
209
|
"detail": {
|
|
210
|
+
"description": "Description of the error",
|
|
190
211
|
"type": "string"
|
|
191
212
|
},
|
|
192
213
|
"requestId": {
|
|
214
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
193
215
|
"type": "string"
|
|
194
216
|
},
|
|
195
217
|
"name": {
|
|
218
|
+
"description": "Name of the error type",
|
|
196
219
|
"type": "string"
|
|
197
220
|
},
|
|
198
|
-
"validation": {
|
|
221
|
+
"validation": {
|
|
222
|
+
"description": "List of the validation errors",
|
|
223
|
+
"type": "array",
|
|
224
|
+
"items": {
|
|
225
|
+
"type": "object",
|
|
226
|
+
"properties": {
|
|
227
|
+
"fieldName": {
|
|
228
|
+
"type": "string"
|
|
229
|
+
},
|
|
230
|
+
"message": {
|
|
231
|
+
"type": "string"
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
"required": [
|
|
235
|
+
"fieldName",
|
|
236
|
+
"message"
|
|
237
|
+
]
|
|
238
|
+
}
|
|
239
|
+
},
|
|
199
240
|
"validationContext": {
|
|
200
241
|
"type": "string"
|
|
242
|
+
},
|
|
243
|
+
"statusCode": {
|
|
244
|
+
"type": "number"
|
|
201
245
|
}
|
|
202
246
|
},
|
|
203
247
|
"required": [
|
|
204
248
|
"code",
|
|
205
249
|
"detail",
|
|
206
250
|
"requestId",
|
|
207
|
-
"name"
|
|
208
|
-
|
|
209
|
-
}
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
}
|
|
213
|
-
}
|
|
214
|
-
},
|
|
215
|
-
"post": {
|
|
216
|
-
"tags": [
|
|
217
|
-
"Addresses"
|
|
218
|
-
],
|
|
219
|
-
"requestBody": {
|
|
220
|
-
"content": {
|
|
221
|
-
"application/json": {
|
|
222
|
-
"schema": {
|
|
223
|
-
"type": "object",
|
|
224
|
-
"properties": {
|
|
225
|
-
"addressLine1": {
|
|
226
|
-
"type": "string"
|
|
227
|
-
},
|
|
228
|
-
"addressLine2": {
|
|
229
|
-
"type": "string"
|
|
230
|
-
},
|
|
231
|
-
"town": {
|
|
232
|
-
"type": "string"
|
|
233
|
-
},
|
|
234
|
-
"county": {
|
|
235
|
-
"type": "string"
|
|
236
|
-
},
|
|
237
|
-
"eirecode": {
|
|
238
|
-
"type": "string"
|
|
239
|
-
},
|
|
240
|
-
"moveInDate": {
|
|
241
|
-
"type": "string"
|
|
242
|
-
},
|
|
243
|
-
"moveOutDate": {
|
|
244
|
-
"type": "string"
|
|
245
|
-
}
|
|
246
|
-
},
|
|
247
|
-
"required": [
|
|
248
|
-
"addressLine1",
|
|
249
|
-
"town",
|
|
250
|
-
"county",
|
|
251
|
-
"eirecode"
|
|
252
|
-
]
|
|
253
|
-
}
|
|
254
|
-
}
|
|
255
|
-
},
|
|
256
|
-
"required": true
|
|
257
|
-
},
|
|
258
|
-
"responses": {
|
|
259
|
-
"200": {
|
|
260
|
-
"description": "Default Response",
|
|
261
|
-
"content": {
|
|
262
|
-
"application/json": {
|
|
263
|
-
"schema": {
|
|
264
|
-
"type": "object",
|
|
265
|
-
"properties": {
|
|
266
|
-
"data": {
|
|
267
|
-
"type": "object",
|
|
268
|
-
"properties": {
|
|
269
|
-
"id": {
|
|
270
|
-
"type": "string"
|
|
271
|
-
}
|
|
272
|
-
},
|
|
273
|
-
"required": [
|
|
274
|
-
"id"
|
|
275
|
-
]
|
|
276
|
-
},
|
|
277
|
-
"metadata": {
|
|
278
|
-
"type": "object",
|
|
279
|
-
"properties": {
|
|
280
|
-
"links": {
|
|
281
|
-
"description": "Object containing the links to the related endpoints",
|
|
282
|
-
"type": "object",
|
|
283
|
-
"properties": {
|
|
284
|
-
"self": {
|
|
285
|
-
"type": "object",
|
|
286
|
-
"properties": {
|
|
287
|
-
"href": {
|
|
288
|
-
"description": "URL pointing to the request itself",
|
|
289
|
-
"type": "string"
|
|
290
|
-
}
|
|
291
|
-
}
|
|
292
|
-
},
|
|
293
|
-
"next": {
|
|
294
|
-
"type": "object",
|
|
295
|
-
"properties": {
|
|
296
|
-
"href": {
|
|
297
|
-
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
298
|
-
"type": "string"
|
|
299
|
-
}
|
|
300
|
-
}
|
|
301
|
-
},
|
|
302
|
-
"prev": {
|
|
303
|
-
"type": "object",
|
|
304
|
-
"properties": {
|
|
305
|
-
"href": {
|
|
306
|
-
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
307
|
-
"type": "string"
|
|
308
|
-
}
|
|
309
|
-
}
|
|
310
|
-
},
|
|
311
|
-
"first": {
|
|
312
|
-
"type": "object",
|
|
313
|
-
"properties": {
|
|
314
|
-
"href": {
|
|
315
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
316
|
-
"type": "string"
|
|
317
|
-
}
|
|
318
|
-
}
|
|
319
|
-
},
|
|
320
|
-
"last": {
|
|
321
|
-
"type": "object",
|
|
322
|
-
"properties": {
|
|
323
|
-
"href": {
|
|
324
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
325
|
-
"type": "string"
|
|
326
|
-
}
|
|
327
|
-
}
|
|
328
|
-
},
|
|
329
|
-
"pages": {
|
|
330
|
-
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
331
|
-
"type": "object",
|
|
332
|
-
"additionalProperties": {
|
|
333
|
-
"type": "object",
|
|
334
|
-
"properties": {
|
|
335
|
-
"href": {
|
|
336
|
-
"type": "string"
|
|
337
|
-
}
|
|
338
|
-
}
|
|
339
|
-
}
|
|
340
|
-
}
|
|
341
|
-
},
|
|
342
|
-
"required": [
|
|
343
|
-
"self",
|
|
344
|
-
"first",
|
|
345
|
-
"last",
|
|
346
|
-
"pages"
|
|
347
|
-
]
|
|
348
|
-
},
|
|
349
|
-
"totalCount": {
|
|
350
|
-
"description": "Number representing the total number of available items",
|
|
351
|
-
"type": "number"
|
|
352
|
-
}
|
|
353
|
-
}
|
|
354
|
-
}
|
|
355
|
-
},
|
|
356
|
-
"required": [
|
|
357
|
-
"data"
|
|
251
|
+
"name",
|
|
252
|
+
"statusCode"
|
|
358
253
|
]
|
|
359
254
|
}
|
|
360
255
|
}
|
|
361
256
|
}
|
|
362
257
|
},
|
|
363
|
-
"
|
|
258
|
+
"5XX": {
|
|
364
259
|
"description": "Default Response",
|
|
365
260
|
"content": {
|
|
366
261
|
"application/json": {
|
|
@@ -368,27 +263,53 @@
|
|
|
368
263
|
"type": "object",
|
|
369
264
|
"properties": {
|
|
370
265
|
"code": {
|
|
266
|
+
"description": "Code used to categorize the error",
|
|
371
267
|
"type": "string"
|
|
372
268
|
},
|
|
373
269
|
"detail": {
|
|
270
|
+
"description": "Description of the error",
|
|
374
271
|
"type": "string"
|
|
375
272
|
},
|
|
376
273
|
"requestId": {
|
|
274
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
377
275
|
"type": "string"
|
|
378
276
|
},
|
|
379
277
|
"name": {
|
|
278
|
+
"description": "Name of the error type",
|
|
380
279
|
"type": "string"
|
|
381
280
|
},
|
|
382
|
-
"validation": {
|
|
281
|
+
"validation": {
|
|
282
|
+
"description": "List of the validation errors",
|
|
283
|
+
"type": "array",
|
|
284
|
+
"items": {
|
|
285
|
+
"type": "object",
|
|
286
|
+
"properties": {
|
|
287
|
+
"fieldName": {
|
|
288
|
+
"type": "string"
|
|
289
|
+
},
|
|
290
|
+
"message": {
|
|
291
|
+
"type": "string"
|
|
292
|
+
}
|
|
293
|
+
},
|
|
294
|
+
"required": [
|
|
295
|
+
"fieldName",
|
|
296
|
+
"message"
|
|
297
|
+
]
|
|
298
|
+
}
|
|
299
|
+
},
|
|
383
300
|
"validationContext": {
|
|
384
301
|
"type": "string"
|
|
302
|
+
},
|
|
303
|
+
"statusCode": {
|
|
304
|
+
"type": "number"
|
|
385
305
|
}
|
|
386
306
|
},
|
|
387
307
|
"required": [
|
|
388
308
|
"code",
|
|
389
309
|
"detail",
|
|
390
310
|
"requestId",
|
|
391
|
-
"name"
|
|
311
|
+
"name",
|
|
312
|
+
"statusCode"
|
|
392
313
|
]
|
|
393
314
|
}
|
|
394
315
|
}
|
|
@@ -397,605 +318,208 @@
|
|
|
397
318
|
}
|
|
398
319
|
}
|
|
399
320
|
},
|
|
400
|
-
"/api/v1/
|
|
401
|
-
"
|
|
321
|
+
"/api/v1/profiles/import-profiles": {
|
|
322
|
+
"post": {
|
|
323
|
+
"operationId": "importProfiles",
|
|
402
324
|
"tags": [
|
|
403
|
-
"
|
|
404
|
-
],
|
|
405
|
-
"parameters": [
|
|
406
|
-
{
|
|
407
|
-
"schema": {
|
|
408
|
-
"type": "string"
|
|
409
|
-
},
|
|
410
|
-
"in": "path",
|
|
411
|
-
"name": "addressId",
|
|
412
|
-
"required": true
|
|
413
|
-
}
|
|
325
|
+
"Profiles"
|
|
414
326
|
],
|
|
415
|
-
"
|
|
416
|
-
"
|
|
417
|
-
"
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
"
|
|
421
|
-
"
|
|
422
|
-
|
|
423
|
-
"
|
|
327
|
+
"requestBody": {
|
|
328
|
+
"content": {
|
|
329
|
+
"application/json": {
|
|
330
|
+
"schema": {
|
|
331
|
+
"type": "object",
|
|
332
|
+
"properties": {
|
|
333
|
+
"profiles": {
|
|
334
|
+
"minItems": 1,
|
|
335
|
+
"type": "array",
|
|
336
|
+
"items": {
|
|
424
337
|
"type": "object",
|
|
425
338
|
"properties": {
|
|
426
|
-
"
|
|
339
|
+
"email": {
|
|
340
|
+
"format": "email",
|
|
427
341
|
"type": "string"
|
|
428
342
|
},
|
|
429
|
-
"
|
|
343
|
+
"firstName": {
|
|
430
344
|
"type": "string"
|
|
431
345
|
},
|
|
432
|
-
"
|
|
346
|
+
"lastName": {
|
|
433
347
|
"type": "string"
|
|
434
348
|
},
|
|
435
|
-
"
|
|
349
|
+
"city": {
|
|
436
350
|
"type": "string"
|
|
437
351
|
},
|
|
438
|
-
"
|
|
352
|
+
"address": {
|
|
439
353
|
"type": "string"
|
|
440
354
|
},
|
|
441
|
-
"
|
|
355
|
+
"phone": {
|
|
442
356
|
"type": "string"
|
|
443
357
|
},
|
|
444
|
-
"
|
|
358
|
+
"dateOfBirth": {
|
|
359
|
+
"format": "date",
|
|
445
360
|
"type": "string"
|
|
446
361
|
},
|
|
447
|
-
"
|
|
448
|
-
"type": "string"
|
|
449
|
-
},
|
|
450
|
-
"moveOutDate": {
|
|
451
|
-
"type": "string"
|
|
452
|
-
},
|
|
453
|
-
"isPrimary": {
|
|
454
|
-
"type": "boolean"
|
|
455
|
-
},
|
|
456
|
-
"ownershipStatus": {
|
|
457
|
-
"type": "string"
|
|
458
|
-
}
|
|
459
|
-
},
|
|
460
|
-
"required": [
|
|
461
|
-
"addressId",
|
|
462
|
-
"addressLine1",
|
|
463
|
-
"addressLine2",
|
|
464
|
-
"town",
|
|
465
|
-
"county",
|
|
466
|
-
"eirecode",
|
|
467
|
-
"updatedAt"
|
|
468
|
-
]
|
|
469
|
-
},
|
|
470
|
-
"metadata": {
|
|
471
|
-
"type": "object",
|
|
472
|
-
"properties": {
|
|
473
|
-
"links": {
|
|
474
|
-
"description": "Object containing the links to the related endpoints",
|
|
475
|
-
"type": "object",
|
|
476
|
-
"properties": {
|
|
477
|
-
"self": {
|
|
478
|
-
"type": "object",
|
|
479
|
-
"properties": {
|
|
480
|
-
"href": {
|
|
481
|
-
"description": "URL pointing to the request itself",
|
|
482
|
-
"type": "string"
|
|
483
|
-
}
|
|
484
|
-
}
|
|
485
|
-
},
|
|
486
|
-
"next": {
|
|
487
|
-
"type": "object",
|
|
488
|
-
"properties": {
|
|
489
|
-
"href": {
|
|
490
|
-
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
491
|
-
"type": "string"
|
|
492
|
-
}
|
|
493
|
-
}
|
|
494
|
-
},
|
|
495
|
-
"prev": {
|
|
496
|
-
"type": "object",
|
|
497
|
-
"properties": {
|
|
498
|
-
"href": {
|
|
499
|
-
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
500
|
-
"type": "string"
|
|
501
|
-
}
|
|
502
|
-
}
|
|
503
|
-
},
|
|
504
|
-
"first": {
|
|
505
|
-
"type": "object",
|
|
506
|
-
"properties": {
|
|
507
|
-
"href": {
|
|
508
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
509
|
-
"type": "string"
|
|
510
|
-
}
|
|
511
|
-
}
|
|
512
|
-
},
|
|
513
|
-
"last": {
|
|
514
|
-
"type": "object",
|
|
515
|
-
"properties": {
|
|
516
|
-
"href": {
|
|
517
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
518
|
-
"type": "string"
|
|
519
|
-
}
|
|
520
|
-
}
|
|
521
|
-
},
|
|
522
|
-
"pages": {
|
|
523
|
-
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
524
|
-
"type": "object",
|
|
525
|
-
"additionalProperties": {
|
|
526
|
-
"type": "object",
|
|
527
|
-
"properties": {
|
|
528
|
-
"href": {
|
|
529
|
-
"type": "string"
|
|
530
|
-
}
|
|
531
|
-
}
|
|
532
|
-
}
|
|
533
|
-
}
|
|
534
|
-
},
|
|
535
|
-
"required": [
|
|
536
|
-
"self",
|
|
537
|
-
"first",
|
|
538
|
-
"last",
|
|
539
|
-
"pages"
|
|
540
|
-
]
|
|
541
|
-
},
|
|
542
|
-
"totalCount": {
|
|
543
|
-
"description": "Number representing the total number of available items",
|
|
544
|
-
"type": "number"
|
|
545
|
-
}
|
|
546
|
-
}
|
|
547
|
-
}
|
|
548
|
-
},
|
|
549
|
-
"required": [
|
|
550
|
-
"data"
|
|
551
|
-
]
|
|
552
|
-
}
|
|
553
|
-
}
|
|
554
|
-
}
|
|
555
|
-
},
|
|
556
|
-
"404": {
|
|
557
|
-
"description": "Default Response",
|
|
558
|
-
"content": {
|
|
559
|
-
"application/json": {
|
|
560
|
-
"schema": {
|
|
561
|
-
"type": "object",
|
|
562
|
-
"properties": {
|
|
563
|
-
"code": {
|
|
564
|
-
"type": "string"
|
|
565
|
-
},
|
|
566
|
-
"detail": {
|
|
567
|
-
"type": "string"
|
|
568
|
-
},
|
|
569
|
-
"requestId": {
|
|
570
|
-
"type": "string"
|
|
571
|
-
},
|
|
572
|
-
"name": {
|
|
573
|
-
"type": "string"
|
|
574
|
-
},
|
|
575
|
-
"validation": {},
|
|
576
|
-
"validationContext": {
|
|
577
|
-
"type": "string"
|
|
578
|
-
}
|
|
579
|
-
},
|
|
580
|
-
"required": [
|
|
581
|
-
"code",
|
|
582
|
-
"detail",
|
|
583
|
-
"requestId",
|
|
584
|
-
"name"
|
|
585
|
-
]
|
|
586
|
-
}
|
|
587
|
-
}
|
|
588
|
-
}
|
|
589
|
-
},
|
|
590
|
-
"500": {
|
|
591
|
-
"description": "Default Response",
|
|
592
|
-
"content": {
|
|
593
|
-
"application/json": {
|
|
594
|
-
"schema": {
|
|
595
|
-
"type": "object",
|
|
596
|
-
"properties": {
|
|
597
|
-
"code": {
|
|
598
|
-
"type": "string"
|
|
599
|
-
},
|
|
600
|
-
"detail": {
|
|
601
|
-
"type": "string"
|
|
602
|
-
},
|
|
603
|
-
"requestId": {
|
|
604
|
-
"type": "string"
|
|
605
|
-
},
|
|
606
|
-
"name": {
|
|
607
|
-
"type": "string"
|
|
608
|
-
},
|
|
609
|
-
"validation": {},
|
|
610
|
-
"validationContext": {
|
|
611
|
-
"type": "string"
|
|
612
|
-
}
|
|
613
|
-
},
|
|
614
|
-
"required": [
|
|
615
|
-
"code",
|
|
616
|
-
"detail",
|
|
617
|
-
"requestId",
|
|
618
|
-
"name"
|
|
619
|
-
]
|
|
620
|
-
}
|
|
621
|
-
}
|
|
622
|
-
}
|
|
623
|
-
}
|
|
624
|
-
}
|
|
625
|
-
},
|
|
626
|
-
"put": {
|
|
627
|
-
"tags": [
|
|
628
|
-
"Addresses"
|
|
629
|
-
],
|
|
630
|
-
"requestBody": {
|
|
631
|
-
"content": {
|
|
632
|
-
"application/json": {
|
|
633
|
-
"schema": {
|
|
634
|
-
"type": "object",
|
|
635
|
-
"properties": {
|
|
636
|
-
"addressLine1": {
|
|
637
|
-
"type": "string"
|
|
638
|
-
},
|
|
639
|
-
"addressLine2": {
|
|
640
|
-
"type": "string"
|
|
641
|
-
},
|
|
642
|
-
"town": {
|
|
643
|
-
"type": "string"
|
|
644
|
-
},
|
|
645
|
-
"county": {
|
|
646
|
-
"type": "string"
|
|
647
|
-
},
|
|
648
|
-
"eirecode": {
|
|
649
|
-
"type": "string"
|
|
650
|
-
},
|
|
651
|
-
"moveInDate": {
|
|
652
|
-
"type": "string"
|
|
653
|
-
},
|
|
654
|
-
"moveOutDate": {
|
|
655
|
-
"type": "string"
|
|
656
|
-
},
|
|
657
|
-
"isPrimary": {
|
|
658
|
-
"type": "boolean"
|
|
659
|
-
},
|
|
660
|
-
"ownershipStatus": {
|
|
661
|
-
"type": "string"
|
|
662
|
-
}
|
|
663
|
-
},
|
|
664
|
-
"required": [
|
|
665
|
-
"addressLine1",
|
|
666
|
-
"town",
|
|
667
|
-
"county",
|
|
668
|
-
"eirecode",
|
|
669
|
-
"isPrimary",
|
|
670
|
-
"ownershipStatus"
|
|
671
|
-
]
|
|
672
|
-
}
|
|
673
|
-
}
|
|
674
|
-
},
|
|
675
|
-
"required": true
|
|
676
|
-
},
|
|
677
|
-
"parameters": [
|
|
678
|
-
{
|
|
679
|
-
"schema": {
|
|
680
|
-
"type": "string"
|
|
681
|
-
},
|
|
682
|
-
"in": "path",
|
|
683
|
-
"name": "addressId",
|
|
684
|
-
"required": true
|
|
685
|
-
}
|
|
686
|
-
],
|
|
687
|
-
"responses": {
|
|
688
|
-
"200": {
|
|
689
|
-
"description": "Default Response",
|
|
690
|
-
"content": {
|
|
691
|
-
"application/json": {
|
|
692
|
-
"schema": {
|
|
693
|
-
"type": "object",
|
|
694
|
-
"properties": {
|
|
695
|
-
"data": {
|
|
696
|
-
"type": "object",
|
|
697
|
-
"properties": {
|
|
698
|
-
"id": {
|
|
699
|
-
"type": "string"
|
|
700
|
-
}
|
|
701
|
-
},
|
|
702
|
-
"required": [
|
|
703
|
-
"id"
|
|
704
|
-
]
|
|
705
|
-
},
|
|
706
|
-
"metadata": {
|
|
707
|
-
"type": "object",
|
|
708
|
-
"properties": {
|
|
709
|
-
"links": {
|
|
710
|
-
"description": "Object containing the links to the related endpoints",
|
|
711
|
-
"type": "object",
|
|
712
|
-
"properties": {
|
|
713
|
-
"self": {
|
|
714
|
-
"type": "object",
|
|
715
|
-
"properties": {
|
|
716
|
-
"href": {
|
|
717
|
-
"description": "URL pointing to the request itself",
|
|
718
|
-
"type": "string"
|
|
719
|
-
}
|
|
720
|
-
}
|
|
721
|
-
},
|
|
722
|
-
"next": {
|
|
723
|
-
"type": "object",
|
|
724
|
-
"properties": {
|
|
725
|
-
"href": {
|
|
726
|
-
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
727
|
-
"type": "string"
|
|
728
|
-
}
|
|
729
|
-
}
|
|
730
|
-
},
|
|
731
|
-
"prev": {
|
|
732
|
-
"type": "object",
|
|
733
|
-
"properties": {
|
|
734
|
-
"href": {
|
|
735
|
-
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
736
|
-
"type": "string"
|
|
737
|
-
}
|
|
738
|
-
}
|
|
739
|
-
},
|
|
740
|
-
"first": {
|
|
741
|
-
"type": "object",
|
|
742
|
-
"properties": {
|
|
743
|
-
"href": {
|
|
744
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
745
|
-
"type": "string"
|
|
746
|
-
}
|
|
747
|
-
}
|
|
748
|
-
},
|
|
749
|
-
"last": {
|
|
750
|
-
"type": "object",
|
|
751
|
-
"properties": {
|
|
752
|
-
"href": {
|
|
753
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
754
|
-
"type": "string"
|
|
755
|
-
}
|
|
756
|
-
}
|
|
757
|
-
},
|
|
758
|
-
"pages": {
|
|
759
|
-
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
760
|
-
"type": "object",
|
|
761
|
-
"additionalProperties": {
|
|
762
|
-
"type": "object",
|
|
763
|
-
"properties": {
|
|
764
|
-
"href": {
|
|
765
|
-
"type": "string"
|
|
766
|
-
}
|
|
767
|
-
}
|
|
768
|
-
}
|
|
769
|
-
}
|
|
770
|
-
},
|
|
771
|
-
"required": [
|
|
772
|
-
"self",
|
|
773
|
-
"first",
|
|
774
|
-
"last",
|
|
775
|
-
"pages"
|
|
776
|
-
]
|
|
362
|
+
"ppsn": {
|
|
363
|
+
"type": "string"
|
|
777
364
|
},
|
|
778
|
-
"
|
|
779
|
-
"
|
|
780
|
-
"
|
|
365
|
+
"preferredLanguage": {
|
|
366
|
+
"type": "string",
|
|
367
|
+
"enum": [
|
|
368
|
+
"en",
|
|
369
|
+
"ga"
|
|
370
|
+
],
|
|
371
|
+
"default": "en"
|
|
781
372
|
}
|
|
782
|
-
}
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
}
|
|
789
|
-
}
|
|
790
|
-
}
|
|
791
|
-
},
|
|
792
|
-
"404": {
|
|
793
|
-
"description": "Default Response",
|
|
794
|
-
"content": {
|
|
795
|
-
"application/json": {
|
|
796
|
-
"schema": {
|
|
797
|
-
"type": "object",
|
|
798
|
-
"properties": {
|
|
799
|
-
"code": {
|
|
800
|
-
"type": "string"
|
|
801
|
-
},
|
|
802
|
-
"detail": {
|
|
803
|
-
"type": "string"
|
|
804
|
-
},
|
|
805
|
-
"requestId": {
|
|
806
|
-
"type": "string"
|
|
807
|
-
},
|
|
808
|
-
"name": {
|
|
809
|
-
"type": "string"
|
|
810
|
-
},
|
|
811
|
-
"validation": {},
|
|
812
|
-
"validationContext": {
|
|
813
|
-
"type": "string"
|
|
373
|
+
},
|
|
374
|
+
"required": [
|
|
375
|
+
"email",
|
|
376
|
+
"firstName",
|
|
377
|
+
"lastName"
|
|
378
|
+
]
|
|
814
379
|
}
|
|
815
380
|
},
|
|
816
|
-
"
|
|
817
|
-
"code",
|
|
818
|
-
"detail",
|
|
819
|
-
"requestId",
|
|
820
|
-
"name"
|
|
821
|
-
]
|
|
381
|
+
"file": {}
|
|
822
382
|
}
|
|
823
383
|
}
|
|
824
|
-
}
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
"
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
384
|
+
},
|
|
385
|
+
"multipart/form-data": {
|
|
386
|
+
"schema": {
|
|
387
|
+
"type": "object",
|
|
388
|
+
"properties": {
|
|
389
|
+
"profiles": {
|
|
390
|
+
"minItems": 1,
|
|
391
|
+
"type": "array",
|
|
392
|
+
"items": {
|
|
393
|
+
"type": "object",
|
|
394
|
+
"properties": {
|
|
395
|
+
"email": {
|
|
396
|
+
"format": "email",
|
|
397
|
+
"type": "string"
|
|
398
|
+
},
|
|
399
|
+
"firstName": {
|
|
400
|
+
"type": "string"
|
|
401
|
+
},
|
|
402
|
+
"lastName": {
|
|
403
|
+
"type": "string"
|
|
404
|
+
},
|
|
405
|
+
"city": {
|
|
406
|
+
"type": "string"
|
|
407
|
+
},
|
|
408
|
+
"address": {
|
|
409
|
+
"type": "string"
|
|
410
|
+
},
|
|
411
|
+
"phone": {
|
|
412
|
+
"type": "string"
|
|
413
|
+
},
|
|
414
|
+
"dateOfBirth": {
|
|
415
|
+
"format": "date",
|
|
416
|
+
"type": "string"
|
|
417
|
+
},
|
|
418
|
+
"ppsn": {
|
|
419
|
+
"type": "string"
|
|
420
|
+
},
|
|
421
|
+
"preferredLanguage": {
|
|
422
|
+
"type": "string",
|
|
423
|
+
"enum": [
|
|
424
|
+
"en",
|
|
425
|
+
"ga"
|
|
426
|
+
],
|
|
427
|
+
"default": "en"
|
|
428
|
+
}
|
|
429
|
+
},
|
|
430
|
+
"required": [
|
|
431
|
+
"email",
|
|
432
|
+
"firstName",
|
|
433
|
+
"lastName"
|
|
434
|
+
]
|
|
848
435
|
}
|
|
849
436
|
},
|
|
850
|
-
"
|
|
851
|
-
"code",
|
|
852
|
-
"detail",
|
|
853
|
-
"requestId",
|
|
854
|
-
"name"
|
|
855
|
-
]
|
|
437
|
+
"file": {}
|
|
856
438
|
}
|
|
857
439
|
}
|
|
858
|
-
}
|
|
859
|
-
|
|
860
|
-
}
|
|
861
|
-
},
|
|
862
|
-
"patch": {
|
|
863
|
-
"tags": [
|
|
864
|
-
"Addresses"
|
|
865
|
-
],
|
|
866
|
-
"requestBody": {
|
|
867
|
-
"content": {
|
|
868
|
-
"application/json": {
|
|
440
|
+
},
|
|
441
|
+
"text/csv": {
|
|
869
442
|
"schema": {
|
|
870
443
|
"type": "object",
|
|
871
444
|
"properties": {
|
|
872
|
-
"
|
|
873
|
-
"
|
|
445
|
+
"profiles": {
|
|
446
|
+
"minItems": 1,
|
|
447
|
+
"type": "array",
|
|
448
|
+
"items": {
|
|
449
|
+
"type": "object",
|
|
450
|
+
"properties": {
|
|
451
|
+
"email": {
|
|
452
|
+
"format": "email",
|
|
453
|
+
"type": "string"
|
|
454
|
+
},
|
|
455
|
+
"firstName": {
|
|
456
|
+
"type": "string"
|
|
457
|
+
},
|
|
458
|
+
"lastName": {
|
|
459
|
+
"type": "string"
|
|
460
|
+
},
|
|
461
|
+
"city": {
|
|
462
|
+
"type": "string"
|
|
463
|
+
},
|
|
464
|
+
"address": {
|
|
465
|
+
"type": "string"
|
|
466
|
+
},
|
|
467
|
+
"phone": {
|
|
468
|
+
"type": "string"
|
|
469
|
+
},
|
|
470
|
+
"dateOfBirth": {
|
|
471
|
+
"format": "date",
|
|
472
|
+
"type": "string"
|
|
473
|
+
},
|
|
474
|
+
"ppsn": {
|
|
475
|
+
"type": "string"
|
|
476
|
+
},
|
|
477
|
+
"preferredLanguage": {
|
|
478
|
+
"type": "string",
|
|
479
|
+
"enum": [
|
|
480
|
+
"en",
|
|
481
|
+
"ga"
|
|
482
|
+
],
|
|
483
|
+
"default": "en"
|
|
484
|
+
}
|
|
485
|
+
},
|
|
486
|
+
"required": [
|
|
487
|
+
"email",
|
|
488
|
+
"firstName",
|
|
489
|
+
"lastName"
|
|
490
|
+
]
|
|
491
|
+
}
|
|
874
492
|
},
|
|
875
|
-
"
|
|
876
|
-
"type": "string"
|
|
877
|
-
}
|
|
493
|
+
"file": {}
|
|
878
494
|
}
|
|
879
495
|
}
|
|
880
496
|
}
|
|
881
497
|
}
|
|
882
498
|
},
|
|
883
|
-
"parameters": [
|
|
884
|
-
{
|
|
885
|
-
"schema": {
|
|
886
|
-
"type": "string"
|
|
887
|
-
},
|
|
888
|
-
"in": "path",
|
|
889
|
-
"name": "addressId",
|
|
890
|
-
"required": true
|
|
891
|
-
}
|
|
892
|
-
],
|
|
893
499
|
"responses": {
|
|
894
500
|
"200": {
|
|
895
501
|
"description": "Default Response",
|
|
896
502
|
"content": {
|
|
897
503
|
"application/json": {
|
|
898
504
|
"schema": {
|
|
899
|
-
"type": "object",
|
|
900
|
-
"properties": {
|
|
901
|
-
"
|
|
902
|
-
"type": "
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
}
|
|
907
|
-
},
|
|
908
|
-
"required": [
|
|
909
|
-
"id"
|
|
910
|
-
]
|
|
911
|
-
},
|
|
912
|
-
"metadata": {
|
|
913
|
-
"type": "object",
|
|
914
|
-
"properties": {
|
|
915
|
-
"links": {
|
|
916
|
-
"description": "Object containing the links to the related endpoints",
|
|
917
|
-
"type": "object",
|
|
918
|
-
"properties": {
|
|
919
|
-
"self": {
|
|
920
|
-
"type": "object",
|
|
921
|
-
"properties": {
|
|
922
|
-
"href": {
|
|
923
|
-
"description": "URL pointing to the request itself",
|
|
924
|
-
"type": "string"
|
|
925
|
-
}
|
|
926
|
-
}
|
|
927
|
-
},
|
|
928
|
-
"next": {
|
|
929
|
-
"type": "object",
|
|
930
|
-
"properties": {
|
|
931
|
-
"href": {
|
|
932
|
-
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
933
|
-
"type": "string"
|
|
934
|
-
}
|
|
935
|
-
}
|
|
936
|
-
},
|
|
937
|
-
"prev": {
|
|
938
|
-
"type": "object",
|
|
939
|
-
"properties": {
|
|
940
|
-
"href": {
|
|
941
|
-
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
942
|
-
"type": "string"
|
|
943
|
-
}
|
|
944
|
-
}
|
|
945
|
-
},
|
|
946
|
-
"first": {
|
|
947
|
-
"type": "object",
|
|
948
|
-
"properties": {
|
|
949
|
-
"href": {
|
|
950
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
951
|
-
"type": "string"
|
|
952
|
-
}
|
|
953
|
-
}
|
|
954
|
-
},
|
|
955
|
-
"last": {
|
|
956
|
-
"type": "object",
|
|
957
|
-
"properties": {
|
|
958
|
-
"href": {
|
|
959
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
960
|
-
"type": "string"
|
|
961
|
-
}
|
|
962
|
-
}
|
|
963
|
-
},
|
|
964
|
-
"pages": {
|
|
965
|
-
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
966
|
-
"type": "object",
|
|
967
|
-
"additionalProperties": {
|
|
968
|
-
"type": "object",
|
|
969
|
-
"properties": {
|
|
970
|
-
"href": {
|
|
971
|
-
"type": "string"
|
|
972
|
-
}
|
|
973
|
-
}
|
|
974
|
-
}
|
|
975
|
-
}
|
|
976
|
-
},
|
|
977
|
-
"required": [
|
|
978
|
-
"self",
|
|
979
|
-
"first",
|
|
980
|
-
"last",
|
|
981
|
-
"pages"
|
|
982
|
-
]
|
|
983
|
-
},
|
|
984
|
-
"totalCount": {
|
|
985
|
-
"description": "Number representing the total number of available items",
|
|
986
|
-
"type": "number"
|
|
987
|
-
}
|
|
988
|
-
}
|
|
505
|
+
"type": "object",
|
|
506
|
+
"properties": {
|
|
507
|
+
"status": {
|
|
508
|
+
"type": "string"
|
|
509
|
+
},
|
|
510
|
+
"jobId": {
|
|
511
|
+
"type": "string"
|
|
989
512
|
}
|
|
990
513
|
},
|
|
991
514
|
"required": [
|
|
992
|
-
"
|
|
515
|
+
"status",
|
|
516
|
+
"jobId"
|
|
993
517
|
]
|
|
994
518
|
}
|
|
995
519
|
}
|
|
996
520
|
}
|
|
997
521
|
},
|
|
998
|
-
"
|
|
522
|
+
"4XX": {
|
|
999
523
|
"description": "Default Response",
|
|
1000
524
|
"content": {
|
|
1001
525
|
"application/json": {
|
|
@@ -1003,33 +527,59 @@
|
|
|
1003
527
|
"type": "object",
|
|
1004
528
|
"properties": {
|
|
1005
529
|
"code": {
|
|
530
|
+
"description": "Code used to categorize the error",
|
|
1006
531
|
"type": "string"
|
|
1007
532
|
},
|
|
1008
533
|
"detail": {
|
|
534
|
+
"description": "Description of the error",
|
|
1009
535
|
"type": "string"
|
|
1010
536
|
},
|
|
1011
537
|
"requestId": {
|
|
538
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1012
539
|
"type": "string"
|
|
1013
540
|
},
|
|
1014
541
|
"name": {
|
|
542
|
+
"description": "Name of the error type",
|
|
1015
543
|
"type": "string"
|
|
1016
544
|
},
|
|
1017
|
-
"validation": {
|
|
545
|
+
"validation": {
|
|
546
|
+
"description": "List of the validation errors",
|
|
547
|
+
"type": "array",
|
|
548
|
+
"items": {
|
|
549
|
+
"type": "object",
|
|
550
|
+
"properties": {
|
|
551
|
+
"fieldName": {
|
|
552
|
+
"type": "string"
|
|
553
|
+
},
|
|
554
|
+
"message": {
|
|
555
|
+
"type": "string"
|
|
556
|
+
}
|
|
557
|
+
},
|
|
558
|
+
"required": [
|
|
559
|
+
"fieldName",
|
|
560
|
+
"message"
|
|
561
|
+
]
|
|
562
|
+
}
|
|
563
|
+
},
|
|
1018
564
|
"validationContext": {
|
|
1019
565
|
"type": "string"
|
|
566
|
+
},
|
|
567
|
+
"statusCode": {
|
|
568
|
+
"type": "number"
|
|
1020
569
|
}
|
|
1021
570
|
},
|
|
1022
571
|
"required": [
|
|
1023
572
|
"code",
|
|
1024
573
|
"detail",
|
|
1025
574
|
"requestId",
|
|
1026
|
-
"name"
|
|
575
|
+
"name",
|
|
576
|
+
"statusCode"
|
|
1027
577
|
]
|
|
1028
578
|
}
|
|
1029
579
|
}
|
|
1030
580
|
}
|
|
1031
581
|
},
|
|
1032
|
-
"
|
|
582
|
+
"5XX": {
|
|
1033
583
|
"description": "Default Response",
|
|
1034
584
|
"content": {
|
|
1035
585
|
"application/json": {
|
|
@@ -1037,46 +587,77 @@
|
|
|
1037
587
|
"type": "object",
|
|
1038
588
|
"properties": {
|
|
1039
589
|
"code": {
|
|
590
|
+
"description": "Code used to categorize the error",
|
|
1040
591
|
"type": "string"
|
|
1041
592
|
},
|
|
1042
593
|
"detail": {
|
|
594
|
+
"description": "Description of the error",
|
|
1043
595
|
"type": "string"
|
|
1044
596
|
},
|
|
1045
597
|
"requestId": {
|
|
598
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1046
599
|
"type": "string"
|
|
1047
600
|
},
|
|
1048
601
|
"name": {
|
|
602
|
+
"description": "Name of the error type",
|
|
1049
603
|
"type": "string"
|
|
1050
604
|
},
|
|
1051
|
-
"validation": {
|
|
605
|
+
"validation": {
|
|
606
|
+
"description": "List of the validation errors",
|
|
607
|
+
"type": "array",
|
|
608
|
+
"items": {
|
|
609
|
+
"type": "object",
|
|
610
|
+
"properties": {
|
|
611
|
+
"fieldName": {
|
|
612
|
+
"type": "string"
|
|
613
|
+
},
|
|
614
|
+
"message": {
|
|
615
|
+
"type": "string"
|
|
616
|
+
}
|
|
617
|
+
},
|
|
618
|
+
"required": [
|
|
619
|
+
"fieldName",
|
|
620
|
+
"message"
|
|
621
|
+
]
|
|
622
|
+
}
|
|
623
|
+
},
|
|
1052
624
|
"validationContext": {
|
|
1053
625
|
"type": "string"
|
|
626
|
+
},
|
|
627
|
+
"statusCode": {
|
|
628
|
+
"type": "number"
|
|
1054
629
|
}
|
|
1055
630
|
},
|
|
1056
631
|
"required": [
|
|
1057
632
|
"code",
|
|
1058
633
|
"detail",
|
|
1059
634
|
"requestId",
|
|
1060
|
-
"name"
|
|
635
|
+
"name",
|
|
636
|
+
"statusCode"
|
|
1061
637
|
]
|
|
1062
638
|
}
|
|
1063
639
|
}
|
|
1064
640
|
}
|
|
1065
641
|
}
|
|
1066
642
|
}
|
|
1067
|
-
}
|
|
1068
|
-
|
|
643
|
+
}
|
|
644
|
+
},
|
|
645
|
+
"/api/v1/profiles/select-profiles": {
|
|
646
|
+
"get": {
|
|
647
|
+
"operationId": "selectProfiles",
|
|
1069
648
|
"tags": [
|
|
1070
|
-
"
|
|
649
|
+
"Profiles"
|
|
1071
650
|
],
|
|
1072
651
|
"parameters": [
|
|
1073
652
|
{
|
|
1074
653
|
"schema": {
|
|
654
|
+
"pattern": "^[a-zA-Z0-9-]+(,[a-zA-Z0-9-]+)*$",
|
|
1075
655
|
"type": "string"
|
|
1076
656
|
},
|
|
1077
|
-
"in": "
|
|
1078
|
-
"name": "
|
|
1079
|
-
"required": true
|
|
657
|
+
"in": "query",
|
|
658
|
+
"name": "ids",
|
|
659
|
+
"required": true,
|
|
660
|
+
"description": "Comma-separated list of profile IDs"
|
|
1080
661
|
}
|
|
1081
662
|
],
|
|
1082
663
|
"responses": {
|
|
@@ -1088,15 +669,94 @@
|
|
|
1088
669
|
"type": "object",
|
|
1089
670
|
"properties": {
|
|
1090
671
|
"data": {
|
|
1091
|
-
"type": "
|
|
1092
|
-
"
|
|
1093
|
-
"
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
672
|
+
"type": "array",
|
|
673
|
+
"items": {
|
|
674
|
+
"type": "object",
|
|
675
|
+
"properties": {
|
|
676
|
+
"id": {
|
|
677
|
+
"type": "string"
|
|
678
|
+
},
|
|
679
|
+
"publicName": {
|
|
680
|
+
"type": "string"
|
|
681
|
+
},
|
|
682
|
+
"email": {
|
|
683
|
+
"format": "email",
|
|
684
|
+
"type": "string"
|
|
685
|
+
},
|
|
686
|
+
"primaryUserId": {
|
|
687
|
+
"type": "string"
|
|
688
|
+
},
|
|
689
|
+
"safeLevel": {
|
|
690
|
+
"type": "number"
|
|
691
|
+
},
|
|
692
|
+
"preferredLanguage": {
|
|
693
|
+
"type": "string",
|
|
694
|
+
"enum": [
|
|
695
|
+
"en",
|
|
696
|
+
"ga"
|
|
697
|
+
],
|
|
698
|
+
"default": "en"
|
|
699
|
+
},
|
|
700
|
+
"createdAt": {
|
|
701
|
+
"format": "date-time",
|
|
702
|
+
"type": "string"
|
|
703
|
+
},
|
|
704
|
+
"updatedAt": {
|
|
705
|
+
"format": "date-time",
|
|
706
|
+
"type": "string"
|
|
707
|
+
},
|
|
708
|
+
"details": {
|
|
709
|
+
"type": "object",
|
|
710
|
+
"properties": {
|
|
711
|
+
"email": {
|
|
712
|
+
"format": "email",
|
|
713
|
+
"type": "string"
|
|
714
|
+
},
|
|
715
|
+
"firstName": {
|
|
716
|
+
"type": "string"
|
|
717
|
+
},
|
|
718
|
+
"lastName": {
|
|
719
|
+
"type": "string"
|
|
720
|
+
},
|
|
721
|
+
"city": {
|
|
722
|
+
"type": "string"
|
|
723
|
+
},
|
|
724
|
+
"address": {
|
|
725
|
+
"type": "string"
|
|
726
|
+
},
|
|
727
|
+
"phone": {
|
|
728
|
+
"type": "string"
|
|
729
|
+
},
|
|
730
|
+
"dateOfBirth": {
|
|
731
|
+
"format": "date",
|
|
732
|
+
"type": "string"
|
|
733
|
+
},
|
|
734
|
+
"ppsn": {
|
|
735
|
+
"type": "string"
|
|
736
|
+
},
|
|
737
|
+
"preferredLanguage": {
|
|
738
|
+
"type": "string",
|
|
739
|
+
"enum": [
|
|
740
|
+
"en",
|
|
741
|
+
"ga"
|
|
742
|
+
],
|
|
743
|
+
"default": "en"
|
|
744
|
+
}
|
|
745
|
+
},
|
|
746
|
+
"required": [
|
|
747
|
+
"email",
|
|
748
|
+
"firstName",
|
|
749
|
+
"lastName"
|
|
750
|
+
]
|
|
751
|
+
}
|
|
752
|
+
},
|
|
753
|
+
"required": [
|
|
754
|
+
"id",
|
|
755
|
+
"publicName",
|
|
756
|
+
"email",
|
|
757
|
+
"primaryUserId"
|
|
758
|
+
]
|
|
759
|
+
}
|
|
1100
760
|
},
|
|
1101
761
|
"metadata": {
|
|
1102
762
|
"type": "object",
|
|
@@ -1184,7 +844,7 @@
|
|
|
1184
844
|
}
|
|
1185
845
|
}
|
|
1186
846
|
},
|
|
1187
|
-
"
|
|
847
|
+
"4XX": {
|
|
1188
848
|
"description": "Default Response",
|
|
1189
849
|
"content": {
|
|
1190
850
|
"application/json": {
|
|
@@ -1192,33 +852,59 @@
|
|
|
1192
852
|
"type": "object",
|
|
1193
853
|
"properties": {
|
|
1194
854
|
"code": {
|
|
855
|
+
"description": "Code used to categorize the error",
|
|
1195
856
|
"type": "string"
|
|
1196
857
|
},
|
|
1197
858
|
"detail": {
|
|
859
|
+
"description": "Description of the error",
|
|
1198
860
|
"type": "string"
|
|
1199
861
|
},
|
|
1200
862
|
"requestId": {
|
|
863
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1201
864
|
"type": "string"
|
|
1202
865
|
},
|
|
1203
866
|
"name": {
|
|
867
|
+
"description": "Name of the error type",
|
|
1204
868
|
"type": "string"
|
|
1205
869
|
},
|
|
1206
|
-
"validation": {
|
|
870
|
+
"validation": {
|
|
871
|
+
"description": "List of the validation errors",
|
|
872
|
+
"type": "array",
|
|
873
|
+
"items": {
|
|
874
|
+
"type": "object",
|
|
875
|
+
"properties": {
|
|
876
|
+
"fieldName": {
|
|
877
|
+
"type": "string"
|
|
878
|
+
},
|
|
879
|
+
"message": {
|
|
880
|
+
"type": "string"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"required": [
|
|
884
|
+
"fieldName",
|
|
885
|
+
"message"
|
|
886
|
+
]
|
|
887
|
+
}
|
|
888
|
+
},
|
|
1207
889
|
"validationContext": {
|
|
1208
890
|
"type": "string"
|
|
891
|
+
},
|
|
892
|
+
"statusCode": {
|
|
893
|
+
"type": "number"
|
|
1209
894
|
}
|
|
1210
895
|
},
|
|
1211
896
|
"required": [
|
|
1212
897
|
"code",
|
|
1213
898
|
"detail",
|
|
1214
899
|
"requestId",
|
|
1215
|
-
"name"
|
|
900
|
+
"name",
|
|
901
|
+
"statusCode"
|
|
1216
902
|
]
|
|
1217
903
|
}
|
|
1218
904
|
}
|
|
1219
905
|
}
|
|
1220
906
|
},
|
|
1221
|
-
"
|
|
907
|
+
"5XX": {
|
|
1222
908
|
"description": "Default Response",
|
|
1223
909
|
"content": {
|
|
1224
910
|
"application/json": {
|
|
@@ -1226,196 +912,53 @@
|
|
|
1226
912
|
"type": "object",
|
|
1227
913
|
"properties": {
|
|
1228
914
|
"code": {
|
|
915
|
+
"description": "Code used to categorize the error",
|
|
1229
916
|
"type": "string"
|
|
1230
917
|
},
|
|
1231
918
|
"detail": {
|
|
919
|
+
"description": "Description of the error",
|
|
1232
920
|
"type": "string"
|
|
1233
921
|
},
|
|
1234
922
|
"requestId": {
|
|
923
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1235
924
|
"type": "string"
|
|
1236
925
|
},
|
|
1237
926
|
"name": {
|
|
927
|
+
"description": "Name of the error type",
|
|
1238
928
|
"type": "string"
|
|
1239
929
|
},
|
|
1240
|
-
"validation": {
|
|
1241
|
-
|
|
1242
|
-
"type": "string"
|
|
1243
|
-
}
|
|
1244
|
-
},
|
|
1245
|
-
"required": [
|
|
1246
|
-
"code",
|
|
1247
|
-
"detail",
|
|
1248
|
-
"requestId",
|
|
1249
|
-
"name"
|
|
1250
|
-
]
|
|
1251
|
-
}
|
|
1252
|
-
}
|
|
1253
|
-
}
|
|
1254
|
-
}
|
|
1255
|
-
}
|
|
1256
|
-
}
|
|
1257
|
-
},
|
|
1258
|
-
"/api/v1/entitlements/": {
|
|
1259
|
-
"get": {
|
|
1260
|
-
"tags": [
|
|
1261
|
-
"Entitlements"
|
|
1262
|
-
],
|
|
1263
|
-
"responses": {
|
|
1264
|
-
"200": {
|
|
1265
|
-
"description": "Default Response",
|
|
1266
|
-
"content": {
|
|
1267
|
-
"application/json": {
|
|
1268
|
-
"schema": {
|
|
1269
|
-
"type": "object",
|
|
1270
|
-
"properties": {
|
|
1271
|
-
"data": {
|
|
930
|
+
"validation": {
|
|
931
|
+
"description": "List of the validation errors",
|
|
1272
932
|
"type": "array",
|
|
1273
933
|
"items": {
|
|
1274
934
|
"type": "object",
|
|
1275
935
|
"properties": {
|
|
1276
|
-
"
|
|
1277
|
-
"type": "string"
|
|
1278
|
-
},
|
|
1279
|
-
"lastname": {
|
|
1280
|
-
"type": "string"
|
|
1281
|
-
},
|
|
1282
|
-
"type": {
|
|
936
|
+
"fieldName": {
|
|
1283
937
|
"type": "string"
|
|
1284
938
|
},
|
|
1285
|
-
"
|
|
1286
|
-
"type": "string"
|
|
1287
|
-
},
|
|
1288
|
-
"expiryDate": {
|
|
1289
|
-
"type": "string"
|
|
1290
|
-
},
|
|
1291
|
-
"documentNumber": {
|
|
939
|
+
"message": {
|
|
1292
940
|
"type": "string"
|
|
1293
941
|
}
|
|
1294
942
|
},
|
|
1295
943
|
"required": [
|
|
1296
|
-
"
|
|
1297
|
-
"
|
|
1298
|
-
"type",
|
|
1299
|
-
"issueDate",
|
|
1300
|
-
"documentNumber"
|
|
944
|
+
"fieldName",
|
|
945
|
+
"message"
|
|
1301
946
|
]
|
|
1302
947
|
}
|
|
1303
948
|
},
|
|
1304
|
-
"metadata": {
|
|
1305
|
-
"type": "object",
|
|
1306
|
-
"properties": {
|
|
1307
|
-
"links": {
|
|
1308
|
-
"description": "Object containing the links to the related endpoints",
|
|
1309
|
-
"type": "object",
|
|
1310
|
-
"properties": {
|
|
1311
|
-
"self": {
|
|
1312
|
-
"type": "object",
|
|
1313
|
-
"properties": {
|
|
1314
|
-
"href": {
|
|
1315
|
-
"description": "URL pointing to the request itself",
|
|
1316
|
-
"type": "string"
|
|
1317
|
-
}
|
|
1318
|
-
}
|
|
1319
|
-
},
|
|
1320
|
-
"next": {
|
|
1321
|
-
"type": "object",
|
|
1322
|
-
"properties": {
|
|
1323
|
-
"href": {
|
|
1324
|
-
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
1325
|
-
"type": "string"
|
|
1326
|
-
}
|
|
1327
|
-
}
|
|
1328
|
-
},
|
|
1329
|
-
"prev": {
|
|
1330
|
-
"type": "object",
|
|
1331
|
-
"properties": {
|
|
1332
|
-
"href": {
|
|
1333
|
-
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
|
|
1334
|
-
"type": "string"
|
|
1335
|
-
}
|
|
1336
|
-
}
|
|
1337
|
-
},
|
|
1338
|
-
"first": {
|
|
1339
|
-
"type": "object",
|
|
1340
|
-
"properties": {
|
|
1341
|
-
"href": {
|
|
1342
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
1343
|
-
"type": "string"
|
|
1344
|
-
}
|
|
1345
|
-
}
|
|
1346
|
-
},
|
|
1347
|
-
"last": {
|
|
1348
|
-
"type": "object",
|
|
1349
|
-
"properties": {
|
|
1350
|
-
"href": {
|
|
1351
|
-
"description": "URL pointing to the first page of results in a paginated response",
|
|
1352
|
-
"type": "string"
|
|
1353
|
-
}
|
|
1354
|
-
}
|
|
1355
|
-
},
|
|
1356
|
-
"pages": {
|
|
1357
|
-
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
1358
|
-
"type": "object",
|
|
1359
|
-
"additionalProperties": {
|
|
1360
|
-
"type": "object",
|
|
1361
|
-
"properties": {
|
|
1362
|
-
"href": {
|
|
1363
|
-
"type": "string"
|
|
1364
|
-
}
|
|
1365
|
-
}
|
|
1366
|
-
}
|
|
1367
|
-
}
|
|
1368
|
-
},
|
|
1369
|
-
"required": [
|
|
1370
|
-
"self",
|
|
1371
|
-
"first",
|
|
1372
|
-
"last",
|
|
1373
|
-
"pages"
|
|
1374
|
-
]
|
|
1375
|
-
},
|
|
1376
|
-
"totalCount": {
|
|
1377
|
-
"description": "Number representing the total number of available items",
|
|
1378
|
-
"type": "number"
|
|
1379
|
-
}
|
|
1380
|
-
}
|
|
1381
|
-
}
|
|
1382
|
-
},
|
|
1383
|
-
"required": [
|
|
1384
|
-
"data"
|
|
1385
|
-
]
|
|
1386
|
-
}
|
|
1387
|
-
}
|
|
1388
|
-
}
|
|
1389
|
-
},
|
|
1390
|
-
"500": {
|
|
1391
|
-
"description": "Default Response",
|
|
1392
|
-
"content": {
|
|
1393
|
-
"application/json": {
|
|
1394
|
-
"schema": {
|
|
1395
|
-
"type": "object",
|
|
1396
|
-
"properties": {
|
|
1397
|
-
"code": {
|
|
1398
|
-
"type": "string"
|
|
1399
|
-
},
|
|
1400
|
-
"detail": {
|
|
1401
|
-
"type": "string"
|
|
1402
|
-
},
|
|
1403
|
-
"requestId": {
|
|
1404
|
-
"type": "string"
|
|
1405
|
-
},
|
|
1406
|
-
"name": {
|
|
1407
|
-
"type": "string"
|
|
1408
|
-
},
|
|
1409
|
-
"validation": {},
|
|
1410
949
|
"validationContext": {
|
|
1411
950
|
"type": "string"
|
|
951
|
+
},
|
|
952
|
+
"statusCode": {
|
|
953
|
+
"type": "number"
|
|
1412
954
|
}
|
|
1413
955
|
},
|
|
1414
956
|
"required": [
|
|
1415
957
|
"code",
|
|
1416
958
|
"detail",
|
|
1417
959
|
"requestId",
|
|
1418
|
-
"name"
|
|
960
|
+
"name",
|
|
961
|
+
"statusCode"
|
|
1419
962
|
]
|
|
1420
963
|
}
|
|
1421
964
|
}
|
|
@@ -1424,19 +967,49 @@
|
|
|
1424
967
|
}
|
|
1425
968
|
}
|
|
1426
969
|
},
|
|
1427
|
-
"/api/v1/
|
|
970
|
+
"/api/v1/profiles/find-profile": {
|
|
1428
971
|
"get": {
|
|
972
|
+
"operationId": "findProfile",
|
|
1429
973
|
"tags": [
|
|
1430
|
-
"
|
|
974
|
+
"Profiles"
|
|
1431
975
|
],
|
|
1432
976
|
"parameters": [
|
|
977
|
+
{
|
|
978
|
+
"schema": {
|
|
979
|
+
"format": "email",
|
|
980
|
+
"type": "string"
|
|
981
|
+
},
|
|
982
|
+
"in": "query",
|
|
983
|
+
"name": "email",
|
|
984
|
+
"required": false,
|
|
985
|
+
"description": "Email address to search for"
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
"schema": {
|
|
989
|
+
"type": "string"
|
|
990
|
+
},
|
|
991
|
+
"in": "query",
|
|
992
|
+
"name": "firstName",
|
|
993
|
+
"required": false,
|
|
994
|
+
"description": "First name to search for"
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
"schema": {
|
|
998
|
+
"type": "string"
|
|
999
|
+
},
|
|
1000
|
+
"in": "query",
|
|
1001
|
+
"name": "lastName",
|
|
1002
|
+
"required": false,
|
|
1003
|
+
"description": "Last name to search for"
|
|
1004
|
+
},
|
|
1433
1005
|
{
|
|
1434
1006
|
"schema": {
|
|
1435
1007
|
"type": "string"
|
|
1436
1008
|
},
|
|
1437
|
-
"in": "
|
|
1438
|
-
"name": "
|
|
1439
|
-
"required":
|
|
1009
|
+
"in": "query",
|
|
1010
|
+
"name": "phone",
|
|
1011
|
+
"required": false,
|
|
1012
|
+
"description": "Phone number to search for"
|
|
1440
1013
|
}
|
|
1441
1014
|
],
|
|
1442
1015
|
"responses": {
|
|
@@ -1450,104 +1023,88 @@
|
|
|
1450
1023
|
"data": {
|
|
1451
1024
|
"type": "object",
|
|
1452
1025
|
"properties": {
|
|
1453
|
-
"
|
|
1454
|
-
"
|
|
1455
|
-
"anyOf": [
|
|
1456
|
-
{
|
|
1457
|
-
"type": "null"
|
|
1458
|
-
},
|
|
1459
|
-
{
|
|
1460
|
-
"type": "string"
|
|
1461
|
-
}
|
|
1462
|
-
]
|
|
1026
|
+
"id": {
|
|
1027
|
+
"type": "string"
|
|
1463
1028
|
},
|
|
1464
|
-
"
|
|
1029
|
+
"publicName": {
|
|
1465
1030
|
"type": "string"
|
|
1466
1031
|
},
|
|
1467
|
-
"
|
|
1032
|
+
"email": {
|
|
1033
|
+
"format": "email",
|
|
1468
1034
|
"type": "string"
|
|
1469
1035
|
},
|
|
1470
|
-
"
|
|
1471
|
-
"
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1036
|
+
"primaryUserId": {
|
|
1037
|
+
"type": "string"
|
|
1038
|
+
},
|
|
1039
|
+
"safeLevel": {
|
|
1040
|
+
"type": "number"
|
|
1041
|
+
},
|
|
1042
|
+
"preferredLanguage": {
|
|
1043
|
+
"type": "string",
|
|
1044
|
+
"enum": [
|
|
1045
|
+
"en",
|
|
1046
|
+
"ga"
|
|
1047
|
+
],
|
|
1048
|
+
"default": "en"
|
|
1049
|
+
},
|
|
1050
|
+
"createdAt": {
|
|
1051
|
+
"format": "date-time",
|
|
1052
|
+
"type": "string"
|
|
1053
|
+
},
|
|
1054
|
+
"updatedAt": {
|
|
1055
|
+
"format": "date-time",
|
|
1056
|
+
"type": "string"
|
|
1057
|
+
},
|
|
1058
|
+
"details": {
|
|
1059
|
+
"type": "object",
|
|
1060
|
+
"properties": {
|
|
1061
|
+
"email": {
|
|
1062
|
+
"format": "email",
|
|
1063
|
+
"type": "string"
|
|
1475
1064
|
},
|
|
1476
|
-
{
|
|
1477
|
-
"format": "date-time",
|
|
1065
|
+
"firstName": {
|
|
1478
1066
|
"type": "string"
|
|
1479
|
-
}
|
|
1480
|
-
]
|
|
1481
|
-
},
|
|
1482
|
-
"ppsn": {
|
|
1483
|
-
"default": null,
|
|
1484
|
-
"anyOf": [
|
|
1485
|
-
{
|
|
1486
|
-
"type": "null"
|
|
1487
1067
|
},
|
|
1488
|
-
{
|
|
1068
|
+
"lastName": {
|
|
1489
1069
|
"type": "string"
|
|
1490
|
-
}
|
|
1491
|
-
]
|
|
1492
|
-
},
|
|
1493
|
-
"ppsnVisible": {
|
|
1494
|
-
"default": false,
|
|
1495
|
-
"anyOf": [
|
|
1496
|
-
{
|
|
1497
|
-
"type": "null"
|
|
1498
1070
|
},
|
|
1499
|
-
{
|
|
1500
|
-
"type": "
|
|
1501
|
-
}
|
|
1502
|
-
]
|
|
1503
|
-
},
|
|
1504
|
-
"gender": {
|
|
1505
|
-
"default": null,
|
|
1506
|
-
"anyOf": [
|
|
1507
|
-
{
|
|
1508
|
-
"type": "null"
|
|
1071
|
+
"city": {
|
|
1072
|
+
"type": "string"
|
|
1509
1073
|
},
|
|
1510
|
-
{
|
|
1074
|
+
"address": {
|
|
1511
1075
|
"type": "string"
|
|
1512
|
-
}
|
|
1513
|
-
]
|
|
1514
|
-
},
|
|
1515
|
-
"email": {
|
|
1516
|
-
"format": "email",
|
|
1517
|
-
"type": "string"
|
|
1518
|
-
},
|
|
1519
|
-
"phone": {
|
|
1520
|
-
"default": null,
|
|
1521
|
-
"anyOf": [
|
|
1522
|
-
{
|
|
1523
|
-
"type": "null"
|
|
1524
1076
|
},
|
|
1525
|
-
{
|
|
1077
|
+
"phone": {
|
|
1078
|
+
"type": "string"
|
|
1079
|
+
},
|
|
1080
|
+
"dateOfBirth": {
|
|
1081
|
+
"format": "date",
|
|
1082
|
+
"type": "string"
|
|
1083
|
+
},
|
|
1084
|
+
"ppsn": {
|
|
1526
1085
|
"type": "string"
|
|
1527
|
-
}
|
|
1528
|
-
]
|
|
1529
|
-
},
|
|
1530
|
-
"consentToPrefillData": {
|
|
1531
|
-
"default": false,
|
|
1532
|
-
"anyOf": [
|
|
1533
|
-
{
|
|
1534
|
-
"type": "null"
|
|
1535
1086
|
},
|
|
1536
|
-
{
|
|
1537
|
-
"type": "
|
|
1087
|
+
"preferredLanguage": {
|
|
1088
|
+
"type": "string",
|
|
1089
|
+
"enum": [
|
|
1090
|
+
"en",
|
|
1091
|
+
"ga"
|
|
1092
|
+
],
|
|
1093
|
+
"default": "en"
|
|
1538
1094
|
}
|
|
1095
|
+
},
|
|
1096
|
+
"required": [
|
|
1097
|
+
"email",
|
|
1098
|
+
"firstName",
|
|
1099
|
+
"lastName"
|
|
1539
1100
|
]
|
|
1540
|
-
},
|
|
1541
|
-
"preferredLanguage": {
|
|
1542
|
-
"default": "en",
|
|
1543
|
-
"type": "string"
|
|
1544
1101
|
}
|
|
1545
1102
|
},
|
|
1546
1103
|
"required": [
|
|
1547
|
-
"
|
|
1548
|
-
"
|
|
1104
|
+
"id",
|
|
1105
|
+
"publicName",
|
|
1549
1106
|
"email",
|
|
1550
|
-
"
|
|
1107
|
+
"primaryUserId"
|
|
1551
1108
|
]
|
|
1552
1109
|
},
|
|
1553
1110
|
"metadata": {
|
|
@@ -1636,7 +1193,7 @@
|
|
|
1636
1193
|
}
|
|
1637
1194
|
}
|
|
1638
1195
|
},
|
|
1639
|
-
"
|
|
1196
|
+
"4XX": {
|
|
1640
1197
|
"description": "Default Response",
|
|
1641
1198
|
"content": {
|
|
1642
1199
|
"application/json": {
|
|
@@ -1644,33 +1201,59 @@
|
|
|
1644
1201
|
"type": "object",
|
|
1645
1202
|
"properties": {
|
|
1646
1203
|
"code": {
|
|
1204
|
+
"description": "Code used to categorize the error",
|
|
1647
1205
|
"type": "string"
|
|
1648
1206
|
},
|
|
1649
1207
|
"detail": {
|
|
1208
|
+
"description": "Description of the error",
|
|
1650
1209
|
"type": "string"
|
|
1651
1210
|
},
|
|
1652
1211
|
"requestId": {
|
|
1212
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1653
1213
|
"type": "string"
|
|
1654
1214
|
},
|
|
1655
1215
|
"name": {
|
|
1216
|
+
"description": "Name of the error type",
|
|
1656
1217
|
"type": "string"
|
|
1657
1218
|
},
|
|
1658
|
-
"validation": {
|
|
1219
|
+
"validation": {
|
|
1220
|
+
"description": "List of the validation errors",
|
|
1221
|
+
"type": "array",
|
|
1222
|
+
"items": {
|
|
1223
|
+
"type": "object",
|
|
1224
|
+
"properties": {
|
|
1225
|
+
"fieldName": {
|
|
1226
|
+
"type": "string"
|
|
1227
|
+
},
|
|
1228
|
+
"message": {
|
|
1229
|
+
"type": "string"
|
|
1230
|
+
}
|
|
1231
|
+
},
|
|
1232
|
+
"required": [
|
|
1233
|
+
"fieldName",
|
|
1234
|
+
"message"
|
|
1235
|
+
]
|
|
1236
|
+
}
|
|
1237
|
+
},
|
|
1659
1238
|
"validationContext": {
|
|
1660
1239
|
"type": "string"
|
|
1240
|
+
},
|
|
1241
|
+
"statusCode": {
|
|
1242
|
+
"type": "number"
|
|
1661
1243
|
}
|
|
1662
1244
|
},
|
|
1663
1245
|
"required": [
|
|
1664
1246
|
"code",
|
|
1665
1247
|
"detail",
|
|
1666
1248
|
"requestId",
|
|
1667
|
-
"name"
|
|
1249
|
+
"name",
|
|
1250
|
+
"statusCode"
|
|
1668
1251
|
]
|
|
1669
1252
|
}
|
|
1670
1253
|
}
|
|
1671
1254
|
}
|
|
1672
1255
|
},
|
|
1673
|
-
"
|
|
1256
|
+
"5XX": {
|
|
1674
1257
|
"description": "Default Response",
|
|
1675
1258
|
"content": {
|
|
1676
1259
|
"application/json": {
|
|
@@ -1678,103 +1261,118 @@
|
|
|
1678
1261
|
"type": "object",
|
|
1679
1262
|
"properties": {
|
|
1680
1263
|
"code": {
|
|
1264
|
+
"description": "Code used to categorize the error",
|
|
1681
1265
|
"type": "string"
|
|
1682
1266
|
},
|
|
1683
1267
|
"detail": {
|
|
1268
|
+
"description": "Description of the error",
|
|
1684
1269
|
"type": "string"
|
|
1685
1270
|
},
|
|
1686
1271
|
"requestId": {
|
|
1272
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1687
1273
|
"type": "string"
|
|
1688
1274
|
},
|
|
1689
1275
|
"name": {
|
|
1276
|
+
"description": "Name of the error type",
|
|
1690
1277
|
"type": "string"
|
|
1691
1278
|
},
|
|
1692
|
-
"validation": {
|
|
1279
|
+
"validation": {
|
|
1280
|
+
"description": "List of the validation errors",
|
|
1281
|
+
"type": "array",
|
|
1282
|
+
"items": {
|
|
1283
|
+
"type": "object",
|
|
1284
|
+
"properties": {
|
|
1285
|
+
"fieldName": {
|
|
1286
|
+
"type": "string"
|
|
1287
|
+
},
|
|
1288
|
+
"message": {
|
|
1289
|
+
"type": "string"
|
|
1290
|
+
}
|
|
1291
|
+
},
|
|
1292
|
+
"required": [
|
|
1293
|
+
"fieldName",
|
|
1294
|
+
"message"
|
|
1295
|
+
]
|
|
1296
|
+
}
|
|
1297
|
+
},
|
|
1693
1298
|
"validationContext": {
|
|
1694
1299
|
"type": "string"
|
|
1300
|
+
},
|
|
1301
|
+
"statusCode": {
|
|
1302
|
+
"type": "number"
|
|
1695
1303
|
}
|
|
1696
1304
|
},
|
|
1697
1305
|
"required": [
|
|
1698
1306
|
"code",
|
|
1699
1307
|
"detail",
|
|
1700
1308
|
"requestId",
|
|
1701
|
-
"name"
|
|
1309
|
+
"name",
|
|
1310
|
+
"statusCode"
|
|
1702
1311
|
]
|
|
1703
1312
|
}
|
|
1704
1313
|
}
|
|
1705
1314
|
}
|
|
1706
1315
|
}
|
|
1707
1316
|
}
|
|
1708
|
-
}
|
|
1709
|
-
|
|
1317
|
+
}
|
|
1318
|
+
},
|
|
1319
|
+
"/api/v1/profiles/imports": {
|
|
1320
|
+
"get": {
|
|
1710
1321
|
"tags": [
|
|
1711
|
-
"
|
|
1322
|
+
"profiles"
|
|
1712
1323
|
],
|
|
1713
|
-
"
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
"
|
|
1729
|
-
"
|
|
1730
|
-
|
|
1731
|
-
"dateOfBirth": {
|
|
1732
|
-
"type": "string"
|
|
1733
|
-
},
|
|
1734
|
-
"ppsn": {
|
|
1735
|
-
"type": "string"
|
|
1736
|
-
},
|
|
1737
|
-
"ppsnVisible": {
|
|
1738
|
-
"type": "boolean"
|
|
1739
|
-
},
|
|
1740
|
-
"gender": {
|
|
1741
|
-
"type": "string"
|
|
1742
|
-
},
|
|
1743
|
-
"phone": {
|
|
1744
|
-
"type": "string"
|
|
1745
|
-
},
|
|
1746
|
-
"consentToPrefillData": {
|
|
1747
|
-
"type": "boolean"
|
|
1748
|
-
},
|
|
1749
|
-
"preferredLanguage": {
|
|
1750
|
-
"type": "string"
|
|
1751
|
-
}
|
|
1324
|
+
"description": "List profile imports with pagination",
|
|
1325
|
+
"parameters": [
|
|
1326
|
+
{
|
|
1327
|
+
"schema": {
|
|
1328
|
+
"type": "string"
|
|
1329
|
+
},
|
|
1330
|
+
"in": "query",
|
|
1331
|
+
"name": "organizationId",
|
|
1332
|
+
"required": false
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
"schema": {
|
|
1336
|
+
"anyOf": [
|
|
1337
|
+
{
|
|
1338
|
+
"type": "string",
|
|
1339
|
+
"enum": [
|
|
1340
|
+
"csv"
|
|
1341
|
+
]
|
|
1752
1342
|
},
|
|
1753
|
-
|
|
1754
|
-
"
|
|
1755
|
-
"
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
]
|
|
1765
|
-
}
|
|
1766
|
-
}
|
|
1343
|
+
{
|
|
1344
|
+
"type": "string",
|
|
1345
|
+
"enum": [
|
|
1346
|
+
"json"
|
|
1347
|
+
]
|
|
1348
|
+
}
|
|
1349
|
+
]
|
|
1350
|
+
},
|
|
1351
|
+
"in": "query",
|
|
1352
|
+
"name": "source",
|
|
1353
|
+
"required": false
|
|
1767
1354
|
},
|
|
1768
|
-
"required": true
|
|
1769
|
-
},
|
|
1770
|
-
"parameters": [
|
|
1771
1355
|
{
|
|
1772
1356
|
"schema": {
|
|
1357
|
+
"pattern": "^[0-9][0-9]*|undefined$",
|
|
1358
|
+
"default": "0",
|
|
1773
1359
|
"type": "string"
|
|
1774
1360
|
},
|
|
1775
|
-
"in": "
|
|
1776
|
-
"name": "
|
|
1777
|
-
"required":
|
|
1361
|
+
"in": "query",
|
|
1362
|
+
"name": "offset",
|
|
1363
|
+
"required": false,
|
|
1364
|
+
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
1365
|
+
},
|
|
1366
|
+
{
|
|
1367
|
+
"schema": {
|
|
1368
|
+
"default": "20",
|
|
1369
|
+
"pattern": "^([1-9]|100)|undefined$",
|
|
1370
|
+
"type": "string"
|
|
1371
|
+
},
|
|
1372
|
+
"in": "query",
|
|
1373
|
+
"name": "limit",
|
|
1374
|
+
"required": false,
|
|
1375
|
+
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
1778
1376
|
}
|
|
1779
1377
|
],
|
|
1780
1378
|
"responses": {
|
|
@@ -1786,15 +1384,72 @@
|
|
|
1786
1384
|
"type": "object",
|
|
1787
1385
|
"properties": {
|
|
1788
1386
|
"data": {
|
|
1789
|
-
"type": "
|
|
1790
|
-
"
|
|
1791
|
-
"
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1387
|
+
"type": "array",
|
|
1388
|
+
"items": {
|
|
1389
|
+
"type": "object",
|
|
1390
|
+
"properties": {
|
|
1391
|
+
"id": {
|
|
1392
|
+
"format": "uuid",
|
|
1393
|
+
"type": "string"
|
|
1394
|
+
},
|
|
1395
|
+
"jobId": {
|
|
1396
|
+
"type": "string"
|
|
1397
|
+
},
|
|
1398
|
+
"organisationId": {
|
|
1399
|
+
"type": "string"
|
|
1400
|
+
},
|
|
1401
|
+
"status": {
|
|
1402
|
+
"type": "string"
|
|
1403
|
+
},
|
|
1404
|
+
"source": {
|
|
1405
|
+
"anyOf": [
|
|
1406
|
+
{
|
|
1407
|
+
"type": "string",
|
|
1408
|
+
"enum": [
|
|
1409
|
+
"csv"
|
|
1410
|
+
]
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"type": "string",
|
|
1414
|
+
"enum": [
|
|
1415
|
+
"json"
|
|
1416
|
+
]
|
|
1417
|
+
}
|
|
1418
|
+
]
|
|
1419
|
+
},
|
|
1420
|
+
"metadata": {
|
|
1421
|
+
"type": "object",
|
|
1422
|
+
"properties": {
|
|
1423
|
+
"filename": {
|
|
1424
|
+
"type": "string"
|
|
1425
|
+
},
|
|
1426
|
+
"mimetype": {
|
|
1427
|
+
"type": "string"
|
|
1428
|
+
}
|
|
1429
|
+
},
|
|
1430
|
+
"required": [
|
|
1431
|
+
"filename",
|
|
1432
|
+
"mimetype"
|
|
1433
|
+
]
|
|
1434
|
+
},
|
|
1435
|
+
"createdAt": {
|
|
1436
|
+
"format": "date-time",
|
|
1437
|
+
"type": "string"
|
|
1438
|
+
},
|
|
1439
|
+
"updatedAt": {
|
|
1440
|
+
"format": "date-time",
|
|
1441
|
+
"type": "string"
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
"required": [
|
|
1445
|
+
"id",
|
|
1446
|
+
"jobId",
|
|
1447
|
+
"status",
|
|
1448
|
+
"source",
|
|
1449
|
+
"createdAt",
|
|
1450
|
+
"updatedAt"
|
|
1451
|
+
]
|
|
1452
|
+
}
|
|
1798
1453
|
},
|
|
1799
1454
|
"metadata": {
|
|
1800
1455
|
"type": "object",
|
|
@@ -1882,7 +1537,7 @@
|
|
|
1882
1537
|
}
|
|
1883
1538
|
}
|
|
1884
1539
|
},
|
|
1885
|
-
"
|
|
1540
|
+
"4XX": {
|
|
1886
1541
|
"description": "Default Response",
|
|
1887
1542
|
"content": {
|
|
1888
1543
|
"application/json": {
|
|
@@ -1890,33 +1545,59 @@
|
|
|
1890
1545
|
"type": "object",
|
|
1891
1546
|
"properties": {
|
|
1892
1547
|
"code": {
|
|
1548
|
+
"description": "Code used to categorize the error",
|
|
1893
1549
|
"type": "string"
|
|
1894
1550
|
},
|
|
1895
1551
|
"detail": {
|
|
1552
|
+
"description": "Description of the error",
|
|
1896
1553
|
"type": "string"
|
|
1897
1554
|
},
|
|
1898
1555
|
"requestId": {
|
|
1556
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1899
1557
|
"type": "string"
|
|
1900
1558
|
},
|
|
1901
1559
|
"name": {
|
|
1560
|
+
"description": "Name of the error type",
|
|
1902
1561
|
"type": "string"
|
|
1903
1562
|
},
|
|
1904
|
-
"validation": {
|
|
1563
|
+
"validation": {
|
|
1564
|
+
"description": "List of the validation errors",
|
|
1565
|
+
"type": "array",
|
|
1566
|
+
"items": {
|
|
1567
|
+
"type": "object",
|
|
1568
|
+
"properties": {
|
|
1569
|
+
"fieldName": {
|
|
1570
|
+
"type": "string"
|
|
1571
|
+
},
|
|
1572
|
+
"message": {
|
|
1573
|
+
"type": "string"
|
|
1574
|
+
}
|
|
1575
|
+
},
|
|
1576
|
+
"required": [
|
|
1577
|
+
"fieldName",
|
|
1578
|
+
"message"
|
|
1579
|
+
]
|
|
1580
|
+
}
|
|
1581
|
+
},
|
|
1905
1582
|
"validationContext": {
|
|
1906
1583
|
"type": "string"
|
|
1584
|
+
},
|
|
1585
|
+
"statusCode": {
|
|
1586
|
+
"type": "number"
|
|
1907
1587
|
}
|
|
1908
1588
|
},
|
|
1909
1589
|
"required": [
|
|
1910
1590
|
"code",
|
|
1911
1591
|
"detail",
|
|
1912
1592
|
"requestId",
|
|
1913
|
-
"name"
|
|
1593
|
+
"name",
|
|
1594
|
+
"statusCode"
|
|
1914
1595
|
]
|
|
1915
1596
|
}
|
|
1916
1597
|
}
|
|
1917
1598
|
}
|
|
1918
1599
|
},
|
|
1919
|
-
"
|
|
1600
|
+
"5XX": {
|
|
1920
1601
|
"description": "Default Response",
|
|
1921
1602
|
"content": {
|
|
1922
1603
|
"application/json": {
|
|
@@ -1924,65 +1605,75 @@
|
|
|
1924
1605
|
"type": "object",
|
|
1925
1606
|
"properties": {
|
|
1926
1607
|
"code": {
|
|
1608
|
+
"description": "Code used to categorize the error",
|
|
1927
1609
|
"type": "string"
|
|
1928
1610
|
},
|
|
1929
1611
|
"detail": {
|
|
1612
|
+
"description": "Description of the error",
|
|
1930
1613
|
"type": "string"
|
|
1931
1614
|
},
|
|
1932
1615
|
"requestId": {
|
|
1616
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
1933
1617
|
"type": "string"
|
|
1934
1618
|
},
|
|
1935
1619
|
"name": {
|
|
1620
|
+
"description": "Name of the error type",
|
|
1936
1621
|
"type": "string"
|
|
1937
1622
|
},
|
|
1938
|
-
"validation": {
|
|
1623
|
+
"validation": {
|
|
1624
|
+
"description": "List of the validation errors",
|
|
1625
|
+
"type": "array",
|
|
1626
|
+
"items": {
|
|
1627
|
+
"type": "object",
|
|
1628
|
+
"properties": {
|
|
1629
|
+
"fieldName": {
|
|
1630
|
+
"type": "string"
|
|
1631
|
+
},
|
|
1632
|
+
"message": {
|
|
1633
|
+
"type": "string"
|
|
1634
|
+
}
|
|
1635
|
+
},
|
|
1636
|
+
"required": [
|
|
1637
|
+
"fieldName",
|
|
1638
|
+
"message"
|
|
1639
|
+
]
|
|
1640
|
+
}
|
|
1641
|
+
},
|
|
1939
1642
|
"validationContext": {
|
|
1940
1643
|
"type": "string"
|
|
1644
|
+
},
|
|
1645
|
+
"statusCode": {
|
|
1646
|
+
"type": "number"
|
|
1941
1647
|
}
|
|
1942
1648
|
},
|
|
1943
1649
|
"required": [
|
|
1944
1650
|
"code",
|
|
1945
1651
|
"detail",
|
|
1946
1652
|
"requestId",
|
|
1947
|
-
"name"
|
|
1653
|
+
"name",
|
|
1654
|
+
"statusCode"
|
|
1948
1655
|
]
|
|
1949
1656
|
}
|
|
1950
1657
|
}
|
|
1951
1658
|
}
|
|
1952
1659
|
}
|
|
1953
1660
|
}
|
|
1954
|
-
}
|
|
1955
|
-
|
|
1661
|
+
}
|
|
1662
|
+
},
|
|
1663
|
+
"/api/v1/profiles/imports/{importId}": {
|
|
1664
|
+
"get": {
|
|
1665
|
+
"operationId": "getProfileImportDetails",
|
|
1956
1666
|
"tags": [
|
|
1957
|
-
"
|
|
1667
|
+
"Profiles"
|
|
1958
1668
|
],
|
|
1959
|
-
"
|
|
1960
|
-
"content": {
|
|
1961
|
-
"application/json": {
|
|
1962
|
-
"schema": {
|
|
1963
|
-
"type": "object",
|
|
1964
|
-
"properties": {
|
|
1965
|
-
"ppsnVisible": {
|
|
1966
|
-
"type": "boolean"
|
|
1967
|
-
},
|
|
1968
|
-
"consentToPrefillData": {
|
|
1969
|
-
"type": "boolean"
|
|
1970
|
-
},
|
|
1971
|
-
"preferredLanguage": {
|
|
1972
|
-
"type": "string"
|
|
1973
|
-
}
|
|
1974
|
-
}
|
|
1975
|
-
}
|
|
1976
|
-
}
|
|
1977
|
-
}
|
|
1978
|
-
},
|
|
1669
|
+
"description": "Get details of profiles in a specific import",
|
|
1979
1670
|
"parameters": [
|
|
1980
1671
|
{
|
|
1981
1672
|
"schema": {
|
|
1982
1673
|
"type": "string"
|
|
1983
1674
|
},
|
|
1984
1675
|
"in": "path",
|
|
1985
|
-
"name": "
|
|
1676
|
+
"name": "importId",
|
|
1986
1677
|
"required": true
|
|
1987
1678
|
}
|
|
1988
1679
|
],
|
|
@@ -1993,17 +1684,53 @@
|
|
|
1993
1684
|
"application/json": {
|
|
1994
1685
|
"schema": {
|
|
1995
1686
|
"type": "object",
|
|
1996
|
-
"properties": {
|
|
1997
|
-
"data": {
|
|
1998
|
-
"type": "
|
|
1999
|
-
"
|
|
2000
|
-
"
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
|
|
1687
|
+
"properties": {
|
|
1688
|
+
"data": {
|
|
1689
|
+
"type": "array",
|
|
1690
|
+
"items": {
|
|
1691
|
+
"type": "object",
|
|
1692
|
+
"properties": {
|
|
1693
|
+
"email": {
|
|
1694
|
+
"format": "email",
|
|
1695
|
+
"type": "string"
|
|
1696
|
+
},
|
|
1697
|
+
"firstName": {
|
|
1698
|
+
"type": "string"
|
|
1699
|
+
},
|
|
1700
|
+
"lastName": {
|
|
1701
|
+
"type": "string"
|
|
1702
|
+
},
|
|
1703
|
+
"city": {
|
|
1704
|
+
"type": "string"
|
|
1705
|
+
},
|
|
1706
|
+
"address": {
|
|
1707
|
+
"type": "string"
|
|
1708
|
+
},
|
|
1709
|
+
"phone": {
|
|
1710
|
+
"type": "string"
|
|
1711
|
+
},
|
|
1712
|
+
"dateOfBirth": {
|
|
1713
|
+
"format": "date",
|
|
1714
|
+
"type": "string"
|
|
1715
|
+
},
|
|
1716
|
+
"ppsn": {
|
|
1717
|
+
"type": "string"
|
|
1718
|
+
},
|
|
1719
|
+
"preferredLanguage": {
|
|
1720
|
+
"type": "string",
|
|
1721
|
+
"enum": [
|
|
1722
|
+
"en",
|
|
1723
|
+
"ga"
|
|
1724
|
+
],
|
|
1725
|
+
"default": "en"
|
|
1726
|
+
}
|
|
1727
|
+
},
|
|
1728
|
+
"required": [
|
|
1729
|
+
"email",
|
|
1730
|
+
"firstName",
|
|
1731
|
+
"lastName"
|
|
1732
|
+
]
|
|
1733
|
+
}
|
|
2007
1734
|
},
|
|
2008
1735
|
"metadata": {
|
|
2009
1736
|
"type": "object",
|
|
@@ -2091,7 +1818,7 @@
|
|
|
2091
1818
|
}
|
|
2092
1819
|
}
|
|
2093
1820
|
},
|
|
2094
|
-
"
|
|
1821
|
+
"4XX": {
|
|
2095
1822
|
"description": "Default Response",
|
|
2096
1823
|
"content": {
|
|
2097
1824
|
"application/json": {
|
|
@@ -2099,33 +1826,59 @@
|
|
|
2099
1826
|
"type": "object",
|
|
2100
1827
|
"properties": {
|
|
2101
1828
|
"code": {
|
|
1829
|
+
"description": "Code used to categorize the error",
|
|
2102
1830
|
"type": "string"
|
|
2103
1831
|
},
|
|
2104
1832
|
"detail": {
|
|
1833
|
+
"description": "Description of the error",
|
|
2105
1834
|
"type": "string"
|
|
2106
1835
|
},
|
|
2107
1836
|
"requestId": {
|
|
1837
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2108
1838
|
"type": "string"
|
|
2109
1839
|
},
|
|
2110
1840
|
"name": {
|
|
1841
|
+
"description": "Name of the error type",
|
|
2111
1842
|
"type": "string"
|
|
2112
1843
|
},
|
|
2113
|
-
"validation": {
|
|
1844
|
+
"validation": {
|
|
1845
|
+
"description": "List of the validation errors",
|
|
1846
|
+
"type": "array",
|
|
1847
|
+
"items": {
|
|
1848
|
+
"type": "object",
|
|
1849
|
+
"properties": {
|
|
1850
|
+
"fieldName": {
|
|
1851
|
+
"type": "string"
|
|
1852
|
+
},
|
|
1853
|
+
"message": {
|
|
1854
|
+
"type": "string"
|
|
1855
|
+
}
|
|
1856
|
+
},
|
|
1857
|
+
"required": [
|
|
1858
|
+
"fieldName",
|
|
1859
|
+
"message"
|
|
1860
|
+
]
|
|
1861
|
+
}
|
|
1862
|
+
},
|
|
2114
1863
|
"validationContext": {
|
|
2115
1864
|
"type": "string"
|
|
1865
|
+
},
|
|
1866
|
+
"statusCode": {
|
|
1867
|
+
"type": "number"
|
|
2116
1868
|
}
|
|
2117
1869
|
},
|
|
2118
1870
|
"required": [
|
|
2119
1871
|
"code",
|
|
2120
1872
|
"detail",
|
|
2121
1873
|
"requestId",
|
|
2122
|
-
"name"
|
|
1874
|
+
"name",
|
|
1875
|
+
"statusCode"
|
|
2123
1876
|
]
|
|
2124
1877
|
}
|
|
2125
1878
|
}
|
|
2126
1879
|
}
|
|
2127
1880
|
},
|
|
2128
|
-
"
|
|
1881
|
+
"5XX": {
|
|
2129
1882
|
"description": "Default Response",
|
|
2130
1883
|
"content": {
|
|
2131
1884
|
"application/json": {
|
|
@@ -2133,27 +1886,53 @@
|
|
|
2133
1886
|
"type": "object",
|
|
2134
1887
|
"properties": {
|
|
2135
1888
|
"code": {
|
|
1889
|
+
"description": "Code used to categorize the error",
|
|
2136
1890
|
"type": "string"
|
|
2137
1891
|
},
|
|
2138
1892
|
"detail": {
|
|
1893
|
+
"description": "Description of the error",
|
|
2139
1894
|
"type": "string"
|
|
2140
1895
|
},
|
|
2141
1896
|
"requestId": {
|
|
1897
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2142
1898
|
"type": "string"
|
|
2143
1899
|
},
|
|
2144
1900
|
"name": {
|
|
1901
|
+
"description": "Name of the error type",
|
|
2145
1902
|
"type": "string"
|
|
2146
1903
|
},
|
|
2147
|
-
"validation": {
|
|
1904
|
+
"validation": {
|
|
1905
|
+
"description": "List of the validation errors",
|
|
1906
|
+
"type": "array",
|
|
1907
|
+
"items": {
|
|
1908
|
+
"type": "object",
|
|
1909
|
+
"properties": {
|
|
1910
|
+
"fieldName": {
|
|
1911
|
+
"type": "string"
|
|
1912
|
+
},
|
|
1913
|
+
"message": {
|
|
1914
|
+
"type": "string"
|
|
1915
|
+
}
|
|
1916
|
+
},
|
|
1917
|
+
"required": [
|
|
1918
|
+
"fieldName",
|
|
1919
|
+
"message"
|
|
1920
|
+
]
|
|
1921
|
+
}
|
|
1922
|
+
},
|
|
2148
1923
|
"validationContext": {
|
|
2149
1924
|
"type": "string"
|
|
1925
|
+
},
|
|
1926
|
+
"statusCode": {
|
|
1927
|
+
"type": "number"
|
|
2150
1928
|
}
|
|
2151
1929
|
},
|
|
2152
1930
|
"required": [
|
|
2153
1931
|
"code",
|
|
2154
1932
|
"detail",
|
|
2155
1933
|
"requestId",
|
|
2156
|
-
"name"
|
|
1934
|
+
"name",
|
|
1935
|
+
"statusCode"
|
|
2157
1936
|
]
|
|
2158
1937
|
}
|
|
2159
1938
|
}
|
|
@@ -2162,63 +1941,31 @@
|
|
|
2162
1941
|
}
|
|
2163
1942
|
}
|
|
2164
1943
|
},
|
|
2165
|
-
"/api/v1/
|
|
2166
|
-
"
|
|
1944
|
+
"/api/v1/profiles/{profileId}": {
|
|
1945
|
+
"get": {
|
|
1946
|
+
"operationId": "getProfile",
|
|
2167
1947
|
"tags": [
|
|
2168
|
-
"
|
|
1948
|
+
"Profiles"
|
|
2169
1949
|
],
|
|
2170
|
-
"
|
|
2171
|
-
|
|
2172
|
-
"
|
|
2173
|
-
"
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
},
|
|
2179
|
-
"lastname": {
|
|
2180
|
-
"type": "string"
|
|
2181
|
-
},
|
|
2182
|
-
"email": {
|
|
2183
|
-
"type": "string"
|
|
2184
|
-
},
|
|
2185
|
-
"title": {
|
|
2186
|
-
"type": "string"
|
|
2187
|
-
},
|
|
2188
|
-
"dateOfBirth": {
|
|
2189
|
-
"type": "string"
|
|
2190
|
-
},
|
|
2191
|
-
"ppsn": {
|
|
2192
|
-
"type": "string"
|
|
2193
|
-
},
|
|
2194
|
-
"ppsnVisible": {
|
|
2195
|
-
"type": "boolean"
|
|
2196
|
-
},
|
|
2197
|
-
"gender": {
|
|
2198
|
-
"type": "string"
|
|
2199
|
-
},
|
|
2200
|
-
"phone": {
|
|
2201
|
-
"type": "string"
|
|
2202
|
-
},
|
|
2203
|
-
"consentToPrefillData": {
|
|
2204
|
-
"type": "boolean"
|
|
2205
|
-
},
|
|
2206
|
-
"preferredLanguage": {
|
|
2207
|
-
"default": "en",
|
|
2208
|
-
"type": "string"
|
|
2209
|
-
}
|
|
2210
|
-
},
|
|
2211
|
-
"required": [
|
|
2212
|
-
"firstname",
|
|
2213
|
-
"lastname",
|
|
2214
|
-
"email",
|
|
2215
|
-
"preferredLanguage"
|
|
2216
|
-
]
|
|
2217
|
-
}
|
|
2218
|
-
}
|
|
1950
|
+
"parameters": [
|
|
1951
|
+
{
|
|
1952
|
+
"schema": {
|
|
1953
|
+
"type": "string"
|
|
1954
|
+
},
|
|
1955
|
+
"in": "query",
|
|
1956
|
+
"name": "organizationId",
|
|
1957
|
+
"required": false
|
|
2219
1958
|
},
|
|
2220
|
-
|
|
2221
|
-
|
|
1959
|
+
{
|
|
1960
|
+
"schema": {
|
|
1961
|
+
"type": "string"
|
|
1962
|
+
},
|
|
1963
|
+
"in": "path",
|
|
1964
|
+
"name": "profileId",
|
|
1965
|
+
"required": true,
|
|
1966
|
+
"description": "ID of the profile to retrieve"
|
|
1967
|
+
}
|
|
1968
|
+
],
|
|
2222
1969
|
"responses": {
|
|
2223
1970
|
"200": {
|
|
2224
1971
|
"description": "Default Response",
|
|
@@ -2232,10 +1979,86 @@
|
|
|
2232
1979
|
"properties": {
|
|
2233
1980
|
"id": {
|
|
2234
1981
|
"type": "string"
|
|
1982
|
+
},
|
|
1983
|
+
"publicName": {
|
|
1984
|
+
"type": "string"
|
|
1985
|
+
},
|
|
1986
|
+
"email": {
|
|
1987
|
+
"format": "email",
|
|
1988
|
+
"type": "string"
|
|
1989
|
+
},
|
|
1990
|
+
"primaryUserId": {
|
|
1991
|
+
"type": "string"
|
|
1992
|
+
},
|
|
1993
|
+
"safeLevel": {
|
|
1994
|
+
"type": "number"
|
|
1995
|
+
},
|
|
1996
|
+
"preferredLanguage": {
|
|
1997
|
+
"type": "string",
|
|
1998
|
+
"enum": [
|
|
1999
|
+
"en",
|
|
2000
|
+
"ga"
|
|
2001
|
+
],
|
|
2002
|
+
"default": "en"
|
|
2003
|
+
},
|
|
2004
|
+
"createdAt": {
|
|
2005
|
+
"format": "date-time",
|
|
2006
|
+
"type": "string"
|
|
2007
|
+
},
|
|
2008
|
+
"updatedAt": {
|
|
2009
|
+
"format": "date-time",
|
|
2010
|
+
"type": "string"
|
|
2011
|
+
},
|
|
2012
|
+
"details": {
|
|
2013
|
+
"type": "object",
|
|
2014
|
+
"properties": {
|
|
2015
|
+
"email": {
|
|
2016
|
+
"format": "email",
|
|
2017
|
+
"type": "string"
|
|
2018
|
+
},
|
|
2019
|
+
"firstName": {
|
|
2020
|
+
"type": "string"
|
|
2021
|
+
},
|
|
2022
|
+
"lastName": {
|
|
2023
|
+
"type": "string"
|
|
2024
|
+
},
|
|
2025
|
+
"city": {
|
|
2026
|
+
"type": "string"
|
|
2027
|
+
},
|
|
2028
|
+
"address": {
|
|
2029
|
+
"type": "string"
|
|
2030
|
+
},
|
|
2031
|
+
"phone": {
|
|
2032
|
+
"type": "string"
|
|
2033
|
+
},
|
|
2034
|
+
"dateOfBirth": {
|
|
2035
|
+
"format": "date",
|
|
2036
|
+
"type": "string"
|
|
2037
|
+
},
|
|
2038
|
+
"ppsn": {
|
|
2039
|
+
"type": "string"
|
|
2040
|
+
},
|
|
2041
|
+
"preferredLanguage": {
|
|
2042
|
+
"type": "string",
|
|
2043
|
+
"enum": [
|
|
2044
|
+
"en",
|
|
2045
|
+
"ga"
|
|
2046
|
+
],
|
|
2047
|
+
"default": "en"
|
|
2048
|
+
}
|
|
2049
|
+
},
|
|
2050
|
+
"required": [
|
|
2051
|
+
"email",
|
|
2052
|
+
"firstName",
|
|
2053
|
+
"lastName"
|
|
2054
|
+
]
|
|
2235
2055
|
}
|
|
2236
2056
|
},
|
|
2237
2057
|
"required": [
|
|
2238
|
-
"id"
|
|
2058
|
+
"id",
|
|
2059
|
+
"publicName",
|
|
2060
|
+
"email",
|
|
2061
|
+
"primaryUserId"
|
|
2239
2062
|
]
|
|
2240
2063
|
},
|
|
2241
2064
|
"metadata": {
|
|
@@ -2324,7 +2147,67 @@
|
|
|
2324
2147
|
}
|
|
2325
2148
|
}
|
|
2326
2149
|
},
|
|
2327
|
-
"
|
|
2150
|
+
"4XX": {
|
|
2151
|
+
"description": "Default Response",
|
|
2152
|
+
"content": {
|
|
2153
|
+
"application/json": {
|
|
2154
|
+
"schema": {
|
|
2155
|
+
"type": "object",
|
|
2156
|
+
"properties": {
|
|
2157
|
+
"code": {
|
|
2158
|
+
"description": "Code used to categorize the error",
|
|
2159
|
+
"type": "string"
|
|
2160
|
+
},
|
|
2161
|
+
"detail": {
|
|
2162
|
+
"description": "Description of the error",
|
|
2163
|
+
"type": "string"
|
|
2164
|
+
},
|
|
2165
|
+
"requestId": {
|
|
2166
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2167
|
+
"type": "string"
|
|
2168
|
+
},
|
|
2169
|
+
"name": {
|
|
2170
|
+
"description": "Name of the error type",
|
|
2171
|
+
"type": "string"
|
|
2172
|
+
},
|
|
2173
|
+
"validation": {
|
|
2174
|
+
"description": "List of the validation errors",
|
|
2175
|
+
"type": "array",
|
|
2176
|
+
"items": {
|
|
2177
|
+
"type": "object",
|
|
2178
|
+
"properties": {
|
|
2179
|
+
"fieldName": {
|
|
2180
|
+
"type": "string"
|
|
2181
|
+
},
|
|
2182
|
+
"message": {
|
|
2183
|
+
"type": "string"
|
|
2184
|
+
}
|
|
2185
|
+
},
|
|
2186
|
+
"required": [
|
|
2187
|
+
"fieldName",
|
|
2188
|
+
"message"
|
|
2189
|
+
]
|
|
2190
|
+
}
|
|
2191
|
+
},
|
|
2192
|
+
"validationContext": {
|
|
2193
|
+
"type": "string"
|
|
2194
|
+
},
|
|
2195
|
+
"statusCode": {
|
|
2196
|
+
"type": "number"
|
|
2197
|
+
}
|
|
2198
|
+
},
|
|
2199
|
+
"required": [
|
|
2200
|
+
"code",
|
|
2201
|
+
"detail",
|
|
2202
|
+
"requestId",
|
|
2203
|
+
"name",
|
|
2204
|
+
"statusCode"
|
|
2205
|
+
]
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
}
|
|
2209
|
+
},
|
|
2210
|
+
"5XX": {
|
|
2328
2211
|
"description": "Default Response",
|
|
2329
2212
|
"content": {
|
|
2330
2213
|
"application/json": {
|
|
@@ -2332,104 +2215,129 @@
|
|
|
2332
2215
|
"type": "object",
|
|
2333
2216
|
"properties": {
|
|
2334
2217
|
"code": {
|
|
2218
|
+
"description": "Code used to categorize the error",
|
|
2335
2219
|
"type": "string"
|
|
2336
2220
|
},
|
|
2337
2221
|
"detail": {
|
|
2222
|
+
"description": "Description of the error",
|
|
2338
2223
|
"type": "string"
|
|
2339
2224
|
},
|
|
2340
2225
|
"requestId": {
|
|
2226
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2341
2227
|
"type": "string"
|
|
2342
2228
|
},
|
|
2343
2229
|
"name": {
|
|
2230
|
+
"description": "Name of the error type",
|
|
2344
2231
|
"type": "string"
|
|
2345
2232
|
},
|
|
2346
|
-
"validation": {
|
|
2233
|
+
"validation": {
|
|
2234
|
+
"description": "List of the validation errors",
|
|
2235
|
+
"type": "array",
|
|
2236
|
+
"items": {
|
|
2237
|
+
"type": "object",
|
|
2238
|
+
"properties": {
|
|
2239
|
+
"fieldName": {
|
|
2240
|
+
"type": "string"
|
|
2241
|
+
},
|
|
2242
|
+
"message": {
|
|
2243
|
+
"type": "string"
|
|
2244
|
+
}
|
|
2245
|
+
},
|
|
2246
|
+
"required": [
|
|
2247
|
+
"fieldName",
|
|
2248
|
+
"message"
|
|
2249
|
+
]
|
|
2250
|
+
}
|
|
2251
|
+
},
|
|
2347
2252
|
"validationContext": {
|
|
2348
2253
|
"type": "string"
|
|
2254
|
+
},
|
|
2255
|
+
"statusCode": {
|
|
2256
|
+
"type": "number"
|
|
2349
2257
|
}
|
|
2350
2258
|
},
|
|
2351
2259
|
"required": [
|
|
2352
2260
|
"code",
|
|
2353
2261
|
"detail",
|
|
2354
2262
|
"requestId",
|
|
2355
|
-
"name"
|
|
2263
|
+
"name",
|
|
2264
|
+
"statusCode"
|
|
2356
2265
|
]
|
|
2357
2266
|
}
|
|
2358
2267
|
}
|
|
2359
2268
|
}
|
|
2360
2269
|
}
|
|
2361
|
-
}
|
|
2362
|
-
}
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2270
|
+
}
|
|
2271
|
+
},
|
|
2272
|
+
"put": {
|
|
2273
|
+
"operationId": "updateProfilePut",
|
|
2274
|
+
"tags": [
|
|
2275
|
+
"Profiles"
|
|
2276
|
+
],
|
|
2277
|
+
"requestBody": {
|
|
2278
|
+
"content": {
|
|
2279
|
+
"application/json": {
|
|
2280
|
+
"schema": {
|
|
2281
|
+
"additionalProperties": false,
|
|
2282
|
+
"type": "object",
|
|
2283
|
+
"properties": {
|
|
2284
|
+
"publicName": {
|
|
2285
|
+
"type": "string"
|
|
2286
|
+
},
|
|
2287
|
+
"email": {
|
|
2288
|
+
"format": "email",
|
|
2289
|
+
"type": "string"
|
|
2290
|
+
},
|
|
2291
|
+
"phone": {
|
|
2292
|
+
"type": "string"
|
|
2293
|
+
},
|
|
2294
|
+
"address": {
|
|
2295
|
+
"type": "string"
|
|
2296
|
+
},
|
|
2297
|
+
"city": {
|
|
2298
|
+
"type": "string"
|
|
2299
|
+
},
|
|
2300
|
+
"firstName": {
|
|
2301
|
+
"type": "string"
|
|
2302
|
+
},
|
|
2303
|
+
"lastName": {
|
|
2304
|
+
"type": "string"
|
|
2305
|
+
},
|
|
2306
|
+
"dateOfBirth": {
|
|
2307
|
+
"format": "date",
|
|
2308
|
+
"type": "string"
|
|
2309
|
+
},
|
|
2310
|
+
"preferredLanguage": {
|
|
2311
|
+
"type": "string",
|
|
2312
|
+
"enum": [
|
|
2313
|
+
"en",
|
|
2314
|
+
"ga"
|
|
2315
|
+
],
|
|
2316
|
+
"default": "en"
|
|
2317
|
+
}
|
|
2318
|
+
}
|
|
2319
|
+
}
|
|
2320
|
+
}
|
|
2321
|
+
}
|
|
2322
|
+
},
|
|
2369
2323
|
"parameters": [
|
|
2370
2324
|
{
|
|
2371
2325
|
"schema": {
|
|
2372
2326
|
"type": "string"
|
|
2373
2327
|
},
|
|
2374
2328
|
"in": "query",
|
|
2375
|
-
"name": "
|
|
2376
|
-
"required": false
|
|
2377
|
-
|
|
2378
|
-
{
|
|
2379
|
-
"schema": {
|
|
2380
|
-
"type": "string"
|
|
2381
|
-
},
|
|
2382
|
-
"in": "query",
|
|
2383
|
-
"name": "lastname",
|
|
2384
|
-
"required": false
|
|
2385
|
-
},
|
|
2386
|
-
{
|
|
2387
|
-
"schema": {
|
|
2388
|
-
"type": "string"
|
|
2389
|
-
},
|
|
2390
|
-
"in": "query",
|
|
2391
|
-
"name": "email",
|
|
2392
|
-
"required": false
|
|
2393
|
-
},
|
|
2394
|
-
{
|
|
2395
|
-
"schema": {
|
|
2396
|
-
"type": "string"
|
|
2397
|
-
},
|
|
2398
|
-
"in": "query",
|
|
2399
|
-
"name": "dateOfBirth",
|
|
2400
|
-
"required": false
|
|
2401
|
-
},
|
|
2402
|
-
{
|
|
2403
|
-
"schema": {
|
|
2404
|
-
"type": "string"
|
|
2405
|
-
},
|
|
2406
|
-
"in": "query",
|
|
2407
|
-
"name": "ppsn",
|
|
2408
|
-
"required": false
|
|
2329
|
+
"name": "organizationId",
|
|
2330
|
+
"required": false,
|
|
2331
|
+
"description": "Organization ID owning the profile"
|
|
2409
2332
|
},
|
|
2410
2333
|
{
|
|
2411
2334
|
"schema": {
|
|
2412
2335
|
"type": "string"
|
|
2413
2336
|
},
|
|
2414
|
-
"in": "
|
|
2415
|
-
"name": "
|
|
2416
|
-
"required":
|
|
2417
|
-
|
|
2418
|
-
{
|
|
2419
|
-
"schema": {
|
|
2420
|
-
"type": "string"
|
|
2421
|
-
},
|
|
2422
|
-
"in": "query",
|
|
2423
|
-
"name": "phone",
|
|
2424
|
-
"required": false
|
|
2425
|
-
},
|
|
2426
|
-
{
|
|
2427
|
-
"schema": {
|
|
2428
|
-
"type": "boolean"
|
|
2429
|
-
},
|
|
2430
|
-
"in": "query",
|
|
2431
|
-
"name": "strict",
|
|
2432
|
-
"required": false
|
|
2337
|
+
"in": "path",
|
|
2338
|
+
"name": "profileId",
|
|
2339
|
+
"required": true,
|
|
2340
|
+
"description": "ID of the profile to update"
|
|
2433
2341
|
}
|
|
2434
2342
|
],
|
|
2435
2343
|
"responses": {
|
|
@@ -2446,34 +2354,85 @@
|
|
|
2446
2354
|
"id": {
|
|
2447
2355
|
"type": "string"
|
|
2448
2356
|
},
|
|
2449
|
-
"
|
|
2357
|
+
"publicName": {
|
|
2450
2358
|
"type": "string"
|
|
2451
2359
|
},
|
|
2452
|
-
"
|
|
2360
|
+
"email": {
|
|
2361
|
+
"format": "email",
|
|
2453
2362
|
"type": "string"
|
|
2454
2363
|
},
|
|
2455
|
-
"
|
|
2456
|
-
"
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
|
|
2364
|
+
"primaryUserId": {
|
|
2365
|
+
"type": "string"
|
|
2366
|
+
},
|
|
2367
|
+
"safeLevel": {
|
|
2368
|
+
"type": "number"
|
|
2369
|
+
},
|
|
2370
|
+
"preferredLanguage": {
|
|
2371
|
+
"type": "string",
|
|
2372
|
+
"enum": [
|
|
2373
|
+
"en",
|
|
2374
|
+
"ga"
|
|
2375
|
+
],
|
|
2376
|
+
"default": "en"
|
|
2377
|
+
},
|
|
2378
|
+
"createdAt": {
|
|
2379
|
+
"format": "date-time",
|
|
2380
|
+
"type": "string"
|
|
2381
|
+
},
|
|
2382
|
+
"updatedAt": {
|
|
2383
|
+
"format": "date-time",
|
|
2384
|
+
"type": "string"
|
|
2385
|
+
},
|
|
2386
|
+
"details": {
|
|
2387
|
+
"type": "object",
|
|
2388
|
+
"properties": {
|
|
2389
|
+
"email": {
|
|
2390
|
+
"format": "email",
|
|
2391
|
+
"type": "string"
|
|
2392
|
+
},
|
|
2393
|
+
"firstName": {
|
|
2394
|
+
"type": "string"
|
|
2395
|
+
},
|
|
2396
|
+
"lastName": {
|
|
2397
|
+
"type": "string"
|
|
2462
2398
|
},
|
|
2463
|
-
{
|
|
2399
|
+
"city": {
|
|
2400
|
+
"type": "string"
|
|
2401
|
+
},
|
|
2402
|
+
"address": {
|
|
2403
|
+
"type": "string"
|
|
2404
|
+
},
|
|
2405
|
+
"phone": {
|
|
2406
|
+
"type": "string"
|
|
2407
|
+
},
|
|
2408
|
+
"dateOfBirth": {
|
|
2409
|
+
"format": "date",
|
|
2410
|
+
"type": "string"
|
|
2411
|
+
},
|
|
2412
|
+
"ppsn": {
|
|
2413
|
+
"type": "string"
|
|
2414
|
+
},
|
|
2415
|
+
"preferredLanguage": {
|
|
2464
2416
|
"type": "string",
|
|
2465
2417
|
"enum": [
|
|
2466
|
-
"
|
|
2467
|
-
|
|
2418
|
+
"en",
|
|
2419
|
+
"ga"
|
|
2420
|
+
],
|
|
2421
|
+
"default": "en"
|
|
2468
2422
|
}
|
|
2423
|
+
},
|
|
2424
|
+
"required": [
|
|
2425
|
+
"email",
|
|
2426
|
+
"firstName",
|
|
2427
|
+
"lastName"
|
|
2469
2428
|
]
|
|
2470
2429
|
}
|
|
2471
2430
|
},
|
|
2472
2431
|
"required": [
|
|
2473
2432
|
"id",
|
|
2474
|
-
"
|
|
2475
|
-
"
|
|
2476
|
-
"
|
|
2433
|
+
"publicName",
|
|
2434
|
+
"email",
|
|
2435
|
+
"primaryUserId"
|
|
2477
2436
|
]
|
|
2478
2437
|
},
|
|
2479
2438
|
"metadata": {
|
|
@@ -2562,7 +2521,7 @@
|
|
|
2562
2521
|
}
|
|
2563
2522
|
}
|
|
2564
2523
|
},
|
|
2565
|
-
"
|
|
2524
|
+
"4XX": {
|
|
2566
2525
|
"description": "Default Response",
|
|
2567
2526
|
"content": {
|
|
2568
2527
|
"application/json": {
|
|
@@ -2570,33 +2529,59 @@
|
|
|
2570
2529
|
"type": "object",
|
|
2571
2530
|
"properties": {
|
|
2572
2531
|
"code": {
|
|
2532
|
+
"description": "Code used to categorize the error",
|
|
2573
2533
|
"type": "string"
|
|
2574
2534
|
},
|
|
2575
2535
|
"detail": {
|
|
2536
|
+
"description": "Description of the error",
|
|
2576
2537
|
"type": "string"
|
|
2577
2538
|
},
|
|
2578
2539
|
"requestId": {
|
|
2540
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2579
2541
|
"type": "string"
|
|
2580
2542
|
},
|
|
2581
2543
|
"name": {
|
|
2544
|
+
"description": "Name of the error type",
|
|
2582
2545
|
"type": "string"
|
|
2583
2546
|
},
|
|
2584
|
-
"validation": {
|
|
2547
|
+
"validation": {
|
|
2548
|
+
"description": "List of the validation errors",
|
|
2549
|
+
"type": "array",
|
|
2550
|
+
"items": {
|
|
2551
|
+
"type": "object",
|
|
2552
|
+
"properties": {
|
|
2553
|
+
"fieldName": {
|
|
2554
|
+
"type": "string"
|
|
2555
|
+
},
|
|
2556
|
+
"message": {
|
|
2557
|
+
"type": "string"
|
|
2558
|
+
}
|
|
2559
|
+
},
|
|
2560
|
+
"required": [
|
|
2561
|
+
"fieldName",
|
|
2562
|
+
"message"
|
|
2563
|
+
]
|
|
2564
|
+
}
|
|
2565
|
+
},
|
|
2585
2566
|
"validationContext": {
|
|
2586
2567
|
"type": "string"
|
|
2568
|
+
},
|
|
2569
|
+
"statusCode": {
|
|
2570
|
+
"type": "number"
|
|
2587
2571
|
}
|
|
2588
2572
|
},
|
|
2589
2573
|
"required": [
|
|
2590
2574
|
"code",
|
|
2591
2575
|
"detail",
|
|
2592
2576
|
"requestId",
|
|
2593
|
-
"name"
|
|
2577
|
+
"name",
|
|
2578
|
+
"statusCode"
|
|
2594
2579
|
]
|
|
2595
2580
|
}
|
|
2596
2581
|
}
|
|
2597
2582
|
}
|
|
2598
2583
|
},
|
|
2599
|
-
"
|
|
2584
|
+
"5XX": {
|
|
2600
2585
|
"description": "Default Response",
|
|
2601
2586
|
"content": {
|
|
2602
2587
|
"application/json": {
|
|
@@ -2604,61 +2589,131 @@
|
|
|
2604
2589
|
"type": "object",
|
|
2605
2590
|
"properties": {
|
|
2606
2591
|
"code": {
|
|
2592
|
+
"description": "Code used to categorize the error",
|
|
2607
2593
|
"type": "string"
|
|
2608
2594
|
},
|
|
2609
2595
|
"detail": {
|
|
2596
|
+
"description": "Description of the error",
|
|
2610
2597
|
"type": "string"
|
|
2611
2598
|
},
|
|
2612
2599
|
"requestId": {
|
|
2600
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2613
2601
|
"type": "string"
|
|
2614
2602
|
},
|
|
2615
2603
|
"name": {
|
|
2604
|
+
"description": "Name of the error type",
|
|
2616
2605
|
"type": "string"
|
|
2617
2606
|
},
|
|
2618
|
-
"validation": {
|
|
2607
|
+
"validation": {
|
|
2608
|
+
"description": "List of the validation errors",
|
|
2609
|
+
"type": "array",
|
|
2610
|
+
"items": {
|
|
2611
|
+
"type": "object",
|
|
2612
|
+
"properties": {
|
|
2613
|
+
"fieldName": {
|
|
2614
|
+
"type": "string"
|
|
2615
|
+
},
|
|
2616
|
+
"message": {
|
|
2617
|
+
"type": "string"
|
|
2618
|
+
}
|
|
2619
|
+
},
|
|
2620
|
+
"required": [
|
|
2621
|
+
"fieldName",
|
|
2622
|
+
"message"
|
|
2623
|
+
]
|
|
2624
|
+
}
|
|
2625
|
+
},
|
|
2619
2626
|
"validationContext": {
|
|
2620
2627
|
"type": "string"
|
|
2628
|
+
},
|
|
2629
|
+
"statusCode": {
|
|
2630
|
+
"type": "number"
|
|
2621
2631
|
}
|
|
2622
2632
|
},
|
|
2623
2633
|
"required": [
|
|
2624
2634
|
"code",
|
|
2625
2635
|
"detail",
|
|
2626
2636
|
"requestId",
|
|
2627
|
-
"name"
|
|
2637
|
+
"name",
|
|
2638
|
+
"statusCode"
|
|
2628
2639
|
]
|
|
2629
2640
|
}
|
|
2630
2641
|
}
|
|
2631
2642
|
}
|
|
2632
2643
|
}
|
|
2633
2644
|
}
|
|
2634
|
-
}
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
"post": {
|
|
2645
|
+
},
|
|
2646
|
+
"patch": {
|
|
2647
|
+
"operationId": "updateProfilePatch",
|
|
2638
2648
|
"tags": [
|
|
2639
|
-
"
|
|
2649
|
+
"Profiles"
|
|
2640
2650
|
],
|
|
2641
2651
|
"requestBody": {
|
|
2642
2652
|
"content": {
|
|
2643
2653
|
"application/json": {
|
|
2644
2654
|
"schema": {
|
|
2655
|
+
"additionalProperties": false,
|
|
2645
2656
|
"type": "object",
|
|
2646
2657
|
"properties": {
|
|
2647
|
-
"
|
|
2648
|
-
"type": "
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2658
|
+
"publicName": {
|
|
2659
|
+
"type": "string"
|
|
2660
|
+
},
|
|
2661
|
+
"email": {
|
|
2662
|
+
"format": "email",
|
|
2663
|
+
"type": "string"
|
|
2664
|
+
},
|
|
2665
|
+
"phone": {
|
|
2666
|
+
"type": "string"
|
|
2667
|
+
},
|
|
2668
|
+
"address": {
|
|
2669
|
+
"type": "string"
|
|
2670
|
+
},
|
|
2671
|
+
"city": {
|
|
2672
|
+
"type": "string"
|
|
2673
|
+
},
|
|
2674
|
+
"firstName": {
|
|
2675
|
+
"type": "string"
|
|
2676
|
+
},
|
|
2677
|
+
"lastName": {
|
|
2678
|
+
"type": "string"
|
|
2679
|
+
},
|
|
2680
|
+
"dateOfBirth": {
|
|
2681
|
+
"format": "date",
|
|
2682
|
+
"type": "string"
|
|
2683
|
+
},
|
|
2684
|
+
"preferredLanguage": {
|
|
2685
|
+
"type": "string",
|
|
2686
|
+
"enum": [
|
|
2687
|
+
"en",
|
|
2688
|
+
"ga"
|
|
2689
|
+
],
|
|
2690
|
+
"default": "en"
|
|
2652
2691
|
}
|
|
2653
|
-
}
|
|
2654
|
-
"required": [
|
|
2655
|
-
"ids"
|
|
2656
|
-
]
|
|
2692
|
+
}
|
|
2657
2693
|
}
|
|
2658
2694
|
}
|
|
2659
|
-
}
|
|
2660
|
-
"required": true
|
|
2695
|
+
}
|
|
2661
2696
|
},
|
|
2697
|
+
"parameters": [
|
|
2698
|
+
{
|
|
2699
|
+
"schema": {
|
|
2700
|
+
"type": "string"
|
|
2701
|
+
},
|
|
2702
|
+
"in": "query",
|
|
2703
|
+
"name": "organizationId",
|
|
2704
|
+
"required": false,
|
|
2705
|
+
"description": "Organization ID owning the profile"
|
|
2706
|
+
},
|
|
2707
|
+
{
|
|
2708
|
+
"schema": {
|
|
2709
|
+
"type": "string"
|
|
2710
|
+
},
|
|
2711
|
+
"in": "path",
|
|
2712
|
+
"name": "profileId",
|
|
2713
|
+
"required": true,
|
|
2714
|
+
"description": "ID of the profile to update"
|
|
2715
|
+
}
|
|
2716
|
+
],
|
|
2662
2717
|
"responses": {
|
|
2663
2718
|
"200": {
|
|
2664
2719
|
"description": "Default Response",
|
|
@@ -2668,41 +2723,91 @@
|
|
|
2668
2723
|
"type": "object",
|
|
2669
2724
|
"properties": {
|
|
2670
2725
|
"data": {
|
|
2671
|
-
"type": "
|
|
2672
|
-
"
|
|
2673
|
-
"
|
|
2674
|
-
|
|
2675
|
-
"id": {
|
|
2676
|
-
"type": "string"
|
|
2677
|
-
},
|
|
2678
|
-
"firstName": {
|
|
2679
|
-
"type": "string"
|
|
2680
|
-
},
|
|
2681
|
-
"lastName": {
|
|
2682
|
-
"type": "string"
|
|
2683
|
-
},
|
|
2684
|
-
"ppsn": {
|
|
2685
|
-
"type": "string"
|
|
2686
|
-
},
|
|
2687
|
-
"email": {
|
|
2688
|
-
"format": "email",
|
|
2689
|
-
"type": "string"
|
|
2690
|
-
},
|
|
2691
|
-
"phone": {
|
|
2692
|
-
"type": "string"
|
|
2693
|
-
},
|
|
2694
|
-
"preferredLanguage": {
|
|
2695
|
-
"type": "string"
|
|
2696
|
-
}
|
|
2726
|
+
"type": "object",
|
|
2727
|
+
"properties": {
|
|
2728
|
+
"id": {
|
|
2729
|
+
"type": "string"
|
|
2697
2730
|
},
|
|
2698
|
-
"
|
|
2699
|
-
"
|
|
2700
|
-
|
|
2701
|
-
|
|
2702
|
-
"
|
|
2703
|
-
"
|
|
2704
|
-
|
|
2705
|
-
|
|
2731
|
+
"publicName": {
|
|
2732
|
+
"type": "string"
|
|
2733
|
+
},
|
|
2734
|
+
"email": {
|
|
2735
|
+
"format": "email",
|
|
2736
|
+
"type": "string"
|
|
2737
|
+
},
|
|
2738
|
+
"primaryUserId": {
|
|
2739
|
+
"type": "string"
|
|
2740
|
+
},
|
|
2741
|
+
"safeLevel": {
|
|
2742
|
+
"type": "number"
|
|
2743
|
+
},
|
|
2744
|
+
"preferredLanguage": {
|
|
2745
|
+
"type": "string",
|
|
2746
|
+
"enum": [
|
|
2747
|
+
"en",
|
|
2748
|
+
"ga"
|
|
2749
|
+
],
|
|
2750
|
+
"default": "en"
|
|
2751
|
+
},
|
|
2752
|
+
"createdAt": {
|
|
2753
|
+
"format": "date-time",
|
|
2754
|
+
"type": "string"
|
|
2755
|
+
},
|
|
2756
|
+
"updatedAt": {
|
|
2757
|
+
"format": "date-time",
|
|
2758
|
+
"type": "string"
|
|
2759
|
+
},
|
|
2760
|
+
"details": {
|
|
2761
|
+
"type": "object",
|
|
2762
|
+
"properties": {
|
|
2763
|
+
"email": {
|
|
2764
|
+
"format": "email",
|
|
2765
|
+
"type": "string"
|
|
2766
|
+
},
|
|
2767
|
+
"firstName": {
|
|
2768
|
+
"type": "string"
|
|
2769
|
+
},
|
|
2770
|
+
"lastName": {
|
|
2771
|
+
"type": "string"
|
|
2772
|
+
},
|
|
2773
|
+
"city": {
|
|
2774
|
+
"type": "string"
|
|
2775
|
+
},
|
|
2776
|
+
"address": {
|
|
2777
|
+
"type": "string"
|
|
2778
|
+
},
|
|
2779
|
+
"phone": {
|
|
2780
|
+
"type": "string"
|
|
2781
|
+
},
|
|
2782
|
+
"dateOfBirth": {
|
|
2783
|
+
"format": "date",
|
|
2784
|
+
"type": "string"
|
|
2785
|
+
},
|
|
2786
|
+
"ppsn": {
|
|
2787
|
+
"type": "string"
|
|
2788
|
+
},
|
|
2789
|
+
"preferredLanguage": {
|
|
2790
|
+
"type": "string",
|
|
2791
|
+
"enum": [
|
|
2792
|
+
"en",
|
|
2793
|
+
"ga"
|
|
2794
|
+
],
|
|
2795
|
+
"default": "en"
|
|
2796
|
+
}
|
|
2797
|
+
},
|
|
2798
|
+
"required": [
|
|
2799
|
+
"email",
|
|
2800
|
+
"firstName",
|
|
2801
|
+
"lastName"
|
|
2802
|
+
]
|
|
2803
|
+
}
|
|
2804
|
+
},
|
|
2805
|
+
"required": [
|
|
2806
|
+
"id",
|
|
2807
|
+
"publicName",
|
|
2808
|
+
"email",
|
|
2809
|
+
"primaryUserId"
|
|
2810
|
+
]
|
|
2706
2811
|
},
|
|
2707
2812
|
"metadata": {
|
|
2708
2813
|
"type": "object",
|
|
@@ -2798,27 +2903,53 @@
|
|
|
2798
2903
|
"type": "object",
|
|
2799
2904
|
"properties": {
|
|
2800
2905
|
"code": {
|
|
2906
|
+
"description": "Code used to categorize the error",
|
|
2801
2907
|
"type": "string"
|
|
2802
2908
|
},
|
|
2803
2909
|
"detail": {
|
|
2910
|
+
"description": "Description of the error",
|
|
2804
2911
|
"type": "string"
|
|
2805
2912
|
},
|
|
2806
2913
|
"requestId": {
|
|
2914
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2807
2915
|
"type": "string"
|
|
2808
2916
|
},
|
|
2809
2917
|
"name": {
|
|
2918
|
+
"description": "Name of the error type",
|
|
2810
2919
|
"type": "string"
|
|
2811
2920
|
},
|
|
2812
|
-
"validation": {
|
|
2921
|
+
"validation": {
|
|
2922
|
+
"description": "List of the validation errors",
|
|
2923
|
+
"type": "array",
|
|
2924
|
+
"items": {
|
|
2925
|
+
"type": "object",
|
|
2926
|
+
"properties": {
|
|
2927
|
+
"fieldName": {
|
|
2928
|
+
"type": "string"
|
|
2929
|
+
},
|
|
2930
|
+
"message": {
|
|
2931
|
+
"type": "string"
|
|
2932
|
+
}
|
|
2933
|
+
},
|
|
2934
|
+
"required": [
|
|
2935
|
+
"fieldName",
|
|
2936
|
+
"message"
|
|
2937
|
+
]
|
|
2938
|
+
}
|
|
2939
|
+
},
|
|
2813
2940
|
"validationContext": {
|
|
2814
2941
|
"type": "string"
|
|
2942
|
+
},
|
|
2943
|
+
"statusCode": {
|
|
2944
|
+
"type": "number"
|
|
2815
2945
|
}
|
|
2816
2946
|
},
|
|
2817
2947
|
"required": [
|
|
2818
2948
|
"code",
|
|
2819
2949
|
"detail",
|
|
2820
2950
|
"requestId",
|
|
2821
|
-
"name"
|
|
2951
|
+
"name",
|
|
2952
|
+
"statusCode"
|
|
2822
2953
|
]
|
|
2823
2954
|
}
|
|
2824
2955
|
}
|
|
@@ -2832,27 +2963,53 @@
|
|
|
2832
2963
|
"type": "object",
|
|
2833
2964
|
"properties": {
|
|
2834
2965
|
"code": {
|
|
2966
|
+
"description": "Code used to categorize the error",
|
|
2835
2967
|
"type": "string"
|
|
2836
2968
|
},
|
|
2837
2969
|
"detail": {
|
|
2970
|
+
"description": "Description of the error",
|
|
2838
2971
|
"type": "string"
|
|
2839
2972
|
},
|
|
2840
2973
|
"requestId": {
|
|
2974
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
2841
2975
|
"type": "string"
|
|
2842
2976
|
},
|
|
2843
2977
|
"name": {
|
|
2978
|
+
"description": "Name of the error type",
|
|
2844
2979
|
"type": "string"
|
|
2845
2980
|
},
|
|
2846
|
-
"validation": {
|
|
2981
|
+
"validation": {
|
|
2982
|
+
"description": "List of the validation errors",
|
|
2983
|
+
"type": "array",
|
|
2984
|
+
"items": {
|
|
2985
|
+
"type": "object",
|
|
2986
|
+
"properties": {
|
|
2987
|
+
"fieldName": {
|
|
2988
|
+
"type": "string"
|
|
2989
|
+
},
|
|
2990
|
+
"message": {
|
|
2991
|
+
"type": "string"
|
|
2992
|
+
}
|
|
2993
|
+
},
|
|
2994
|
+
"required": [
|
|
2995
|
+
"fieldName",
|
|
2996
|
+
"message"
|
|
2997
|
+
]
|
|
2998
|
+
}
|
|
2999
|
+
},
|
|
2847
3000
|
"validationContext": {
|
|
2848
3001
|
"type": "string"
|
|
3002
|
+
},
|
|
3003
|
+
"statusCode": {
|
|
3004
|
+
"type": "number"
|
|
2849
3005
|
}
|
|
2850
3006
|
},
|
|
2851
3007
|
"required": [
|
|
2852
3008
|
"code",
|
|
2853
3009
|
"detail",
|
|
2854
3010
|
"requestId",
|
|
2855
|
-
"name"
|
|
3011
|
+
"name",
|
|
3012
|
+
"statusCode"
|
|
2856
3013
|
]
|
|
2857
3014
|
}
|
|
2858
3015
|
}
|
|
@@ -2860,17 +3017,442 @@
|
|
|
2860
3017
|
}
|
|
2861
3018
|
}
|
|
2862
3019
|
}
|
|
2863
|
-
}
|
|
2864
|
-
},
|
|
2865
|
-
"tags": [
|
|
2866
|
-
{
|
|
2867
|
-
"name": "User"
|
|
2868
3020
|
},
|
|
2869
|
-
{
|
|
2870
|
-
"
|
|
3021
|
+
"/api/v1/profiles/imports/template": {
|
|
3022
|
+
"get": {
|
|
3023
|
+
"operationId": "getProfileTemplate",
|
|
3024
|
+
"tags": [
|
|
3025
|
+
"Profiles"
|
|
3026
|
+
],
|
|
3027
|
+
"responses": {
|
|
3028
|
+
"200": {
|
|
3029
|
+
"description": "Default Response",
|
|
3030
|
+
"content": {
|
|
3031
|
+
"text/csv": {
|
|
3032
|
+
"schema": {
|
|
3033
|
+
"type": "object",
|
|
3034
|
+
"properties": {
|
|
3035
|
+
"type": {
|
|
3036
|
+
"type": "string",
|
|
3037
|
+
"enum": [
|
|
3038
|
+
"Buffer"
|
|
3039
|
+
]
|
|
3040
|
+
},
|
|
3041
|
+
"data": {
|
|
3042
|
+
"type": "array",
|
|
3043
|
+
"items": {
|
|
3044
|
+
"type": "number"
|
|
3045
|
+
}
|
|
3046
|
+
}
|
|
3047
|
+
},
|
|
3048
|
+
"required": [
|
|
3049
|
+
"type",
|
|
3050
|
+
"data"
|
|
3051
|
+
]
|
|
3052
|
+
}
|
|
3053
|
+
}
|
|
3054
|
+
}
|
|
3055
|
+
},
|
|
3056
|
+
"4XX": {
|
|
3057
|
+
"description": "Default Response",
|
|
3058
|
+
"content": {
|
|
3059
|
+
"text/csv": {
|
|
3060
|
+
"schema": {
|
|
3061
|
+
"type": "object",
|
|
3062
|
+
"properties": {
|
|
3063
|
+
"code": {
|
|
3064
|
+
"description": "Code used to categorize the error",
|
|
3065
|
+
"type": "string"
|
|
3066
|
+
},
|
|
3067
|
+
"detail": {
|
|
3068
|
+
"description": "Description of the error",
|
|
3069
|
+
"type": "string"
|
|
3070
|
+
},
|
|
3071
|
+
"requestId": {
|
|
3072
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
3073
|
+
"type": "string"
|
|
3074
|
+
},
|
|
3075
|
+
"name": {
|
|
3076
|
+
"description": "Name of the error type",
|
|
3077
|
+
"type": "string"
|
|
3078
|
+
},
|
|
3079
|
+
"validation": {
|
|
3080
|
+
"description": "List of the validation errors",
|
|
3081
|
+
"type": "array",
|
|
3082
|
+
"items": {
|
|
3083
|
+
"type": "object",
|
|
3084
|
+
"properties": {
|
|
3085
|
+
"fieldName": {
|
|
3086
|
+
"type": "string"
|
|
3087
|
+
},
|
|
3088
|
+
"message": {
|
|
3089
|
+
"type": "string"
|
|
3090
|
+
}
|
|
3091
|
+
},
|
|
3092
|
+
"required": [
|
|
3093
|
+
"fieldName",
|
|
3094
|
+
"message"
|
|
3095
|
+
]
|
|
3096
|
+
}
|
|
3097
|
+
},
|
|
3098
|
+
"validationContext": {
|
|
3099
|
+
"type": "string"
|
|
3100
|
+
},
|
|
3101
|
+
"statusCode": {
|
|
3102
|
+
"type": "number"
|
|
3103
|
+
}
|
|
3104
|
+
},
|
|
3105
|
+
"required": [
|
|
3106
|
+
"code",
|
|
3107
|
+
"detail",
|
|
3108
|
+
"requestId",
|
|
3109
|
+
"name",
|
|
3110
|
+
"statusCode"
|
|
3111
|
+
]
|
|
3112
|
+
}
|
|
3113
|
+
}
|
|
3114
|
+
}
|
|
3115
|
+
},
|
|
3116
|
+
"5XX": {
|
|
3117
|
+
"description": "Default Response",
|
|
3118
|
+
"content": {
|
|
3119
|
+
"text/csv": {
|
|
3120
|
+
"schema": {
|
|
3121
|
+
"type": "object",
|
|
3122
|
+
"properties": {
|
|
3123
|
+
"code": {
|
|
3124
|
+
"description": "Code used to categorize the error",
|
|
3125
|
+
"type": "string"
|
|
3126
|
+
},
|
|
3127
|
+
"detail": {
|
|
3128
|
+
"description": "Description of the error",
|
|
3129
|
+
"type": "string"
|
|
3130
|
+
},
|
|
3131
|
+
"requestId": {
|
|
3132
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems",
|
|
3133
|
+
"type": "string"
|
|
3134
|
+
},
|
|
3135
|
+
"name": {
|
|
3136
|
+
"description": "Name of the error type",
|
|
3137
|
+
"type": "string"
|
|
3138
|
+
},
|
|
3139
|
+
"validation": {
|
|
3140
|
+
"description": "List of the validation errors",
|
|
3141
|
+
"type": "array",
|
|
3142
|
+
"items": {
|
|
3143
|
+
"type": "object",
|
|
3144
|
+
"properties": {
|
|
3145
|
+
"fieldName": {
|
|
3146
|
+
"type": "string"
|
|
3147
|
+
},
|
|
3148
|
+
"message": {
|
|
3149
|
+
"type": "string"
|
|
3150
|
+
}
|
|
3151
|
+
},
|
|
3152
|
+
"required": [
|
|
3153
|
+
"fieldName",
|
|
3154
|
+
"message"
|
|
3155
|
+
]
|
|
3156
|
+
}
|
|
3157
|
+
},
|
|
3158
|
+
"validationContext": {
|
|
3159
|
+
"type": "string"
|
|
3160
|
+
},
|
|
3161
|
+
"statusCode": {
|
|
3162
|
+
"type": "number"
|
|
3163
|
+
}
|
|
3164
|
+
},
|
|
3165
|
+
"required": [
|
|
3166
|
+
"code",
|
|
3167
|
+
"detail",
|
|
3168
|
+
"requestId",
|
|
3169
|
+
"name",
|
|
3170
|
+
"statusCode"
|
|
3171
|
+
]
|
|
3172
|
+
}
|
|
3173
|
+
}
|
|
3174
|
+
}
|
|
3175
|
+
}
|
|
3176
|
+
}
|
|
3177
|
+
}
|
|
2871
3178
|
},
|
|
3179
|
+
"/user-login-wh": {
|
|
3180
|
+
"post": {
|
|
3181
|
+
"operationId": "logtoUserCreated",
|
|
3182
|
+
"tags": [
|
|
3183
|
+
"webhooks"
|
|
3184
|
+
],
|
|
3185
|
+
"requestBody": {
|
|
3186
|
+
"content": {
|
|
3187
|
+
"application/json": {
|
|
3188
|
+
"schema": {
|
|
3189
|
+
"type": "object",
|
|
3190
|
+
"properties": {
|
|
3191
|
+
"hookId": {
|
|
3192
|
+
"anyOf": [
|
|
3193
|
+
{
|
|
3194
|
+
"type": "string"
|
|
3195
|
+
},
|
|
3196
|
+
{
|
|
3197
|
+
"type": "null"
|
|
3198
|
+
}
|
|
3199
|
+
]
|
|
3200
|
+
},
|
|
3201
|
+
"event": {
|
|
3202
|
+
"anyOf": [
|
|
3203
|
+
{
|
|
3204
|
+
"type": "string"
|
|
3205
|
+
},
|
|
3206
|
+
{
|
|
3207
|
+
"type": "null"
|
|
3208
|
+
}
|
|
3209
|
+
]
|
|
3210
|
+
},
|
|
3211
|
+
"sessionId": {
|
|
3212
|
+
"anyOf": [
|
|
3213
|
+
{
|
|
3214
|
+
"type": "string"
|
|
3215
|
+
},
|
|
3216
|
+
{
|
|
3217
|
+
"type": "null"
|
|
3218
|
+
}
|
|
3219
|
+
]
|
|
3220
|
+
},
|
|
3221
|
+
"userAgent": {
|
|
3222
|
+
"anyOf": [
|
|
3223
|
+
{
|
|
3224
|
+
"type": "string"
|
|
3225
|
+
},
|
|
3226
|
+
{
|
|
3227
|
+
"type": "null"
|
|
3228
|
+
}
|
|
3229
|
+
]
|
|
3230
|
+
},
|
|
3231
|
+
"ip": {
|
|
3232
|
+
"anyOf": [
|
|
3233
|
+
{
|
|
3234
|
+
"type": "string"
|
|
3235
|
+
},
|
|
3236
|
+
{
|
|
3237
|
+
"type": "null"
|
|
3238
|
+
}
|
|
3239
|
+
]
|
|
3240
|
+
},
|
|
3241
|
+
"path": {
|
|
3242
|
+
"anyOf": [
|
|
3243
|
+
{
|
|
3244
|
+
"type": "string"
|
|
3245
|
+
},
|
|
3246
|
+
{
|
|
3247
|
+
"type": "null"
|
|
3248
|
+
}
|
|
3249
|
+
]
|
|
3250
|
+
},
|
|
3251
|
+
"method": {
|
|
3252
|
+
"anyOf": [
|
|
3253
|
+
{
|
|
3254
|
+
"type": "string"
|
|
3255
|
+
},
|
|
3256
|
+
{
|
|
3257
|
+
"type": "null"
|
|
3258
|
+
}
|
|
3259
|
+
]
|
|
3260
|
+
},
|
|
3261
|
+
"status": {
|
|
3262
|
+
"type": "number"
|
|
3263
|
+
},
|
|
3264
|
+
"createdAt": {
|
|
3265
|
+
"format": "date-time",
|
|
3266
|
+
"type": "string"
|
|
3267
|
+
},
|
|
3268
|
+
"data": {
|
|
3269
|
+
"type": "object",
|
|
3270
|
+
"properties": {
|
|
3271
|
+
"id": {
|
|
3272
|
+
"type": "string"
|
|
3273
|
+
},
|
|
3274
|
+
"username": {
|
|
3275
|
+
"anyOf": [
|
|
3276
|
+
{
|
|
3277
|
+
"type": "string"
|
|
3278
|
+
},
|
|
3279
|
+
{
|
|
3280
|
+
"type": "null"
|
|
3281
|
+
}
|
|
3282
|
+
]
|
|
3283
|
+
},
|
|
3284
|
+
"primaryEmail": {
|
|
3285
|
+
"format": "email",
|
|
3286
|
+
"type": "string"
|
|
3287
|
+
},
|
|
3288
|
+
"primaryPhone": {
|
|
3289
|
+
"anyOf": [
|
|
3290
|
+
{
|
|
3291
|
+
"type": "string"
|
|
3292
|
+
},
|
|
3293
|
+
{
|
|
3294
|
+
"type": "null"
|
|
3295
|
+
}
|
|
3296
|
+
]
|
|
3297
|
+
},
|
|
3298
|
+
"name": {
|
|
3299
|
+
"anyOf": [
|
|
3300
|
+
{
|
|
3301
|
+
"type": "string"
|
|
3302
|
+
},
|
|
3303
|
+
{
|
|
3304
|
+
"type": "null"
|
|
3305
|
+
}
|
|
3306
|
+
]
|
|
3307
|
+
},
|
|
3308
|
+
"avatar": {
|
|
3309
|
+
"anyOf": [
|
|
3310
|
+
{
|
|
3311
|
+
"type": "string"
|
|
3312
|
+
},
|
|
3313
|
+
{
|
|
3314
|
+
"type": "null"
|
|
3315
|
+
}
|
|
3316
|
+
]
|
|
3317
|
+
},
|
|
3318
|
+
"customData": {
|
|
3319
|
+
"type": "object",
|
|
3320
|
+
"properties": {
|
|
3321
|
+
"jobId": {
|
|
3322
|
+
"anyOf": [
|
|
3323
|
+
{
|
|
3324
|
+
"type": "string"
|
|
3325
|
+
},
|
|
3326
|
+
{
|
|
3327
|
+
"type": "null"
|
|
3328
|
+
}
|
|
3329
|
+
]
|
|
3330
|
+
},
|
|
3331
|
+
"organizationId": {
|
|
3332
|
+
"anyOf": [
|
|
3333
|
+
{
|
|
3334
|
+
"type": "string"
|
|
3335
|
+
},
|
|
3336
|
+
{
|
|
3337
|
+
"type": "null"
|
|
3338
|
+
}
|
|
3339
|
+
]
|
|
3340
|
+
}
|
|
3341
|
+
}
|
|
3342
|
+
},
|
|
3343
|
+
"identities": {
|
|
3344
|
+
"type": "object",
|
|
3345
|
+
"additionalProperties": {
|
|
3346
|
+
"type": "object",
|
|
3347
|
+
"properties": {
|
|
3348
|
+
"details": {
|
|
3349
|
+
"type": "object",
|
|
3350
|
+
"properties": {
|
|
3351
|
+
"email": {
|
|
3352
|
+
"anyOf": [
|
|
3353
|
+
{
|
|
3354
|
+
"type": "string"
|
|
3355
|
+
},
|
|
3356
|
+
{
|
|
3357
|
+
"type": "null"
|
|
3358
|
+
}
|
|
3359
|
+
]
|
|
3360
|
+
},
|
|
3361
|
+
"rawData": {
|
|
3362
|
+
"type": "object",
|
|
3363
|
+
"additionalProperties": {
|
|
3364
|
+
"anyOf": [
|
|
3365
|
+
{
|
|
3366
|
+
"type": "string"
|
|
3367
|
+
},
|
|
3368
|
+
{
|
|
3369
|
+
"type": "null"
|
|
3370
|
+
},
|
|
3371
|
+
{
|
|
3372
|
+
"type": "number"
|
|
3373
|
+
},
|
|
3374
|
+
{
|
|
3375
|
+
"type": "boolean"
|
|
3376
|
+
}
|
|
3377
|
+
]
|
|
3378
|
+
}
|
|
3379
|
+
}
|
|
3380
|
+
},
|
|
3381
|
+
"required": [
|
|
3382
|
+
"rawData"
|
|
3383
|
+
]
|
|
3384
|
+
}
|
|
3385
|
+
},
|
|
3386
|
+
"required": [
|
|
3387
|
+
"details"
|
|
3388
|
+
]
|
|
3389
|
+
}
|
|
3390
|
+
},
|
|
3391
|
+
"lastSignInAt": {
|
|
3392
|
+
"anyOf": [
|
|
3393
|
+
{
|
|
3394
|
+
"type": "number"
|
|
3395
|
+
},
|
|
3396
|
+
{
|
|
3397
|
+
"type": "null"
|
|
3398
|
+
}
|
|
3399
|
+
]
|
|
3400
|
+
},
|
|
3401
|
+
"createdAt": {
|
|
3402
|
+
"type": "number"
|
|
3403
|
+
},
|
|
3404
|
+
"updatedAt": {
|
|
3405
|
+
"type": "number"
|
|
3406
|
+
},
|
|
3407
|
+
"profile": {
|
|
3408
|
+
"type": "object",
|
|
3409
|
+
"additionalProperties": {}
|
|
3410
|
+
},
|
|
3411
|
+
"applicationId": {
|
|
3412
|
+
"anyOf": [
|
|
3413
|
+
{
|
|
3414
|
+
"type": "string"
|
|
3415
|
+
},
|
|
3416
|
+
{
|
|
3417
|
+
"type": "null"
|
|
3418
|
+
}
|
|
3419
|
+
]
|
|
3420
|
+
},
|
|
3421
|
+
"isSuspended": {
|
|
3422
|
+
"type": "boolean"
|
|
3423
|
+
},
|
|
3424
|
+
"hasPassword": {
|
|
3425
|
+
"type": "boolean"
|
|
3426
|
+
}
|
|
3427
|
+
},
|
|
3428
|
+
"required": [
|
|
3429
|
+
"id",
|
|
3430
|
+
"username",
|
|
3431
|
+
"primaryEmail",
|
|
3432
|
+
"customData",
|
|
3433
|
+
"identities"
|
|
3434
|
+
]
|
|
3435
|
+
}
|
|
3436
|
+
},
|
|
3437
|
+
"required": [
|
|
3438
|
+
"data"
|
|
3439
|
+
]
|
|
3440
|
+
}
|
|
3441
|
+
}
|
|
3442
|
+
},
|
|
3443
|
+
"required": true
|
|
3444
|
+
},
|
|
3445
|
+
"responses": {
|
|
3446
|
+
"200": {
|
|
3447
|
+
"description": "Default Response"
|
|
3448
|
+
}
|
|
3449
|
+
}
|
|
3450
|
+
}
|
|
3451
|
+
}
|
|
3452
|
+
},
|
|
3453
|
+
"security": [
|
|
2872
3454
|
{
|
|
2873
|
-
"
|
|
3455
|
+
"bearerAuth": []
|
|
2874
3456
|
}
|
|
2875
3457
|
]
|
|
2876
3458
|
}
|