GET api/rewards
Gets a list of rewards ordered by create date. The offset and count parameters can be used to specify the set of referrals.
Request Information
URI Parameters
Query String: programId={programId}&memberId={memberId}&query={query}&status={status}&sort={sort}&dateFrom={dateFrom}&dateTo={dateTo}&offset={offset}&count={count}
Name | Description | Type | Additional information |
---|---|---|---|
programId |
ID of the program, program name, or program title. Optional. |
string |
None. |
memberId |
ID of the member. Optional. |
globally unique identifier |
None. |
query |
If specified, the recipient must have this value as its email address, id, or external id. You can also query by member referral code Optional. |
string |
None. |
status |
If specified, the rewards must be in this status. Accepted values are 'Pending', 'Processing', and 'Issued'. Optional |
string |
None. |
sort |
Column to sort by. Accepted values: Create_Dt_Asc , Create_Dt_Desc , Reward_Action_Desc, Reward_Action_Asc, Recipient_Name_Desc, Recipient_Name_Asc, Complete_Dt_Desc, Complete_Dt_Asc. Optional. |
string |
Default value is Create_Dt_Desc |
dateFrom |
Show all members created after this date. Optional. |
date |
None. |
dateTo |
Show all members created before this date. Optional. |
date |
None. |
offset |
Starting index (0 based) of the referrals. Optional. |
integer |
Default value is 0 |
count |
Count of referrals rewards. Optional. |
integer |
Default value is 2147483647 |
Body Parameters
None.
Response Information
Resource Description
[HTTP Status 200 - OK] A set of rewards.
Type: RewardSet
Name | Description | Type | Additional information |
---|---|---|---|
rewards | Collection of Reward |
None. |
|
offset |
Starting index (0 based) of the elements in the set. |
integer |
None. |
total |
Total number of elements in the set. |
integer |
None. |
message |
The message provides more information about the results of the client's request. Review this field for error information. |
string |
None. |
Response Formats
application/json, text/json
{ "offset": 1, "total": 2, "message": "sample string 3", "rewards": [ { "id": "ef7144fe-28c2-431d-aeb2-359d6bbbf0a7", "payoutId": "5beeac24-ea10-4e55-bfee-a078f7eec187", "payoutDescription": "sample string 3", "programId": "ff0a9f4c-213b-429b-8979-b1646b73614e", "programName": "sample string 5", "memberId": "63f9f745-7358-4cf9-ab50-5da61193736a", "referralId": "2a84cf52-42d7-468a-ade1-67059350d541", "type": "sample string 6", "recipientId": "a7e7aed4-5b96-4d46-9a8e-c4e9211dc2c8", "recipientName": "sample string 7", "recipientEmailAddress": "sample string 8", "recipientExternalIdentifier": "sample string 9", "externalIdentifier": "sample string 10", "status": "sample string 11", "amount": 12.0, "createDate": "2024-03-29T04:36:24.2247085Z", "issueDate": "2024-03-29T04:36:24.2247085Z", "eligibilityDate": "2024-03-29T04:36:24.2247085Z", "description": "sample string 15", "transactionID": "e4b96c1f-2ce0-45c2-8076-47e58ab1fa5f", "updateDate": "2024-03-29T04:36:24.2247085Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "c05b8056-4f64-4f5d-8fb9-d2c5db1147cf", "paymentType": "sample string 20", "paymentCode": "sample string 21", "completeNote": "sample string 22" }, { "id": "ef7144fe-28c2-431d-aeb2-359d6bbbf0a7", "payoutId": "5beeac24-ea10-4e55-bfee-a078f7eec187", "payoutDescription": "sample string 3", "programId": "ff0a9f4c-213b-429b-8979-b1646b73614e", "programName": "sample string 5", "memberId": "63f9f745-7358-4cf9-ab50-5da61193736a", "referralId": "2a84cf52-42d7-468a-ade1-67059350d541", "type": "sample string 6", "recipientId": "a7e7aed4-5b96-4d46-9a8e-c4e9211dc2c8", "recipientName": "sample string 7", "recipientEmailAddress": "sample string 8", "recipientExternalIdentifier": "sample string 9", "externalIdentifier": "sample string 10", "status": "sample string 11", "amount": 12.0, "createDate": "2024-03-29T04:36:24.2247085Z", "issueDate": "2024-03-29T04:36:24.2247085Z", "eligibilityDate": "2024-03-29T04:36:24.2247085Z", "description": "sample string 15", "transactionID": "e4b96c1f-2ce0-45c2-8076-47e58ab1fa5f", "updateDate": "2024-03-29T04:36:24.2247085Z", "referralDisplayName": "sample string 17", "currencyCode": "sample string 18", "source": "sample string 19", "programRewardRuleId": "c05b8056-4f64-4f5d-8fb9-d2c5db1147cf", "paymentType": "sample string 20", "paymentCode": "sample string 21", "completeNote": "sample string 22" } ] }
application/xml, text/xml
<RewardSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <offset>1</offset> <total>2</total> <message>sample string 3</message> <rewards> <reward> <id>ef7144fe-28c2-431d-aeb2-359d6bbbf0a7</id> <payoutId>5beeac24-ea10-4e55-bfee-a078f7eec187</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>ff0a9f4c-213b-429b-8979-b1646b73614e</programId> <programName>sample string 5</programName> <memberId>63f9f745-7358-4cf9-ab50-5da61193736a</memberId> <referralId>2a84cf52-42d7-468a-ade1-67059350d541</referralId> <type>sample string 6</type> <recipientId>a7e7aed4-5b96-4d46-9a8e-c4e9211dc2c8</recipientId> <recipientName>sample string 7</recipientName> <recipientEmailAddress>sample string 8</recipientEmailAddress> <recipientExternalIdentifier>sample string 9</recipientExternalIdentifier> <externalIdentifier>sample string 10</externalIdentifier> <status>sample string 11</status> <amount>12</amount> <createDate>2024-03-29T04:36:24.2247085+00:00</createDate> <issueDate>2024-03-29T04:36:24.2247085+00:00</issueDate> <eligibilityDate>2024-03-29T04:36:24.2247085+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>e4b96c1f-2ce0-45c2-8076-47e58ab1fa5f</transactionID> <updateDate>2024-03-29T04:36:24.2247085+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>c05b8056-4f64-4f5d-8fb9-d2c5db1147cf</programRewardRuleId> <paymentType>sample string 20</paymentType> <paymentCode>sample string 21</paymentCode> <completeNote>sample string 22</completeNote> </reward> <reward> <id>ef7144fe-28c2-431d-aeb2-359d6bbbf0a7</id> <payoutId>5beeac24-ea10-4e55-bfee-a078f7eec187</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>ff0a9f4c-213b-429b-8979-b1646b73614e</programId> <programName>sample string 5</programName> <memberId>63f9f745-7358-4cf9-ab50-5da61193736a</memberId> <referralId>2a84cf52-42d7-468a-ade1-67059350d541</referralId> <type>sample string 6</type> <recipientId>a7e7aed4-5b96-4d46-9a8e-c4e9211dc2c8</recipientId> <recipientName>sample string 7</recipientName> <recipientEmailAddress>sample string 8</recipientEmailAddress> <recipientExternalIdentifier>sample string 9</recipientExternalIdentifier> <externalIdentifier>sample string 10</externalIdentifier> <status>sample string 11</status> <amount>12</amount> <createDate>2024-03-29T04:36:24.2247085+00:00</createDate> <issueDate>2024-03-29T04:36:24.2247085+00:00</issueDate> <eligibilityDate>2024-03-29T04:36:24.2247085+00:00</eligibilityDate> <description>sample string 15</description> <transactionID>e4b96c1f-2ce0-45c2-8076-47e58ab1fa5f</transactionID> <updateDate>2024-03-29T04:36:24.2247085+00:00</updateDate> <referralDisplayName>sample string 17</referralDisplayName> <currencyCode>sample string 18</currencyCode> <source>sample string 19</source> <programRewardRuleId>c05b8056-4f64-4f5d-8fb9-d2c5db1147cf</programRewardRuleId> <paymentType>sample string 20</paymentType> <paymentCode>sample string 21</paymentCode> <completeNote>sample string 22</completeNote> </reward> </rewards> </RewardSet>