~xibo-maintainers/xibo/tempel

« back to all changes in this revision

Viewing changes to web/swagger.json

  • Committer: Dan Garner
  • Date: 2019-01-29 16:18:26 UTC
  • mto: (688.1.4)
  • mto: This revision was merged to the branch mainline in revision 681.
  • Revision ID: git-v1:b696ec11fc9ebb52753501569c9c70c1e4ea939b
Update swagger.json - include tokenizer extension in dev docker file to that we can run this.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1267
1267
                }
1268
1268
            }
1269
1269
        },
 
1270
        "/dataset/{dataSetId}/rss": {
 
1271
            "get": {
 
1272
                "tags": [
 
1273
                    "dataset"
 
1274
                ],
 
1275
                "summary": "Search RSSs",
 
1276
                "description": "Search RSSs for DataSet",
 
1277
                "operationId": "dataSetRSSSearch",
 
1278
                "parameters": [
 
1279
                    {
 
1280
                        "name": "dataSetId",
 
1281
                        "in": "path",
 
1282
                        "description": "The DataSet ID",
 
1283
                        "required": true,
 
1284
                        "type": "integer"
 
1285
                    }
 
1286
                ],
 
1287
                "responses": {
 
1288
                    "200": {
 
1289
                        "description": "successful operation",
 
1290
                        "schema": {
 
1291
                            "type": "array",
 
1292
                            "items": {
 
1293
                                "$ref": "#/definitions/DataSetFeed"
 
1294
                            }
 
1295
                        }
 
1296
                    }
 
1297
                }
 
1298
            },
 
1299
            "post": {
 
1300
                "tags": [
 
1301
                    "dataset"
 
1302
                ],
 
1303
                "summary": "Add RSS",
 
1304
                "description": "Add a RSS to a DataSet",
 
1305
                "operationId": "dataSetColumnAdd",
 
1306
                "parameters": [
 
1307
                    {
 
1308
                        "name": "dataSetId",
 
1309
                        "in": "path",
 
1310
                        "description": "The DataSet ID",
 
1311
                        "required": true,
 
1312
                        "type": "integer"
 
1313
                    },
 
1314
                    {
 
1315
                        "name": "title",
 
1316
                        "in": "formData",
 
1317
                        "description": "The title for the RSS",
 
1318
                        "required": true,
 
1319
                        "type": "string"
 
1320
                    },
 
1321
                    {
 
1322
                        "name": "title",
 
1323
                        "in": "formData",
 
1324
                        "description": "The author for the RSS",
 
1325
                        "required": true,
 
1326
                        "type": "string"
 
1327
                    },
 
1328
                    {
 
1329
                        "name": "summaryColumnId",
 
1330
                        "in": "formData",
 
1331
                        "description": "The columnId to be used as each item summary",
 
1332
                        "required": true,
 
1333
                        "type": "integer"
 
1334
                    },
 
1335
                    {
 
1336
                        "name": "contentColumnId",
 
1337
                        "in": "formData",
 
1338
                        "description": "The columnId to be used as each item content",
 
1339
                        "required": true,
 
1340
                        "type": "integer"
 
1341
                    },
 
1342
                    {
 
1343
                        "name": "publishedDateColumnId",
 
1344
                        "in": "formData",
 
1345
                        "description": "The columnId to be used as each item published date",
 
1346
                        "required": true,
 
1347
                        "type": "integer"
 
1348
                    }
 
1349
                ],
 
1350
                "responses": {
 
1351
                    "201": {
 
1352
                        "description": "successful operation",
 
1353
                        "schema": {
 
1354
                            "$ref": "#/definitions/DataSetRss"
 
1355
                        },
 
1356
                        "headers": {
 
1357
                            "Location": {
 
1358
                                "description": "Location of the new record",
 
1359
                                "type": "string"
 
1360
                            }
 
1361
                        }
 
1362
                    }
 
1363
                }
 
1364
            }
 
1365
        },
 
1366
        "/dataset/{dataSetId}/rss/{$rssId}": {
 
1367
            "put": {
 
1368
                "tags": [
 
1369
                    "dataset"
 
1370
                ],
 
1371
                "summary": "Edit Rss",
 
1372
                "description": "Edit DataSet Rss Feed",
 
1373
                "operationId": "dataSetRssEdit",
 
1374
                "parameters": [
 
1375
                    {
 
1376
                        "name": "dataSetId",
 
1377
                        "in": "path",
 
1378
                        "description": "The DataSet ID",
 
1379
                        "required": true,
 
1380
                        "type": "integer"
 
1381
                    },
 
1382
                    {
 
1383
                        "name": "rssId",
 
1384
                        "in": "path",
 
1385
                        "description": "The RSS ID",
 
1386
                        "required": true,
 
1387
                        "type": "integer"
 
1388
                    },
 
1389
                    {
 
1390
                        "name": "title",
 
1391
                        "in": "formData",
 
1392
                        "description": "The title for the RSS",
 
1393
                        "required": true,
 
1394
                        "type": "string"
 
1395
                    },
 
1396
                    {
 
1397
                        "name": "title",
 
1398
                        "in": "formData",
 
1399
                        "description": "The author for the RSS",
 
1400
                        "required": true,
 
1401
                        "type": "string"
 
1402
                    },
 
1403
                    {
 
1404
                        "name": "summaryColumnId",
 
1405
                        "in": "formData",
 
1406
                        "description": "The rssId to be used as each item summary",
 
1407
                        "required": true,
 
1408
                        "type": "integer"
 
1409
                    },
 
1410
                    {
 
1411
                        "name": "contentColumnId",
 
1412
                        "in": "formData",
 
1413
                        "description": "The columnId to be used as each item content",
 
1414
                        "required": true,
 
1415
                        "type": "integer"
 
1416
                    },
 
1417
                    {
 
1418
                        "name": "publishedDateColumnId",
 
1419
                        "in": "formData",
 
1420
                        "description": "The columnId to be used as each item published date",
 
1421
                        "required": true,
 
1422
                        "type": "integer"
 
1423
                    },
 
1424
                    {
 
1425
                        "name": "regeneratePsk",
 
1426
                        "in": "formData",
 
1427
                        "description": "Regenerate the PSK?",
 
1428
                        "required": true,
 
1429
                        "type": "integer"
 
1430
                    }
 
1431
                ],
 
1432
                "responses": {
 
1433
                    "204": {
 
1434
                        "description": "successful operation"
 
1435
                    }
 
1436
                }
 
1437
            }
 
1438
        },
 
1439
        "/dataset/{dataSetId}/rss/{rssId}": {
 
1440
            "delete": {
 
1441
                "tags": [
 
1442
                    "dataset"
 
1443
                ],
 
1444
                "summary": "Delete RSS",
 
1445
                "description": "Delete DataSet RSS",
 
1446
                "operationId": "dataSetRSSDelete",
 
1447
                "parameters": [
 
1448
                    {
 
1449
                        "name": "dataSetId",
 
1450
                        "in": "path",
 
1451
                        "description": "The DataSet ID",
 
1452
                        "required": true,
 
1453
                        "type": "integer"
 
1454
                    },
 
1455
                    {
 
1456
                        "name": "rssId",
 
1457
                        "in": "path",
 
1458
                        "description": "The RSS ID",
 
1459
                        "required": true,
 
1460
                        "type": "integer"
 
1461
                    }
 
1462
                ],
 
1463
                "responses": {
 
1464
                    "204": {
 
1465
                        "description": "successful operation"
 
1466
                    }
 
1467
                }
 
1468
            }
 
1469
        },
1270
1470
        "/daypart": {
1271
1471
            "get": {
1272
1472
                "tags": [
1552
1752
                        "type": "string"
1553
1753
                    },
1554
1754
                    {
 
1755
                        "name": "clientType",
 
1756
                        "in": "formData",
 
1757
                        "description": "Filter by Client Type",
 
1758
                        "required": false,
 
1759
                        "type": "string"
 
1760
                    },
 
1761
                    {
 
1762
                        "name": "clientCode",
 
1763
                        "in": "formData",
 
1764
                        "description": "Filter by Client Code",
 
1765
                        "required": false,
 
1766
                        "type": "string"
 
1767
                    },
 
1768
                    {
1555
1769
                        "name": "embed",
1556
1770
                        "in": "formData",
1557
1771
                        "description": "Embed related data, namely displaygroups. A comma separated list of child objects to embed.",
1571
1785
                        "description": "Filter by Display Profile",
1572
1786
                        "required": false,
1573
1787
                        "type": "integer"
 
1788
                    },
 
1789
                    {
 
1790
                        "name": "mediaInventoryStatus",
 
1791
                        "in": "formData",
 
1792
                        "description": "Filter by Display Status ( 1 - up to date, 2 - downloading, 3 - Out of date)",
 
1793
                        "required": false,
 
1794
                        "type": "integer"
 
1795
                    },
 
1796
                    {
 
1797
                        "name": "loggedIn",
 
1798
                        "in": "formData",
 
1799
                        "description": "Filter by Logged In flag",
 
1800
                        "required": false,
 
1801
                        "type": "integer"
 
1802
                    },
 
1803
                    {
 
1804
                        "name": "lastAccessed",
 
1805
                        "in": "formData",
 
1806
                        "description": "Filter by Display Last Accessed date, expects date in Y-m-d H:i:s format",
 
1807
                        "required": false,
 
1808
                        "type": "string"
1574
1809
                    }
1575
1810
                ],
1576
1811
                "responses": {
2002
2237
                        "type": "integer"
2003
2238
                    },
2004
2239
                    {
2005
 
                        "name": "dynamicContent",
 
2240
                        "name": "dynamicCriteria",
2006
2241
                        "in": "formData",
2007
 
                        "description": "The filter criteria for this dynamic group. A command separated set of regular expressions to apply",
 
2242
                        "description": "The filter criteria for this dynamic group. A comma separated set of regular expressions to apply",
2008
2243
                        "required": false,
2009
2244
                        "type": "string"
2010
2245
                    }
2421
2656
                }
2422
2657
            }
2423
2658
        },
2424
 
        "/displaygroup/{displayGroupId}/version": {
2425
 
            "post": {
2426
 
                "tags": [
2427
 
                    "displayGroup"
2428
 
                ],
2429
 
                "summary": "Set the Version for this Display",
2430
 
                "description": "Sets the version instructions on all Displays in the Group",
2431
 
                "operationId": "displayGroupDisplayVersion",
2432
 
                "parameters": [
2433
 
                    {
2434
 
                        "name": "displayGroupId",
2435
 
                        "in": "path",
2436
 
                        "description": "The Display Group ID",
2437
 
                        "required": true,
2438
 
                        "type": "integer"
2439
 
                    },
2440
 
                    {
2441
 
                        "name": "mediaId",
2442
 
                        "in": "formData",
2443
 
                        "description": "The Media Id of the Installer File",
2444
 
                        "required": true,
2445
 
                        "type": "integer"
2446
 
                    }
2447
 
                ],
2448
 
                "responses": {
2449
 
                    "204": {
2450
 
                        "description": "successful operation"
2451
 
                    }
2452
 
                }
2453
 
            }
2454
 
        },
2455
2659
        "/displaygroup/{displayGroupId}/action/collectNow": {
2456
2660
            "post": {
2457
2661
                "tags": [
2678
2882
                    {
2679
2883
                        "name": "type",
2680
2884
                        "in": "formData",
2681
 
                        "description": "Filter by DisplayProfile Type (windows|android)",
 
2885
                        "description": "Filter by DisplayProfile Type (windows|android|lg)",
 
2886
                        "required": false,
 
2887
                        "type": "string"
 
2888
                    },
 
2889
                    {
 
2890
                        "name": "embed",
 
2891
                        "in": "formData",
 
2892
                        "description": "Embed related data such as config,commands,configWithDefault",
2682
2893
                        "required": false,
2683
2894
                        "type": "string"
2684
2895
                    }
2780
2991
                    }
2781
2992
                ],
2782
2993
                "responses": {
2783
 
                    "201": {
2784
 
                        "description": "successful operation",
2785
 
                        "schema": {
2786
 
                            "$ref": "#/definitions/DisplayProfile"
2787
 
                        },
2788
 
                        "headers": {
2789
 
                            "Location": {
2790
 
                                "description": "Location of the new record",
2791
 
                                "type": "string"
2792
 
                            }
2793
 
                        }
 
2994
                    "204": {
 
2995
                        "description": "successful operation"
2794
2996
                    }
2795
2997
                }
2796
2998
            },
2817
3019
                }
2818
3020
            }
2819
3021
        },
 
3022
        "/displayprofile/{displayProfileId}/copy": {
 
3023
            "post": {
 
3024
                "tags": [
 
3025
                    "displayprofile"
 
3026
                ],
 
3027
                "summary": "Copy Display Profile",
 
3028
                "description": "Copy an existing Display Profile",
 
3029
                "operationId": "displayProfileCopy",
 
3030
                "parameters": [
 
3031
                    {
 
3032
                        "name": "displayProfileId",
 
3033
                        "in": "path",
 
3034
                        "description": "The Display Profile ID",
 
3035
                        "required": true,
 
3036
                        "type": "integer"
 
3037
                    },
 
3038
                    {
 
3039
                        "name": "name",
 
3040
                        "in": "path",
 
3041
                        "description": "The name for the copy",
 
3042
                        "required": true,
 
3043
                        "type": "string"
 
3044
                    }
 
3045
                ],
 
3046
                "responses": {
 
3047
                    "201": {
 
3048
                        "description": "successful operation",
 
3049
                        "schema": {
 
3050
                            "$ref": "#/definitions/DisplayProfile"
 
3051
                        },
 
3052
                        "headers": {
 
3053
                            "Location": {
 
3054
                                "description": "Location of the new record",
 
3055
                                "type": "string"
 
3056
                            }
 
3057
                        }
 
3058
                    }
 
3059
                }
 
3060
            }
 
3061
        },
2820
3062
        "/layout": {
2821
3063
            "get": {
2822
3064
                "tags": [
3640
3882
                }
3641
3883
            }
3642
3884
        },
 
3885
        "/library/copy/{mediaId}": {
 
3886
            "post": {
 
3887
                "tags": [
 
3888
                    "library"
 
3889
                ],
 
3890
                "summary": "Copy Media",
 
3891
                "description": "Copy a Media, providing a new name and tags if applicable",
 
3892
                "operationId": "mediaCopy",
 
3893
                "parameters": [
 
3894
                    {
 
3895
                        "name": "mediaId",
 
3896
                        "in": "path",
 
3897
                        "description": "The media ID to Copy",
 
3898
                        "required": true,
 
3899
                        "type": "integer"
 
3900
                    },
 
3901
                    {
 
3902
                        "name": "name",
 
3903
                        "in": "formData",
 
3904
                        "description": "The name for the new Media",
 
3905
                        "required": true,
 
3906
                        "type": "string"
 
3907
                    },
 
3908
                    {
 
3909
                        "name": "tags",
 
3910
                        "in": "formData",
 
3911
                        "description": "The Optional tags for new Media",
 
3912
                        "required": false,
 
3913
                        "type": "string"
 
3914
                    }
 
3915
                ],
 
3916
                "responses": {
 
3917
                    "201": {
 
3918
                        "description": "successful operation",
 
3919
                        "schema": {
 
3920
                            "$ref": "#/definitions/Media"
 
3921
                        },
 
3922
                        "headers": {
 
3923
                            "Location": {
 
3924
                                "description": "Location of the new record",
 
3925
                                "type": "string"
 
3926
                            }
 
3927
                        }
 
3928
                    }
 
3929
                }
 
3930
            }
 
3931
        },
3643
3932
        "/about": {
3644
3933
            "get": {
3645
3934
                "tags": [
3876
4165
                        "description": "Filter by Subject",
3877
4166
                        "required": false,
3878
4167
                        "type": "string"
 
4168
                    },
 
4169
                    {
 
4170
                        "name": "embed",
 
4171
                        "in": "formData",
 
4172
                        "description": "Embed related data such as userGroups,displayGroups",
 
4173
                        "required": false,
 
4174
                        "type": "string"
3879
4175
                    }
3880
4176
                ],
3881
4177
                "responses": {
4074
4370
                }
4075
4371
            }
4076
4372
        },
 
4373
        "/playersoftware/{versionId}": {
 
4374
            "put": {
 
4375
                "tags": [
 
4376
                    "Player Software"
 
4377
                ],
 
4378
                "summary": "Edit Player Version",
 
4379
                "description": "Edit a Player Version file information",
 
4380
                "operationId": "playersoftwareEdit",
 
4381
                "parameters": [
 
4382
                    {
 
4383
                        "name": "versionId",
 
4384
                        "in": "path",
 
4385
                        "description": "The Version ID to Edit",
 
4386
                        "required": true,
 
4387
                        "type": "integer"
 
4388
                    },
 
4389
                    {
 
4390
                        "name": "playerShowVersion",
 
4391
                        "in": "formData",
 
4392
                        "description": "The Name of the player version application, this will be displayed in Version dropdowns in Display Profile and Display",
 
4393
                        "required": false,
 
4394
                        "type": "string"
 
4395
                    },
 
4396
                    {
 
4397
                        "name": "version",
 
4398
                        "in": "formData",
 
4399
                        "description": "The Version number",
 
4400
                        "required": false,
 
4401
                        "type": "string"
 
4402
                    },
 
4403
                    {
 
4404
                        "name": "code",
 
4405
                        "in": "formData",
 
4406
                        "description": "The Code number",
 
4407
                        "required": false,
 
4408
                        "type": "integer"
 
4409
                    }
 
4410
                ],
 
4411
                "responses": {
 
4412
                    "200": {
 
4413
                        "description": "successful operation",
 
4414
                        "schema": {
 
4415
                            "$ref": "#/definitions/Media"
 
4416
                        }
 
4417
                    }
 
4418
                }
 
4419
            },
 
4420
            "delete": {
 
4421
                "tags": [
 
4422
                    "Player Software"
 
4423
                ],
 
4424
                "summary": "Delete Version",
 
4425
                "description": "Delete Version file from the Library and Player Versions table",
 
4426
                "operationId": "playerSoftwareDelete",
 
4427
                "parameters": [
 
4428
                    {
 
4429
                        "name": "versionId",
 
4430
                        "in": "path",
 
4431
                        "description": "The Version ID to Delete",
 
4432
                        "required": true,
 
4433
                        "type": "integer"
 
4434
                    }
 
4435
                ],
 
4436
                "responses": {
 
4437
                    "204": {
 
4438
                        "description": "successful operation"
 
4439
                    }
 
4440
                }
 
4441
            }
 
4442
        },
4077
4443
        "/playlist/widget": {
4078
4444
            "get": {
4079
4445
                "tags": [
5297
5663
                        "description": "Flag indicating whether to hide the navigation",
5298
5664
                        "required": true,
5299
5665
                        "type": "integer"
5300
 
                    }
5301
 
                ],
5302
 
                "responses": {
5303
 
                    "201": {
5304
 
                        "description": "successful operation",
5305
 
                        "schema": {
5306
 
                            "$ref": "#/definitions/User"
5307
 
                        },
5308
 
                        "headers": {
5309
 
                            "Location": {
5310
 
                                "description": "Location of the new record",
5311
 
                                "type": "string"
 
5666
                    },
 
5667
                    {
 
5668
                        "name": "isPasswordChangeRequired",
 
5669
                        "in": "formData",
 
5670
                        "description": "A flag indicating whether password change should be forced for this user",
 
5671
                        "required": false,
 
5672
                        "type": "integer"
 
5673
                    }
 
5674
                ],
 
5675
                "responses": {
 
5676
                    "201": {
 
5677
                        "description": "successful operation",
 
5678
                        "schema": {
 
5679
                            "$ref": "#/definitions/User"
 
5680
                        },
 
5681
                        "headers": {
 
5682
                            "Location": {
 
5683
                                "description": "Location of the new record",
 
5684
                                "type": "string"
 
5685
                            }
 
5686
                        }
 
5687
                    }
 
5688
                }
 
5689
            }
 
5690
        },
 
5691
        "/user/{userId}": {
 
5692
            "put": {
 
5693
                "tags": [
 
5694
                    "user"
 
5695
                ],
 
5696
                "summary": "Edit User",
 
5697
                "description": "Edit existing User",
 
5698
                "operationId": "userEdit",
 
5699
                "parameters": [
 
5700
                    {
 
5701
                        "name": "userId",
 
5702
                        "in": "path",
 
5703
                        "description": "The user ID to edit",
 
5704
                        "required": true,
 
5705
                        "type": "integer"
 
5706
                    },
 
5707
                    {
 
5708
                        "name": "userName",
 
5709
                        "in": "formData",
 
5710
                        "description": "The User Name",
 
5711
                        "required": true,
 
5712
                        "type": "string"
 
5713
                    },
 
5714
                    {
 
5715
                        "name": "email",
 
5716
                        "in": "formData",
 
5717
                        "description": "The user email address",
 
5718
                        "required": false,
 
5719
                        "type": "string"
 
5720
                    },
 
5721
                    {
 
5722
                        "name": "userTypeId",
 
5723
                        "in": "formData",
 
5724
                        "description": "The user type ID",
 
5725
                        "required": true,
 
5726
                        "type": "integer"
 
5727
                    },
 
5728
                    {
 
5729
                        "name": "homePageId",
 
5730
                        "in": "formData",
 
5731
                        "description": "The homepage to use for this User",
 
5732
                        "required": true,
 
5733
                        "type": "integer"
 
5734
                    },
 
5735
                    {
 
5736
                        "name": "libraryQuota",
 
5737
                        "in": "formData",
 
5738
                        "description": "The users library quota in kilobytes",
 
5739
                        "required": false,
 
5740
                        "type": "integer"
 
5741
                    },
 
5742
                    {
 
5743
                        "name": "newPassword",
 
5744
                        "in": "formData",
 
5745
                        "description": "New User password",
 
5746
                        "required": false,
 
5747
                        "type": "string"
 
5748
                    },
 
5749
                    {
 
5750
                        "name": "retypeNewPassword",
 
5751
                        "in": "formData",
 
5752
                        "description": "Repeat the new User password",
 
5753
                        "required": false,
 
5754
                        "type": "string"
 
5755
                    },
 
5756
                    {
 
5757
                        "name": "retired",
 
5758
                        "in": "formData",
 
5759
                        "description": "Flag indicating whether to retire this user",
 
5760
                        "required": false,
 
5761
                        "type": "integer"
 
5762
                    },
 
5763
                    {
 
5764
                        "name": "firstName",
 
5765
                        "in": "formData",
 
5766
                        "description": "The users first name",
 
5767
                        "required": false,
 
5768
                        "type": "string"
 
5769
                    },
 
5770
                    {
 
5771
                        "name": "lastName",
 
5772
                        "in": "formData",
 
5773
                        "description": "The users last name",
 
5774
                        "required": false,
 
5775
                        "type": "string"
 
5776
                    },
 
5777
                    {
 
5778
                        "name": "phone",
 
5779
                        "in": "formData",
 
5780
                        "description": "The users phone number",
 
5781
                        "required": false,
 
5782
                        "type": "string"
 
5783
                    },
 
5784
                    {
 
5785
                        "name": "ref1",
 
5786
                        "in": "formData",
 
5787
                        "description": "Reference 1",
 
5788
                        "required": false,
 
5789
                        "type": "string"
 
5790
                    },
 
5791
                    {
 
5792
                        "name": "ref2",
 
5793
                        "in": "formData",
 
5794
                        "description": "Reference 2",
 
5795
                        "required": false,
 
5796
                        "type": "string"
 
5797
                    },
 
5798
                    {
 
5799
                        "name": "ref3",
 
5800
                        "in": "formData",
 
5801
                        "description": "Reference 3",
 
5802
                        "required": false,
 
5803
                        "type": "string"
 
5804
                    },
 
5805
                    {
 
5806
                        "name": "ref4",
 
5807
                        "in": "formData",
 
5808
                        "description": "Reference 4",
 
5809
                        "required": false,
 
5810
                        "type": "string"
 
5811
                    },
 
5812
                    {
 
5813
                        "name": "ref5",
 
5814
                        "in": "formData",
 
5815
                        "description": "Reference 5",
 
5816
                        "required": false,
 
5817
                        "type": "string"
 
5818
                    },
 
5819
                    {
 
5820
                        "name": "newUserWizard",
 
5821
                        "in": "formData",
 
5822
                        "description": "Flag indicating whether to show the new user guide",
 
5823
                        "required": true,
 
5824
                        "type": "integer"
 
5825
                    },
 
5826
                    {
 
5827
                        "name": "hideNavigation",
 
5828
                        "in": "formData",
 
5829
                        "description": "Flag indicating whether to hide the navigation",
 
5830
                        "required": true,
 
5831
                        "type": "integer"
 
5832
                    },
 
5833
                    {
 
5834
                        "name": "isPasswordChangeRequired",
 
5835
                        "in": "formData",
 
5836
                        "description": "A flag indicating whether password change should be forced for this user",
 
5837
                        "required": false,
 
5838
                        "type": "integer"
 
5839
                    }
 
5840
                ],
 
5841
                "responses": {
 
5842
                    "201": {
 
5843
                        "description": "successful operation",
 
5844
                        "schema": {
 
5845
                            "$ref": "#/definitions/User"
 
5846
                        },
 
5847
                        "headers": {
 
5848
                            "Location": {
 
5849
                                "description": "Location of the new record",
 
5850
                                "type": "string"
 
5851
                            }
 
5852
                        }
 
5853
                    }
 
5854
                }
 
5855
            },
 
5856
            "delete": {
 
5857
                "tags": [
 
5858
                    "user"
 
5859
                ],
 
5860
                "summary": "User Delete",
 
5861
                "description": "Delete user",
 
5862
                "operationId": "userDelete",
 
5863
                "parameters": [
 
5864
                    {
 
5865
                        "name": "userId",
 
5866
                        "in": "path",
 
5867
                        "description": "Id of the user to delete",
 
5868
                        "required": true,
 
5869
                        "type": "integer"
 
5870
                    },
 
5871
                    {
 
5872
                        "name": "deleteAllItems",
 
5873
                        "in": "formData",
 
5874
                        "description": "Flag indicating whether to delete all items owned by that user",
 
5875
                        "required": false,
 
5876
                        "type": "integer"
 
5877
                    },
 
5878
                    {
 
5879
                        "name": "reassignUserId",
 
5880
                        "in": "formData",
 
5881
                        "description": "Reassign all items owned by this user to the specified user ID",
 
5882
                        "required": false,
 
5883
                        "type": "integer"
 
5884
                    }
 
5885
                ],
 
5886
                "responses": {
 
5887
                    "204": {
 
5888
                        "description": "successful operation",
 
5889
                        "schema": {
 
5890
                            "type": "array",
 
5891
                            "items": {
 
5892
                                "$ref": "#/definitions/User"
5312
5893
                            }
5313
5894
                        }
5314
5895
                    }
6137
6718
                    {
6138
6719
                        "name": "items",
6139
6720
                        "in": "formData",
6140
 
                        "description": "Items wanted",
 
6721
                        "description": "A comma separated list of Currency Acronyms/Abbreviations, e.g. GBP,USD,EUR. For the best results enter no more than 5 items.",
6141
6722
                        "required": true,
6142
6723
                        "type": "string"
6143
6724
                    },
6355
6936
                    {
6356
6937
                        "name": "upperLimit",
6357
6938
                        "in": "formData",
6358
 
                        "description": "EDIT Only - Upper low limit for this dataSet, 0 for nor limit",
 
6939
                        "description": "EDIT Only - Upper row limit for this dataSet, 0 for no limit",
6359
6940
                        "required": false,
6360
6941
                        "type": "integer"
6361
6942
                    },
6362
6943
                    {
6363
6944
                        "name": "lowerLimit",
6364
6945
                        "in": "formData",
6365
 
                        "description": "EDIT Only - Lower low limit for this dataSet, 0 for nor limit",
 
6946
                        "description": "EDIT Only - Lower row limit for this dataSet, 0 for no limit",
6366
6947
                        "required": false,
6367
6948
                        "type": "integer"
6368
6949
                    },
6893
7474
                    {
6894
7475
                        "name": "longitude",
6895
7476
                        "in": "formData",
6896
 
                        "description": "The longitude for this weather widget, only pass if useDisplayLocation set to 0",
 
7477
                        "description": "The longitude for this Google Traffic widget, only pass if useDisplayLocation set to 0",
6897
7478
                        "required": false,
6898
7479
                        "type": "number"
6899
7480
                    },
6900
7481
                    {
6901
7482
                        "name": "latitude",
6902
7483
                        "in": "formData",
6903
 
                        "description": "The latitude for this weather widget, only pass if useDisplayLocation set to 0",
 
7484
                        "description": "The latitude for this Google Traffic widget, only pass if useDisplayLocation set to 0",
6904
7485
                        "required": false,
6905
7486
                        "type": "number"
6906
7487
                    }
7411
7992
                    {
7412
7993
                        "name": "items",
7413
7994
                        "in": "formData",
7414
 
                        "description": "Items wanted, can be comma separated",
 
7995
                        "description": "A comma separated list of Stock Ticker Symbols, e.g. GOOGL,NVDA,AMZN. For the best results enter no more than 5 items.",
7415
7996
                        "required": true,
7416
7997
                        "type": "string"
7417
7998
                    },
7692
8273
                        "type": "integer"
7693
8274
                    },
7694
8275
                    {
 
8276
                        "name": "updateIntervalImages",
 
8277
                        "in": "formData",
 
8278
                        "description": "EDIT Only - Update interval for downloaded Images, in minutes",
 
8279
                        "required": false,
 
8280
                        "type": "integer"
 
8281
                    },
 
8282
                    {
7695
8283
                        "name": "effect",
7696
8284
                        "in": "formData",
7697
8285
                        "description": "Edit only - Effect that will be used to transitions between items, available options: fade, fadeout, scrollVert, scollHorz, flipVert, flipHorz, shuffle, tileSlide, tileBlind, marqueeUp, marqueeDown, marqueeRight, marqueeLeft",
7727
8315
                        "type": "string"
7728
8316
                    },
7729
8317
                    {
 
8318
                        "name": "reverseOrder",
 
8319
                        "in": "formData",
 
8320
                        "description": "A flag (0, 1), Should we reverse the order of the feed items as well?",
 
8321
                        "required": false,
 
8322
                        "type": "integer"
 
8323
                    },
 
8324
                    {
7730
8325
                        "name": "durationIsPerItem",
7731
8326
                        "in": "formData",
7732
8327
                        "description": "A flag (0, 1), The duration specified is per item, otherwise it is per feed",
8948
9543
        },
8949
9544
        "Display": {
8950
9545
            "properties": {
 
9546
                "overrideConfig": {
 
9547
                    "description": "The configuration options that will overwrite Display Profile Config",
 
9548
                    "type": "array",
 
9549
                    "items": {
 
9550
                        "type": "string"
 
9551
                    }
 
9552
                },
8951
9553
                "displayId": {
8952
9554
                    "description": "The ID of this Display",
8953
9555
                    "type": "integer"
9050
9652
                    "type": "number",
9051
9653
                    "format": "double"
9052
9654
                },
9053
 
                "versionInstructions": {
9054
 
                    "description": "A JSON string representing the player installer that should be installed",
9055
 
                    "type": "string"
9056
 
                },
9057
9655
                "clientType": {
9058
9656
                    "description": "A string representing the player type",
9059
9657
                    "type": "string"
9656
10254
                }
9657
10255
            }
9658
10256
        },
 
10257
        "PlayerVersion": {
 
10258
            "properties": {
 
10259
                "versionId": {
 
10260
                    "description": "Version ID",
 
10261
                    "type": "integer"
 
10262
                },
 
10263
                "type": {
 
10264
                    "description": "Player type",
 
10265
                    "type": "string"
 
10266
                },
 
10267
                "version": {
 
10268
                    "description": "Version number",
 
10269
                    "type": "string"
 
10270
                },
 
10271
                "code": {
 
10272
                    "description": "Code number",
 
10273
                    "type": "integer"
 
10274
                },
 
10275
                "groupsWithPermissions": {
 
10276
                    "description": "A comma separated list of groups/users with permissions to this Media",
 
10277
                    "type": "string"
 
10278
                },
 
10279
                "mediaId": {
 
10280
                    "description": "The Media ID",
 
10281
                    "type": "integer"
 
10282
                },
 
10283
                "playerShowVersion": {
 
10284
                    "description": "Player version to show",
 
10285
                    "type": "string"
 
10286
                },
 
10287
                "originalFileName": {
 
10288
                    "description": "Original name of the uploaded installer file",
 
10289
                    "type": "string"
 
10290
                },
 
10291
                "storedAs": {
 
10292
                    "description": "Stored As",
 
10293
                    "type": "string"
 
10294
                }
 
10295
            }
 
10296
        },
9659
10297
        "Playlist": {
9660
10298
            "properties": {
9661
10299
                "playlistId": {
9929
10567
                    "description": "Does this event have custom from/to date times?",
9930
10568
                    "type": "integer"
9931
10569
                },
 
10570
                "syncEvent": {
 
10571
                    "description": "Flag indicating whether the event should be synchronised across displays",
 
10572
                    "type": "integer"
 
10573
                },
9932
10574
                "syncTimezone": {
9933
10575
                    "description": "Flag indicating whether the event will sync to the Display timezone",
9934
10576
                    "type": "integer"
10045
10687
                    "description": "A flag indicating whether the user is retired",
10046
10688
                    "type": "integer"
10047
10689
                },
 
10690
                "isPasswordChangeRequired": {
 
10691
                    "description": "A flag indicating whether password change should be forced for this user",
 
10692
                    "type": "integer"
 
10693
                },
10048
10694
                "groupId": {
10049
10695
                    "description": "The users user group ID",
10050
10696
                    "type": "integer"
10472
11118
        {
10473
11119
            "name": "task",
10474
11120
            "description": "Tasks"
 
11121
        },
 
11122
        {
 
11123
            "name": "version",
 
11124
            "description": "Player Versions"
10475
11125
        }
10476
11126
    ],
10477
11127
    "externalDocs": {