CRMContractDetail.CreateAndRetrieve Method
The CreateAndRetrieve method creates a new contract detail and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InContractXml As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string InContractXml
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* InContractXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateContract and prvReadContract privileges. See CUserAuth.
InContractXml
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 newly created contract detail information. The XML schema is described by contractdetail.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.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 strContractId = "";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the contract detail
string xml = "<contractdetail>";
xml += "<contractid>" + strContractId + "</contractid>";
xml += "<title>Contract detail title</title>";
xml += "</contractdetail>";
// Create the contract detail, and then retrieve it
string strContractXML = contractdetail.CreateAndRetrieve(userAuth, 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