CRMTerritory.Retrieve Method

The Retrieve method retrieves a territory.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadTerritory privilege to perform this action. See CUserAuth.

EntityId

Specifies the ID of the territory that is to be retrieved.

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 territory.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data containing the territory information. The fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by territory.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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "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://" + strServerName + "/" + 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";

// CRMTerritory proxy object
Microsoft.CRM.Proxy.CRMTerritory territory = new Microsoft.CRM.Proxy.CRMTerritory();
territory.Credentials = System.Net.CredentialCache.DefaultCredentials;
territory.Url = strDir + "CRMTerritory.srf";

string strErrorMsg;
string strTerritoryId = "{465FB749-DF3A-4105-KJ8D-603DB8726496}";

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

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

   // Retrieve the territory
   string strResultsXml = territory.Retrieve (userAuth, strTerritoryId, 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

© 2003 Microsoft Corporation. All rights reserved.