CRMContractTemplate.Create Method
The Create method creates a contract template.
Syntax
[Visual Basic .NET]
Public Function Create(
ByVal Caller As CUserAuth,
ByVal ContractTemplate As String
) As String
[C#]
public string Create(
CUserAuth Caller,
string ContractTemplate
);
[C++]
public: String* Create(
CUserAuth* Caller,
String* ContractTemplate
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateContractTemplate privilege. See CUserAuth.
ContractTemplate
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 ID of the newly created contract template.
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.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;
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 5</name>";
strContractTemplateXml += "<abbreviation>CT5</abbreviation>";
strContractTemplateXml += "</contracttemplate>";
// Create a contract template
string strContractTemplateId = contractTemplate.Create(userAuth, 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