NetCard Server Web API

<back to all web services

LoginVisitor

The following routes are available for this service:
POST/Visitor/LoginVisitor

To override the Content-type in your clients 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.

POST /jsv/reply/LoginVisitor HTTP/1.1 
Host: ncapi.net.au 
Content-Type: text/jsv
Content-Length: length

{
	VisitorNumber: String
}
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
			}
		]
	},
	Visitor: 
	{
		VisitorId: 0,
		UserId: 0,
		VisitorNumber: String,
		User: 
		{
			UserId: 0,
			Username: String,
			Password: String,
			IsActive: False,
			LastUpdated: 0001-01-01,
			Title: String,
			FirstName: String,
			LastName: String,
			UserGenderId: 0,
			Phone: String,
			Email: String,
			MailAddress: String,
			MemberId: String,
			CustomerId: 0,
			UserAccessTypeId: 0,
			DateOfBirth: 0001-01-01,
			Mobile: String,
			StreetNumber: String,
			City: String,
			State: String,
			LocationId: 0,
			ChildLocationId: 0,
			UserAccount: 
			{
				UserId: 0,
				UserAccountTypeId: 0,
				AccountCode: String,
				AccountPin: String,
				AmountAvailable: 0,
				LastUpdated: 0001-01-01,
				IsActive: False,
				RewardPoints: 0,
				LunchMoney: 0,
				Block: String,
				SpendingLimit: 0,
				AmountAvailable2: 0,
				DischargeAmount: 0,
				LunchMoneyStatus: 0,
				AmountDeposited: 0,
				CardNumber: String,
				ProfileImagePath: String,
				IncidentalInStatus: 0,
				ActivationDate: 0001-01-01,
				Note: String,
				CollectedLunchMoneyDate: 0001-01-01,
				NumberOfShopsBuy: 0,
				PinLockOutTimeUtc: 0001-01-01,
				PalmId: String
			},
			Location: 
			{
				LocationId: 0,
				Name: String,
				Description: String,
				CustomerId: 0,
				ParentLocationId: 0
			},
			LastLogin: 0001-01-01,
			GroupId: 0,
			IsProntoDown: False
		}
	},
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String
		}
	]
}