BizMerchant.CreateAndRetrieve Method
The CreateAndRetrieve method creates a child business unit and a user in the child business unit, and then retrieves the newly created business unit and user information.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal BusinessXML As String,
ByVal UserXML As String,
ByRef OutUserXML As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string BusinessXML,
string UserXML,
out string OutUserXML
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* BusinessXML,
String* UserXML,
String** OutUserXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateBusinessUnit and prvReadBusinessUnit privileges. See CUserAuth.
BusinessXML
Specifies an XML string containing the business information. The XML schema is described by businessunit.xsd.
UserXML
Specifies an XML string containing the user information. The XML schema is described by systemuser.xsd.
OutUserXML
[out] Specifies an XML string containing the newly created user information. The XML schema is described by systemuser.xsd.
Return Value
Returns a String type that specifies the XML data containing the newly created business unit. The XML schema is described by businessunit.xsd.
Remarks
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#]
// 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.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;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the business unit
string strBusiness = "<businessunit>";
strBusiness+= "<parentbusinessunitid>" + userAuth.MerchantId + "</parentbusinessunitid>";
strBusiness+= "<name>" + "Adventure Works" + "</name>";
strBusiness+= "<description>" + "My Business Description" + "</description>";
strBusiness+= "</businessunit>";
string sUserName = "Fukiko Ogisu";
string strUserXml = "<systemuser><domainname>" + sUserName + "</domainname></systemuser>";;
string strOutUserXml;
string strResultXml = merchant.CreateAndRetrieve(userAuth, strBusiness, strUserXml, out strOutUserXml);
// Now strResultXml contains the newly created business information,
// and strOutUserXml contains the newly created user information
}
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