Client Management Systems API

Request to retrieve a list of Counterparts that belong to an owner.


The following input parameters are available in the request.

Parameter

Mandatory

Description

SessionID

Y

SessionID returned by the Login Request

IncludeSubOwners

Whether to include sub owners or not.

OwnerId

Owner id of the owner to retrieve underlying Counterparts from

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:GetCounterpartListRequest>
       <!-Optional:->
       <ns:IncludeSubOwners>bool</ns:IncludeSubOwners>
       <!-Optional:->
       <ns:OwnerId>int</ns:OwnerId>
     </ns:GetCounterpartListRequest>
   </soapenv:Body>
 </soapenv:Envelope>


 Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="97caa6f7-e29f-4eac-9806-a9cfcd336792" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">guid</ActivityId>
   </s:Header>
  <s:Body>
     <GetCounterpartListResponse xmlns="http://www.saxobank.com/service/cms/2013/08">
       <CounterpartList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <CounterpartListData>
           <CounterpartId>int</CounterpartId>
           <Name>string</Name>
           <OwnerId>int</OwnerId>
         </CounterpartListData>
       </CounterpartList>
     </GetCounterpartListResponse>
   </s:Body>
 </s:Envelope>

Code Examples

Code example 32: GetCounterpartList 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:GetCounterpartListRequest>
       <ns:IncludeSubOwners>false</ns:IncludeSubOwners>
       <ns:OwnerId>3006888</ns:OwnerId>
     </ns:GetCounterpartListRequest>
   </soapenv:Body>
 </soapenv:Envelope>


 Code example 33: GetCounterpartList Response 

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
     <ActivityId CorrelationId="97caa6f7-e29f-4eac-9806-a9cfcd336792" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">51037542-96a7-44ed-86d1-7d8742fbb075</ActivityId>
   </s:Header>
   <s:Body>
     <GetCounterpartListResponse xmlns="http://www.saxobank.com/service/cms/2013/08">
       <CounterpartList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <CounterpartListData>
           <CounterpartId>2586888</CounterpartId>
           <Name>Client 2586888</Name>
           <OwnerId>3006888</OwnerId>
         </CounterpartListData>
         <CounterpartListData>
           <CounterpartId>5291800</CounterpartId>
           <Name>Client 5291800</Name>
           <OwnerId>3006888</OwnerId>
         </CounterpartListData>
         <CounterpartListData>
           <CounterpartId>5423149</CounterpartId>
           <Name>Client 5423149</Name>
           <OwnerId>3006888</OwnerId>
         </CounterpartListData>      
       </CounterpartList>
     </GetCounterpartListResponse>
   </s:Body>
 </s:Envelope>