IRESS Web Services - ChartReq Reference

Description
This method creates encoded url with arguments that would get us a chart.

Syntax

String Results = [object].CreateURL ( String SessionKey, String Securities, Date StartDate, Date EndDate, Long ChartType, Long Frequency, Long Template, Long PictureWidth, Long PictureHeight, Long Options )

Input Parameters

Name

Type

Description

SessionKey

String

The session key obtained from the CreateSessionKey method of Logon object.

Securities

String

Security and Exchange code. Eg. "BHP.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.

ChartType

Long

The chart type constant:

ChartType	Description	X Series	Y Series
0	chChartTypeColumnClustered	Date	Volume
6	chChartTypeLine	Date	ClosePrice
25	chChartTypeScatterLine	Date	ClosePrice
29	chChartTypeArea	Date	ClosePrice
39	chChartTypeStockHLC	Date	HighPrice, LowPrice, ClosePrice
40	chChartTypeStockOHLC	Date	OpenPrice, HighPrice, LowPrice, ClosePrice

Frequency

Long

Interval/frequency of the data series:

Frequency	Description
0	Daily
1	Weekly
2	Monthly
3	Quarterly
4	Yearly
5	IntraDay Tick

Template

Long

Predefined chart template to load with.
Notes:

These templates are designed to work with only 1 or 2 securities
The first security should use be used for a ChartType with price data
The second security should be used for a ChartType of 0, for the volume data.
To create a chart with a Price and Volume subcharts for a security, pass the same security twice, with the same Frequency.

Template	Description	No. of Securities	First Chart		Second Chart
Template	Description	No. of Securities	ChartType	Frequency	ChartType	Frequency
0	Price Chart	1-2	6,39,40	0-4	0	(same as first)
1	Price, Volume Chart	2	6,39,40	0-4	0	(same as first)
2	Price Chart 2	1-2	6,39,40	0-4	0	(same as first)
3	Price, Volume Chart 2	2	6,39,40	0-4	0	(same as first)
4	Trade Chart Intra Day	1	6,39,40	0-4
5	Trade Chart Intra Day 2	1	25	5
10	Price Chart Daily	1-2	6,39,40	0	0	(same as first)
11	Price Chart Weekly	1-2	6,39,40	1	0	(same as first)
12	Price Chart Monthly	1-2	6,39,40	2	0	(same as first)
13	Price Chart Quarterly	1-2	6,39,40	3	0	(same as first)
14	Price Chart Yearly	1-2	6,39,40	4	0	(same as first)
20	Price Volume Chart Daily	1-2	6,39,40	0	0	(same as first)
21	Price Volume Chart Weekly	1-2	6,39,40	1	0	(same as first)
22	Price Volume Chart Monthly	1-2	6,39,40	2	0	(same as first)
23	Price Volume Chart Quarterly	1-2	6,39,40	3	0	(same as first)
24	Price Volume Chart Yearly	1-2	6,39,40	4	0	(same as first)

PictureWidth

Long

The width of the output chart. Eg. 400.

PictureHeight

Long

The height of the output chart. Eg. 300.

Options

Long

Extra output options.

Output

Type

Description

String

The result string is to be used construct getchart.asp URL. The getchart.asp URL is of the form:

http://[host]/xmldata/200304/charts/getchart.asp?i=[SessionKey]&c=[CreateURLOutput]

where:

[host] - Current Web Services hostname
[SessionKey] - The same session key value used for CreateURL
[CreateURLOutput] - The result string from CreateURL

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

Description
This method creates encoded url with arguments that would get us array of charts.

Syntax

String Results = [object].CreateURLbyArray ( String SessionKey, StringArray SecuritiesArray, DateArray StartDateArray, DateArray EndDateArray, LongArray ChartTypeArray, Long Frequency, Long Template, Long PictureWidth, Long PictureHeight, Long Options )

Input Parameters
Name	Type	Description
SessionKey	String	The session key obtained from the CreateSessionKey method of Logon object.
SecuritiesArray	StringArray	Array of Security and Exchange code in the form: "Security.Exchange" Eg. "BHP.ASX".
StartDateArray	DateArray	Array of dates where the time series starts. Eg. 01/01/2001.
EndDateArray	DateArray	Array of dates where the time series ends. Eg. 14/02/2001.
ChartTypeArray	LongArray	See CreateURL parameter ChartType.
Frequency	Long	See CreateURL parameter Frequency.
Template	Long	See CreateURL parameter Template.
PictureWidth	Long	The width of the output chart. Eg. 400.
PictureHeight	Long	The height of the output chart. Eg. 300.
Options	Long	Extra output options.
Output
Type	Description
String	The result string is to be used construct getchart.asp URL. See the CreateURL method output documentation above.

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

ChartReq Methods