IRESS Web Services - TimeseriesXMLReq Reference

Description
This method retrieves Time Series of a Security with daily intervals.

Syntax

String Results = [object].GetDaily ( String SessionKey, String Security, String Exchange, Date StartDate, Date EndDate, 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"
StartDate		Date	The date where the time series starts. Eg. 01/01/2001.
EndDate		Date	The date where the time series ends. Eg. 14/02/2001.
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
Adjustment	Daily	Double	Adjustment factor indicating change to capital.
ClosePrice	Daily	Double	Closing price for the time period in cents.
HighPrice	Daily	Double	High price for the time period in cents.
LowPrice	Daily	Double	Low price for the time period in cents.
OpenPrice	Daily	Double	Opening price for the period in cents.
Trans	Daily	Long	Number of transactions for the period.
tsDate	Daily	Date	Period end dateTime.
Value	Daily	Double	Total value traded for the period.
Volume	Daily	Double	Total volume traded for the period.
Units	GetDaily	Byte	Specifies the securities unit type, 0 - Unknown, 1 - Units, 2 - Cents.

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

Description
This method retrieves Time Series of a Security within the given time period, at an interval specified in minutes.

Syntax

String Results = [object].GetIntraday ( String SessionKey, String Security, String Exchange, Long Frequency, Date StartDate, Date EndDate, 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"
Frequency		Long	The interval of the Time Series results, this value is specified in minutes.
StartDate		Date	The date where the time series starts. Eg. 01/01/2001.
EndDate		Date	The date where the time series ends. Eg. 14/02/2001.
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
Units	GetIntraDay	Byte	Specifies the securities unit type, 0 - Unknown, 1 - Units, 2 - Cents.
ClosePrice	IntraDay	Double	Closing price for the time period in cents.
HighPrice	IntraDay	Double	High price for the time period in cents.
LowPrice	IntraDay	Double	Low price for the time period in cents.
OpenPrice	IntraDay	Double	Opening price for the period in cents.
Trans	IntraDay	Long	Number of transactions for the period.
tsDate	IntraDay	Date	Period end dateTime.
Value	IntraDay	Double	Total value traded for the period.
Volume	IntraDay	Double	Total volume traded for the period.

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

Description
This method retrieves Time Series of a Security with monthly intervals.

Syntax

String Results = [object].GetMonthly ( String SessionKey, String Security, String Exchange, Date StartDate, Date EndDate, 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"
StartDate		Date	The date where the time series starts. Eg. 01/01/2001.
EndDate		Date	The date where the time series ends. Eg. 14/02/2001.
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
Units	GetMonthly	Byte	Specifies the securities unit type, 0 - Unknown, 1 - Units, 2 - Cents.
Adjustment	Monthly	Double	Adjustment factor indicating change to capital.
ClosePrice	Monthly	Double	Closing price for the time period in cents.
HighPrice	Monthly	Double	High price for the time period in cents.
LowPrice	Monthly	Double	Low price for the time period in cents.
OpenPrice	Monthly	Double	Opening price for the period in cents.
Trans	Monthly	Long	Number of transactions for the period.
tsDate	Monthly	Date	Period end dateTime.
Value	Monthly	Double	Total value traded for the period.
Volume	Monthly	Double	Total volume traded for the period.

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

Description
This method retrieves Time Series of a Security with quarterly intervals.

Syntax

String Results = [object].GetQuarterly ( String SessionKey, String Security, String Exchange, Date StartDate, Date EndDate, 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"
StartDate		Date	The date where the time series starts. Eg. 01/01/2001.
EndDate		Date	The date where the time series ends. Eg. 14/02/2001.
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
Units	GetQuarterly	Byte	Specifies the securities unit type, 0 - Unknown, 1 - Units, 2 - Cents.
Adjustment	Quarterly	Double	Adjustment factor indicating change to capital.
ClosePrice	Quarterly	Double	Closing price for the time period in cents.
HighPrice	Quarterly	Double	High price for the time period in cents.
LowPrice	Quarterly	Double	Low price for the time period in cents.
OpenPrice	Quarterly	Double	Opening price for the period in cents.
Trans	Quarterly	Long	Number of transactions for the period.
tsDate	Quarterly	Date	Period end dateTime.
Value	Quarterly	Double	Total value traded for the period.
Volume	Quarterly	Double	Total volume traded for the period.

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

Description
This method retrieves Time Series of a Security with weekly intervals.

Syntax

String Results = [object].GetWeekly ( String SessionKey, String Security, String Exchange, Date StartDate, Date EndDate, 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"
StartDate		Date	The date where the time series starts. Eg. 01/01/2001.
EndDate		Date	The date where the time series ends. Eg. 14/02/2001.
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
Units	GetWeekly	Byte	Specifies the securities unit type, 0 - Unknown, 1 - Units, 2 - Cents.
Adjustment	Weekly	Double	Adjustment factor indicating change to capital.
ClosePrice	Weekly	Double	Closing price for the time period in cents.
HighPrice	Weekly	Double	High price for the time period in cents.
LowPrice	Weekly	Double	Low price for the time period in cents.
OpenPrice	Weekly	Double	Opening price for the period in cents.
Trans	Weekly	Long	Number of transactions for the period.
tsDate	Weekly	Date	Period end dateTime.
Value	Weekly	Double	Total value traded for the period.
Volume	Weekly	Double	Total volume traded for the period.

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

Description
This method retrieves Time Series of a Security with yearly intervals.

Syntax

String Results = [object].GetYearly ( String SessionKey, String Security, String Exchange, Date StartDate, Date EndDate, 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"
StartDate		Date	The date where the time series starts. Eg. 01/01/2001.
EndDate		Date	The date where the time series ends. Eg. 14/02/2001.
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
Units	GetYearly	Byte	Specifies the securities unit type, 0 - Unknown, 1 - Units, 2 - Cents.
Adjustment	Yearly	Double	Adjustment factor indicating change to capital.
ClosePrice	Yearly	Double	Closing price for the time period in cents.
HighPrice	Yearly	Double	High price for the time period in cents.
LowPrice	Yearly	Double	Low price for the time period in cents.
OpenPrice	Yearly	Double	Opening price for the period in cents.
Trans	Yearly	Long	Number of transactions for the period.
tsDate	Yearly	Date	Period end dateTime.
Value	Yearly	Double	Total value traded for the period.
Volume	Yearly	Double	Total volume traded for the period.

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

TimeseriesXMLReq Methods