IRESS Web Services Reference

Object Reference

PriceXMLReq Methods

Last Updated Wednesday, 9 January 2013

  Collapse All

  GetPriceExtra Method 

Description
Get Price Extra for the particular security.

Syntax
String Results = [object].GetPriceExtra ( String SessionKey, String Security, String Exchange, Long Options )

Input Parameters
Name Type Description
SessionKey String The session key obtained from the CreateSessionKey method of Logon object.
Security String Security code. Eg. "BHP".
Exchange String Security exchange. Eg. "ASX".
Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default).
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
CurrentShortSell PriceExtra Double Number of shares currently short sold.
ErrorNo PriceExtra Long The error number if the security was not available.
Exchange PriceExtra String Exchange where the security is listed.
ExDate PriceExtra Long Expiry (exercise) date for derivatives.
ExPrice PriceExtra Single Exercise price for derivatives.
IndexGroup PriceExtra String Index group.
IndVolatility PriceExtra Single Indicative volatility.
IssuerType PriceExtra String The issuer type, e.g. M (Mining), O (Oil) or I (Industrial).
MarketCap PriceExtra Double A security's market capitalisation using the number of indexed shares on issue and investable weight factor from a pre-determined benchmark index
MarketWeight PriceExtra Single Market weight as a percent.
OpenInterest PriceExtra Single Open Interest. This is the number of outstanding (open) contracts in a class or series in the exchange traded options market.
PrevOpenInterest PriceExtra Single Open interest at the end of the previous day.
SecShortDesc PriceExtra String Short description of the security.
SectorWeight PriceExtra Single Weight of the security in the market sector.
Security PriceExtra String Security code.
SecurityType PriceExtra Long Security type code.
SettlementPrice PriceExtra Single Yesterday's settlement price for a derivative.
SharesContract PriceExtra Long Number of underlying shares per option contract.
ShortSellPercent PriceExtra Single Percentage of short limit currently sold short.
TotalShortSell PriceExtra Double Number of shares currently short sold.
UndExchange PriceExtra String Exchange for the underlying security of a derivative.
UndSecurity PriceExtra String Underlying security code for a derivative.

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

  GetPriceExtrasByArray Method 

Description
Get Price Extras for the particular securities in form of array.

Syntax
String Results = [object].GetPriceExtrasByArray ( String SessionKey, StringArray SecuritiesArray, Long Options )

Input Parameters
Name Type Description
SessionKey String The session key obtained from the CreateSessionKey method of Logon object.
SecuritiesArray StringArray An array of securities, in the form: "Security[.Exchange]" Eg. "BHP.ASX" or "ANZ"
Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default).
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
CurrentShortSell GetPriceExtra\PriceExtra Double Number of shares currently short sold.
ErrorNo GetPriceExtra\PriceExtra Long The error number if the security was not available.
Exchange GetPriceExtra\PriceExtra String Exchange where the security is listed.
ExDate GetPriceExtra\PriceExtra Long Expiry (exercise) date for derivatives.
ExPrice GetPriceExtra\PriceExtra Single Exercise price for derivatives.
IndexGroup GetPriceExtra\PriceExtra String Index group.
IndVolatility GetPriceExtra\PriceExtra Single Indicative volatility.
IssuerType GetPriceExtra\PriceExtra String The issuer type, e.g. M (Mining), O (Oil) or I (Industrial).
MarketCap GetPriceExtra\PriceExtra Double A security's market capitalisation using the number of indexed shares on issue and investable weight factor from a pre-determined benchmark index
MarketWeight GetPriceExtra\PriceExtra Single Market weight as a percent.
OpenInterest GetPriceExtra\PriceExtra Single Open Interest. This is the number of outstanding (open) contracts in a class or series in the exchange traded options market.
PrevOpenInterest GetPriceExtra\PriceExtra Single Open interest at the end of the previous day.
SecShortDesc GetPriceExtra\PriceExtra String Short description of the security.
SectorWeight GetPriceExtra\PriceExtra Single Weight of the security in the market sector.
Security GetPriceExtra\PriceExtra String Security code.
SecurityType GetPriceExtra\PriceExtra Long Security type code.
SettlementPrice GetPriceExtra\PriceExtra Single Yesterday's settlement price for a derivative.
SharesContract GetPriceExtra\PriceExtra Long Number of underlying shares per option contract.
ShortSellPercent GetPriceExtra\PriceExtra Single Percentage of short limit currently sold short.
TotalShortSell GetPriceExtra\PriceExtra Double Number of shares currently short sold.
UndExchange GetPriceExtra\PriceExtra String Exchange for the underlying security of a derivative.
UndSecurity GetPriceExtra\PriceExtra String Underlying security code for a derivative.

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

  GetPriceExtrasByList Method 

Description
Get Price Extras for the particular securities in a list form.

Syntax
String Results = [object].GetPriceExtrasByList ( String SessionKey, String SecuritiesList, Long Options )

Input Parameters
Name Type Description
SessionKey String The session key obtained from the CreateSessionKey method of Logon object.
SecuritiesList String A comma-separate list of securities, in the form: "Security[.Exchange], Security[.Exchange], ..." Eg. "BHP.ASX, ANZ, XTL.ASX".
Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default).
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
CurrentShortSell GetPriceExtra\PriceExtra Double Number of shares currently short sold.
ErrorNo GetPriceExtra\PriceExtra Long The error number if the security was not available.
Exchange GetPriceExtra\PriceExtra String Exchange where the security is listed.
ExDate GetPriceExtra\PriceExtra Long Expiry (exercise) date for derivatives.
ExPrice GetPriceExtra\PriceExtra Single Exercise price for derivatives.
IndexGroup GetPriceExtra\PriceExtra String Index group.
IndVolatility GetPriceExtra\PriceExtra Single Indicative volatility.
IssuerType GetPriceExtra\PriceExtra String The issuer type, e.g. M (Mining), O (Oil) or I (Industrial).
MarketCap GetPriceExtra\PriceExtra Double A security's market capitalisation using the number of indexed shares on issue and investable weight factor from a pre-determined benchmark index
MarketWeight GetPriceExtra\PriceExtra Single Market weight as a percent.
OpenInterest GetPriceExtra\PriceExtra Single Open Interest. This is the number of outstanding (open) contracts in a class or series in the exchange traded options market.
PrevOpenInterest GetPriceExtra\PriceExtra Single Open interest at the end of the previous day.
SecShortDesc GetPriceExtra\PriceExtra String Short description of the security.
SectorWeight GetPriceExtra\PriceExtra Single Weight of the security in the market sector.
Security GetPriceExtra\PriceExtra String Security code.
SecurityType GetPriceExtra\PriceExtra Long Security type code.
SettlementPrice GetPriceExtra\PriceExtra Single Yesterday's settlement price for a derivative.
SharesContract GetPriceExtra\PriceExtra Long Number of underlying shares per option contract.
ShortSellPercent GetPriceExtra\PriceExtra Single Percentage of short limit currently sold short.
TotalShortSell GetPriceExtra\PriceExtra Double Number of shares currently short sold.
UndExchange GetPriceExtra\PriceExtra String Exchange for the underlying security of a derivative.
UndSecurity GetPriceExtra\PriceExtra String Underlying security code for a derivative.

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

  GetPriceQuote Method 

Description
Get Price Quote for a particular security.

Syntax
String Results = [object].GetPriceQuote ( String SessionKey, String Security, String Exchange, Long Options )

Input Parameters
Name Type Description
SessionKey String The session key obtained from the CreateSessionKey method of Logon object.
Security String Security code. Eg. "BHP".
Exchange String Security exchange. Eg. "ASX".
Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default).
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
AskFlag PriceQuote String Undisclosed ask flag. Displays u for ask volumes >200,000.
AskNum PriceQuote Single Number of sellers at the current ask price.
AskPrice PriceQuote Single The current ask price.
AskVolume PriceQuote Single Total volume at the current ask price.
BidFlag PriceQuote String Undisclosed bid flag. Displays u for bid volumes >200,000.
BidNum PriceQuote Single Number of buyers at the current bid price.
BidPrice PriceQuote Single The current bid price.
BidVolume PriceQuote Single Total volume at the current bid price.
CumValue PriceQuote Single Total value traded for the current day.
CumVolume PriceQuote Single Total volume traded for the current day.
DataSource PriceQuote String DataSource code indicating the source of the data.
ErrorNo PriceQuote Long The error number if the security was not available.
Exchange PriceQuote String The exchange where the security is listed.
HighPrice PriceQuote Single Highest price traded for the current day.
LastPrice PriceQuote Single Last price in cents.
LowPrice PriceQuote Single Lowest price traded for the current day.
MatchPrice PriceQuote Single Indicative match price before market match occurs.
MatchVolume PriceQuote Single Indicative match volume.
MktValue PriceQuote Single Value traded 10.00 am to 4.05 pm.
MktVolume PriceQuote Single Volume traded 10.00 am to 4.05 pm.
Movement PriceQuote Single Current day's movement in points.
OpenPrice PriceQuote Single Opening price.
QuoteBasis PriceQuote String Basis of quotation for the security.
ReportCode PriceQuote String Company report code. Displays R if there is a report.
Security PriceQuote String Security code.
SecurityStatus PriceQuote String Trading status of the security.
SecurityType PriceQuote Long Security type code.
TradeDate PriceQuote Long Date of the last trade.
TradeDateTime PriceQuote Date DateTime of the last trade.
Trades PriceQuote Long Trades.
TradeTime PriceQuote Long Time of the last trade.
UnadjustedLastPrice PriceQuote Single Last price unadjusted for capital reconstructions.
UpdateDate PriceQuote Long Date of the last update.
UpdateDateTime PriceQuote Date DateTime of the last update.
UpdateTime PriceQuote Long Time of the last update.

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

  GetPriceQuotesByArray Method 

Description
Get Price Quotes for the particular securities in form of array.

Syntax
String Results = [object].GetPriceQuotesByArray ( String SessionKey, StringArray SecuritiesArray, Long Options )

Input Parameters
Name Type Description
SessionKey String The session key obtained from the CreateSessionKey method of Logon object.
SecuritiesArray StringArray An array of securities, in the form: "Security[.Exchange]" Eg. "BHP.ASX" or "ANZ"
Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default).
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
AskFlag GetPriceQuote\PriceQuote String Undisclosed ask flag. Displays u for ask volumes >200,000.
AskNum GetPriceQuote\PriceQuote Single Number of sellers at the current ask price.
AskPrice GetPriceQuote\PriceQuote Single The current ask price.
AskVolume GetPriceQuote\PriceQuote Single Total volume at the current ask price.
BidFlag GetPriceQuote\PriceQuote String Undisclosed bid flag. Displays u for bid volumes >200,000.
BidNum GetPriceQuote\PriceQuote Single Number of buyers at the current bid price.
BidPrice GetPriceQuote\PriceQuote Single The current bid price.
BidVolume GetPriceQuote\PriceQuote Single Total volume at the current bid price.
CumValue GetPriceQuote\PriceQuote Single Total value traded for the current day.
CumVolume GetPriceQuote\PriceQuote Single Total volume traded for the current day.
DataSource GetPriceQuote\PriceQuote String DataSource code indicating the source of the data.
ErrorNo GetPriceQuote\PriceQuote Long The error number if the security was not available.
Exchange GetPriceQuote\PriceQuote String The exchange where the security is listed.
HighPrice GetPriceQuote\PriceQuote Single Highest price traded for the current day.
LastPrice GetPriceQuote\PriceQuote Single Last price in cents.
LowPrice GetPriceQuote\PriceQuote Single Lowest price traded for the current day.
MatchPrice GetPriceQuote\PriceQuote Single Indicative match price before market match occurs.
MatchVolume GetPriceQuote\PriceQuote Single Indicative match volume.
MktValue GetPriceQuote\PriceQuote Single Value traded 10.00 am to 4.05 pm.
MktVolume GetPriceQuote\PriceQuote Single Volume traded 10.00 am to 4.05 pm.
Movement GetPriceQuote\PriceQuote Single Current day's movement in points.
OpenPrice GetPriceQuote\PriceQuote Single Opening price.
QuoteBasis GetPriceQuote\PriceQuote String Basis of quotation for the security.
ReportCode GetPriceQuote\PriceQuote String Company report code. Displays R if there is a report.
Security GetPriceQuote\PriceQuote String Security code.
SecurityStatus GetPriceQuote\PriceQuote String Trading status of the security.
SecurityType GetPriceQuote\PriceQuote Long Security type code.
TradeDate GetPriceQuote\PriceQuote Long Date of the last trade.
TradeDateTime GetPriceQuote\PriceQuote Date DateTime of the last trade.
Trades GetPriceQuote\PriceQuote Long Trades.
TradeTime GetPriceQuote\PriceQuote Long Time of the last trade.
UnadjustedLastPrice GetPriceQuote\PriceQuote Single Last price unadjusted for capital reconstructions.
UpdateDate GetPriceQuote\PriceQuote Long Date of the last update.
UpdateDateTime GetPriceQuote\PriceQuote Date DateTime of the last update.
UpdateTime GetPriceQuote\PriceQuote Long Time of the last update.

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

  GetPriceQuotesByArrayOptions Method 

Description
Get Price Quotes for the particular securities in form of array with options.

Syntax
String Results = [object].GetPriceQuotesByArrayOptions ( String SessionKey, StringArray SecuritiesArray,  OptionsArray, Long Options )

Input Parameters
Name Type Description
SessionKey String The session key obtained from the CreateSessionKey method of Logon object.
SecuritiesArray StringArray An array of securities, in the form: "Security[.Exchange]" Eg. "BHP.ASX" or "ANZ"
OptionsArray An array of security options. 0 - Default, 1 - Delay, 2 - Live(Will override Delay passed in general options).
Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default).
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
AskFlag GetPriceQuote\PriceQuote String Undisclosed ask flag. Displays u for ask volumes >200,000.
AskNum GetPriceQuote\PriceQuote Single Number of sellers at the current ask price.
AskPrice GetPriceQuote\PriceQuote Single The current ask price.
AskVolume GetPriceQuote\PriceQuote Single Total volume at the current ask price.
BidFlag GetPriceQuote\PriceQuote String Undisclosed bid flag. Displays u for bid volumes >200,000.
BidNum GetPriceQuote\PriceQuote Single Number of buyers at the current bid price.
BidPrice GetPriceQuote\PriceQuote Single The current bid price.
BidVolume GetPriceQuote\PriceQuote Single Total volume at the current bid price.
CumValue GetPriceQuote\PriceQuote Single Total value traded for the current day.
CumVolume GetPriceQuote\PriceQuote Single Total volume traded for the current day.
DataSource GetPriceQuote\PriceQuote String DataSource code indicating the source of the data.
ErrorNo GetPriceQuote\PriceQuote Long The error number if the security was not available.
Exchange GetPriceQuote\PriceQuote String The exchange where the security is listed.
HighPrice GetPriceQuote\PriceQuote Single Highest price traded for the current day.
LastPrice GetPriceQuote\PriceQuote Single Last price in cents.
LowPrice GetPriceQuote\PriceQuote Single Lowest price traded for the current day.
MatchPrice GetPriceQuote\PriceQuote Single Indicative match price before market match occurs.
MatchVolume GetPriceQuote\PriceQuote Single Indicative match volume.
MktValue GetPriceQuote\PriceQuote Single Value traded 10.00 am to 4.05 pm.
MktVolume GetPriceQuote\PriceQuote Single Volume traded 10.00 am to 4.05 pm.
Movement GetPriceQuote\PriceQuote Single Current day's movement in points.
OpenPrice GetPriceQuote\PriceQuote Single Opening price.
QuoteBasis GetPriceQuote\PriceQuote String Basis of quotation for the security.
ReportCode GetPriceQuote\PriceQuote String Company report code. Displays R if there is a report.
Security GetPriceQuote\PriceQuote String Security code.
SecurityStatus GetPriceQuote\PriceQuote String Trading status of the security.
SecurityType GetPriceQuote\PriceQuote Long Security type code.
TradeDate GetPriceQuote\PriceQuote Long Date of the last trade.
TradeDateTime GetPriceQuote\PriceQuote Date DateTime of the last trade.
Trades GetPriceQuote\PriceQuote Long Trades.
TradeTime GetPriceQuote\PriceQuote Long Time of the last trade.
UnadjustedLastPrice GetPriceQuote\PriceQuote Single Last price unadjusted for capital reconstructions.
UpdateDate GetPriceQuote\PriceQuote Long Date of the last update.
UpdateDateTime GetPriceQuote\PriceQuote Date DateTime of the last update.
UpdateTime GetPriceQuote\PriceQuote Long Time of the last update.

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

  GetPriceQuotesByList Method 

Description
Get Price Quote for the particular securities in a list form.

Syntax
String Results = [object].GetPriceQuotesByList ( String SessionKey, String SecuritiesList, Long Options )

Input Parameters
Name Type Description
SessionKey String The session key obtained from the CreateSessionKey method of Logon object.
SecuritiesList String A comma-separate list of securities, in the form: "Security[.Exchange], Security[.Exchange], ..." Eg. "BHP.ASX, ANZ, XTL.ASX".
Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default).
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
AskFlag GetPriceQuote\PriceQuote String Undisclosed ask flag. Displays u for ask volumes >200,000.
AskNum GetPriceQuote\PriceQuote Single Number of sellers at the current ask price.
AskPrice GetPriceQuote\PriceQuote Single The current ask price.
AskVolume GetPriceQuote\PriceQuote Single Total volume at the current ask price.
BidFlag GetPriceQuote\PriceQuote String Undisclosed bid flag. Displays u for bid volumes >200,000.
BidNum GetPriceQuote\PriceQuote Single Number of buyers at the current bid price.
BidPrice GetPriceQuote\PriceQuote Single The current bid price.
BidVolume GetPriceQuote\PriceQuote Single Total volume at the current bid price.
CumValue GetPriceQuote\PriceQuote Single Total value traded for the current day.
CumVolume GetPriceQuote\PriceQuote Single Total volume traded for the current day.
DataSource GetPriceQuote\PriceQuote String DataSource code indicating the source of the data.
ErrorNo GetPriceQuote\PriceQuote Long The error number if the security was not available.
Exchange GetPriceQuote\PriceQuote String The exchange where the security is listed.
HighPrice GetPriceQuote\PriceQuote Single Highest price traded for the current day.
LastPrice GetPriceQuote\PriceQuote Single Last price in cents.
LowPrice GetPriceQuote\PriceQuote Single Lowest price traded for the current day.
MatchPrice GetPriceQuote\PriceQuote Single Indicative match price before market match occurs.
MatchVolume GetPriceQuote\PriceQuote Single Indicative match volume.
MktValue GetPriceQuote\PriceQuote Single Value traded 10.00 am to 4.05 pm.
MktVolume GetPriceQuote\PriceQuote Single Volume traded 10.00 am to 4.05 pm.
Movement GetPriceQuote\PriceQuote Single Current day's movement in points.
OpenPrice GetPriceQuote\PriceQuote Single Opening price.
QuoteBasis GetPriceQuote\PriceQuote String Basis of quotation for the security.
ReportCode GetPriceQuote\PriceQuote String Company report code. Displays R if there is a report.
Security GetPriceQuote\PriceQuote String Security code.
SecurityStatus GetPriceQuote\PriceQuote String Trading status of the security.
SecurityType GetPriceQuote\PriceQuote Long Security type code.
TradeDate GetPriceQuote\PriceQuote Long Date of the last trade.
TradeDateTime GetPriceQuote\PriceQuote Date DateTime of the last trade.
Trades GetPriceQuote\PriceQuote Long Trades.
TradeTime GetPriceQuote\PriceQuote Long Time of the last trade.
UnadjustedLastPrice GetPriceQuote\PriceQuote Single Last price unadjusted for capital reconstructions.
UpdateDate GetPriceQuote\PriceQuote Long Date of the last update.
UpdateDateTime GetPriceQuote\PriceQuote Date DateTime of the last update.
UpdateTime GetPriceQuote\PriceQuote Long Time of the last update.

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

Example

For the follwoing xml element:

<OptionsXML>
   <PortfolioBalanceUpdate>1</PortfolioBalanceUpdate>
   <RequestSource>Net</RequestSource>
</OptionsXML>

The encoded string would be:

"&lt;OptionsXML&gt;&lt;PortfolioBalanceUpdate&gt;1&lt;/PortfolioBalanceUpdate&gt;&lt;RequestSource&gt;Net&lt;/RequestSource&gt;&lt;/OptionsXML&gt;"

When part of a SOAP request, it should look like:

<OptionsXML>&lt;OptionsXML&gt;&lt;PortfolioBalanceUpdate&gt;1&lt;/PortfolioBalanceUpdate&gt;&lt;RequestSource&gt;Net&lt;/RequestSource&gt;&lt;/OptionsXML&gt;</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>