CRMAccount.RetrieveSubContacts Method
The RetrieveSubContacts method retrieves the sub-contacts of the specified account.
Syntax
[Visual Basic .NET]
Public Function RetrieveSubContacts(
ByVal Caller As CUserAuth,
ByVal AccountId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveSubContacts(
CUserAuth Caller,
string AccountId,
string ColumnSetXML
);
[C++]
public: String* RetrieveSubContacts(
CUserAuth* Caller,
String* AccountId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadContact privilege to perform this action. See CUserAuth.
AccountId
Specifies the ID of the account.
ColumnSetXML
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in contact.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the sub-contacts requested. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by contact.xsd.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMAccount proxy object
Microsoft.CRM.Proxy.CRMAccount account = new Microsoft.CRM.Proxy.CRMAccount ();
account.Credentials = System.Net.CredentialCache.DefaultCredentials;
account.Url = strDir + "CRMAccount.srf";
string strErrorMsg;
string strAccountId = "{3E24E79C-7EC5-4473-95FF-7E46FEBB534B}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>contactid</column>";
strColumnSetXml += "<column>fullname</column>";
strColumnSetXml += "</columnset>";
// Retrieve the contacts
string strResultsXml = account.RetrieveSubContacts(userAuth, strAccountId, strColumnSetXml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.CRM.Proxy
Assembly: microsoft.crm.proxy.dll
See Also