| POST,GET | /api/Member/GetMember |
|---|
export enum Gender
{
Unknown = 'Unknown',
Male = 'Male',
Female = 'Female',
Other = 'Other',
PreferNotToSay = 'PreferNotToSay',
}
export enum ExternalStatus
{
Off = 'Off',
Active = 'Active',
Pending = 'Pending',
CancelledInsideContract = 'CancelledInsideContract',
CancelledOutsideContract = 'CancelledOutsideContract',
WithDebtRecovery = 'WithDebtRecovery',
Suspended = 'Suspended',
}
export enum MemberType
{
Prospect = 'Prospect',
Active = 'Active',
Cancelled = 'Cancelled',
Expired = 'Expired',
Suspended = 'Suspended',
ClubCancelled = 'ClubCancelled',
DropOut = 'DropOut',
}
export enum MembershipState
{
Prospect = 'Prospect',
Active = 'Active',
Expired = 'Expired',
Cancelled = 'Cancelled',
PaymentRequired = 'PaymentRequired',
Suspended = 'Suspended',
}
// @Flags()
export enum MessageTemplateContentType
{
Transactional = 1,
Marketing = 2,
None = 1048576,
}
// @Flags()
export enum MessageTemplateType
{
SMS = 1,
Email = 2,
Telephone = 4,
DirectMail = 8,
Notification = 16,
Page = 32,
None = 1048576,
NoConsent = 2097152,
}
export class Member
{
public MemberId?: number;
public BranchId?: number;
public MembershipNumber?: string;
public JoinedDate?: string;
public CardNumber?: string;
public CompanyName?: string;
public Gender?: Gender;
public GenderName?: string;
public FullName?: string;
public Title?: string;
public Forenames?: string;
public Surname?: string;
public Address1?: string;
public Address2?: string;
public County?: string;
public City?: string;
public HomePhone?: string;
public MobilePhone?: string;
public EmailAddress?: string;
public ExternalReference?: string;
public Country?: string;
public EmailOptOut?: boolean;
public SmsOptOut?: boolean;
public PhoneOptOut?: boolean;
public LetterOptOut?: boolean;
public UseExternalStatus?: boolean;
public ExternalStatus?: ExternalStatus;
public DateOfBirth?: string;
public Postcode?: string;
public Notes?: string;
public StartDate?: string;
public Expires?: string;
public SessionsRemaining?: number;
public ContractEndDate?: string;
public DaysRemaining?: number;
public MembershipType?: string;
public LastAttendance?: string;
public Attendance?: number;
public MemberType?: MemberType;
public RecurringPayments?: number;
public OverduePayments?: number;
public AttendanceThisWeek?: number;
public retentionMetric?: number;
public MonthlyAttendanceFrequency?: number;
public TotalProductSpend?: number;
public JournalEntry?: string;
public Balance?: number;
public CreditLimit?: number;
public guid?: string;
public MembershipState?: MembershipState;
public BookingsAttended?: number;
public DateOfLastBooking?: string;
public PhotoModifiedDate?: string;
public CreatedDate?: string;
public ModifiedDate?: string;
public DeletedDate?: string;
public MemberKey?: string;
public CreatedByUserId?: number;
public AssignedToUserId?: number;
public DeletedByUserId?: number;
public GiftAidPermission?: boolean;
public FirstAidPermission?: boolean;
public PhotoPermission?: boolean;
public EmergencyContact?: string;
public WonOrLost?: number;
public WonOrLostDate?: string;
public WonOrLostByUserId?: number;
public LicenseReference?: string;
public LicenseStartDate?: string;
public LicenseRenewalDate?: string;
public AgreedToTerms?: string;
public OnlineBookingBanned?: boolean;
public ChildBranchId?: number;
public ChildBranch?: string;
public ProspectingPoints?: number;
public AchievementPoints?: number;
public ParentForenames?: string;
public ParentSurname?: string;
public GradingReadiness?: number;
public DirectDebitAccountHolder?: string;
public DirectDebitAccountNumber?: string;
public DirectDebitSortCode?: string;
public DirectDebitBankAddress?: string;
public InvitedDate?: string;
public Grade?: string;
public ColourLeft?: string;
public ColourRight?: string;
public SessionsToComplete?: number;
public UniqueId?: string;
public PreferenceLink?: string;
public MarketingAllLink?: string;
public MarketingNoneLink?: string;
public AppRegistrationId?: string;
public AppRegistrationLink?: string;
public AppQrImageLink?: string;
public CardNumberQrImageLink?: string;
public PhotoThumbnailLink?: string;
public ContentTypesOptIn?: MessageTemplateContentType;
public TemplateTypesOptIn?: MessageTemplateType;
public CanEmail?: boolean;
public CanDirectMail?: boolean;
public CanSMS?: boolean;
public CanTelephone?: boolean;
public NoMarketingConsent?: boolean;
public CanSendInvite?: boolean;
public BranchKey?: string;
public SageLink?: string;
public SageLastPaymentDate?: string;
public SageFirstPaymentDate?: string;
public SageLastPaymentAmount?: number;
public SageFirstPaymentAmount?: number;
public SageTotalPaid?: number;
public constructor(init?: Partial<Member>) { (Object as any).assign(this, init); }
}
TypeScript MemberService.GetMemberRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Member/GetMember HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<MemberService.GetMemberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services">
<MemberId>0</MemberId>
</MemberService.GetMemberRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <Member xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Models.Member"> <_x003C_AchievementPoints_x003E_k__BackingField>0</_x003C_AchievementPoints_x003E_k__BackingField> <_x003C_Address1_x003E_k__BackingField>String</_x003C_Address1_x003E_k__BackingField> <_x003C_Address2_x003E_k__BackingField>String</_x003C_Address2_x003E_k__BackingField> <_x003C_AgreedToTerms_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_AgreedToTerms_x003E_k__BackingField> <_x003C_AssignedToUserId_x003E_k__BackingField>0</_x003C_AssignedToUserId_x003E_k__BackingField> <_x003C_AttendanceThisWeek_x003E_k__BackingField>0</_x003C_AttendanceThisWeek_x003E_k__BackingField> <_x003C_Attendance_x003E_k__BackingField>0</_x003C_Attendance_x003E_k__BackingField> <_x003C_Balance_x003E_k__BackingField>0</_x003C_Balance_x003E_k__BackingField> <_x003C_BookingsAttended_x003E_k__BackingField>0</_x003C_BookingsAttended_x003E_k__BackingField> <_x003C_BranchId_x003E_k__BackingField>0</_x003C_BranchId_x003E_k__BackingField> <_x003C_BranchKey_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_BranchKey_x003E_k__BackingField> <_x003C_CardNumber_x003E_k__BackingField>String</_x003C_CardNumber_x003E_k__BackingField> <_x003C_ChildBranchId_x003E_k__BackingField>0</_x003C_ChildBranchId_x003E_k__BackingField> <_x003C_ChildBranch_x003E_k__BackingField>String</_x003C_ChildBranch_x003E_k__BackingField> <_x003C_City_x003E_k__BackingField>String</_x003C_City_x003E_k__BackingField> <_x003C_ColourLeft_x003E_k__BackingField>String</_x003C_ColourLeft_x003E_k__BackingField> <_x003C_ColourRight_x003E_k__BackingField>String</_x003C_ColourRight_x003E_k__BackingField> <_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField> <_x003C_ContentTypesOptIn_x003E_k__BackingField>Transactional</_x003C_ContentTypesOptIn_x003E_k__BackingField> <_x003C_ContractEndDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ContractEndDate_x003E_k__BackingField> <_x003C_Country_x003E_k__BackingField>String</_x003C_Country_x003E_k__BackingField> <_x003C_County_x003E_k__BackingField>String</_x003C_County_x003E_k__BackingField> <_x003C_CreatedByUserId_x003E_k__BackingField>0</_x003C_CreatedByUserId_x003E_k__BackingField> <_x003C_CreatedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CreatedDate_x003E_k__BackingField> <_x003C_CreditLimit_x003E_k__BackingField>0</_x003C_CreditLimit_x003E_k__BackingField> <_x003C_DateOfBirth_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateOfBirth_x003E_k__BackingField> <_x003C_DateOfLastBooking_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateOfLastBooking_x003E_k__BackingField> <_x003C_DaysRemaining_x003E_k__BackingField>0</_x003C_DaysRemaining_x003E_k__BackingField> <_x003C_DeletedByUserId_x003E_k__BackingField>0</_x003C_DeletedByUserId_x003E_k__BackingField> <_x003C_DeletedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DeletedDate_x003E_k__BackingField> <_x003C_DirectDebitAccountHolder_x003E_k__BackingField>String</_x003C_DirectDebitAccountHolder_x003E_k__BackingField> <_x003C_DirectDebitAccountNumber_x003E_k__BackingField>String</_x003C_DirectDebitAccountNumber_x003E_k__BackingField> <_x003C_DirectDebitBankAddress_x003E_k__BackingField>String</_x003C_DirectDebitBankAddress_x003E_k__BackingField> <_x003C_DirectDebitSortCode_x003E_k__BackingField>String</_x003C_DirectDebitSortCode_x003E_k__BackingField> <_x003C_EmailAddress_x003E_k__BackingField>String</_x003C_EmailAddress_x003E_k__BackingField> <_x003C_EmailOptOut_x003E_k__BackingField>false</_x003C_EmailOptOut_x003E_k__BackingField> <_x003C_EmergencyContact_x003E_k__BackingField>String</_x003C_EmergencyContact_x003E_k__BackingField> <_x003C_Expires_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_Expires_x003E_k__BackingField> <_x003C_ExternalReference_x003E_k__BackingField>String</_x003C_ExternalReference_x003E_k__BackingField> <_x003C_ExternalStatus_x003E_k__BackingField>Off</_x003C_ExternalStatus_x003E_k__BackingField> <_x003C_FirstAidPermission_x003E_k__BackingField>false</_x003C_FirstAidPermission_x003E_k__BackingField> <_x003C_Forenames_x003E_k__BackingField>String</_x003C_Forenames_x003E_k__BackingField> <_x003C_FullName_x003E_k__BackingField>String</_x003C_FullName_x003E_k__BackingField> <_x003C_GenderName_x003E_k__BackingField>String</_x003C_GenderName_x003E_k__BackingField> <_x003C_Gender_x003E_k__BackingField>Unknown</_x003C_Gender_x003E_k__BackingField> <_x003C_GiftAidPermission_x003E_k__BackingField>false</_x003C_GiftAidPermission_x003E_k__BackingField> <_x003C_Grade_x003E_k__BackingField>String</_x003C_Grade_x003E_k__BackingField> <_x003C_GradingReadiness_x003E_k__BackingField>0</_x003C_GradingReadiness_x003E_k__BackingField> <_x003C_HomePhone_x003E_k__BackingField>String</_x003C_HomePhone_x003E_k__BackingField> <_x003C_InvitedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_InvitedDate_x003E_k__BackingField> <_x003C_JoinedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_JoinedDate_x003E_k__BackingField> <_x003C_JournalEntry_x003E_k__BackingField>String</_x003C_JournalEntry_x003E_k__BackingField> <_x003C_LastAttendance_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastAttendance_x003E_k__BackingField> <_x003C_LetterOptOut_x003E_k__BackingField>false</_x003C_LetterOptOut_x003E_k__BackingField> <_x003C_LicenseReference_x003E_k__BackingField>String</_x003C_LicenseReference_x003E_k__BackingField> <_x003C_LicenseRenewalDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LicenseRenewalDate_x003E_k__BackingField> <_x003C_LicenseStartDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LicenseStartDate_x003E_k__BackingField> <_x003C_MemberId_x003E_k__BackingField>0</_x003C_MemberId_x003E_k__BackingField> <_x003C_MemberKey_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_MemberKey_x003E_k__BackingField> <_x003C_MemberType_x003E_k__BackingField>Prospect</_x003C_MemberType_x003E_k__BackingField> <_x003C_MembershipNumber_x003E_k__BackingField>String</_x003C_MembershipNumber_x003E_k__BackingField> <_x003C_MembershipState_x003E_k__BackingField>Prospect</_x003C_MembershipState_x003E_k__BackingField> <_x003C_MembershipType_x003E_k__BackingField>String</_x003C_MembershipType_x003E_k__BackingField> <_x003C_MobilePhone_x003E_k__BackingField>String</_x003C_MobilePhone_x003E_k__BackingField> <_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField> <_x003C_MonthlyAttendanceFrequency_x003E_k__BackingField>0</_x003C_MonthlyAttendanceFrequency_x003E_k__BackingField> <_x003C_Notes_x003E_k__BackingField>String</_x003C_Notes_x003E_k__BackingField> <_x003C_OnlineBookingBanned_x003E_k__BackingField>false</_x003C_OnlineBookingBanned_x003E_k__BackingField> <_x003C_OverduePayments_x003E_k__BackingField>0</_x003C_OverduePayments_x003E_k__BackingField> <_x003C_ParentForenames_x003E_k__BackingField>String</_x003C_ParentForenames_x003E_k__BackingField> <_x003C_ParentSurname_x003E_k__BackingField>String</_x003C_ParentSurname_x003E_k__BackingField> <_x003C_PhoneOptOut_x003E_k__BackingField>false</_x003C_PhoneOptOut_x003E_k__BackingField> <_x003C_PhotoModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_PhotoModifiedDate_x003E_k__BackingField> <_x003C_PhotoPermission_x003E_k__BackingField>false</_x003C_PhotoPermission_x003E_k__BackingField> <_x003C_Postcode_x003E_k__BackingField>String</_x003C_Postcode_x003E_k__BackingField> <_x003C_ProspectingPoints_x003E_k__BackingField>0</_x003C_ProspectingPoints_x003E_k__BackingField> <_x003C_RecurringPayments_x003E_k__BackingField>0</_x003C_RecurringPayments_x003E_k__BackingField> <_x003C_SageFirstPaymentAmount_x003E_k__BackingField>0</_x003C_SageFirstPaymentAmount_x003E_k__BackingField> <_x003C_SageFirstPaymentDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_SageFirstPaymentDate_x003E_k__BackingField> <_x003C_SageLastPaymentAmount_x003E_k__BackingField>0</_x003C_SageLastPaymentAmount_x003E_k__BackingField> <_x003C_SageLastPaymentDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_SageLastPaymentDate_x003E_k__BackingField> <_x003C_SageLink_x003E_k__BackingField>String</_x003C_SageLink_x003E_k__BackingField> <_x003C_SageTotalPaid_x003E_k__BackingField>0</_x003C_SageTotalPaid_x003E_k__BackingField> <_x003C_SessionsRemaining_x003E_k__BackingField>0</_x003C_SessionsRemaining_x003E_k__BackingField> <_x003C_SessionsToComplete_x003E_k__BackingField>0</_x003C_SessionsToComplete_x003E_k__BackingField> <_x003C_SmsOptOut_x003E_k__BackingField>false</_x003C_SmsOptOut_x003E_k__BackingField> <_x003C_StartDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_StartDate_x003E_k__BackingField> <_x003C_Surname_x003E_k__BackingField>String</_x003C_Surname_x003E_k__BackingField> <_x003C_TemplateTypesOptIn_x003E_k__BackingField>SMS</_x003C_TemplateTypesOptIn_x003E_k__BackingField> <_x003C_Title_x003E_k__BackingField>String</_x003C_Title_x003E_k__BackingField> <_x003C_TotalProductSpend_x003E_k__BackingField>0</_x003C_TotalProductSpend_x003E_k__BackingField> <_x003C_UseExternalStatus_x003E_k__BackingField>false</_x003C_UseExternalStatus_x003E_k__BackingField> <_x003C_WonOrLostByUserId_x003E_k__BackingField>0</_x003C_WonOrLostByUserId_x003E_k__BackingField> <_x003C_WonOrLostDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_WonOrLostDate_x003E_k__BackingField> <_x003C_WonOrLost_x003E_k__BackingField>0</_x003C_WonOrLost_x003E_k__BackingField> <_x003C_guid_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_guid_x003E_k__BackingField> <_x003C_retentionMetric_x003E_k__BackingField>0</_x003C_retentionMetric_x003E_k__BackingField> </Member>