BizMerchant.RetrieveAllTeams Method

The RetrieveAllTeams method retrieves all teams in the specified business unit hierarchy.

Syntax

[Visual Basic .NET]
Public Function RetrieveAllTeams(
  ByVal Caller As CUserAuth,
  ByVal BusinessId As String,
  ByVal ColumnSet As String
) As String
[C#]
public string RetrieveAllTeams(
  CUserAuth  Caller,
  string  BusinessId,
  string  ColumnSet
);
[C++]
public: String* RetrieveAllTeams(
  CUserAuth*  Caller,
  String*  BusinessId,
  String*  ColumnSet
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvReadBusinessUnit privilege and access rights on the objects to be retrieved. See CUserAuth.

BusinessId

Specifies the ID of the business unit. This ID is specified by the platform and obtained at creation time.

ColumnSet

Specifies an XML string describing the fields you would like returned for each team. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). The XML schema is described by team.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that contains the XML data listing teams in the business unit. The fields that are returned for each team depend on what fields are specified in the ColumnSet parameter. This XML string is in the format

<teams> + team1..N + </teams>

where the XML schema for each team is described by team.xsd.

Remarks

The team XML data that is returned is not in hierarchical format. Instead, it is a flat format, as shown in the following example:

Business hierarchy:

                 B0 - t01, t02
                /  \
  t11, t12 - B1     B2 - t21, t22

A call to RetrieveAllTeams for business unit B0 returns the following XML data:

<teams>
   <team>t01 fields</team>
   <team>t02 fields</team>
   <team>t11 fields</team>
   <team>t12 fields</team>
   <team>t21 fields</team>
   <team>t22 fields</team>
</teams>

Note   This order is not guaranteed unless OrderXml is specified in the ColumnSet parameter. See ColumnSetXML Schema.

Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.

The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.

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#]
// It is assumed that the caller has the privileges to perform this action,
// 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 = "http://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// BizMerchant proxy object
Microsoft.Crm.Platform.Proxy.BizMerchant merchant = new Microsoft.Crm.Platform.Proxy.BizMerchant ();
merchant.Credentials = System.Net.CredentialCache.DefaultCredentials;
merchant.Url = strDir + "BizMerchant.srf";

string strErrorMsg;
string strColumnSetXml;
string strResultXml;

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the columns that you want to retrieve
   strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>teamid</column>";
   strColumnSetXml += "<column>name</column>";
   strColumnSetXml += "<column>emailaddress</column>";
   strColumnSetXml += "</columnset>";

   // Retrieve all of the teams that are associated with the merchant
   strResultXml = merchant.RetrieveAllTeams(userAuth, userAuth.MerchantId, 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.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.