CRMContract.UpdateAndRetrieve Method

The UpdateAndRetrieve method updates a contract and then retrieves it.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteContract and prvReadContract privileges and access rights on the object to be modified. See CUserAuth.

ContractId

Specifies the ID of the contract.

InContractXml

Specifies an XML string describing the contract. The XML schema is described by contract.xsd.

Return Value

Returns a String type that specifies the XML data representing the newly updated contract. The XML schema is described by contract.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 = "https://" + 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";

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

string strErrorMsg;
string strContractId = "{A87D821C-DF25-4FA0-A4F6-E2F41AB2B336}"; 
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string to update the contract
   string strContractXml = "<contract>";
   strContractXml += "<billingstarton>" + start + "</billingstarton>";
   strContractXml += "<billingendon>" + end + "</billingendon>";
   strContractXml += "</contract>";

   // Update and then retrieve the contract
   string strNewContractXml = contract.UpdateAndRetrieve(userAuth, strContractId, strContractXml);
}
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.