-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.txt
586 lines (535 loc) · 52.6 KB
/
api.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
@layeredapps/dashboard 0.0.150
http://localhost:8000
|------------------------------------------------------------------|
| /api/administrator/account |
| RETURNS--| REDACTS-------| EXCEPTIONS----------------------------|
| object | usernameHash | invalid-accountid |
| | passwordHash | * unspecified querystring accountid |
| | sessionKey | * invalid querystring accountid |
|----------|---------------|---------------------------------------|
|--------------------------------------------------------------------------------------------|
| /api/administrator/accounts |
| RECEIVES-------------------------------| RETURNS--| REDACTS-------| CONFIGURATION----------|
| optional querystring offset (integer) | array | usernameHash | environment PAGE_SIZE |
| optional querystring limit (integer) | | passwordHash | |
| optional querystring all (boolean) | | sessionKey | |
|----------------------------------------|----------|---------------|------------------------|
|------------------------------------|
| /api/administrator/accounts-count |
| RETURNS----------------------------|
| integer |
|------------------------------------|
|--------------------------------------------------------------------------------------------|
| /api/administrator/administrator-accounts |
| RECEIVES-------------------------------| RETURNS--| REDACTS-------| CONFIGURATION----------|
| optional querystring offset (integer) | array | usernameHash | environment PAGE_SIZE |
| optional querystring limit (integer) | | passwordHash | |
| optional querystring all (boolean) | | sessionKey | |
|----------------------------------------|----------|---------------|------------------------|
|--------------------------------------------------|
| /api/administrator/administrator-accounts-count |
| RETURNS------------------------------------------|
| integer |
|--------------------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------------------|
| /api/administrator/create-reset-code |
| RECEIVES---------------------| RETURNS--| EXCEPTIONS-----------------------------------------| CONFIGURATION--------------------------|
| required posted secret-code | object | invalid-accountid | environment MINIMUM_RESET_CODE_LENGTH |
| | | * unspecified querystring accountid | environment MAXIMUM_RESET_CODE_LENGTH |
| | | * invalid querystring accountid | |
| | | invalid-secret-code | |
| | | * missing posted secret-code | |
| | | * invalid posted secret-code is not alphanumeric | |
| | | invalid-secret-code-length | |
| | | * invalid posted secret-code length | |
|------------------------------|----------|----------------------------------------------------|----------------------------------------|
|--------------------------------------------------------------------------------|
| /api/administrator/delete-account |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | boolean | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | receieves |
| | | * querystring accountid |
|---------------------------------|----------|-----------------------------------|
|--------------------------------------------------------------------------------------------|
| /api/administrator/deleted-accounts |
| RECEIVES-------------------------------| RETURNS--| REDACTS-------| CONFIGURATION----------|
| optional querystring offset (integer) | array | usernameHash | environment PAGE_SIZE |
| optional querystring limit (integer) | | passwordHash | |
| optional querystring all (boolean) | | sessionKey | |
|----------------------------------------|----------|---------------|------------------------|
|--------------------------------------------|
| /api/administrator/deleted-accounts-count |
| RETURNS------------------------------------|
| querystring accountid |
|--------------------------------------------|
|--------------------------------------------------------------------------------|
| /api/administrator/profile |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring profileid | object | invalid-profileid |
| | | * missing querystring profileid |
| | | * invalid querystring profileid |
|---------------------------------|----------|-----------------------------------|
|------------------------------------------------------------------------------|
| /api/administrator/profiles |
| RECEIVES---------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
| optional querystring accountid (string) | | |
|------------------------------------------|----------|------------------------|
|------------------------------------|
| /api/administrator/profiles-count |
| RETURNS----------------------------|
| integer |
|------------------------------------|
|---------------------------------------------------------------------------------------------|
| /api/administrator/reset-account-administrator |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS-------------------------------------|
| required querystring accountid | object | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * accessing account is not owner |
| | | * querystring accountid is not administrator |
|---------------------------------|----------|------------------------------------------------|
|--------------------------------------------------------------------------------------------|
| /api/administrator/reset-code |
| RECEIVES---------------------| RETURNS--| REDACTS---------| EXCEPTIONS---------------------|
| required querystring codeid | object | secretCodeHash | invalid-reset-codeid |
| | | | * missing querystring codeid |
| | | | * invalid querystring codeid |
|------------------------------|----------|-----------------|--------------------------------|
|------------------------------------------------------------------------------------------------|
| /api/administrator/reset-codes |
| RECEIVES---------------------------------| RETURNS--| REDACTS---------| CONFIGURATION----------|
| optional querystring offset (integer) | array | secretCodeHash | environment PAGE_SIZE |
| optional querystring limit (integer) | | | |
| optional querystring all (boolean) | | | |
| optional querystring accountid (string) | | | |
|------------------------------------------|----------|-----------------|------------------------|
|---------------------------------------|
| /api/administrator/reset-codes-count |
| RETURNS-------------------------------|
| integer |
|---------------------------------------|
|--------------------------------------------------------------------------------------------|
| /api/administrator/reset-session-key |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------------------|
| required querystring accountid | object | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible querystring account is deleted |
| | | requires |
| | | * querystring accountid is not deleted |
|---------------------------------|----------|-----------------------------------------------|
|---------------------------------------------------------------|
| /api/administrator/session |
| RETURNS--| REDACTS----| EXCEPTIONS----------------------------|
| object | tokenHash | invalid-sessionid |
| | | * unspecified querystring accountid |
| | | * invalid querystring sessionid |
|----------|------------|---------------------------------------|
|-------------------------------------------------------------------------------------------|
| /api/administrator/sessions |
| RECEIVES---------------------------------| RETURNS--| REDACTS----| CONFIGURATION----------|
| optional querystring offset (integer) | array | tokenHash | environment PAGE_SIZE |
| optional querystring limit (integer) | | | |
| optional querystring all (boolean) | | | |
| optional querystring accountid (string) | | | |
|------------------------------------------|----------|------------|------------------------|
|------------------------------------|
| /api/administrator/sessions-count |
| RETURNS----------------------------|
| integer |
|------------------------------------|
|------------------------------------------------------------------------|
| /api/administrator/set-account-administrator |
| RETURNS--| EXCEPTIONS--------------------------------------------------|
| object | invalid-accountid |
| | * unspecified querystring accountid |
| | * invalid querystring accountid |
| | invalid-account |
| | * ineligible querystring account is already administrator |
| | requires |
| | * querystring accountid is not administrator |
|----------|-------------------------------------------------------------|
|----------------------------------------------------------------------------------------------|
| /api/administrator/set-account-deleted |
| RETURNS--| EXCEPTIONS--------------------------------------------| CONFIGURATION-------------|
| object | invalid-accountid | environment DELETE_DELAY |
| | * unspecified querystring accountid | |
| | * invalid querystring accountid | |
| | invalid-account | |
| | * ineligible querystring account is already deleted | |
| | * querystring accountid is deleted | |
|----------|-------------------------------------------------------|---------------------------|
|--------------------------------------------------------------------------------------------------|
| /api/administrator/set-owner-account |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------------------------|
| required querystring accountid | object | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
| | | * ineligible querystring account is already owner |
| | | requires |
| | | * accessing account is owner |
| | | * querystring account is not owner |
| | | * querystring account is not deleted |
|---------------------------------|----------|-----------------------------------------------------|
|------------------------------------------------------------------------------------------------|
| /api/user/account |
| RECEIVES------------------------| RETURNS--| REDACTS-------| EXCEPTIONS------------------------|
| required querystring accountid | object | usernameHash | invalid-accountid |
| | | passwordHash | * missing querystring accountid |
| | | sessionKey | * invalid querystring accountid |
| | | | invalid-account |
| | | | * ineligible accessing account |
|---------------------------------|----------|---------------|-----------------------------------|
|---------------------------------------------------------------------------------------------------------------------------------------------|
| /api/user/create-account |
| RECEIVES----------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION------------------------------------|
| required posted dob | object | invalid-username | environment MINIMUM_USERNAME_LENGTH |
| required posted phone | | * missing posted username | environment MAXIMUM_USERNAME_LENGTH |
| required posted occupation | | duplicate-username | environment MINIMUM_PASSWORD_LENGTH |
| required posted location | | * username already registered | environment MAXIMUM_PASSWORD_LENGTH |
| required posted display-email | | invalid-username-length | environment REQUIRE_PROFILE |
| required posted contact-email | | * posted username too short | environment USER_PROFILE_FIELDS |
| required posted company-name | | * posted username too long | environment MINIMUM_PROFILE_FULL_NAME_LENGTH |
| required posted display-name | | invalid-password | environment MAXIMUM_PROFILE_FULL_NAME_LENGTH |
| required posted full-name | | * missing posted password | environment MINIMUM_PROFILE_DISPLAY_NAME_LENGTH |
| required posted password | | invalid-password-length | environment MAXIMUM_PROFILE_DISPLAY_NAME_LENGTH |
| required posted username | | * posted password too short | environment MINIMUM_PROFILE_COMPANY_NAME_LENGTH |
| optionally-required posted full-name | | * posted password too long | environment MAXIMUM_PROFILE_COMPANY_NAME_LENGTH |
| optionally-required posted display-name | | invalid-full-name | override req.userProfileFields |
| optionally-required posted company-name | | * missing posted full-name | |
| optionally-required posted contact-email | | invalid-full-name-length | |
| optionally-required posted display-email | | * posted full-name too short | |
| optionally-required posted location | | * posted full-name too long | |
| optionally-required posted occupation | | invalid-display-name | |
| optionally-required posted phone | | * missing posted display-name | |
| optionally-required posted dob | | invalid-display-name-length | |
| | | * posted display-name too short | |
| | | * posted display-name too long | |
| | | invalid-company-name | |
| | | * missing posted company-name | |
| | | invalid-contact-email | |
| | | * missing posted contact-email | |
| | | invalid-display-email | |
| | | * missing posted display-email | |
| | | invalid-location | |
| | | * missing posted location | |
| | | invalid-occupation | |
| | | * missing posted occupation | |
| | | invalid-phone | |
| | | * missing posted phone | |
| | | invalid-dob | |
| | | * missing posted dob | |
|-------------------------------------------|----------|-----------------------------------|--------------------------------------------------|
|---------------------------------------------------------------------------------------------------------------------------------------------|
| /api/user/create-profile |
| RECEIVES----------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION------------------------------------|
| required posted dob | object | invalid-accountid | environment USER_PROFILE_FIELDS |
| required posted phone | | * missing querystring accountid | environment MINIMUM_PROFILE_FULL_NAME_LENGTH |
| required posted occupation | | * invalid querystring accountid | environment MAXIMUM_PROFILE_FULL_NAME_LENGTH |
| required posted location | | * ineligible accessing account | environment MINIMUM_PROFILE_DISPLAY_NAME_LENGTH |
| required posted display-email | | invalid-full-name | environment MAXIMUM_PROFILE_DISPLAY_NAME_LENGTH |
| required posted contact-email | | * missing posted full-name | environment MINIMUM_PROFILE_COMPANY_NAME_LENGTH |
| required posted display-name | | invalid-full-name-length | environment MAXIMUM_PROFILE_COMPANY_NAME_LENGTH |
| required posted full-name | | * posted full-name too short | override req.userProfileFields |
| required querystring accountid | | * posted full-name too long | |
| optionally-required posted full-name | | invalid-display-name | |
| optionally-required posted display-name | | * missing posted display-name | |
| optionally-required posted company-name | | invalid-display-name-length | |
| optionally-required posted contact-email | | * posted display-name too short | |
| optionally-required posted display-email | | * posted display-name too long | |
| optionally-required posted location | | invalid-company-name-length | |
| optionally-required posted occupation | | * posted company-name too short | |
| optionally-required posted phone | | * posted company-name too long | |
| optionally-required posted dob | | invalid-contact-email | |
| | | * missing posted contact-email | |
| | | invalid-display-email | |
| | | * missing posted display-email | |
| | | invalid-location | |
| | | * missing posted location | |
| | | invalid-occupation | |
| | | * missing posted occupation | |
| | | invalid-phone | |
| | | * missing posted phone | |
| | | invalid-dob | |
| | | * missing posted dob | |
|-------------------------------------------|----------|-----------------------------------|--------------------------------------------------|
|-------------------------------------------------------------------------------------------------|
| /api/user/create-reset-code |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS-----------------------------------------|
| required posted secret-code | object | invalid-accountid |
| required querystring accountid | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | * ineligible accessing account |
| | | invalid-secret-code |
| | | * missing posted secret-code |
| | | * invalid posted secret-code is not alphanumeric |
| | | invalid-secret-code-length |
| | | * posted secret code too short |
| | | * posted secret code too long |
|---------------------------------|----------|----------------------------------------------------|
|---------------------------------------------------------------------------------|
| /api/user/create-session |
| RECEIVES-------------------------------| RETURNS--| EXCEPTIONS------------------|
| required posted password | object | invalid-username |
| required posted username | | * missing posted username |
| optional posted remember (hours|days) | | invalid-password |
| | | * missing posted password |
|----------------------------------------|----------|-----------------------------|
|---------------------------------------------------------------------------------------------------|
| /api/user/delete-profile |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS-------------------------------------------|
| required querystring profileid | boolean | invalid-profileid |
| | | * missing querystring profileid |
| | | * invalid querystring profileid |
| | | invalid-profile |
| | | * querystring profileid is default contact profile |
| | | invalid-account |
| | | * ineligible querystring profileid |
|---------------------------------|----------|------------------------------------------------------|
|-----------------------------------------------------------------------------|
| /api/user/delete-reset-code |
| RECEIVES---------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring codeid | boolean | invalid-reset-codeid |
| | | * missing querystring codeid |
| | | * invalid querystring codeid |
| | | invalid-account |
| | | * ineligible querystring codeid |
|------------------------------|----------|-----------------------------------|
|-----------------------------------------------------------------------------------|
| /api/user/profile |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS---------------------------|
| required querystring profileid | object | invalid-profileid |
| | | * missing querystring profileid |
| | | * invalid querystring profileid |
| | | invalid-account |
| | | * ineligible querystring profileid |
|---------------------------------|----------|--------------------------------------|
|----------------------------------------------------------------------------------------------------------------|
| /api/user/profiles |
| RECEIVES-------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION----------|
| required querystring accountid | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring accountid | |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | invalid-account | |
| | | * ineligible accessing account | |
|----------------------------------------|----------|-----------------------------------|------------------------|
|--------------------------------------------------------------------------------|
| /api/user/profiles-count |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | integer | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
|---------------------------------|----------|-----------------------------------|
|-----------------------------------------------------------------------------------------------|
| /api/user/reset-account-deleted |
| RECEIVES------------------| RETURNS--| EXCEPTIONS---------------------------------------------|
| required posted password | object | invalid-username |
| required posted username | | * missing posted username |
| | | * invalid posted username |
| | | invalid-password |
| | | * missing posted password |
| | | * invalid posted password |
| | | invalid-account |
| | | * credentialed account is not scheduled for deletion |
|---------------------------|----------|--------------------------------------------------------|
|----------------------------------------------------------------------------|
| /api/user/reset-account-password |
| RECEIVES----------------------| RETURNS--| EXCEPTIONS----------------------|
| required posted secret-code | boolean | invalid-username |
| required posted new-password | | * missing posted username |
| required posted username | | * invalid posted username |
| | | invalid-password |
| | | * missing posted new-password |
| | | invalid-secret-code |
| | | * missing posted secret-code |
| | | invalid-reset-code |
| | | * invalid posted secret-code |
|-------------------------------|----------|---------------------------------|
|-----------------------------------------------------------------------------------------------|
| /api/user/reset-code |
| RECEIVES---------------------| RETURNS--| REDACTS---------| EXCEPTIONS------------------------|
| required querystring codeid | object | secretCodeHash | invalid-reset-codeid |
| | | | * missing querystring codeid |
| | | | * invalid querystring codeid |
| | | | invalid-account |
| | | | * ineligible querystring codeid |
|------------------------------|----------|-----------------|-----------------------------------|
|----------------------------------------------------------------------------------------------------------------------------------|
| /api/user/reset-codes |
| RECEIVES-------------------------------| RETURNS--| REDACTS---------| EXCEPTIONS------------------------| CONFIGURATION----------|
| required querystring accountid | array | secretCodeHash | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | | * missing querystring accountid | |
| optional querystring limit (integer) | | | * invalid querystring accountid | |
| optional querystring all (boolean) | | | invalid-account | |
| | | | * ineligible accessing account | |
|----------------------------------------|----------|-----------------|-----------------------------------|------------------------|
|--------------------------------------------------------------------------------|
| /api/user/reset-codes-count |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | integer | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
|---------------------------------|----------|-----------------------------------|
|--------------------------------------------------------------------------------|
| /api/user/reset-session-key |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | boolean | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
|---------------------------------|----------|-----------------------------------|
|------------------------------------------------------------------------------------------------|
| /api/user/session |
| RECEIVES------------------------| RETURNS--| REDACTS----| EXCEPTIONS---------------------------|
| required querystring sessionid | object | tokenHash | invalid-sessionid |
| | | | * missing querystring sessionid |
| | | | * invalid querystring sessionid |
| | | | invalid-account |
| | | | * ineligible querystring sessionid |
|---------------------------------|----------|------------|--------------------------------------|
|----------------------------------------------------------------------------------------------------------------|
| /api/user/sessions |
| RECEIVES-------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION----------|
| required querystring accountid | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring accountid | |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | invalid-account | |
| | | * ineligible accessing account | |
|----------------------------------------|----------|-----------------------------------|------------------------|
|--------------------------------------------------------------------------------|
| /api/user/sessions-count |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | integer | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
|---------------------------------|----------|-----------------------------------|
|------------------------------------------------------------------------------------------------------------|
| /api/user/set-account-deleted |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION-------------|
| required posted password | object | invalid-accountid | environment DELETE_DELAY |
| required querystring accountid | | * missing querystring accountid | |
| | | * invalid querystring accountid | |
| | | invalid-account | |
| | | * ineligible accessing account | |
| | | invalid-password | |
| | | * missing posted password | |
| | | * invalid posted password | |
|---------------------------------|----------|-----------------------------------|---------------------------|
|--------------------------------------------------------------------------------|
| /api/user/set-account-password |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required posted new-password | object | invalid-accountid |
| required posted password | | * missing querystring accountid |
| required querystring accountid | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-password |
| | | * missing posted password |
| | | * invalid posted password |
| | | invalid-new-password |
| | | * missing posted new-password |
| | | invalid-new-password-length |
| | | * posted new-password too short |
| | | * posted new-password too long |
|---------------------------------|----------|-----------------------------------|
|--------------------------------------------------------------------------------|
| /api/user/set-account-profile |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required posted profileid | object | invalid-accountid |
| required querystring accountid | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-profileid |
| | | * missing posted profileid |
| | | * invalid posted profileid |
|---------------------------------|----------|-----------------------------------|
|--------------------------------------------------------------------------------|
| /api/user/set-account-username |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required posted new-username | object | invalid-accountid |
| required posted password | | * missing querystring accountid |
| required querystring accountid | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
| | | invalid-password |
| | | * missing posted password |
| | | * invalid posted password |
| | | invalid-new-username |
| | | * missing posted new-username |
| | | invalid-new-username-length |
| | | * posted new-username too short |
| | | * posted new-username too long |
|---------------------------------|----------|-----------------------------------|
|-----------------------------------------------------------------------------------------|
| /api/user/set-session-ended |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS---------------------------------|
| required querystring sessionid | object | invalid-sessionid |
| | | * missing querystring sessionid |
| | | * invalid querystring sessionid |
| | | invalid-session |
| | | * querystring sessionid is already ended |
| | | invalid-account |
| | | * ineligible querystring sessionid |
|---------------------------------|----------|--------------------------------------------|
|-----------------------------------------------------------------------------------|
| /api/user/set-session-verified |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS---------------------------|
| required querystring sessionid | object | invalid-sessionid |
| | | * missing querystring sessionid |
| | | * invalid querystring sessionid |
| | | invalid-account |
| | | * ineligible querystring sessionid |
|---------------------------------|----------|--------------------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------|
| /api/user/update-profile |
| RECEIVES----------------------------------| RETURNS--| EXCEPTIONS---------------------------| CONFIGURATION------------------------------------|
| required posted dob | object | invalid-profileid | environment USER_PROFILE_FIELDS |
| required posted phone | | * missing querystring profileid | environment MINIMUM_PROFILE_FULL_NAME_LENGTH |
| required posted occupation | | * invalid querystring profileid | environment MAXIMUM_PROFILE_FULL_NAME_LENGTH |
| required posted location | | * ineligible querystring profileid | environment MINIMUM_PROFILE_DISPLAY_NAME_LENGTH |
| required posted display-email | | invalid-full-name | environment MAXIMUM_PROFILE_DISPLAY_NAME_LENGTH |
| required posted contact-email | | * missing posted full-name | environment MINIMUM_PROFILE_COMPANY_NAME_LENGTH |
| required posted company-name | | invalid-full-name-length | environment MAXIMUM_PROFILE_COMPANY_NAME_LENGTH |
| required posted display-name | | * posted full-name too short | override req.userProfileFields |
| required posted full-name | | * posted full-name too long | |
| required querystring profileid | | invalid-display-name | |
| optionally-required posted full-name | | * missing posted display-name | |
| optionally-required posted display-name | | invalid-display-name-length | |
| optionally-required posted company-name | | * posted display-name too short | |
| optionally-required posted contact-email | | * posted display-name too long | |
| optionally-required posted display-email | | invalid-company-name | |
| optionally-required posted location | | * missing posted company-name | |
| optionally-required posted occupation | | invalid-company-name-length | |
| optionally-required posted phone | | * posted company-name too short | |
| optionally-required posted dob | | * posted company-name too long | |
| | | invalid-contact-email | |
| | | * missing posted contact-email | |
| | | invalid-display-email | |
| | | * missing posted display-email | |
| | | invalid-location | |
| | | * missing posted location | |
| | | invalid-occupation | |
| | | * missing posted occupation | |
| | | invalid-phone | |
| | | * missing posted phone | |
| | | invalid-dob | |
| | | * missing posted dob | |
|-------------------------------------------|----------|--------------------------------------|--------------------------------------------------|
2022-06-24T02:44:51.952Z