ClubManager.Api

<back to all web services

FindMembership

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/Membership
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
MembershipInstance Parameters:
NameParameterData TypeRequiredDescription
MembershipIdformintNo
StartDateformDateTimeNo
EndDateformDateTimeNo
ContractEndDateformDateTimeNo
NameformstringNo
EnrolmentFeeformdecimalNo
InductionFeeformdecimalNo
MembershipFeeformdecimal?No
DirectDebitPaymentformdecimal?No
DirectDebitDateformDateTime?No
MemberformMemberInstanceNo
MemberIdformintNo
RefererMemberIdformint?No
PromotionIdformint?No
Payment1Feeformdecimal?No
Payment1DateformDateTime?No
Payment2Feeformdecimal?No
Payment2DateformDateTime?No
Payment1TypeformintNo
Payment1MethodformintNo
Payment2TypeformintNo
Payment2MethodformintNo
Payment3TypeformintNo
Payment3MethodformintNo
Payment3Feeformdecimal?No
Payment3DateformDateTime?No
MembershipTypeformMembershipTypeInstanceNo
MembershipTypeIdformint?No
ProviderIdformint?No
DefinitionformstringNo
HasRecurringPaymentsformboolNo
DeletedformboolNo
DemoformboolNo
MembershipKeyformGuid?No
SessionsRemainingformint?No
ClassesRemainingformint?No
CancelledformDateTime?No
APICreatedformDateTime?No
SuspensionStartformDateTime?No
SuspensionEndformDateTime?No
IpAddressformstringNo
MemberInstance Parameters:
NameParameterData TypeRequiredDescription
MemberIdformintNo
MemberTypeformintNo
MembershipNumberformstringNo
CardNumberformstringNo
CompanyNameformstringNo
SurnameformstringNo
ForenamesformstringNo
TitleformstringNo
GenderformintNo
DateOfBirthformDateTime?No
Address1formstringNo
Address2formstringNo
CityformstringNo
CountyformstringNo
PostcodeformstringNo
HomePhoneformstringNo
MobilePhoneformstringNo
EmailAddressformstringNo
EmailOptOutformboolNo
SmsOptOutformboolNo
PhoneOptOutformboolNo
LetterOptOutformboolNo
DirectDebitAccountHolderformstringNo
DirectDebitAccountNumberformstringNo
DirectDebitSortCodeformstringNo
JoinedDateformDateTime?No
DirectDebitBankAddressformstringNo
FullNameformstringNo
ExternalReferenceformstringNo
Photoformbyte[]No
PhotoModifiedDateformDateTime?No
NotesformstringNo
DeletedformboolNo
DemoformboolNo
UseExternalStatusformboolNo
ExternalStatusformintNo
FreeTextformstringNo
MemberKeyformGuid?No
BalanceformdecimalNo
CreditLimitformdecimalNo
CreatedDateformDateTimeNo
ModifiedDateformDateTime?No
DeletedDateformDateTime?No
ExternalSourceformintNo
RetentionMetricformdecimal?No
MonthlyAttendanceFrequencyformdecimal?No
AssignedToUserIdformint?No
CreatedByUserIdformint?No
DeletedByUserIdformint?No
LossReasonformLossReasonInstanceNo
LossReasonIdformint?No
WonOrLostformint?No
WonOrLostDateformDateTime?No
GiftAidPermissionformboolNo
PhotoPermissionformbool?No
FirstAidPermissionformbool?No
EmergencyContactformstringNo
WonOrLostByUserformUserInstanceNo
WonOrLostByUserIdformint?No
AgreedToTermsformDateTime?No
OnlineBookingBannedformboolNo
CountryformstringNo
FingerprintEnrolledformDateTime?No
LastPaymentAmountformdecimal?No
PinformstringNo
ProspectingPointsformintNo
AchievementPointsformintNo
ParentForenamesformstringNo
ParentSurnameformstringNo
LossReasonInstance Parameters:
NameParameterData TypeRequiredDescription
LossReasonIdformintNo
ReasonformstringNo
DeletedformboolNo
DemoformboolNo
SelectableformboolNo
UserInstance Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
NameformstringNo
EmailformstringNo
MobilePhoneformstringNo
EnabledformboolNo
LastLoginformDateTime?No
CreatedformDateTimeNo
TrainingformboolNo
DeletedformboolNo
CoursesCompletedformintNo
DisplayHomeNotificationformbool?No
TwoFactorEnabledformboolNo
EmailConfirmedformboolNo
MobilePhoneConfirmedformboolNo
NotificationsformboolNo
ChangePasswordformDateTime?No
ActivatedformDateTime?No
MembershipTypeInstance Parameters:
NameParameterData TypeRequiredDescription
MembershipTypeIdformintNo
NameformstringNo
DescriptionformstringNo
DefinitionformstringNo
ScheduleformScheduleInstanceNo
ScheduleIdformintNo
DeletedformboolNo
DemoformboolNo
PublicformboolNo
SessionsRemainingformint?No
ClassesRemainingformint?No
SortOrderformint?No
SpecialformboolNo
MultiSiteAccessformboolNo
MemberLimitformintNo
PromotionCodeformstringNo
PromotionStartformDateTime?No
PromotionEndformDateTime?No
LicensesRemainingformint?No
BookingAccessOnlyformboolNo
SessionsPeriodformint?No
SessionsFrequencyformint?No
StartsOnformDateTime?No
AllowSelectionAfterStartsOnformboolNo
ScheduleInstance Parameters:
NameParameterData TypeRequiredDescription
ScheduleIdformintNo
NameformstringNo
DescriptionformstringNo
MondayFromformTimeSpan?No
MondayToformTimeSpan?No
TuesdayFromformTimeSpan?No
TuesdayToformTimeSpan?No
WednesdayFromformTimeSpan?No
WednesdayToformTimeSpan?No
ThursdayFromformTimeSpan?No
ThursdayToformTimeSpan?No
FridayFromformTimeSpan?No
FridayToformTimeSpan?No
SaturdayFromformTimeSpan?No
SaturdayToformTimeSpan?No
SundayFromformTimeSpan?No
SundayToformTimeSpan?No
ScheduleTypeformintNo
DeletedformboolNo
DemoformboolNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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
		}
	}
}