IRESS Web Services - Logon Reference

Description
Creates a new SessionKey string. The SessionKey is passed as the first parameter of the methods accessing market data. The SessionKey will expire after 30 minutes.

Syntax

String Results = [object].CreateSessionKey ( String UserName, String Password )

Input Parameters
Name	Type	Description
UserName	String	A string in the form: UserName@CompanyName
Password	String	The password of the particular user
Output
Type	Description
String	The result string is a session key. Use this string for the SessionKey parameter of most other methods.

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

Description
Creates a new TradingSessionKey string. The TradingSessionKey is passed as the first parameter of the methods accessing the IOS trading platform. The TradingSessionKey will expire after 30 minutes.

Syntax

String Results = [object].CreateTradingSessionKey ( String UserName, String Password )

Input Parameters
Name	Type	Description
UserName	String	The name or id of the user using the system
Password	String	The password of the particular user
Output
Type	Description
String	The result string is a trading session key. Use this string for the TradingSessionKey parameter of trading methods.

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

Description
Creates a new TradingSessionKey string, for use with all of the methods of the IOSXMLReq object. The key is associated with a specific IOS user.

Syntax

String Results = [object].CreateTradingSessionKey2 ( String UserName, String Password, String IOSUserName, String IOSPassword )

Input Parameters
Name	Type	Description
UserName	String	A string in the form: UserName@CompanyName
Password	String	The password of the particular user
IOSUserName	String	An IOS user code, with the syntax usercode[@iosname], where @iosname is optional.
IOSPassword	String	An IOS user password.
Output
Type	Description
String	The result string is a trading session key. Use this string for the TradingSessionKey parameter of trading methods.

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

Description
Creates a new TradingSessionKey, for use with all of the methods of the IOSXMLReq object. The key is associated with a specific IOS user.

Syntax

String Results = [object].CreateTradingSessionKey3 ( String UserName, String Password, String IOSUserName, String IOSPassword, String OptionsXML )

Input Parameters
Name	Type	Description
UserName	String	The name or id of the user using the system
Password	String	The password of the particular user
IOSUserName	String	An IOS user code, with the syntax usercode[@iosname], where @iosname is optional.
IOSPassword	String	An IOS user password.
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 is a trading session key. Use this string for the TradingSessionKey parameter of trading methods.

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

Description
Retrieves a list of availiable Vendors of a specified type.

Syntax

String Results = [object].GetVendorsXML ( String SessionKey, Integer sTypeID, Long Options )

Input Parameters
Name		Type	Description
SessionKey		String	The session key obtained from the CreateSessionKey method of Logon object.
sTypeID		Integer	ID of the type of Vendors you wish to retrive, a value of -1 retrieves vendors of all types
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
AccessType	Vendor	Long	Access type for the vendor.
Code	Vendor	String	Vendor code.
Description	Vendor	String	Vendor description
TypeID	Vendor	Long	Vendor Type ID.

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

Description
Retrieves a list of availiable Vendor Types.

Syntax

String Results = [object].GetVendorTypesXML ( 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
ID	VendorType	Long	Vendor Type ID.
Name	VendorType	String	Vendor Type name.

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

Description
This method allows the caller to renew a session key. A new session key is returned with an expiry in the future. Both SessionKeys must be associated with users in the same company, but cannot be the same user.

Syntax

String Results = [object].RenewSessionKey ( String SessionKey, String SessionKeyToRenew )

Input Parameters
Name	Type	Description
SessionKey	String	The session key obtained from the CreateSessionKey method, of the renewer
SessionKeyToRenew	String	The session key you wish to renew. This must be for a different user that the renewer
Output
Type	Description
String	The result string is a session key. Use this string for the SessionKey parameter of most other methods.

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

Syntax

String Results = [object].RenewTradingSessionKey ( String SessionKey, String TradingSessionKeyToRenew )

Input Parameters
Name	Type	Description
SessionKey	String	The session key obtained from the CreateSessionKey method, of the renewer
TradingSessionKeyToRenew	String	The session key you wish to renew. This must be for a different user that the renewer
Output
Type	Description
String	The result string is a trading session key. Use this string for the TradingSessionKey parameter of trading methods.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/Logon.RenewTradingSessionKey
End Point URL: http://webservices.iress.com.au/xmldata/200304/Logon.asp
WSDL File: Logon.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

Logon Methods