Saxo Bank Developer Portal

Request to retrieve the counterpart structure, including all users, accounts and owner hierarchy.

SuBject	URL
WSDL	https://enterprise.saxobank.com/cmslive/CmsService.svc?WSDL
End Point URL	https://enterprise.saxobank.com/cmslive/CmsService.svc
Operation	GetCounterpartStructure

The following input parameters are available in the request.

Parameter	Mandatory	Description
SessionID	Y	SessionID returned by the Login Request
AccountNumber	N	The Account number of an account where to retrieve the structure from. Apart from the SessionID, only one parameter should be provided.
CounterpartId	N	The Counterpart id on a Counterpart where to retrieve the structure from. Apart from the SessionID, only one parameter should be provided.
UserId	N	The User id of a user where to retrieve the structure from. Apart from the SessionID, only one parameter should be provided.
UserLogin	N	The User login of a user where to retrieve the structure from. Apart from the SessionID, only one parameter should be provided.

SOAP 1.2 Definition

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.saxobank.com/service/cms/2013/08">
   <soapenv:Header>
     <ns:SessionId>string</ns:SessionId>
   </soapenv:Header>
   <soapenv:Body>
     <ns:GetCounterpartStructureRequest>
       <!-Optional:->
       <ns:AccountNumber>string</ns:AccountNumber>
       <!-Optional:->
       <ns:CounterpartId>int</ns:CounterpartId>
       <!-Optional:->
       <ns:UserId>int</ns:UserId>
       <!-Optional:->
       <ns:UserLogin>string</ns:UserLogin>
     </ns:GetCounterpartStructureRequest>
   </soapenv:Body>
 </soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="10f64e70-ec3d-4d4e-8470-c6b85a9d5dc5" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">d5f346ed-87ba-4f9b-b0fc-0e09f79348d7</ActivityId>
   </s:Header>
   <s:Body>
     <GetCounterpartStructureResponse xmlns="http://www.saxobank.com/service/cms/2013/08">
       <CounterpartStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <Users>
           <UserInfo>
             <Id>int</Id>
             <CounterpartId>int</CounterpartId>
             <Name>string</Name>
             <Login>string</Login>
             <Active>bool</Active>
           </UserInfo>
         </Users>
         <Counterpart>
           <Id>int</Id>
           <OwnerId>int</OwnerId>
           <Name>string</Name>
           <Active>bool</Active>
         </Counterpart>
         <Owners>
           <OwnerInfo>
             <Id>int</Id>
             <OwnerId>int</OwnerId>
             <Active>bool</Active>
             <Name>string</Name>
           </OwnerInfo>
         </Owners>
         <Accounts>
           <AccountInfo>
             <AccountNumber>string</AccountNumber>
             <CounterpartId>int</CounterpartId>
             <Description>string</Description>
             <InternalAccountNumber>string</InternalAccountNumber>
             <Active>bool</Active>
           </AccountInfo>
         </Accounts>
       </CounterpartStructure>
    </GetCounterpartStructureResponse>
   </s:Body>
 </s:Envelope>

Code Examples

Code example 34: GetCounterpartStructure Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.saxobank.com/service/cms/2013/08">
   <soapenv:Header>
     <ns:SessionId>QAs01NW22ajBAsjFZTGM</ns:SessionId>
   </soapenv:Header>
   <soapenv:Body>
     <ns:GetCounterpartStructureRequest>
       <ns:CounterpartId>3006888</ns:CounterpartId>
     </ns:GetCounterpartStructureRequest>
   </soapenv:Body>
 </soapenv:Envelope>

Code example 35: GetCounterpartStructure Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="10f64e70-ec3d-4d4e-8470-c6b85a9d5dc5" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">d5f346ed-87ba-4f9b-b0fc-0e09f79348d7</ActivityId>
   </s:Header>
   <s:Body>
     <GetCounterpartStructureResponse xmlns="http://www.saxobank.com/service/cms/2013/08">
       <CounterpartStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <Users>
           <UserInfo>
             <Id>3006888</Id>
             <CounterpartId>3006888</CounterpartId>
             <Name>User 3006888</Name>
             <Login>3006888</Login>
             <Active>true</Active>
           </UserInfo>
           <UserInfo>
             <Id>5235422</Id>
             <CounterpartId>3006888</CounterpartId>
             <Name>User 5235422</Name>
             <Login>5235422</Login>
             <Active>true</Active>
           </UserInfo>          
         </Users>
         <Counterpart>
           <Id>3006888</Id>
           <OwnerId>3006888</OwnerId>
           <Name>Teravaco LLP</Name>
           <Active>true</Active>
        </Counterpart>
         <Owners>
           <OwnerInfo>
             <Id>3006888</Id>
             <OwnerId>961917</OwnerId>
             <Active>true</Active>
             <Name>Tara</Name>
           </OwnerInfo>
           <OwnerInfo>
             <Id>961917</Id>
             <OwnerId>1</OwnerId>
             <Active>true</Active>
             <Name>Hara</Name>
           </OwnerInfo>
         </Owners>
         <Accounts>
           <AccountInfo>
             <AccountNumber>33930</AccountNumber>
             <CounterpartId>3006888</CounterpartId>
             <Description>33930</Description>
             <InternalAccountNumber>LAK - 33930</InternalAccountNumber>
             <Active>true</Active>
           </AccountInfo>
           <AccountInfo>
             <AccountNumber>33930/7891123457</AccountNumber>
             <CounterpartId>3006888</CounterpartId>
             <Description/>
             <InternalAccountNumber/>
             <Active>true</Active>
           </AccountInfo>
         </Accounts>
       </CounterpartStructure>
     </GetCounterpartStructureResponse>
   </s:Body>
 </s:Envelope>