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

HTTP + JSV

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: 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: 
	{
		CardId: String,
		Number: String,
		Password: String,
		CreateDate: 0001-01-01,
		ActivationDate: 0001-01-01,
		Points: 0,
		Discount: 0,
		Status: 0,
		CardType: 0,
		Suspended: False,
		Issuer: 
		{
			Id: 0,
			Code: String,
			Name: String,
			IssuerType: 0,
			Suspended: False,
			CityId: String
		},
		Owner: 
		{
			Id: 0,
			Sn: String,
			FirstName: String,
			SecondName: String,
			LastName: String,
			FullName: String,
			DateOfBirth: 0001-01-01,
			Sex: 0,
			UnId: 00000000000000000000000000000000
		},
		AvaliablePoints: 0
	}
}