CurrencyBalance

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
(New page: ==Summary== Returns a user’s currency balance based on goods id passed. '''Resource''' GET api/v1/currencyBalance '''Parameters''' goods user '''Example Call''' http://demo-loyalty....)
Current revision (22:43, 29 June 2016) (edit) (undo)
m (→Summary)
 
Line 5: Line 5:
'''Resource'''
'''Resource'''
-
GET
+
GET api/v1/currencyBalance
-
api/v1/currencyBalance
+
'''Parameters'''
'''Parameters'''
-
goods
+
* goods
-
user
+
* user
-
'''Example Call'''
+
Example Request Body
-
http://demo-loyalty.promodev.eprize.com api/v1/currencyBalance
+
-
{
+
{
-
“currency”: “demoPoints”,
+
"currency": "demoPoints",
-
"user": 288000000034,
+
"user": 288000000034,
-
}
+
}
Example Response: Success
Example Response: Success
-
{
+
{
-
"Response": {
+
"Response":
-
"__Type__": "Vo",
+
{
-
"__TypeCode__": "Common.UserCurrencyBalance",
+
"__Type__": "Vo",
-
"Id": 312000000074,
+
"__TypeCode__": "Common.UserCurrencyBalance",
-
"TransactionDate": "2015-09-22T15:13:47.944-04:00",
+
"Id": 312000000074,
-
"UserId": 288000000034,
+
"TransactionDate": "2015-09-22T15:13:47.944-04:00",
-
"GoodsTypeId": 990850001,
+
"UserId": 288000000034,
-
"GoodsId": 2.1844100000004e+14,
+
"GoodsTypeId": 990850001,
-
"SupplierId": 2.0876200000002e+14,
+
"GoodsId": 21844100000004545444443414,
-
"ReferenceId": 0,
+
"SupplierId": 210876200000002332342342342,
-
"FulfilmentId": 0,
+
"ReferenceId": 0,
-
"IssueDate": "2015-09-22T15:13:47.944-04:00",
+
"FulfilmentId": 0,
-
"CertificateNumber": "",
+
"IssueDate": "2015-09-22T15:13:47.944-04:00",
-
"IssueAmount": 200,
+
"CertificateNumber": "",
-
"RedeemedAmount": 3,
+
"IssueAmount": 200,
-
"ExpiryDate": null,
+
"RedeemedAmount": 3,
-
"ExpiryMessageCode": "",
+
"ExpiryDate": null,
-
"Closed": false,
+
"ExpiryMessageCode": "",
-
"RecordCode": 313000000074,
+
"Closed": false,
-
"Balance": 197
+
"RecordCode": 313000000074,
 +
"Balance": 197
 +
}
}
}
-
}
 

Current revision

Summary

Returns a user’s currency balance based on goods id passed.

Resource

GET api/v1/currencyBalance

Parameters

  • goods
  • user

Example Request Body 

   {
       "currency":  "demoPoints",
       "user":  288000000034,
   }


Example Response: Success 

   {
       "Response": 
       {        
           "__Type__": "Vo",
           "__TypeCode__": "Common.UserCurrencyBalance",     
           "Id": 312000000074,     
           "TransactionDate": "2015-09-22T15:13:47.944-04:00",     
           "UserId": 288000000034,     
           "GoodsTypeId": 990850001,     
           "GoodsId": 21844100000004545444443414,     
           "SupplierId": 210876200000002332342342342,     
           "ReferenceId": 0,     
           "FulfilmentId": 0,     
           "IssueDate": "2015-09-22T15:13:47.944-04:00",     
           "CertificateNumber": "",     
           "IssueAmount": 200,     
           "RedeemedAmount": 3,     
           "ExpiryDate": null,     
           "ExpiryMessageCode": "",     
           "Closed": false,     
           "RecordCode": 313000000074,     
           "Balance": 197   
       }
   }
Retrieved from "https://code.helloworld.com/wiki/index.php/CurrencyBalance"
Personal tools