ApexERPHost

<back to all web services

GetSocarCardBalance

Requires Authentication
The following routes are available for this service:
GET/POS/SocarCards/Balance/{CardNum}
GET/POS/SocarCards/Balance
GetSocarCardBalance Parameters:
NameParameterData TypeRequiredDescription
CardNumpathstringNo
GetSocarCardBalanceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformSocarBalanceResponseNo
SocarBalanceResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformintNo
MessageformstringNo
ResultsformSocarBalanceResultNo
SocarBalanceResult Parameters:
NameParameterData TypeRequiredDescription
PointsBalanceformdecimal?No
BalanceAmountformdecimal?No
OperationStatusformint?No
PNformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .wire suffix or ?format=wire

HTTP + WIRE

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /POS/SocarCards/Balance/{CardNum} HTTP/1.1 
Host: 10.10.0.107 
Accept: application/x-wire
HTTP/1.1 200 OK
Content-Type: application/x-wire
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Result":{"Status":0,"Message":"String","Results":{"PointsBalance":0,"BalanceAmount":0,"OperationStatus":0,"PN":"String"}}}