BizOrganization.Retrieve Method
The Retrieve method retrieves the XML data for an organization.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal OrganizationId As String,
ByVal ColumnSet As String
) As String
[C#]
public string Retrieve(
string OrganizationId,
string ColumnSet
);
[C++]
public: String* Retrieve(
String* OrganizationId,
String* ColumnSet
);
Parameters
OrganizationId
Specifies the ID of the organization. This ID is obtained when you create the Organizational Unit in Active Directory.
ColumnSet
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 organization.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the organization. The XML schema is described by organization.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
Note The following example contains sample data for the administrator login name and password. This is for illustration only. User credentials should never be hard-coded. For more information, see Building Secure ASP.NET Applications, https://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnnetsec/html/SecNetch12.asp.
[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 + "/";
// BizOrganization proxy object
Microsoft.CRM.Proxy.BizOrganization organization = new Microsoft.CRM.Proxy.BizOrganization ();
organization.Credentials = System.Net.CredentialCache.DefaultCredentials;
organization.Url = strDir + "BizOrganization.srf";
string strOrgXML = "";
string strOrgName = "MyOrganization";
// Get the GUID of an OU from Active Directory
// that is going to represent the OU for the Microsoft CRM organization object
// The name of the OU should be the same as the name of the Microsoft CRM organization
// The organization is created in Microsoft CRM
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}";
// See Note above regarding the use of hard-coded passwords
string strDomainAdminUserName = "Administrator";
string strDomainAdminUserPass = "Admin";
string strDomainName = "MyDomain";
string strErrorMsg = "";
string strRetrievedOrgXML = "";
try
{
// Retrieve the organization
strRetrievedOrgXML = organization.Retrieve(strOrgId, "");
}
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