Versions Compared

Old Version 5

changes.mady.by.user Stefan Willebrand

Saved on

compared with

New Version 6

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Filter inputs

 
Name
Type
Description
MandatoryAvailable from version
BrickIdGuid

The BrickId of the allocation profile

  



OwnerGuidThe owner associated with the allocation profile  

KeyStringThe key of the allocation profile  

AccountNoStringThe AccountNo associated with the allocation profile  

CreatedDateFromDateTime?When used, both from date and to date should be provided in the request 
2.02.20160506
CreatedDateToDateTime? 
2.02.20160506     
DecisionMakersWithinFirmGuid[]Filter for Decision Makers Within Firm
2.14
BrickIdsGuid[]Filter for BrickIds
2.14
OwnersGuid[]Filter for owners associated with the allocation profile
2.14
KeysString[]Filter for allocation profile keys
2.14
AccountNosString[]Filter for account numbers
2.14

Response rows (Array) inherits from EntityBase

Name
Type
Description
Available from version
NameString

The name of the allocation profile

 


CreatedDateDateTimeThe date when the allocation profile was created2.02.20160506
KeyStringThe key of the allocation profile 
OwnerGuidThe owner associated with the allocation profile 
AllocationItemsAllocationItem[]

Array of allocation items

NameTypeDescription
AssetGuidId of the instrument
AllocationPercentageDecimalThe allocation percentage for the asset
 



OrderAlgorithmKeyStringHow the cash should be distributed into orders in the allocation profile2.14
ExchangeAlgorithmKeyStringHow should exchange be handled2.14
StatusKeyStringWho can see the allocation profile2.14
MinOrderAmountStringMinimum order amount2.14
DecisionMakerWithinFirmGuidDecision Maker Within Firm (for MiFID2/TRS)2.14


Code Block
languagexmlc#
themeRDark
titleXML request exampleC# - Get Allocation profiles
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetAllocationProfiles xmlns="http://tempuri.org/">
      <req>           var request = new bfsapi.GetAllocationProfileRequest()
            {

                Credentials = new bfsapi.Credentials
                {
                    UserName = "...",
                    Password = "..."
                },
                identify = "..."
            };

            req.Args = new bfsapi.GetAllocationProfileArgs
            {
                BrickIds = new Guid[] { new Guid("b8cf3841-3b67-46d0-9189-20fd24a3c998"), new Guid("ecab32eb-1f01-4037-8916-3c16207281e9") },
                AccountNos = new string[] { "10002988" }
            };

            req.Fields = new bfsapi.GetAllocationProfileFields
            {
                BrickId = true,
             <Credentials>   AllocationItems = true,
     <UserName>yourusername</UserName>           <Password>yourpassword</Password>CreatedDate = true,
      </Credentials>         <identify>youridentifier</identify> Key = true,
     <Args>           <BrickIdOwner xsi:nil="true" /> true,
                <OwnerName xsi:nil="true" /> true,
                OrderAlgorithmKey = true,
  <Key>AllocationProfile1</Key>         </Args>     ExchangeAlgorithmKey = true,
 <Fields>              <BrickId>true</BrickId> StatusKey = true,
       <Name>true</Name>         MinOrderAmount = <Key>true</Key>true,
          <AllocationItems>false</AllocationItems>      DecisionMakerWithinFirm = true
  <Owner>true</Owner>         </Fields> };

    </req>     </GetAllocationProfiles>   </s:Body>
</s:Envelope>
 var response = bfsapiSoapClient.GetAllocationProfiles(request);