GET api/brokerageTemplate/{brokerageTemplateID}

Get brokerage template data with brokerage template id

Request Information

URI Parameters

Name	Description	Type	Additional information
brokerageTemplateID		integer	Required

Body Parameters

None.

Response Information

Resource Description

BrokerageTemplate

Name	Description	Type	Additional 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	List of Brokerage Schedules.	Collection of BrokerageSchedule	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<BrokerageTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.BrokerageTemplate">
  <BrokerageSchedules>
    <BrokerageSchedule>
      <BrokerageScheduleID>1234</BrokerageScheduleID>
      <BrokerageSteps>
        <BrokerageSchedule.BrokerageStep>
          <BaseValue>0.00</BaseValue>
          <BrokerageStepID>12345</BrokerageStepID>
          <LowerBound>1000.00</LowerBound>
          <MinValue>10.00</MinValue>
          <MinimumTrades>10</MinimumTrades>
          <RateValue>0.1000</RateValue>
        </BrokerageSchedule.BrokerageStep>
      </BrokerageSteps>
      <OrderExecutionType>Limit</OrderExecutionType>
      <OrderOriginType>Internet</OrderOriginType>
      <OrderSettlementType>BrokerSponsored</OrderSettlementType>
      <ScheduleName>ASXPhoneBrokerLimit</ScheduleName>
      <SecurityGroupID>1</SecurityGroupID>
    </BrokerageSchedule>
  </BrokerageSchedules>
  <BrokerageTemplateID>1632</BrokerageTemplateID>
  <ExternalReference>MPM</ExternalReference>
  <TemplateName>Free Brokerage</TemplateName>
</BrokerageTemplate>