SecRole.CreateAndRetrieve Method
The CreateAndRetrieve method creates a new role and then returns the complete XML data for the newly created role.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InRoleXML As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string InRoleXML
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* InRoleXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateRole and prvReadRole privileges. See CUserAuth.
InRoleXML
Specifies an XML string describing the role to be created. The role name and the business unit ID are required fields in the XML string. The XML schema is described by role.xsd.
Return Value
Returns a String type that specifies the XML data describing the returned role. The XML schema is described by role.xsd.
Remarks
The name field in the parameter RoleXML must contain a unique role name.
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";
// strVirtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string strVirtualDirectory = "mscrmservices";
// Create the URL to the SRF files for platform objects
string strDir = "https://" + strServer + "/" + strVirtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser user = new Microsoft.Crm.Platform.Proxy.BizUser ();
user.Credentials = System.Net.CredentialCache.DefaultCredentials;
user.Url = strDir + "BizUser.srf";
// SecRole proxy object
Microsoft.Crm.Platform.Proxy.SecRole secRole = new Microsoft.Crm.Platform.Proxy.SecRole ();
secRole.Credentials = System.Net.CredentialCache.DefaultCredentials;
secRole.Url = strDir + "SecRole.srf";
// Declare the caller
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = null;
string strErrorMsg;
try
{
// Get the UserAuth of the current logged-on user
userAuth = user.WhoAmI();
// Set up the XML string for the role in the business unit of the caller
string strSecRoleXML = "<role>" +
"<name>My New Custom Security Role</name>" +
"<businessunitid>" + userAuth.MerchantId + "</businessunitid>" +
"</role>";
// Create and then retrieve the custom role
string strNewRoleXml = secRole.CreateAndRetrieve(userAuth, strSecRoleXML);
}
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 + "Source: " + err.Source );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also