ClubManager.Api

MemberService.GetMemberByKeyRequest

The following routes are available for this service:
POST,GET	/api/Member/GetMemberByKey

**Member** Parameters:
Name	Parameter	Data Type	Required
MemberId	form	int	No
BranchId	form	int	No
MembershipNumber	form	string	No
JoinedDate	form	DateTime?	No
CardNumber	form	string	No
CompanyName	form	string	No
Gender	form	Gender	No
GenderName	form	string	No
FullName	form	string	No
Title	form	string	No
Forenames	form	string	No
Surname	form	string	No
Address1	form	string	No
Address2	form	string	No
County	form	string	No
City	form	string	No
HomePhone	form	string	No
MobilePhone	form	string	No
EmailAddress	form	string	No
ExternalReference	form	string	No
Country	form	string	No
EmailOptOut	form	bool	No
SmsOptOut	form	bool	No
PhoneOptOut	form	bool	No
LetterOptOut	form	bool	No
UseExternalStatus	form	bool	No
ExternalStatus	form	ExternalStatus	No
DateOfBirth	form	DateTime?	No
Postcode	form	string	No
Notes	form	string	No
StartDate	form	DateTime?	No
Expires	form	DateTime?	No
SessionsRemaining	form	int?	No
ContractEndDate	form	DateTime?	No
DaysRemaining	form	int	No
MembershipType	form	string	No
LastAttendance	form	DateTime?	No
Attendance	form	int	No
MemberType	form	MemberType	No
RecurringPayments	form	int	No
OverduePayments	form	int	No
AttendanceThisWeek	form	int	No
retentionMetric	form	decimal	No
MonthlyAttendanceFrequency	form	decimal	No
TotalProductSpend	form	decimal	No
JournalEntry	form	string	No
Balance	form	decimal	No
CreditLimit	form	decimal	No
guid	form	Guid	No
MembershipState	form	MembershipState	No
BookingsAttended	form	int	No
DateOfLastBooking	form	DateTime?	No
PhotoModifiedDate	form	DateTime?	No
CreatedDate	form	DateTime?	No
ModifiedDate	form	DateTime?	No
DeletedDate	form	DateTime?	No
MemberKey	form	Guid	No
CreatedByUserId	form	int	No
AssignedToUserId	form	int	No
DeletedByUserId	form	int	No
GiftAidPermission	form	bool	No
FirstAidPermission	form	bool	No
PhotoPermission	form	bool	No
EmergencyContact	form	string	No
WonOrLost	form	int?	No
WonOrLostDate	form	DateTime?	No
WonOrLostByUserId	form	int?	No
LicenseReference	form	string	No
LicenseStartDate	form	DateTime?	No
LicenseRenewalDate	form	DateTime?	No
AgreedToTerms	form	DateTime?	No
OnlineBookingBanned	form	bool	No
ChildBranchId	form	int?	No
ChildBranch	form	string	No
ProspectingPoints	form	int	No
AchievementPoints	form	int	No
ParentForenames	form	string	No
ParentSurname	form	string	No
GradingReadiness	form	int	No
DirectDebitAccountHolder	form	string	No
DirectDebitAccountNumber	form	string	No
DirectDebitSortCode	form	string	No
DirectDebitBankAddress	form	string	No
InvitedDate	form	DateTime?	No
Grade	form	string	No
ColourLeft	form	string	No
ColourRight	form	string	No
SessionsToComplete	form	int	No
UniqueId	form	string	No
PreferenceLink	form	string	No
MarketingAllLink	form	string	No
MarketingNoneLink	form	string	No
AppRegistrationId	form	string	No
AppRegistrationLink	form	string	No
AppQrImageLink	form	string	No
CardNumberQrImageLink	form	string	No
PhotoThumbnailLink	form	string	No
ContentTypesOptIn	form	MessageTemplateContentType	No
TemplateTypesOptIn	form	MessageTemplateType	No
CanEmail	form	bool	No
CanDirectMail	form	bool	No
CanSMS	form	bool	No
CanTelephone	form	bool	No
NoMarketingConsent	form	bool	No
CanSendInvite	form	bool	No
BranchKey	form	Guid	No
SageLink	form	string	No
SageLastPaymentDate	form	DateTime?	No
SageFirstPaymentDate	form	DateTime?	No
SageLastPaymentAmount	form	decimal?	No
SageFirstPaymentAmount	form	decimal?	No
SageTotalPaid	form	decimal?	No

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.

POST /api/Member/GetMemberByKey HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MemberKey: 00000000000000000000000000000000
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MemberId: 0,
	BranchId: 0,
	MembershipNumber: String,
	JoinedDate: 0001-01-01,
	CardNumber: String,
	CompanyName: String,
	Gender: Unknown,
	GenderName: String,
	FullName: String,
	Title: String,
	Forenames: String,
	Surname: String,
	Address1: String,
	Address2: String,
	County: String,
	City: String,
	HomePhone: String,
	MobilePhone: String,
	EmailAddress: String,
	ExternalReference: String,
	Country: String,
	EmailOptOut: False,
	SmsOptOut: False,
	PhoneOptOut: False,
	LetterOptOut: False,
	UseExternalStatus: False,
	ExternalStatus: Off,
	DateOfBirth: 0001-01-01,
	Postcode: String,
	Notes: String,
	StartDate: 0001-01-01,
	Expires: 0001-01-01,
	SessionsRemaining: 0,
	ContractEndDate: 0001-01-01,
	DaysRemaining: 0,
	MembershipType: String,
	LastAttendance: 0001-01-01,
	Attendance: 0,
	MemberType: Prospect,
	RecurringPayments: 0,
	OverduePayments: 0,
	AttendanceThisWeek: 0,
	retentionMetric: 0,
	MonthlyAttendanceFrequency: 0,
	TotalProductSpend: 0,
	JournalEntry: String,
	Balance: 0,
	CreditLimit: 0,
	guid: 00000000000000000000000000000000,
	MembershipState: Prospect,
	BookingsAttended: 0,
	DateOfLastBooking: 0001-01-01,
	PhotoModifiedDate: 0001-01-01,
	CreatedDate: 0001-01-01,
	ModifiedDate: 0001-01-01,
	DeletedDate: 0001-01-01,
	MemberKey: 00000000000000000000000000000000,
	CreatedByUserId: 0,
	AssignedToUserId: 0,
	DeletedByUserId: 0,
	GiftAidPermission: False,
	FirstAidPermission: False,
	PhotoPermission: False,
	EmergencyContact: String,
	WonOrLost: 0,
	WonOrLostDate: 0001-01-01,
	WonOrLostByUserId: 0,
	LicenseReference: String,
	LicenseStartDate: 0001-01-01,
	LicenseRenewalDate: 0001-01-01,
	AgreedToTerms: 0001-01-01,
	OnlineBookingBanned: False,
	ChildBranchId: 0,
	ChildBranch: String,
	ProspectingPoints: 0,
	AchievementPoints: 0,
	ParentForenames: String,
	ParentSurname: String,
	GradingReadiness: 0,
	DirectDebitAccountHolder: String,
	DirectDebitAccountNumber: String,
	DirectDebitSortCode: String,
	DirectDebitBankAddress: String,
	InvitedDate: 0001-01-01,
	Grade: String,
	ColourLeft: String,
	ColourRight: String,
	SessionsToComplete: 0,
	UniqueId: buUUT9zb7g16xAG0lpGq2KBZrR3K0Y57B+HimRWN7SU=,
	PreferenceLink: "https://secure.clubmanagercentral.com/Portal/Login/Transfer?id=buUUT9zb7g16xAG0lpGq2KBZrR3K0Y57B%2bHimRWN7SU%3d",
	MarketingAllLink: "https://secure.clubmanagercentral.com/Portal/Login/TransferOptInAll?id=buUUT9zb7g16xAG0lpGq2KBZrR3K0Y57B%2bHimRWN7SU%3d",
	MarketingNoneLink: "https://secure.clubmanagercentral.com/Portal/Login/TransferOptOutAll?id=buUUT9zb7g16xAG0lpGq2KBZrR3K0Y57B%2bHimRWN7SU%3d",
	AppRegistrationId: tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6p4LgwcDFjjr/3H3YHPzOiH9drVrBJwGRBwslbxmZQYyGs2eyt4NVai5QjQMhj0TP6w==,
	AppRegistrationLink: "https://secure.clubmanagercentral.com/Register?id=tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6p4LgwcDFjjr/3H3YHPzOiH9drVrBJwGRBwslbxmZQYyGs2eyt4NVai5QjQMhj0TP6w==",
	AppQrImageLink: "https://secure.clubmanagercentral.com/Member.mvc/GetQrByMemberId?id=36xZln01EfE80ZF7GFWKkg==",
	CardNumberQrImageLink: "https://secure.clubmanagercentral.com/Member.mvc/GetCardNumberQRByMemberId?id=36xZln01EfE80ZF7GFWKkg==",
	PhotoThumbnailLink: "https://secure.clubmanagercentral.com/Member.mvc/GetPhotoThumbnailByMemberId?id=36xZln01EfE80ZF7GFWKkg==",
	ContentTypesOptIn: 1,
	TemplateTypesOptIn: 1,
	CanEmail: False,
	CanDirectMail: False,
	CanSMS: True,
	CanTelephone: False,
	NoMarketingConsent: False,
	CanSendInvite: False,
	BranchKey: 00000000000000000000000000000000,
	SageLink: String,
	SageLastPaymentDate: 0001-01-01,
	SageFirstPaymentDate: 0001-01-01,
	SageLastPaymentAmount: 0,
	SageFirstPaymentAmount: 0,
	SageTotalPaid: 0
}