CRMContract.Create Method

The Create method creates a contract.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvCreateContract privilege to perform this action. See CUserAuth.

Contract

Specifies an XML string containing the new contract information. The XML schema is described by contract.xsd.

Return Value

Returns a String type that specifies the ID of the newly created contract.

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#]
// 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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

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

string strErrorMsg;
string strContractTemplateId = "{AC82B545-FD28-4F77-BF25-7D34985F3E6D}";
string strAccountId = "{FD42F065-174B-499C-90DA-0DE56405085A}";
string start = DateTime.Now.ToString("s");
string end = DateTime.Now.AddDays(5).ToString("s");
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string for the new contract
   string strContractXml = "<contract>";
   strContractXml += "<title>Contract Title</title>";
   strContractXml += "<contracttemplateid>" + strContractTemplateId + "</contracttemplateid>";
   strContractXml += "<customerid type=\"" + Microsoft.CRM.Flags.ObjectType.otAccount.ToString() +"\">";
   strContractXml += strAccountId + "</customerid>";
   strContractXml += "<billingcustomerid type=\"" + Microsoft.CRM.Flags.ObjectType.otAccount.ToString() +"\">";
   strContractXml += strAccountId + "</billingcustomerid>";
   strContractXml += "<billingstarton>" + start + "</billingstarton>";
   strContractXml += "<billingendon>" + end + "</billingendon>";
   strContractXml += "<activeon>" + start + "</activeon>";
   strContractXml += "<expireson>" + end + "</expireson>";
   strContractXml += "<ownerid type=\"" + Microsoft.CRM.Flags.ObjectType.otSystemUser.ToString() +"\">";
   strContractXml += userAuth.UserId + "</ownerid>";
   strContractXml += "</contract>";

   string strContractId = contract.Create(userAuth, 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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.