POST api/person/watchscreen/{watchscreenID}

Updates a watchscreen via the supplied ID in the URL

Request Information

URI Parameters

Name	Description	Type	Additional information
watchscreenID	Watchscreen ID	string	Required

Body Parameters

Request containing the watchscreen name and a list of ASX security codes

WatchscreenUpdateRequest

Name	Description	Type	Additional information
WatchscreenName	Watchscreen name	string	String length: inclusive between 1 and 100
SecurityCodes	List of ASX security codes	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "WatchscreenName": "Watch Test",
  "SecurityCodes": [
    "BHP",
    "NAB"
  ]
}

application/xml, text/xml

Sample:

<WatchscreenUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Person">
  <SecurityCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>BHP</d2p1:string>
    <d2p1:string>NAB</d2p1:string>
  </SecurityCodes>
  <WatchscreenName>Watch Test</WatchscreenName>
</WatchscreenUpdateRequest>

Response Information

Resource Description

Watchscreen ID of the existing watchscreen

WatchscreenUpdateResponse

Name	Description	Type	Additional information
WatchscreenID	Watchscreen ID	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "WatchscreenID": 1
}

application/xml, text/xml

Sample:

<WatchscreenUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Person">
  <WatchscreenID>1</WatchscreenID>
</WatchscreenUpdateResponse>

Error Response Information

Resource Description

Watchscreen ID of the existing watchscreen

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>