Watchlist table

Table Name: Watchlist
Supports: SELECT, INSERT, UPDATE, DELETE
Permissions: Zenith/Market

Provides access to the Watchlists for a User.

SELECT

Allows viewing of the Watchlists for a User.

Columns

Name Type Allows Description
ID String IS, IN The unique identifier of this Watchlist.
Name String IS, BEGINS, CONTAINS A display name for this Watchlist.
Description String A brief description for this Watchlist, if any.
Category String IS, BEGINS, CONTAINS The category this Watchlist belongs to, if any.
IsWritable Boolean True if the Watchlist can be edited, False for Read Only.

Examples

Select a single Watchlist:

SELECT * FROM Watchlist WHERE ID = '123ABC'

Select all Watchlists in the ‘Indices’ category:

SELECT ID, Name FROM Watchlist WHERE Category = 'Indices'

Select all Watchlists with the text ‘ASX’ in the name:

SELECT ID, Name FROM Watchlist WHERE Name CONTAINS 'ASX'

INSERT/UPDATE/DELETE

Allows creation, updating, and deletion of user Watchlists.

Columns

Name Type Set Where Description
ID String I/U/D The unique identifier of this Watchlist.
Name String I/U/D A display name for this Watchlist.
Description String I/U/D A brief description for this Watchlist, if any.
Category String I/U/D The category this Watchlist belongs to, if any.
Members Array I An array of strings describing the Members of the Watchlist.

Results

Name Type Description
ID String The unique identifier of the Watchlist.

Examples

Create a new Watchlist with a set of existing members:

INSERT INTO Watchlist SET Name = 'New User Watchlist', Category = 'User', Members = ['BHP.ASX']

Copy an existing Watchlist:

INSERT INTO Watchlist SET Name = 'Copied Watchlist', Category = 'User' WHERE ID = '123ABC'

Update the details of a Watchlist:

UPDATE Watchlist SET Name = 'Updated Watchlist' WHERE ID = '123ABC'

Delete a Watchlist:

DELETE FROM Watchlist WHERE ID = '123ABC'