OptionsXML is an optional parameter for some methods.
Its purpose is to allow additional settings to be specified for the method call.
, 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.
"<OptionsXML><PortfolioBalanceUpdate>1</PortfolioBalanceUpdate><RequestSource>Net</RequestSource></OptionsXML>"
<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> |