ApexERPHost

<back to all web services

GetLoyaltyCard

Requires Authentication
The following routes are available for this service:
GET/LoyaltyCards/{Number}
GET/LoyaltyCards
GetLoyaltyCard Parameters:
NameParameterData TypeRequiredDescription
NumberpathstringNo
GetLoyaltyCardResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformLoyaltyCardNo
LoyaltyCard Parameters:
NameParameterData TypeRequiredDescription
CardIdformstringNo
NumberformstringNo
PasswordformstringNo
CreateDateformDateTimeNo
ActivationDateformDateTime?No
PointsformdecimalNo
DiscountformdecimalNo
StatusformintNo
CardTypeformintNo
SuspendedformboolNo
IssuerformLoyaltyCardIssuerNo
OwnerformPersonNo
AvaliablePointsformdecimalNo
LoyaltyCardIssuer Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
NameformstringNo
IssuerTypeformintNo
SuspendedformboolNo
CityIdformstringNo
Person Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SnformstringNo
FirstNameformstringNo
SecondNameformstringNo
LastNameformstringNo
FullNameformstringNo
DateOfBirthformDateTime?No
SexformintNo
UnIdformGuidNo

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

<GetLoyaltyCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
  <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>
    <CardId>String</CardId>
    <Number>String</Number>
    <Password>String</Password>
    <CreateDate>0001-01-01T00:00:00</CreateDate>
    <ActivationDate>0001-01-01T00:00:00</ActivationDate>
    <Points>0</Points>
    <Discount>0</Discount>
    <Status>0</Status>
    <CardType>0</CardType>
    <Suspended>false</Suspended>
    <Issuer>
      <Id>0</Id>
      <Code>String</Code>
      <Name>String</Name>
      <IssuerType>0</IssuerType>
      <Suspended>false</Suspended>
      <CityId>String</CityId>
    </Issuer>
    <Owner>
      <Id>0</Id>
      <Sn>String</Sn>
      <FirstName>String</FirstName>
      <SecondName>String</SecondName>
      <LastName>String</LastName>
      <FullName>String</FullName>
      <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
      <Sex>0</Sex>
      <UnId>00000000-0000-0000-0000-000000000000</UnId>
    </Owner>
    <AvaliablePoints>0</AvaliablePoints>
  </Result>
</GetLoyaltyCardResponse>