| Required role: | API |
| All Verbs | /api/Query/MemberGetActiveMembers |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Member | form | MemberInstance | No | |
| MemberId | form | int | No | |
| MembershipNumber | form | string | No | |
| JoinedDate | form | DateTime? | No | |
| CardNumber | form | string | No | |
| CompanyName | form | string | No | |
| FullName | form | string | No | |
| Gender | form | int | No | |
| Title | form | string | No | |
| Forenames | form | string | No | |
| Surname | form | string | No | |
| HomePhone | form | string | No | |
| MobilePhone | form | string | No | |
| EmailAddress | form | string | No | |
| DateOfBirth | form | DateTime? | No | |
| Postcode | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| County | 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 | int | No | |
| RecurringPayments | form | int? | No | |
| OverduePayments | form | int? | No | |
| BranchKey | form | Guid | No | |
| AttendanceThisWeek | form | int | No | |
| retentionMetric | form | decimal? | No | |
| MonthlyAttendanceFrequency | form | decimal? | No | |
| TotalProductSpend | form | decimal? | No | |
| JournalEntry | form | string | No | |
| BookingsAttended | form | int? | No | |
| DateOfLastBooking | form | DateTime? | No | |
| Balance | form | decimal | No | |
| CreditLimit | form | decimal | No | |
| MemberKey | form | Guid? | No | |
| EmailOptOut | form | bool | No | |
| SmsOptOut | form | bool | No | |
| PhoneOptOut | form | bool | No | |
| LetterOptOut | form | bool | No | |
| UseExternalStatus | form | bool | No | |
| ExternalStatus | form | int | No | |
| CreatedDate | form | DateTime | No | |
| ModifiedDate | form | DateTime? | No | |
| PhotoModifiedDate | form | DateTime? | No | |
| DeletedDate | form | DateTime? | No | |
| ExternalReference | form | string | No | |
| RecurringPaymentsPaidInLast30Days | form | int? | No | |
| MembershipState | form | int | No | |
| HasRecurringPayments | form | int | No | |
| LicenseRenewalDate | form | DateTime? | No | |
| LicenseReference | form | string | No | |
| LicenseStartDate | form | DateTime? | No | |
| PaymentRecurrenceCount | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LossReasonId | form | int | No | |
| Reason | form | string | No | |
| Deleted | form | bool | No | |
| Demo | form | bool | No | |
| Selectable | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | int | No | |
| UserName | form | string | No | |
| Name | form | string | No | |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/MemberGetActiveMembers HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Member":{"MemberId":0,"MemberType":0,"MembershipNumber":"String","CardNumber":"String","CompanyName":"String","Surname":"String","Forenames":"String","Title":"String","Gender":0,"DateOfBirth":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","DirectDebitBankAddress":"String","FullName":"String","ExternalReference":"String","Photo":"AA==","PhotoModifiedDate":"0001-01-01T00:00:00.0000000","Notes":"String","Deleted":false,"Demo":false,"UseExternalStatus":false,"ExternalStatus":0,"FreeText":"String","MemberKey":"00000000000000000000000000000000","Balance":0,"CreditLimit":0,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","DeletedDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","GiftAidPermission":false,"PhotoPermission":false,"FirstAidPermission":false,"EmergencyContact":"String","WonOrLostByUser":{"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"},"WonOrLostByUserId":0,"AgreedToTerms":"0001-01-01T00:00:00.0000000","OnlineBookingBanned":false,"Country":"String","FingerprintEnrolled":"0001-01-01T00:00:00.0000000","LastPaymentAmount":0,"Pin":"String","ProspectingPoints":0,"AchievementPoints":0,"ParentForenames":"String","ParentSurname":"String"},"MemberId":0,"MembershipNumber":"String","JoinedDate":"0001-01-01T00:00:00.0000000","CardNumber":"String","CompanyName":"String","FullName":"String","Gender":0,"Title":"String","Forenames":"String","Surname":"String","HomePhone":"String","MobilePhone":"String","EmailAddress":"String","DateOfBirth":"0001-01-01T00:00:00.0000000","Postcode":"String","Address1":"String","Address2":"String","City":"String","County":"String","StartDate":"0001-01-01T00:00:00.0000000","Expires":"0001-01-01T00:00:00.0000000","SessionsRemaining":0,"ContractEndDate":"0001-01-01T00:00:00.0000000","DaysRemaining":0,"MembershipType":"String","LastAttendance":"0001-01-01T00:00:00.0000000","Attendance":0,"MemberType":0,"RecurringPayments":0,"OverduePayments":0,"BranchKey":"00000000000000000000000000000000","AttendanceThisWeek":0,"retentionMetric":0,"MonthlyAttendanceFrequency":0,"TotalProductSpend":0,"JournalEntry":"String","BookingsAttended":0,"DateOfLastBooking":"0001-01-01T00:00:00.0000000","Balance":0,"CreditLimit":0,"MemberKey":"00000000000000000000000000000000","EmailOptOut":false,"SmsOptOut":false,"PhoneOptOut":false,"LetterOptOut":false,"UseExternalStatus":false,"ExternalStatus":0,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","PhotoModifiedDate":"0001-01-01T00:00:00.0000000","DeletedDate":"0001-01-01T00:00:00.0000000","ExternalReference":"String","RecurringPaymentsPaidInLast30Days":0,"MembershipState":0,"HasRecurringPayments":0,"LicenseRenewalDate":"0001-01-01T00:00:00.0000000","LicenseReference":"String","LicenseStartDate":"0001-01-01T00:00:00.0000000","PaymentRecurrenceCount":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}