CRMTerritory.CreateAndRetrieve Method
The CreateAndRetrieve method creates a territory and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal EntityXml As String,
ByVal ColumnSet As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string EntityXml,
string ColumnSet
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* EntityXml,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateTerritory and prvReadTerritory privileges to perform this action. See CUserAuth.
EntityXml
Specifies an XML string representing the territory. The XML schema is described by territory.xsd.
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 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
This method always returns a single object so any filter criteria specified in the ColumnSet parameter are ignored.
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 XML string for the territory
string xml = "<territory>";
xml += "<name>Central</name>";
xml += "<organizationid>" + strOrganizationId + "</organizationid>";
xml += "<managerid>" + userAuth.UserId + "</managerid>";
xml += "</territory>";
// 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>";
// Create the territory
string strResultTerritoryXml = territory.CreateAndRetrieve (userAuth, xml, 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