CurrencyActivityStatement

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
(New page: ==Summary== Returns the list of currency transactions for a particular user. Activity Types that are returned: REDEMPTION, ADJUSTMENT, REWARD '''Resource''' GET api/v1/currencyActivityS...)
Current revision (22:46, 29 June 2016) (edit) (undo)
m (→Summary)
 
Line 3: Line 3:
Returns the list of currency transactions for a particular user.
Returns the list of currency transactions for a particular user.
-
Activity Types that are returned: REDEMPTION, ADJUSTMENT, REWARD
+
Activity Types that are returned:
 +
 
 +
*REDEMPTION
 +
*ADJUSTMENT
 +
*REWARD
'''Resource'''
'''Resource'''
-
GET
+
GET api/v1/currencyActivityStatement
-
api/v1/currencyActivityStatement
+
'''Parameters'''
'''Parameters'''
-
currency
+
* currency
-
user
+
* user
-
dateRange
+
* dateRange
-
sortBy
+
* sortBy
-
sortOrder
+
* sortOrder
-
 
+
-
'''Example Call'''
+
-
http://demo-loyalty.promodev.eprize.com api/v1/currencyActivityStatement
+
-
{
+
Example Request Body
-
“currency”: “demoPoints”,
+
{
-
"user": 350000000016,
+
"currency": "demoPoints",
-
“datRange”: 20131001-20161001,
+
"user": 350000000016,
-
“sortBy”:”Activity Date”,
+
"dateRange": 20131001-20161001,
-
“sortOrder”: “DESC”,
+
"sortBy": "Activity Date",
-
}
+
"sortOrder": "DESC",
 +
}
Example Response: Success
Example Response: Success
-
{
+
{
-
"Response":{
+
"Response":
-
"__Type__":"VoList",
+
{
-
"List":[
+
"__Type__":"VoList",
-
{
+
"List":
-
"Id":312000000119,
+
[{
-
"Activity Date":"2015-09-22T18:10:11.417-04:00",
+
"Id":312000000119,
-
"Description":"Adjustment - Points Adjustment",
+
"Activity Date":"2015-09-22T18:10:11.417-04:00",
-
"BaseRewardAmount":5000,
+
"Description":"Adjustment - Points Adjustment",
-
"Bonus Reward Amount":0,
+
"BaseRewardAmount":5000,
-
"Amount":5000,
+
"Bonus Reward Amount":0,
-
"Balance":5000,
+
"Amount":5000,
-
"Activity Type":"ADJUSTMENT"
+
"Balance":5000,
-
},
+
"Activity Type":"ADJUSTMENT"
-
{
+
},
-
"Id":313000000168,
+
{
-
"Activity Date":"2015-09-22T18:12:31.838-04:00",
+
"Id":313000000168,
-
"Description":"1 Digital Item Redemption",
+
"Activity Date":"2015-09-22T18:12:31.838-04:00",
-
"BaseRewardAmount":-2007,
+
"Description":"1 Digital Item Redemption",
-
"Bonus Reward Amount":0,
+
"BaseRewardAmount":-2007,
-
"Amount":-2007,
+
"Bonus Reward Amount":0,
-
"Balance":2993,
+
"Amount":-2007,
-
"Activity Type":"REDEMPTION"
+
"Balance":2993,
-
}
+
"Activity Type":"REDEMPTION"
-
],
+
}],
-
"TotalRecords":2,
+
"TotalRecords":2,
-
"RecordsPerPage":500,
+
"RecordsPerPage":500,
-
"CurrentDataRecordNumber":0
+
"CurrentDataRecordNumber":0
-
}
+
}
-
}
+
}

Current revision

Summary

Returns the list of currency transactions for a particular user.

Activity Types that are returned:

  • REDEMPTION
  • ADJUSTMENT
  • REWARD

Resource GET api/v1/currencyActivityStatement

Parameters

  • currency
  • user
  • dateRange
  • sortBy
  • sortOrder

Example Request Body 

   {
        "currency":  "demoPoints",
        "user":  350000000016,
        "dateRange": 20131001-20161001,
        "sortBy": "Activity Date",
        "sortOrder": "DESC",
   }


Example Response: Success 

   {
       "Response":
       {
           "__Type__":"VoList",
               "List":
               [{
                   "Id":312000000119,
                   "Activity Date":"2015-09-22T18:10:11.417-04:00",
                   "Description":"Adjustment - Points Adjustment",
                   "BaseRewardAmount":5000,
                   "Bonus Reward Amount":0,
                   "Amount":5000,
                   "Balance":5000,
                   "Activity Type":"ADJUSTMENT"
               },
               {
                   "Id":313000000168,
                   "Activity Date":"2015-09-22T18:12:31.838-04:00",
                   "Description":"1 Digital Item Redemption",
                   "BaseRewardAmount":-2007,
                   "Bonus Reward Amount":0,
                   "Amount":-2007,
                   "Balance":2993,
                   "Activity Type":"REDEMPTION"
               }],
           "TotalRecords":2,
           "RecordsPerPage":500,
           "CurrentDataRecordNumber":0
       }
   }
Retrieved from "https://code.helloworld.com/wiki/index.php/CurrencyActivityStatement"
Personal tools