IRESS Web Services - SecuritySearchXMLReq Reference

Description
This method allows you to retrieve security codes by searching on the issuer code and exchange.

Syntax

String Results = [object].GetByIssuerCode ( String SessionKey, String IssuesCode, String IssuesExchange, String ExchangeList, String SecurityTypeGroupList, Long ActiveSecurities, Long RowStart, Long RowCount, Long Options, String OptionsXML )

Input Parameters
Name		Type	Description
SessionKey		String	The session key obtained from the CreateSessionKey method of Logon object.
IssuesCode		String	The Issuer Code you wish to filter on.
IssuesExchange		String	The Issuer Exchange you wish to filter on.
ExchangeList		String	Comma Separated Exchange list you wish to filter on eg."ASX, NZ". If you do not wish to filter on exchange then pass in an empty string.
SecurityTypeGroupList		String	Comma separated list of Security Types you wish to filter on e.g. ""Traded Securities, Equities, Warrants"". If you do not wish to filter on security type then pass in an empty string.
ActiveSecurities		Long	Implying whether the security is still active which means it has not expired or being delisted eg. Active - 1, Expired/Delisted - 0.
RowStart		Long	The row number at which you wish to begin receiving results, with the first row number being 0. If you do not wish to use rows a -1 may be passed in for this and the RowCount parameter.
RowCount		Long	The number of rows you wish to retrieve. If you do not wish to use rows a -1 may be passed in for this and the RowStart parameter.
Options		Long	Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file.
OptionsXML		String	An XML element, encoded as a string, with child elements. Valid child elements for this method are: For more information about what these elements mean, and for a usage example, please refer to OptionsXML.
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
RowCount	Securities	Long	The total nbumber of rows retrieved.
RowStart	Securities	Long	The row number at which you begin receiving results.
RowsTotal	Securities	Long	Total number of results available.
Code	Securities\Security	String	Security Code.
Description	Securities\Security	String	Description of the security.
Exchange	Securities\Security	String	Security exchange
SecType	Securities\Security	Long	Security type.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetByIssuerCode
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

Description
This method retrieves Securities codes based on the properties of Securities.

Syntax

String Results = [object].GetByProperties ( String SessionKey, Long SecurityTypeMin, Long SecurityTypeMax, Long Suspended, Long Current, Double MktCapMin, Double MktCapMax, String Exchange, String IssuerCode, String IssuerExchange, Long Options )

Input Parameters
Name		Type	Description
SessionKey		String	The session key obtained from the CreateSessionKey method of Logon object.
SecurityTypeMin		Long	Security Type Minimum. Eg. 100.
SecurityTypeMax		Long	Security Type Maximum. Eg. 109.
Suspended		Long	Status of security whether it is suspended or not. Eg. 0(Not suspended)
Current		Long	Whether the security is current. Eg. 1(for Current).
MktCapMin		Double	Market Capital Minimum. Eg. 0
MktCapMax		Double	Market capital maximum. Eg. 9999999999.
Exchange		String	Security exchange. Eg. "ASX".
IssuerCode		String	Issuer code. Eg. "BHP".
IssuerExchange		String	Issuer exchange. 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.
Output Attributes
Name	Element	Type	Description
Exchange	Security	String	Security exchange
Security	Security	String	Security Code.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetByProperties
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

Description
This method retrieves Securities codes based on search text and type of Security.

Syntax

String Results = [object].GetByTextAndTypeGroup ( String SessionKey, String Text, String SecurityTypeGroup, Long ActiveSecurities, Long Options )

Input Parameters
Name		Type	Description
SessionKey		String	The session key obtained from the CreateSessionKey method of Logon object.
Text		String	The text that is related to the securities to be searched.
SecurityTypeGroup		String	Type of Securities eg. "Traded Securities", "Equities", "Warrants".
ActiveSecurities		Long	Implying whether the security is still active which means it has not expired or being delisted eg. Active - 1, Expired/Delisted - 0.
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
Code	Security	String	Security Code.
Description	Security	String	Description of the security.
Exchange	Security	String	Security exchange
SecID	Security	Long	Security ID
SecurityType	Security	Long	Security type.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetByTextAndTypeGroup
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

Description
This method allows you to retrieve Security codes by searching on either their code or company description.

Syntax

String Results = [object].GetByTextExchangeAndType ( String SessionKey, String Text, String ExchangeList, String SecurityTypeGroupList, Long CodeSearchType, Long DescriptionSearchType, Long ActiveSecurities, Long RowStart, Long RowCount, Long Options )

Input Parameters
Name		Type	Description
SessionKey		String	The session key obtained from the CreateSessionKey method of Logon object.
Text		String	The text that is related to the securities to be searched.
ExchangeList		String	Comma separated list of exchanges you wish to filter the search on e.g. ""ASX, NZ"". If you do not wish to filter on exchange then pass in an empty string.
SecurityTypeGroupList		String	Comma separated list of Security Types you wish to filter on e.g. ""Traded Securities, Equities, Warrants"". . If you do not wish to filter on security type then pass in an empty string.
CodeSearchType		Long	The Search Type you wish to perform on Security Code. -1- Do not search on Code, 0- Contains text, 1 = Starts With text, 2- Exact match on text.
DescriptionSearchType		Long	The Search Type you wish to perform on Security Description. -1- Do not search on Description, 0- Contains text, 1 = Starts With text, 2- Exact match on text.
ActiveSecurities		Long	Implying whether the security is still active which means it has not expired or being delisted eg. Active - 1, Expired/Delisted - 0.
RowStart		Long	The row number at which you wish to begin receiving results, with the first row number being 0. If you do not wish to use rows a -1 may be passed in for this and the RowCount parameter.
RowCount		Long	The number of rows you wish to retrieve. If you do not wish to use rows a -1 may be passed in for this and the RowStart parameter.
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
RowCount	Securities	Long	The total nbumber of rows retrieved.
RowStart	Securities	Long	The row number at which you begin receiving results.
RowsTotal	Securities	Long	Total number of results available.
Code	Securities\Security	String	Security Code.
Description	Securities\Security	String	Description of the security.
Exchange	Securities\Security	String	Security exchange
IssuerName	Securities\Security	String	Issuer company name.
SecType	Securities\Security	Long	Security type.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetByTextExchangeAndType
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

Description
This method allows you to retrieve valid issuer codes.

Syntax

String Results = [object].GetIssuerCodes ( String SessionKey, String ExchangeList, String SecurityTypeGroupList, Long RowStart, Long RowCount, Long Options, String OptionsXML )

Input Parameters
Name		Type	Description
SessionKey		String	The session key obtained from the CreateSessionKey method of Logon object.
ExchangeList		String	Comma Separated Exchange list you wish to filter on eg."ASX, NZ". If you do not wish to filter on exchange then pass in an empty string.
SecurityTypeGroupList		String	Comma separated list of Security Types you wish to filter on e.g. ""Traded Securities, Equities, Warrants"". If you do not wish to filter on security type then pass in an empty string.
RowStart		Long	The row number at which you wish to begin receiving results, with the first row number being 0. If you do not wish to use rows a -1 may be passed in for this and the RowCount parameter.
RowCount		Long	The number of rows you wish to retrieve. If you do not wish to use rows a -1 may be passed in for this and the RowStart parameter.
Options		Long	Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file.
OptionsXML		String	An XML element, encoded as a string, with child elements. Valid child elements for this method are: For more information about what these elements mean, and for a usage example, please refer to OptionsXML.
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
RowCount	Securities	Long	The total nbumber of rows retrieved.
RowStart	Securities	Long	The row number at which you begin receiving results.
RowsTotal	Securities	Long	Total number of results available.
Code	Securities\Security	String	Security Code.
Description	Securities\Security	String	Description of the security.
Exchange	Securities\Security	String	Security exchange

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetIssuerCodes
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

Description
This method retrieves the type of securities that can be searched.

Syntax

String Results = [object].GetTypeGroups ( String SessionKey, Long TypeGroupType, Long Options )

Input Parameters
Name		Type	Description
SessionKey		String	The session key obtained from the CreateSessionKey method of Logon object.
TypeGroupType		Long	Implying whether the security is traded security or non traded security eg.Tradable Securities - 1, Non Tradable Securities - 2.
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
GroupType	SecurityTypeGroup	Integer	GroupType
HighType	SecurityTypeGroup	Integer	HighType
LowType	SecurityTypeGroup	Integer	LowType
Name	SecurityTypeGroup	String	The name of the type group.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetTypeGroups
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

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.

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.

Example

For 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>

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.

IRESS Web Services Reference

SecuritySearchXMLReq Methods