LoseOpportunityRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to set the state of an opportunity to Lost.

For the Web API use the LoseOpportunity Action.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.LoseOpportunityRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class LoseOpportunityRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class LoseOpportunityRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod LoseOpportunityRequest()

Initializes a new instance of the LoseOpportunityRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty OpportunityClose

Gets or sets the opportunity close activity. Required.

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Status

Gets or sets a status of the opportunity. Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the LoseOpportunityResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the OpportunityClose entity. For a complete list of the required privileges, see LoseOpportunity message privileges.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


var loseOppRequest = new LoseOpportunityRequest
{
    OpportunityClose = new OpportunityClose
    {
        OpportunityId = new EntityReference
            (Opportunity.EntityLogicalName, _loseOpportunityId)
    },
    Status = new OptionSetValue((int)opportunity_statuscode.Canceled)
};

_serviceProxy.Execute(loseOppRequest);

Console.WriteLine("Opportunity closed as Lost.");

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

LoseOpportunityResponse
Microsoft.Crm.Sdk.Messages Namespace
LoseOpportunity message privileges
Sales entities (lead, opportunity, competitor, quote, order, invoice)
Sample: Process quotes, sales orders and invoices
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright