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": "1475de71-be9f-4817-be3d-fc287835e2b2", "payoutId": "f7946dbf-7004-4bf4-8b64-d4385971dc23", "payoutDescription": "sample string 3", "programId": "14c889f3-66d8-420a-bc00-99b2c958a1dc", "programName": "sample string 5", "memberId": "536e7c54-a8f3-4f43-bc0e-e4866181f032", "referralId": "150d43ce-7d99-4915-8050-3bf667e4eea3", "type": "sample string 6", "recipientId": "c3682629-7ae7-48fd-9781-60e87a198335", "recipientName": "sample string 7", "recipientEmailAddress": "sample string 8", "status": "sample string 9", "amount": 10.0, "createDate": "2022-07-01T04:52:49.1536868Z", "issueDate": "2022-07-01T04:52:49.1536868Z", "eligibilityDate": "2022-07-01T04:52:49.1536868Z", "description": "sample string 13", "transactionID": "e2893642-421e-4f9f-b1e5-f1e8e44302c0", "updateDate": "2022-07-01T04:52:49.1536868Z", "referralDisplayName": "sample string 15", "currencyCode": "sample string 16" }, { "id": "1475de71-be9f-4817-be3d-fc287835e2b2", "payoutId": "f7946dbf-7004-4bf4-8b64-d4385971dc23", "payoutDescription": "sample string 3", "programId": "14c889f3-66d8-420a-bc00-99b2c958a1dc", "programName": "sample string 5", "memberId": "536e7c54-a8f3-4f43-bc0e-e4866181f032", "referralId": "150d43ce-7d99-4915-8050-3bf667e4eea3", "type": "sample string 6", "recipientId": "c3682629-7ae7-48fd-9781-60e87a198335", "recipientName": "sample string 7", "recipientEmailAddress": "sample string 8", "status": "sample string 9", "amount": 10.0, "createDate": "2022-07-01T04:52:49.1536868Z", "issueDate": "2022-07-01T04:52:49.1536868Z", "eligibilityDate": "2022-07-01T04:52:49.1536868Z", "description": "sample string 13", "transactionID": "e2893642-421e-4f9f-b1e5-f1e8e44302c0", "updateDate": "2022-07-01T04:52:49.1536868Z", "referralDisplayName": "sample string 15", "currencyCode": "sample string 16" } ] }
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>1475de71-be9f-4817-be3d-fc287835e2b2</id> <payoutId>f7946dbf-7004-4bf4-8b64-d4385971dc23</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>14c889f3-66d8-420a-bc00-99b2c958a1dc</programId> <programName>sample string 5</programName> <memberId>536e7c54-a8f3-4f43-bc0e-e4866181f032</memberId> <referralId>150d43ce-7d99-4915-8050-3bf667e4eea3</referralId> <type>sample string 6</type> <recipientId>c3682629-7ae7-48fd-9781-60e87a198335</recipientId> <recipientName>sample string 7</recipientName> <recipientEmailAddress>sample string 8</recipientEmailAddress> <status>sample string 9</status> <amount>10</amount> <createDate>2022-07-01T04:52:49.1536868+00:00</createDate> <issueDate>2022-07-01T04:52:49.1536868+00:00</issueDate> <eligibilityDate>2022-07-01T04:52:49.1536868+00:00</eligibilityDate> <description>sample string 13</description> <transactionID>e2893642-421e-4f9f-b1e5-f1e8e44302c0</transactionID> <updateDate>2022-07-01T04:52:49.1536868+00:00</updateDate> <referralDisplayName>sample string 15</referralDisplayName> <currencyCode>sample string 16</currencyCode> </reward> <reward> <id>1475de71-be9f-4817-be3d-fc287835e2b2</id> <payoutId>f7946dbf-7004-4bf4-8b64-d4385971dc23</payoutId> <payoutDescription>sample string 3</payoutDescription> <programId>14c889f3-66d8-420a-bc00-99b2c958a1dc</programId> <programName>sample string 5</programName> <memberId>536e7c54-a8f3-4f43-bc0e-e4866181f032</memberId> <referralId>150d43ce-7d99-4915-8050-3bf667e4eea3</referralId> <type>sample string 6</type> <recipientId>c3682629-7ae7-48fd-9781-60e87a198335</recipientId> <recipientName>sample string 7</recipientName> <recipientEmailAddress>sample string 8</recipientEmailAddress> <status>sample string 9</status> <amount>10</amount> <createDate>2022-07-01T04:52:49.1536868+00:00</createDate> <issueDate>2022-07-01T04:52:49.1536868+00:00</issueDate> <eligibilityDate>2022-07-01T04:52:49.1536868+00:00</eligibilityDate> <description>sample string 13</description> <transactionID>e2893642-421e-4f9f-b1e5-f1e8e44302c0</transactionID> <updateDate>2022-07-01T04:52:49.1536868+00:00</updateDate> <referralDisplayName>sample string 15</referralDisplayName> <currencyCode>sample string 16</currencyCode> </reward> </rewards> </RewardSet>