ClubManager.Api

FindMembership

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Membership

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**MembershipInstance** Parameters:
Name	Parameter	Data Type	Required
MembershipId	form	int	No
StartDate	form	DateTime	No
EndDate	form	DateTime	No
ContractEndDate	form	DateTime	No
Name	form	string	No
EnrolmentFee	form	decimal	No
InductionFee	form	decimal	No
MembershipFee	form	decimal?	No
DirectDebitPayment	form	decimal?	No
DirectDebitDate	form	DateTime?	No
Member	form	MemberInstance	No
MemberId	form	int	No
RefererMemberId	form	int?	No
PromotionId	form	int?	No
Payment1Fee	form	decimal?	No
Payment1Date	form	DateTime?	No
Payment2Fee	form	decimal?	No
Payment2Date	form	DateTime?	No
Payment1Type	form	int	No
Payment1Method	form	int	No
Payment2Type	form	int	No
Payment2Method	form	int	No
Payment3Type	form	int	No
Payment3Method	form	int	No
Payment3Fee	form	decimal?	No
Payment3Date	form	DateTime?	No
MembershipType	form	MembershipTypeInstance	No
MembershipTypeId	form	int?	No
ProviderId	form	int?	No
Definition	form	string	No
HasRecurringPayments	form	bool	No
Deleted	form	bool	No
Demo	form	bool	No
MembershipKey	form	Guid?	No
SessionsRemaining	form	int?	No
ClassesRemaining	form	int?	No
Cancelled	form	DateTime?	No
APICreated	form	DateTime?	No
SuspensionStart	form	DateTime?	No
SuspensionEnd	form	DateTime?	No
IpAddress	form	string	No

**MemberInstance** Parameters:
Name	Parameter	Data Type	Required
MemberId	form	int	No
MemberType	form	int	No
MembershipNumber	form	string	No
CardNumber	form	string	No
CompanyName	form	string	No
Surname	form	string	No
Forenames	form	string	No
Title	form	string	No
Gender	form	int	No
DateOfBirth	form	DateTime?	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
County	form	string	No
Postcode	form	string	No
HomePhone	form	string	No
MobilePhone	form	string	No
EmailAddress	form	string	No
EmailOptOut	form	bool	No
SmsOptOut	form	bool	No
PhoneOptOut	form	bool	No
LetterOptOut	form	bool	No
DirectDebitAccountHolder	form	string	No
DirectDebitAccountNumber	form	string	No
DirectDebitSortCode	form	string	No
JoinedDate	form	DateTime?	No
DirectDebitBankAddress	form	string	No
FullName	form	string	No
ExternalReference	form	string	No
Photo	form	byte[]	No
PhotoModifiedDate	form	DateTime?	No
Notes	form	string	No
Deleted	form	bool	No
Demo	form	bool	No
UseExternalStatus	form	bool	No
ExternalStatus	form	int	No
FreeText	form	string	No
MemberKey	form	Guid?	No
Balance	form	decimal	No
CreditLimit	form	decimal	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime?	No
DeletedDate	form	DateTime?	No
ExternalSource	form	int	No
RetentionMetric	form	decimal?	No
MonthlyAttendanceFrequency	form	decimal?	No
AssignedToUserId	form	int?	No
CreatedByUserId	form	int?	No
DeletedByUserId	form	int?	No
LossReason	form	LossReasonInstance	No
LossReasonId	form	int?	No
WonOrLost	form	int?	No
WonOrLostDate	form	DateTime?	No
GiftAidPermission	form	bool	No
PhotoPermission	form	bool?	No
FirstAidPermission	form	bool?	No
EmergencyContact	form	string	No
WonOrLostByUser	form	UserInstance	No
WonOrLostByUserId	form	int?	No
AgreedToTerms	form	DateTime?	No
OnlineBookingBanned	form	bool	No
Country	form	string	No
FingerprintEnrolled	form	DateTime?	No
LastPaymentAmount	form	decimal?	No
Pin	form	string	No
ProspectingPoints	form	int	No
AchievementPoints	form	int	No
ParentForenames	form	string	No
ParentSurname	form	string	No

**LossReasonInstance** Parameters:
Name	Parameter	Data Type	Required
LossReasonId	form	int	No
Reason	form	string	No
Deleted	form	bool	No
Demo	form	bool	No
Selectable	form	bool	No

**UserInstance** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
UserName	form	string	No
Name	form	string	No
Email	form	string	No
MobilePhone	form	string	No
Enabled	form	bool	No
LastLogin	form	DateTime?	No
Created	form	DateTime	No
Training	form	bool	No
Deleted	form	bool	No
CoursesCompleted	form	int	No
DisplayHomeNotification	form	bool?	No
TwoFactorEnabled	form	bool	No
EmailConfirmed	form	bool	No
MobilePhoneConfirmed	form	bool	No
Notifications	form	bool	No
ChangePassword	form	DateTime?	No
Activated	form	DateTime?	No

**MembershipTypeInstance** Parameters:
Name	Parameter	Data Type	Required
MembershipTypeId	form	int	No
Name	form	string	No
Description	form	string	No
Definition	form	string	No
Schedule	form	ScheduleInstance	No
ScheduleId	form	int	No
Deleted	form	bool	No
Demo	form	bool	No
Public	form	bool	No
SessionsRemaining	form	int?	No
ClassesRemaining	form	int?	No
SortOrder	form	int?	No
Special	form	bool	No
MultiSiteAccess	form	bool	No
MemberLimit	form	int	No
PromotionCode	form	string	No
PromotionStart	form	DateTime?	No
PromotionEnd	form	DateTime?	No
LicensesRemaining	form	int?	No
BookingAccessOnly	form	bool	No
SessionsPeriod	form	int?	No
SessionsFrequency	form	int?	No
StartsOn	form	DateTime?	No
AllowSelectionAfterStartsOn	form	bool	No

**ScheduleInstance** Parameters:
Name	Parameter	Data Type	Required
ScheduleId	form	int	No
Name	form	string	No
Description	form	string	No
MondayFrom	form	TimeSpan?	No
MondayTo	form	TimeSpan?	No
TuesdayFrom	form	TimeSpan?	No
TuesdayTo	form	TimeSpan?	No
WednesdayFrom	form	TimeSpan?	No
WednesdayTo	form	TimeSpan?	No
ThursdayFrom	form	TimeSpan?	No
ThursdayTo	form	TimeSpan?	No
FridayFrom	form	TimeSpan?	No
FridayTo	form	TimeSpan?	No
SaturdayFrom	form	TimeSpan?	No
SaturdayTo	form	TimeSpan?	No
SundayFrom	form	TimeSpan?	No
SundayTo	form	TimeSpan?	No
ScheduleType	form	int	No
Deleted	form	bool	No
Demo	form	bool	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	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/Query/Membership HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			MembershipId: 0,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			ContractEndDate: 0001-01-01,
			Name: String,
			EnrolmentFee: 0,
			InductionFee: 0,
			MembershipFee: 0,
			DirectDebitPayment: 0,
			DirectDebitDate: 0001-01-01,
			Member: 
			{
				MemberId: 0,
				MemberType: 0,
				MembershipNumber: String,
				CardNumber: String,
				CompanyName: String,
				Surname: String,
				Forenames: String,
				Title: String,
				Gender: 0,
				DateOfBirth: 0001-01-01,
				Address1: String,
				Address2: String,
				City: String,
				County: String,
				Postcode: String,
				HomePhone: String,
				MobilePhone: String,
				EmailAddress: String,
				EmailOptOut: False,
				SmsOptOut: False,
				PhoneOptOut: False,
				LetterOptOut: False,
				DirectDebitAccountHolder: String,
				DirectDebitAccountNumber: String,
				DirectDebitSortCode: String,
				JoinedDate: 0001-01-01,
				DirectDebitBankAddress: String,
				FullName: String,
				ExternalReference: String,
				Photo: AA==,
				PhotoModifiedDate: 0001-01-01,
				Notes: String,
				Deleted: False,
				Demo: False,
				UseExternalStatus: False,
				ExternalStatus: 0,
				FreeText: String,
				MemberKey: 00000000000000000000000000000000,
				Balance: 0,
				CreditLimit: 0,
				CreatedDate: 0001-01-01,
				ModifiedDate: 0001-01-01,
				DeletedDate: 0001-01-01,
				ExternalSource: 0,
				RetentionMetric: 0,
				MonthlyAttendanceFrequency: 0,
				AssignedToUserId: 0,
				CreatedByUserId: 0,
				DeletedByUserId: 0,
				LossReason: 
				{
					LossReasonId: 0,
					Reason: String,
					Deleted: False,
					Demo: False,
					Selectable: False
				},
				LossReasonId: 0,
				WonOrLost: 0,
				WonOrLostDate: 0001-01-01,
				GiftAidPermission: False,
				PhotoPermission: False,
				FirstAidPermission: False,
				EmergencyContact: String,
				WonOrLostByUser: 
				{
					UserId: 0,
					UserName: String,
					Name: String,
					Email: String,
					MobilePhone: String,
					Enabled: False,
					LastLogin: 0001-01-01,
					Created: 0001-01-01,
					Training: False,
					Deleted: False,
					CoursesCompleted: 0,
					DisplayHomeNotification: False,
					TwoFactorEnabled: False,
					EmailConfirmed: False,
					MobilePhoneConfirmed: False,
					Notifications: False,
					ChangePassword: 0001-01-01,
					Activated: 0001-01-01
				},
				WonOrLostByUserId: 0,
				AgreedToTerms: 0001-01-01,
				OnlineBookingBanned: False,
				Country: String,
				FingerprintEnrolled: 0001-01-01,
				LastPaymentAmount: 0,
				Pin: String,
				ProspectingPoints: 0,
				AchievementPoints: 0,
				ParentForenames: String,
				ParentSurname: String
			},
			MemberId: 0,
			RefererMemberId: 0,
			PromotionId: 0,
			Payment1Fee: 0,
			Payment1Date: 0001-01-01,
			Payment2Fee: 0,
			Payment2Date: 0001-01-01,
			Payment1Type: 0,
			Payment1Method: 0,
			Payment2Type: 0,
			Payment2Method: 0,
			Payment3Type: 0,
			Payment3Method: 0,
			Payment3Fee: 0,
			Payment3Date: 0001-01-01,
			MembershipType: 
			{
				MembershipTypeId: 0,
				Name: String,
				Description: String,
				Definition: String,
				Schedule: 
				{
					ScheduleId: 0,
					Name: String,
					Description: String,
					MondayFrom: PT0S,
					MondayTo: PT0S,
					TuesdayFrom: PT0S,
					TuesdayTo: PT0S,
					WednesdayFrom: PT0S,
					WednesdayTo: PT0S,
					ThursdayFrom: PT0S,
					ThursdayTo: PT0S,
					FridayFrom: PT0S,
					FridayTo: PT0S,
					SaturdayFrom: PT0S,
					SaturdayTo: PT0S,
					SundayFrom: PT0S,
					SundayTo: PT0S,
					ScheduleType: 0,
					Deleted: False,
					Demo: False
				},
				ScheduleId: 0,
				Deleted: False,
				Demo: False,
				Public: False,
				SessionsRemaining: 0,
				ClassesRemaining: 0,
				SortOrder: 0,
				Special: False,
				MultiSiteAccess: False,
				MemberLimit: 0,
				PromotionCode: String,
				PromotionStart: 0001-01-01,
				PromotionEnd: 0001-01-01,
				LicensesRemaining: 0,
				BookingAccessOnly: False,
				SessionsPeriod: 0,
				SessionsFrequency: 0,
				StartsOn: 0001-01-01,
				AllowSelectionAfterStartsOn: False
			},
			MembershipTypeId: 0,
			ProviderId: 0,
			Definition: String,
			HasRecurringPayments: False,
			Deleted: False,
			Demo: False,
			MembershipKey: 00000000000000000000000000000000,
			SessionsRemaining: 0,
			ClassesRemaining: 0,
			Cancelled: 0001-01-01,
			APICreated: 0001-01-01,
			SuspensionStart: 0001-01-01,
			SuspensionEnd: 0001-01-01,
			IpAddress: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}