POST api/brokerageTemplate

Amend brokerage template data

Request Information

URI Parameters

None.

Body Parameters

New values of brokerage template attributes

AmendBrokerageTemplateRequest
NameDescriptionTypeAdditional information
BrokerageTemplateID

Identity of Brokerage Template that matches existing configured Brokerage Template

integer

None.
TemplateName

Name given to Brokerage Template.

string

None.
ExternalReference

External reference.

string

None.
BrokerageSchedules

Brokerage Schedules details

Collection of AmendBrokerageTemplateRequest+BrokerageScheduleCreate

None.

Request Formats

application/json, text/json

Sample: 
{
  "BrokerageTemplateID": 23456,
  "TemplateName": "Free Brokerage",
  "ExternalReference": "MPM",
  "BrokerageSchedules": [
    {
      "ScheduleName": "ASXPhoneBrokerLimit",
      "SecurityGroupID": 1,
      "OrderOriginType": 1,
      "OrderSettlementType": 1,
      "OrderExecutionType": 1,
      "BrokerageSteps": [
        {
          "LowerBound": 1000.0,
          "MinValue": 10.0,
          "BaseValue": 0.0,
          "RateValue": 0.1,
          "MinimumTrades": 10
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<AmendBrokerageTemplateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:x="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.BrokerageTemplate">
  <BrokerageTemplateID i:type="x:int" xmlns="">23456</BrokerageTemplateID>
  <TemplateName i:type="x:string" xmlns="">Free Brokerage</TemplateName>
  <ExternalReference i:type="x:string" xmlns="">MPM</ExternalReference>
  <BrokerageSchedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.BrokerageTemplate" i:type="d2p1:ArrayOfAmendBrokerageTemplateRequest.BrokerageScheduleCreate" xmlns="">
    <d2p1:AmendBrokerageTemplateRequest.BrokerageScheduleCreate>
      <ScheduleName i:type="x:string">ASXPhoneBrokerLimit</ScheduleName>
      <SecurityGroupID i:type="x:int">1</SecurityGroupID>
      <OrderOriginType xmlns:d4p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" i:type="d4p1:enOrderOriginType">Internet</OrderOriginType>
      <OrderSettlementType xmlns:d4p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" i:type="d4p1:enOrderSettlementType">BrokerSponsored</OrderSettlementType>
      <OrderExecutionType xmlns:d4p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" i:type="d4p1:enOrderPriceType">Limit</OrderExecutionType>
      <BrokerageSteps i:type="d2p1:ArrayOfAmendBrokerageTemplateRequest.BrokerageStepCreate">
        <d2p1:AmendBrokerageTemplateRequest.BrokerageStepCreate>
          <LowerBound i:type="x:decimal">1000.00</LowerBound>
          <MinValue i:type="x:decimal">10.00</MinValue>
          <BaseValue i:type="x:decimal">0.00</BaseValue>
          <RateValue i:type="x:decimal">0.1000</RateValue>
          <MinimumTrades i:type="x:int">10</MinimumTrades>
        </d2p1:AmendBrokerageTemplateRequest.BrokerageStepCreate>
      </BrokerageSteps>
    </d2p1:AmendBrokerageTemplateRequest.BrokerageScheduleCreate>
  </BrokerageSchedules>
</AmendBrokerageTemplateRequest>

Response Information

Resource Description

AmendBrokerageTemplateResult
NameDescriptionTypeAdditional information
BrokerageTemplateID

Brokerage Template ID for the creation of brokerage schedule and step.

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "BrokerageTemplateID": 1234
}

application/xml, text/xml

Sample: 
<AmendBrokerageTemplateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.BrokerageTemplate">
  <BrokerageTemplateID>1234</BrokerageTemplateID>
</AmendBrokerageTemplateResult>

Error Response Information

Resource Description

string

Error Response Formats

application/json, text/json

Sample: 
"sample string 1"

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>