CRMTerritory.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates a territory and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal EntityId As String,
ByVal EntityXml As String,
ByVal ColumnSet As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string EntityId,
string EntityXml,
string ColumnSet
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* EntityId,
String* EntityXml,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. The caller must have prvWriteTerritory and prvReadTerritory privileges to perform this action. See CUserAuth.
EntityId
Specifies the ID of the territory that is to be updated.
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 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 = "https://" + 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 XML string for the territory
string xml = "<territory >";
xml += "<name >Territory2</name >";
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>";
// Update the territory, and then retrieve it
string resultXml = territory.UpdateAndRetrieve (userAuth, strTerritoryId, 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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also