GetPromoCodeGenerationStatus Method
Represents the current status of a promotion code import, export, or generation task.
Namespace: Microsoft.CommerceServer.Marketing.WebService
Assembly: Microsoft.CommerceServer.Marketing.DataManagement (in Microsoft.CommerceServer.Marketing.DataManagement.dll)
Syntax
'Declaration
<WebMethodAttribute> _
Public Overridable Function GetPromoCodeGenerationStatus ( _
promoCodeDefinitionId As Integer _
) As PromoCodeOperationStatus
'Usage
Dim instance As MarketingWebService
Dim promoCodeDefinitionId As Integer
Dim returnValue As PromoCodeOperationStatus
returnValue = instance.GetPromoCodeGenerationStatus(promoCodeDefinitionId)
[WebMethodAttribute]
public virtual PromoCodeOperationStatus GetPromoCodeGenerationStatus(
int promoCodeDefinitionId
)
[WebMethodAttribute]
public:
virtual PromoCodeOperationStatus^ GetPromoCodeGenerationStatus(
int promoCodeDefinitionId
)
public function GetPromoCodeGenerationStatus(
promoCodeDefinitionId : int
) : PromoCodeOperationStatus
Parameters
- promoCodeDefinitionId
Type: System..::.Int32
The identifier of the PromoCodeDefinition for which generation/import status is requested.
Return Value
Type: Microsoft.CommerceServer.Marketing..::.PromoCodeOperationStatus
A PromoCodeOperationStatus or nullNothingnullptra null reference (Nothing in Visual Basic).
Exceptions
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | The promoCodeDefinitionId provided is not a valid ID value. |
| InvalidImportTokenException | The promo code generation batch does not have a required entry in the upload table. |
| EntityDoesNotExistException | The promo code generation batch does not have a required entry in the promo code generation table. |
| ServerFaultException | An unexpected error occurred on the server. |
Remarks
Represents the current status of a promotion code import, export, or generation task. Gets the status of the last operation on a particular PromoCodeDefinition started by the user. This includes the percentage complete of the current phase of a promocode operation.
The discount must already be associated with a PromoCodeDefinition.
Permissions
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.