BizUser.Retrieve Method
The Retrieve method retrieves user information.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal UserId As String,
ByVal ColumnSetXml As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string UserId,
string ColumnSetXml
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* UserId,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadUser privilege to perform this action. See CUserAuth.
UserId
Specifies the ID of the user. This ID is specified by the platform and obtained at creation time.
ColumnSetXml
Specifies an XML string describing the fields you would like returned for each user. Passing "" or null returns all columns. The XML schema is described by systemuser.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the user information. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by systermuser.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";
string strErrorMsg;
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>fullname</column>";
strColumnSetXml += "<column>internalemailaddress</column>";
strColumnSetXml += "</columnset>";
// Retrieve the information for that user
string strUserXml = bizUser.Retrieve(userAuth, strUserID, 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