ClubManager.Api

<back to all web services

FindMembershipType

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/MembershipType
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>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/MembershipType 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: 
	[
		{
			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
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}