IRESS Web Services Reference
Object Reference
WatchlistXMLReq Methods
Last Updated Wednesday, 9 January 2013
AddWatchlist Method
DescriptionThis method creates a new empty watchlist.
Syntax
String Results = [object].AddWatchlist
(
String SessionKey, String watchlistCode, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCode |
String |
The name of the new watchlist you wish to create. |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.AddWatchlist
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
AddWatchlistSecuritiesByList Method
DescriptionThis method adds a list of security codes to the specified Watchlist. NOTE: If The specified watchlist does not exist one will be created.
Syntax
String Results = [object].AddWatchlistSecuritiesByList
(
String SessionKey, String watchlistCode, String securityList, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCode |
String |
The watchlist that you wish to add the securities to. Eg. "$Watchlist1" |
securityList |
String |
The comma seperated list of security codes you wish to add. Eg. "BHP, AMP" |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.AddWatchlistSecuritiesByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
AddWatchlistSecurity Method
DescriptionThis method adds a security code to the specified watchlist. NOTE: If The specified watchlist does not exist one will be created.
Syntax
String Results = [object].AddWatchlistSecurity
(
String SessionKey, String watchlistCode, String Security, String Exchange, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCode |
String |
The watchlist that you wish to add the security to. Eg. "$Watchlist1". |
Security |
String |
Security code you wish to add. Eg. "BHP". |
Exchange |
String |
Exhchange of the security you wish to add. EG. "ASX" . |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.AddWatchlistSecurity
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
DeleteWatchlist Method
DescriptionThis method deletes a specified watchlist.
Syntax
String Results = [object].DeleteWatchlist
(
String SessionKey, String watchlistCode, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCode |
String |
The watchlist that you wish to delete. Eg. "$Watchlist1". |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.DeleteWatchlist
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
DeleteWatchlistsByList Method
DescriptionThis method deletes a list of specified watchlists.
Syntax
String Results = [object].DeleteWatchlistsByList
(
String SessionKey, String watchlistCodeList, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCodeList |
String |
The comma seperated list of watchlists you wish to delete. Eg. "$Watchlist1, $Watchlist2" |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.DeleteWatchlistsByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
GetUserWatchlists Method
DescriptionThis method Retrieves all of the current users watchlists.
Syntax
String Results = [object].GetUserWatchlists
(
String SessionKey, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
Output Attributes |
Name |
Element |
Type |
Description |
Description |
Watchlist |
String |
The watchlist description. |
WatchlistCode |
Watchlist |
String |
The watchlist code. |
WatchlistName |
Watchlist |
String |
The watchlist name. |
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetUserWatchlists
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
GetWatchlistGroups Method
DescriptionThis method Retrieves the names of all the watchlist groups.
Syntax
String Results = [object].GetWatchlistGroups
(
String SessionKey, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
Output Attributes |
Name |
Element |
Type |
Description |
Name |
WatchlistGroup |
String |
The name of the watchlist group. |
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlistGroups
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
GetWatchlists Method
DescriptionThis method Retrieves all of the global watchlists in the specified watchlist group.
Syntax
String Results = [object].GetWatchlists
(
String SessionKey, String WatchlistGroup, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
WatchlistGroup |
String |
The name of the watchlist group whose watchlists you wish to retrieve. |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
Output Attributes |
Name |
Element |
Type |
Description |
Description |
Watchlist |
String |
The watchlist description. |
WatchlistCode |
Watchlist |
String |
The watchlist code. |
WatchlistName |
Watchlist |
String |
The watchlist name. |
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlists
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
GetWatchlistSecurities Method
DescriptionThis method Retrieves a specified watchlist's securities. If the watchlist code has a "$" pre-fix it is a user watchlist, if it has a "/" pre-fix it is a global watchlist
Syntax
String Results = [object].GetWatchlistSecurities
(
String SessionKey, String watchlistCode, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCode |
String |
The watchlist who's securities you wish to Retrieve. Eg. "$Watchlist1" dor a user watchlist or "/XAO" for a global watchlist |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
Output Attributes |
Name |
Element |
Type |
Description |
Description |
Watchlist |
String |
The watchlist description. |
WatchlistCode |
Watchlist |
String |
The watchlist code. |
WatchlistName |
Watchlist |
String |
The watchlist name. |
Exchange |
Watchlist\Security |
String |
The security exchange. |
Security |
Watchlist\Security |
String |
The security code. |
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlistSecurities
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
GetWatchlistSecuritiesByList Method
DescriptionThis method Retrieves the securities of a list of specified watchlists. If the watchlist code has a "$" pre-fix it is a user watchlist, if it has a "/" pre-fix it is a global watchlist
Syntax
String Results = [object].GetWatchlistSecuritiesByList
(
String SessionKey, String watchlistCodeList, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCodeList |
String |
The comma seperated list of watchlists who's securities you wish to Retrieve it can be made up of both global or user watchlists. Eg. "/XAO, $Watchlist1, $Watchlist2, /XAO" |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
Output Attributes |
Name |
Element |
Type |
Description |
Description |
Watchlist |
String |
The watchlist description. |
WatchlistCode |
Watchlist |
String |
The watchlist code. |
WatchlistName |
Watchlist |
String |
The watchlist name. |
Exchange |
Watchlist\Security |
String |
The security exchange. |
Security |
Watchlist\Security |
String |
The security code. |
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlistSecuritiesByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
RemoveWatchlistSecuritiesByList Method
DescriptionThis method removes a list of security codes from the specified watchlist.
Syntax
String Results = [object].RemoveWatchlistSecuritiesByList
(
String SessionKey, String watchlistCode, String securityList, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCode |
String |
The watchlist that you wish to remove the securities from. Eg. "$Watchlist1" |
securityList |
String |
The comma seperated list of security codes you wish to remove. Eg. "BHP, AMP" |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.RemoveWatchlistSecuritiesByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
RemoveWatchlistSecurity Method
DescriptionThis method removes a security code from the specified watchlist.
Syntax
String Results = [object].RemoveWatchlistSecurity
(
String SessionKey, String watchlistCode, String Security, String Exchange, Long Options
)
|
Input Parameters |
Name |
Type |
Description |
SessionKey |
String |
The session key obtained from the CreateSessionKey method of Logon object. |
watchlistCode |
String |
The watchlist that you wish to remove the security from. Eg. "$Watchlist1" |
Security |
String |
Security code you wish to remove. Eg. "BHP". |
Exchange |
String |
Exhchange of the Security you wish to remove. EG. "ASX". |
Options |
Long |
Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file. |
Output |
Type |
Description |
String |
The result string contains an encoded XML document. Below describes the elements and attributes of this XML document.
|
SOAPSOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.RemoveWatchlistSecurity
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl
Error Attribute
Error Id |
Error Description |
0 |
No Error. |
1 |
Server Error (The server may be down or in maintenance). |
2 |
Access Error (User do not have permission to retrieve particular data). |
3 |
Security ID Error (Security ID entered could not be found). |
6 |
No Error - Data Incomplete. |
9 |
Error Occured In XML Body (Check XML body for a more specific error code). |
31 |
No security code given when adding securities to a watchlist or user portfolio. |
32 |
Invalid security code given when adding securities to a watchlist or user portfolio. |
33 |
The security code entered already exist specified watchlist or user portfolio. |
41 |
Watchlist Code Input Error (No watchlist code was entered or the code is missing a '$' symbol for a user watchlist or a '/' symbol for a global watchlist). |
42 |
Watchlist, User Portfolio or Watchlist Group Does Not Exist Error (The watchlist or watchlist group entered does not exist in the database). |
51 |
The IOS Portfolio Does Not Exist. |
Status Attribute
Status Id |
Status Description |
2 |
Access Error (User does not have permission to use paticular method) |
17 |
Request was successful - synchronous. |
18 |
Request was successful - asynchronous. If the request was not intended to be asynchronous then this could indicated a timeout error. |
19 |
Request was successful - default. |
33 |
Unidentified error. |
34 |
Request was improperly formatted. |
35 |
Unknown IOS address or IOSWeb offline./Internal error. |
OptionsXML Parameter
Description
OptionsXML is an optional parameter for some methods.
Its purpose is to allow additional settings to be specified for the method call.
It is specified as an XML element,
<OptionsXML>, with child elements for each setting.
The parameter is of type String, so the element must be encoded as a string according
to the SOAP encoding specifications.
ExampleFor the follwoing xml element:
<OptionsXML>
<PortfolioBalanceUpdate>1</PortfolioBalanceUpdate>
<RequestSource>Net</RequestSource>
</OptionsXML>
The encoded string would be:
"<OptionsXML><PortfolioBalanceUpdate>1</PortfolioBalanceUpdate><RequestSource>Net</RequestSource></OptionsXML>"
When part of a SOAP request, it should look like:
<OptionsXML><OptionsXML><PortfolioBalanceUpdate>1</PortfolioBalanceUpdate><RequestSource>Net</RequestSource></OptionsXML></OptionsXML>
OptionsXML Child Elements |
Name |
Type |
Description |
Example |
Advisor |
String |
Sets an orders Advisor. |
<Advisor>ADMIN</Advisor> |
AdvisorWorking |
Integer |
Only used in ClientOrderCreate to indicate whether the new client order is an advisor working order. 1 - Advisor working order, 0 - Not advisor working order |
<AdvisorWorking>1</AdvisorWorking> |
BOInstructions |
String |
Sets an orders back office instructions. |
<BOInstructions>12A Request</BOInstructions> |
BPO |
Long |
Indicates if an order will be a BPO order. 1 - BPO Order, 0 - Not a BPO Order |
<BPO>1</BPO> |
CommissionCategoryID |
Integer |
Sets an orders commission category. |
<CommissionCategoryID>43</CommissionCategoryID> |
CommissionMin |
Double |
A manually entered commission amount that overrides the default commission. |
<CommissionMin>12.00</CommissionMin> |
CommissionRate |
Double |
A manually entered commission percentage that overrides the default commission. |
<CommissionRate>11.00</CommissionRate> |
NZXCapitalOrder |
Integer |
Capital order value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXCapitalOrder>1</NZXCapitalOrder> |
NZXCSN |
String |
CSN for NZ retail orders. |
<NZXCSN>912891298</NZXCSN> |
NZXEstateWindup |
Integer |
Estate windup value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXEstateWindup>1</NZXEstateWindup> |
NZXOneOffSale |
Integer |
One off sale value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXOneOffSale>1</NZXOneOffSale> |
NZXPrescribedPersons |
Integer |
Prescribed persons value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXPrescribedPersons>1</NZXPrescribedPersons> |
NZXShortSell |
Integer |
Short sell value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXShortSell>1</NZXShortSell> |
NZXMultipleClientAggregatedOrder |
Integer |
Multiple value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXMultipleClientAggregatedOrder>1</NZXMultipleClientAggregatedOrder> |
NZXClientHoldingInNZClear |
Integer |
NZCSD value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXClientHoldingInNZClear>1</NZXClientHoldingInNZClear> |
NZXAustralianClient |
Integer |
Australia value for NZ retail orders, can either be 1 for on or 0 for off. |
<NZXAustralianClient>1</NZXAustralianClient> |
OPInstructions |
String |
Sets an orders instructions. |
<OPInstructions>Test</OPInstructions> |
OrderGiver |
String |
Sets an orders OrderGiver. |
<OrderGiver>ADMIN</OrderGiver> |
PortfolioBalanceUpdate |
Integer |
Indicates whether balances should be updated before returned. |
<PortfolioBalanceUpdate>1</PortfolioBalanceUpdate> |
RequestSource |
String |
Sent with some method calls, to indicate the source of the request |
<RequestSource>Net</RequestSource> |
SellType |
String |
Sets an ask orders Sell Type. S - Short, L - Long |
<SellType>S</SellType> |
SettlementMethod |
String |
Sets an orders settlement method. |
<SettlementMethod>ISSUER</SettlementMethod> |
SRN |
String |
Security reference numbers and the corresponding volume. |
<SRN>srn1(100shs), srn2(200shs)</SRN> |
TransactionBasis |
String |
Sets an orders Transaction Basis. |
<TransactionBasis>Test</TransactionBasis> |
ExternalID |
String |
Sets the ExternalID for the order. |
<ExternalID>Ex123</ExternalID> |