CRMContractTemplate.UpdateAndRetrieve Method

The UpdateAndRetrieve method updates a contract template and then retrieves it.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvReadContractTemplate and prvWriteContractTemplate privileges and access rights on the object to be updated. See CUserAuth.

ContractTemplateId

Specifies the ID of the contract template to be updated.

InContractTemplateXml

Specifies the XML string containing the contract template information. The XML schema is described by contracttemplate.xsd.

Return Value

Returns a String type that specifies the XML data containing the contract template information. The XML schema is described by contracttemplate.xsd.

Remarks

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#]
// 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 = "http://" + strServer + "/" + 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";

// CRMContractTemplate proxy object
Microsoft.Crm.Platform.Proxy.CRMContractTemplate contractTemplate = new Microsoft.Crm.Platform.Proxy.CRMContractTemplate ();
contractTemplate.Credentials = System.Net.CredentialCache.DefaultCredentials;
contractTemplate.Url = strDir + "CRMContractTemplate.srf";

string strErrorMsg;
string strContractTemplateId = "{AC82B545-FD28-4F77-BF25-7D34985F3E6D}";

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

   // Set up the XML string for the new contract template
   string strContractTemplateXml = "<contracttemplate>";
   strContractTemplateXml += "<name>Contract Template 1</name>";
   strContractTemplateXml += "<abbreviation>CT5 changed</abbreviation>";
   strContractTemplateXml += "</contracttemplate>";

   // Update the template, and then retrieve it
   string resultXml = contractTemplate.UpdateAndRetrieve (userAuth, strContractTemplateId, strContractTemplateXml);
}
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

© 2005 Microsoft Corporation. All rights reserved.