GET api/commercialpolicies/getactive/{sdate}

Request Information

URI Parameters

Name	Description	Type	Additional information
sdate		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of CommercialPolicy

Name	Type	Additional information
Id	integer	None.
PolicyType	CommercialPolicyTypes	None.
Title	string	None.
Description	string	None.
AdjustmentValue	decimal number	None.
AdjustmentType	CommercialPolicyAdjustmentTypes	None.
PromoCode	string	None.
UsageLimit	integer	None.
UsageCount	integer	None.
IsActive	boolean	None.
PricelistId	integer	None.
PromoMessage	string	None.
Priority	integer	None.
AllowManualDiscount	boolean	None.
ManualAdjustmentMin	decimal number	None.
ManualAdjustmentMax	decimal number	None.
ExcludeLinesFromInvoicePolicies	boolean	None.
PolicyScope	CommercialPolicyScopes	None.
TargetScope	CommercialPolicyTargetScopes	None.
PolicyGroupId	integer	None.
ExclusivityScope	CommercialPolicyExclusivityScopes	None.
IsUserSelectable	boolean	None.
SelectionMode	CommercialPolicySelectionModes	None.
IsStackable	boolean	None.
StackMethod	CommercialPolicyStackMethods	None.
RequiresApproval	boolean	None.
ApprovalMethod	CommercialPolicyApprovalMethods	None.
ApprovalOtpLength	byte	None.
ApprovalOtpTTLSeconds	integer	None.
ApprovalScope	CommercialPolicyApprovalScopes	None.
ApprovalApproverRole	string	None.
ApprovalSmsProviderId	integer	None.
ApprovalSmsDocumentId	integer	None.
ApprovalSmsTo	string	None.
SelectionDefinition	SelectionDefinition	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "PolicyType": 0,
    "Title": "sample string 2",
    "Description": "sample string 3",
    "AdjustmentValue": 4.0,
    "AdjustmentType": 0,
    "PromoCode": "sample string 5",
    "UsageLimit": 6,
    "UsageCount": 7,
    "IsActive": true,
    "PricelistId": 9,
    "PromoMessage": "sample string 10",
    "Priority": 11,
    "AllowManualDiscount": true,
    "ManualAdjustmentMin": 13.0,
    "ManualAdjustmentMax": 14.0,
    "ExcludeLinesFromInvoicePolicies": true,
    "PolicyScope": 1,
    "TargetScope": 1,
    "PolicyGroupId": 16,
    "ExclusivityScope": 0,
    "IsUserSelectable": true,
    "SelectionMode": 0,
    "IsStackable": true,
    "StackMethod": 0,
    "RequiresApproval": true,
    "ApprovalMethod": 0,
    "ApprovalOtpLength": 64,
    "ApprovalOtpTTLSeconds": 21,
    "ApprovalScope": 1,
    "ApprovalApproverRole": "sample string 22",
    "ApprovalSmsProviderId": 23,
    "ApprovalSmsDocumentId": 24,
    "ApprovalSmsTo": "sample string 25",
    "SelectionDefinition": {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "IsEnabled": true,
      "Nodes": [
        {
          "Title": "sample string 1",
          "Id": 2,
          "SelectionDefinitionId": 3,
          "ParentNodeId": 1,
          "NodeType": 0,
          "LogicalOperator": 0,
          "EntityType": 0,
          "SelectionFieldId": 4,
          "ContextFieldCode": "sample string 5",
          "FieldOperator": 1,
          "ValuesJson": "sample string 6",
          "ParametersJson": "sample string 7",
          "DisplayOrder": 8,
          "IsEnabled": true
        },
        {
          "Title": "sample string 1",
          "Id": 2,
          "SelectionDefinitionId": 3,
          "ParentNodeId": 1,
          "NodeType": 0,
          "LogicalOperator": 0,
          "EntityType": 0,
          "SelectionFieldId": 4,
          "ContextFieldCode": "sample string 5",
          "FieldOperator": 1,
          "ValuesJson": "sample string 6",
          "ParametersJson": "sample string 7",
          "DisplayOrder": 8,
          "IsEnabled": true
        }
      ]
    }
  },
  {
    "Id": 1,
    "PolicyType": 0,
    "Title": "sample string 2",
    "Description": "sample string 3",
    "AdjustmentValue": 4.0,
    "AdjustmentType": 0,
    "PromoCode": "sample string 5",
    "UsageLimit": 6,
    "UsageCount": 7,
    "IsActive": true,
    "PricelistId": 9,
    "PromoMessage": "sample string 10",
    "Priority": 11,
    "AllowManualDiscount": true,
    "ManualAdjustmentMin": 13.0,
    "ManualAdjustmentMax": 14.0,
    "ExcludeLinesFromInvoicePolicies": true,
    "PolicyScope": 1,
    "TargetScope": 1,
    "PolicyGroupId": 16,
    "ExclusivityScope": 0,
    "IsUserSelectable": true,
    "SelectionMode": 0,
    "IsStackable": true,
    "StackMethod": 0,
    "RequiresApproval": true,
    "ApprovalMethod": 0,
    "ApprovalOtpLength": 64,
    "ApprovalOtpTTLSeconds": 21,
    "ApprovalScope": 1,
    "ApprovalApproverRole": "sample string 22",
    "ApprovalSmsProviderId": 23,
    "ApprovalSmsDocumentId": 24,
    "ApprovalSmsTo": "sample string 25",
    "SelectionDefinition": {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "IsEnabled": true,
      "Nodes": [
        {
          "Title": "sample string 1",
          "Id": 2,
          "SelectionDefinitionId": 3,
          "ParentNodeId": 1,
          "NodeType": 0,
          "LogicalOperator": 0,
          "EntityType": 0,
          "SelectionFieldId": 4,
          "ContextFieldCode": "sample string 5",
          "FieldOperator": 1,
          "ValuesJson": "sample string 6",
          "ParametersJson": "sample string 7",
          "DisplayOrder": 8,
          "IsEnabled": true
        },
        {
          "Title": "sample string 1",
          "Id": 2,
          "SelectionDefinitionId": 3,
          "ParentNodeId": 1,
          "NodeType": 0,
          "LogicalOperator": 0,
          "EntityType": 0,
          "SelectionFieldId": 4,
          "ContextFieldCode": "sample string 5",
          "FieldOperator": 1,
          "ValuesJson": "sample string 6",
          "ParametersJson": "sample string 7",
          "DisplayOrder": 8,
          "IsEnabled": true
        }
      ]
    }
  }
]