CRMContract.Renew Method
The Renew method renews a contract and returns the XML data for the new contract. It also creates the new contract details for the new contract.
Syntax
[Visual Basic .NET]
Public Function Renew(
ByVal Caller As CUserAuth,
ByVal ContractId As String,
ByVal Status As Integer,
ByVal IncludeCanceledLines As Integer
) As String
[C#]
public string Renew(
CUserAuth Caller,
string ContractId,
int Status,
int IncludeCanceledLines
);
[C++]
public: String* Renew(
CUserAuth* Caller,
String* ContractId,
long Status,
long IncludeCanceledLines
);
Parameters
Caller
Specifies the identity of the caller. See CUserAuth.
ContractId
Specifies the ID of the contract to be renewed.
Status
Specifies the state of the contract. You can use this parameter to specify application status. See Remarks.
IncludeCanceledLines
Specifies a flag that indicates whether the canceled line items of the originating contract are to be included in the renewed contract.
Return Value
Returns a String type that specifies the XML data representing the renewed contract. The XML schema is described by contract.xsd.
Remarks
Note The Status parameter corresponds to Status Reason in the Microsoft CRM application. If you pass -1 for this parameter, the platform sets the status to the appropriate value for the Microsoft CRM application. You can use the RetrieveStatus method to retrieve the status codes used in the application.
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();
// Invoice the contract
contract.Invoice(userAuth, strContractId, -1);
// Renew the contract
contract.Renew(userAuth, strContractId, -1, 0);
}
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