CRMTerritory.RetrieveByObject Method
The RetrieveByObject method retrieves all territories that are associated with an object (organization).
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Entity As CObjectName,
ByVal ColumnSet As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Entity,
string ColumnSet
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Entity,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadTerritory privilege and access rights on the objects to be retrieved. See CUserAuth.
Entity
Specifies the object (organization). See CObjectName.
ColumnSet
Specifies an XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). 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 set of territories requested. The fields that are returned depend on what fields are specified in the ColumnSet parameter. This XML string is in the format
<territories> + territory1..N + </territories>
where the XML schema for each territory is described by territory.xsd.
Remarks
Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.
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#]
// 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 = "https://" + strServerName + "/" + 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";
// CRMTerritory proxy object
Microsoft.Crm.Platform.Proxy.CRMTerritory territory = new Microsoft.Crm.Platform.Proxy.CRMTerritory();
territory.Credentials = System.Net.CredentialCache.DefaultCredentials;
territory.Url = strDir + "CRMTerritory.srf";
string strErrorMsg;
string strOrganizationId = "{B2BB383D-C9F2-4235-98DE-4A59F7569432}";
try
{
Microsoft.Crm.Platform.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>";
Microsoft.Crm.Platform.Proxy.CObjectName objName = new Microsoft.Crm.Platform.Proxy.CObjectName();
objName.Id = strOrganizationId;
objName.Type = Microsoft.Crm.Platform.Proxy.ObjectType.otOrganization;
// Retrieve the territories for this organization
string strResultsXml = territory.RetrieveByObject(userAuth, objName, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also