CRMContractDetail.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates a contract detail and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal ContractDetailId As String,
ByVal InContractDetailXml As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string ContractDetailId,
string InContractDetailXml
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* ContractDetailId,
String* InContractDetailXml
);
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.
ContractDetailId
Specifies the ID of the contract detail to be updated.
InContractDetailXml
Specifies the XML string containing the contract detail information. The XML schema is described by contractdetail.xsd.
Return Value
Returns a String type that specifies the XML data containing the contract detail information. The XML schema is described by contractdetail.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#]
// 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";
// CRMContractDetail proxy object
Microsoft.Crm.Platform.Proxy.CRMContractDetail contractdetail = new Microsoft.Crm.Platform.Proxy.CRMContractDetail();
contractdetail.Credentials = System.Net.CredentialCache.DefaultCredentials;
contractdetail.Url = strDir + "CRMContractDetail.srf";
string strErrorMsg;
string strContractDetailId = "{506D234F-CF08-40CD-8059-CC0DF6377A19}";
string xml;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the contract detail
xml = "<contractdetail>";
xml += "<title>contract detail changed</title>";
xml += "</contractdetail>";
// Update the contract detail, and then retrieve it
string strResultsXml = contractdetail.UpdateAndRetrieve (userAuth, strContractDetailId, xml);
}
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