GET api/LoyaltyPoints
Retrieve accounts loyalty points
Request Information
URI Parameters
None.
Body Parameters
LoyaltyPointsReqName | Description | Type | Additional information |
---|---|---|---|
Company |
The company name |
string |
Required String length: inclusive between 0 and 6 |
AccountCode |
Optional to retrieve only specific Account Code. |
string |
String length: inclusive between 0 and 15 |
PageSize |
Optional paging parameter. Return x records per page |
integer |
None. |
PageNumber |
Optional paging parameter. Number of page to return |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "Company": "DEMO", "AccountCode": "320001", "PageSize": 2, "PageNumber": 1 }
Response Information
Resource Description
LoyaltyPointsResName | Description | Type | Additional information |
---|---|---|---|
msgControl |
Contains information about the response |
MsgControl |
None. |
LoyaltyPointsList |
List of points |
Collection of LoyaltyPoints |
None. |
Response Formats
application/json, text/json
Sample:
{ "msgControl": { "result": 0, "Message": "Corresponding success and error message", "MethodName": "api/SalesPerson GET", "AppName": "EsoftWebApi", "EsoftUser": "ESOFT", "User": "Username", "Password": "Password", "SystemDate": "2025-01-06T22:32:15.2189577+02:00", "GenList": [], "GenMsg1": "", "GenMsg2": "", "GenMsg3": "" }, "LoyaltyPointsList": [ { "AccountCode": "320001", "Points": 1000 }, { "AccountCode": "320002", "Points": 75 } ] }