Request to retrieve the data on the specified Counterpart, specifically the PII data such as name.
SuBject | URL |
WSDL | |
End Point URL | |
Operation | GetCounterpart |
The following input parameters are available in the request.
Parameter | Mandatory | Description |
SessionID | Y | SessionID returned by the Login Request |
CounterpartId | Y |
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:GetCounterpartRequest> <!-Optional:-> <ns:CounterpartId>string</ns:CounterpartId> </ns:GetCounterpartRequest> </soapenv:Body> </soapenv:Envelope>
Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <ActivityId CorrelationId="1794cdc0-a428-4e84-8dd3-91b9a1a0e069" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">0fca49fb-0fe8-4af3-9162-6e8a9ed27e74</ActivityId> </s:Header> <s:Body> <GetCounterpartResponse xmlns="http://www.saxobank.com/service/cms/2013/08"> <Counterpart xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <OwnerId>int</OwnerId> <CounterpartId>int</CounterpartId> <Name>string</Name> <BaseCurrency>string</BaseCurrency> <IsProfessional>bool</IsProfessional> <Language>string</Language> <CountryOfResidence>string</CountryOfResidence> <TaxCountry>string</TaxCountry> <Email>string</Email> <CompanyRegistrationNumber>string</CompanyRegistrationNumber> <Active>bool</Active> <MarginProfileId>int</MarginProfileId> <MarginCallProfileId>int</MarginCallProfileId> <ProductClassifications> <ProductAreaClassification> <ProductAreaId>int</ProductAreaId> <ProductClassificationId>int</ProductClassificationId> <AppropriatenessTestPassedId>bool</AppropriatenessTestPassedId> </ProductAreaClassification> </ProductClassifications> <ReliefAtSource> <Enabled>bool</Enabled> <TypeId>int</TypeId> <ExpiryDate>DateTime</ExpiryDate> <NifId>string</NifId> </ReliefAtSource> <Vat>string</Vat> <SwissTax> <BrokerIntroduced>bool</BrokerIntroduced> <StampDutyExempt>bool</StampDutyExempt> <Residency>bool</Residency> </SwissTax> <CounterpartType>string</CounterpartType> <WealthManagementProfileId>int</WealthManagementProfileId> <PositionNettingModeId>int</PositionNettingModeId> </Counterpart> </GetCounterpartResponse> </s:Body> </s:Envelope>
Code Examples
Code example 28: GetCounterpart 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:GetCounterpartRequest> <ns:CounterpartId>3006888</ns:CounterpartId> </ns:GetCounterpartRequest> </soapenv:Body> </soapenv:Envelope>
Code example 29: GetCounterpart Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <ActivityId CorrelationId="1794cdc0-a428-4e84-8dd3-91b9a1a0e069" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">0fca49fb-0fe8-4af3-9162-6e8a9ed27e74</ActivityId> </s:Header> <s:Body> <GetCounterpartResponse xmlns="http://www.saxobank.com/service/cms/2013/08"> <Counterpart xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <OwnerId>961917</OwnerId> <CounterpartId>3006888</CounterpartId> <Name>A_Name_3006888</Name> <BaseCurrency>USD</BaseCurrency> <IsProfessional>false</IsProfessional> <Language>EN</Language> <CountryOfResidence>SG</CountryOfResidence> <TaxCountry>SG</TaxCountry> <Email>email@email.com</Email> <CompanyRegistrationNumber>1234</CompanyRegistrationNumber> <Active>true</Active> <MarginProfileId>969</MarginProfileId> <MarginCallProfileId>1047</MarginCallProfileId> <ProductClassifications> <ProductAreaClassification> <ProductAreaId>0</ProductAreaId> <ProductClassificationId>2</ProductClassificationId> <AppropriatenessTestPassedId i:nil="true"/> </ProductAreaClassification> <ProductAreaClassification> <ProductAreaId>1</ProductAreaId> <ProductClassificationId>0</ProductClassificationId> <AppropriatenessTestPassedId i:nil="true"/> </ProductAreaClassification> <ProductAreaClassification> <ProductAreaId>2</ProductAreaId> <ProductClassificationId>0</ProductClassificationId> <AppropriatenessTestPassedId i:nil="true"/> </ProductAreaClassification> </ProductClassifications> <ReliefAtSource> <Enabled>false</Enabled> <TypeId>0</TypeId> <ExpiryDate i:nil="true"/> <NifId i:nil="true"/> </ReliefAtSource> <Vat i:nil="true"/> <SwissTax> <BrokerIntroduced>false</BrokerIntroduced> <StampDutyExempt>false</StampDutyExempt> <Residency>false</Residency> </SwissTax> <CounterpartType i:nil="true"/> <WealthManagementProfileId>0</WealthManagementProfileId> </Counterpart> </GetCounterpartResponse> </s:Body> </s:Envelope>