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 .xml suffix or ?format=xml

HTTP + XML

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: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSocarCardBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.POS">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <Status>0</Status>
    <Message>String</Message>
    <Results>
      <PointsBalance>0</PointsBalance>
      <BalanceAmount>0</BalanceAmount>
      <OperationStatus>0</OperationStatus>
      <PN>String</PN>
    </Results>
  </Result>
</GetSocarCardBalanceResponse>