| GET | /POS/SocarCards/Balance/{CardNum} | ||
|---|---|---|---|
| GET | /POS/SocarCards/Balance |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardNum | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | SocarBalanceResponse | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | int | No | |
| Message | form | string | No | |
| Results | form | SocarBalanceResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PointsBalance | form | decimal? | No | |
| BalanceAmount | form | decimal? | No | |
| OperationStatus | form | int? | No | |
| PN | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}