GET api/rewardrules

Gets a list of member rewards rules.

Request Information

URI Parameters

Query String: programId={programId}

Name	Description	Type	Additional information
programId	ID of the program Required.	string	None.

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A set of reward rules.

Type: MemberRule

Name	Type	Additional information
ruleId	globally unique identifier	None.
isEnabled	boolean	None.
description	string	None.
ruleStartDate	date	None.
ruleEndDate	date	None.
programId	globally unique identifier	None.
payoutId	globally unique identifier	None.
payoutType	string	None.
payoutDescription	string	None.
reward	RewardSpecification	None.
trigger	RewardTrigger	None.
deliveryType	string	None.
deliveryDelay	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ruleId": "5df4509a-e498-4525-8a4e-f2f8d46e748c",
  "isEnabled": true,
  "description": "sample string 1",
  "ruleStartDate": "2024-11-12T10:36:45.7532418Z",
  "ruleEndDate": "2024-11-12T10:36:45.7532418Z",
  "programId": "13b357c0-096e-4f54-92af-764d805be440",
  "payoutId": "a6c5e57a-1571-4af2-b8cc-df5606c147b4",
  "payoutType": "sample string 2",
  "payoutDescription": "sample string 3",
  "reward": {
    "amountCalculationMethod": "sample string 1",
    "fixedAmount": 1.0,
    "startingPercentAmount": 1.0,
    "limitPercentAmount": 1.0,
    "percentRoundingRule": "sample string 2"
  },
  "trigger": {
    "referralStatus": "sample string 1",
    "numberReferralUpperLimit": 1,
    "numberReferralLowerLimit": 1,
    "salesAmountUpperLimit": 1.0,
    "salesAmountLowerLimit": 1.0
  },
  "deliveryType": "sample string 4",
  "deliveryDelay": 1
}

application/xml, text/xml

Sample:

<memberRewardRule xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ruleId>5df4509a-e498-4525-8a4e-f2f8d46e748c</ruleId>
  <isEnabled>true</isEnabled>
  <description>sample string 1</description>
  <ruleStartDate>2024-11-12T10:36:45.7532418+00:00</ruleStartDate>
  <ruleEndDate>2024-11-12T10:36:45.7532418+00:00</ruleEndDate>
  <programId>13b357c0-096e-4f54-92af-764d805be440</programId>
  <payoutId>a6c5e57a-1571-4af2-b8cc-df5606c147b4</payoutId>
  <payoutType>sample string 2</payoutType>
  <payoutDescription>sample string 3</payoutDescription>
  <reward>
    <amountCalculationMethod>sample string 1</amountCalculationMethod>
    <fixedAmount>1</fixedAmount>
    <limitPercentAmount>1</limitPercentAmount>
    <percentRoundingRule>sample string 2</percentRoundingRule>
    <startingPercentAmount>1</startingPercentAmount>
  </reward>
  <trigger>
    <numberReferralLowerLimit>1</numberReferralLowerLimit>
    <numberReferralUpperLimit>1</numberReferralUpperLimit>
    <referralStatus>sample string 1</referralStatus>
    <salesAmountLowerLimit>1</salesAmountLowerLimit>
    <salesAmountUpperLimit>1</salesAmountUpperLimit>
  </trigger>
  <deliveryType>sample string 4</deliveryType>
  <deliveryDelay>1</deliveryDelay>
</memberRewardRule>